Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

Cloud DB for MySQL (VPC) overview

Prev Next

Available in VPC

Cloud DB for MySQL is a fully managed cloud database service using MySQL, which is the most widely used relational database in the world. Cloud DB for MySQL provides CLIs for database management features with the vmysql command.

Common Cloud DB for MySQL (VPC) settings

This section covers the command and option formats used across the Cloud DB for MySQL (VPC) CLI.

Syntax

Run vmysql using the following syntax.

./ncloud vmysql <subcommand> [options]

Options

The following options are available across all vmysql subcommands:

Options Type Required Description
--regionCode String Optional Region code
  • KR | SGN | JPN
  • Default: First Region in the getRegionList query results (default).
--output String Optional Format of the response result
  • json (default) | xml

Cloud DB for MySQL (VPC) commands

The following subcommands are available under vmysql.

DB Server

The following describes the DB server-related commands:

Commands Description
createCloudMysqlInstance Create a Cloud DB for MySQL instance.
getCloudMysqlInstanceList Get Cloud DB for MySQL instance list.
getCloudMysqlInstanceDetail Get Cloud DB for MySQL instance details.
createCloudMysqlSlaveInstance Add a slave server instance in a Cloud DB for MySQL instance.
getCloudMysqlRecoveryTime Get the restorable time of a Cloud DB for MySQL instance.
createCloudMysqlRecoveryInstance Add a recovery server instance in a Cloud DB for MySQL instance.
changeCloudMysqlServerSpec Change the DB server specifications for a Cloud DB for MySQL instance.
upgradeCloudMysqlDbEngineVersion Upgrade the DB engine version of a Cloud DB for MySQL instance.
rebootCloudMysqlServerInstance Restart a Cloud DB for MySQL server instance.
getCloudMysqlEventHistoryList Get the event history list of a Cloud DB for MySQL instance.
deleteCloudMysqlServerInstance Delete a slave or recovery server instance in a Cloud DB for MySQL instance.
deleteCloudMysqlInstance Delete a Cloud DB for MySQL instance.

Database

The following describes the database-related commands:

Commands Description
addCloudMysqlDatabaseList Add a database in a Cloud DB for MySQL instance.
getCloudMysqlDatabaseList Get the database list for a Cloud DB for MySQL instance.
deleteCloudMysqlDatabaseList Delete a database from a Cloud DB for MySQL instance.

DB User

The following describes the DB user-related commands:

Commands Description
addCloudMysqlUserList Add a user to a Cloud DB for MySQL instance.
getCloudMysqlUserList Get the user list for a Cloud DB for MySQL instance.
changeCloudMysqlUserList Edit user information for a Cloud DB for MySQL instance.
deleteCloudMysqlUserList Delete a user from a Cloud DB for MySQL instance.

Backup

The following describes the backup-related commands:

Commands Description
getCloudMysqlBackupList Get the Cloud DB for MySQL instance backup list.
getCloudMysqlBackupDetailList Get the list of Cloud DB for MySQL instance backup details.
exportBackupToObjectStorage Send Cloud DB for MySQL instance backup files to Object Storage.

DB Server Log

The following describes the DB server logs-related commands:

Commands Description
getDbServerLogList Get the DB server log list of a Cloud DB for MySQL instance.
exportDbServerLogToObjectStorage Send DB server log files in a Cloud DB for MySQL instance to Object Storage.

Common

Use the following common lookup commands when creating resources:

Commands Description
getCloudMysqlImageProductList Get the list of Cloud DB for MySQL image product codes.
getCloudMysqlProductList Get the list of Cloud DB for MySQL server specification codes.
getCloudMysqlTargetVpcList Get VPC list.
getCloudMysqlTargetSubnetList Get subnet list.

Cloud DB for MySQL (VPC) related resources

These resources provide additional context and support for the Cloud DB for MySQL (VPC) CLI.