getCloudMysqlInstanceList

Available in VPC

Get the list of Cloud DB for MySQL instances.

Syntax

The getCloudMysqlInstanceList syntax is as follows:

./ncloud vmysql getCloudMysqlInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudMysqlServiceName <service-name>] \
    [--cloudMysqlInstanceNoList <instance-no-list>] \
    [--cloudMysqlServerName <server-name>] \
    [--cloudMysqlServerInstanceNoList <server-instance-no-list>] \
    [--generationCode <G2|G3>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMysqlInstanceList.

Required options

The following options are required for getCloudMysqlInstanceList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Number of items per page `1`-N Required when entering `pageNo`.

Optional options

These are the optional options for getCloudMysqlInstanceList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--zoneCode`	String	Optional	Zone code See getZoneList.
`--vpcNo`	String	Optional	VPC number See getCloudMysqlTargetVpcList.
`--subnetNo`	String	Optional	Subnet number See getCloudMysqlTargetSubnetList.
`--cloudMysqlServiceName`	String	Optional	Cloud DB for MySQL service name
`--cloudMysqlInstanceNoList`	List	Optional	Cloud DB for MySQL instance number list You can enter multiple items separated by spaces (e.g., `--cloudMysqlInstanceNoList 1234 2345`).
`--cloudMysqlServerName`	String	Optional	Cloud DB for MySQL server name
`--cloudMysqlServerInstanceNoList`	List	Optional	Cloud DB for MySQL server instance number list You can enter multiple items separated by spaces (e.g., `--cloudMysqlServerInstanceNoList 1234 2345`).
`--generationCode`	String	Optional	Server generation code `G2` \| `G3`
`--pageNo`	Integer	Optional	Page number `0`-N

Common options

For information about the options common to all vmysql subcommands, see Cloud DB for MySQL (VPC) options.

Examples

If the request to retrieve the list of Cloud DB for MySQL instances is successful, the configuration information and status of each instance are returned.

Command

The command example is as follows:

./ncloud vmysql getCloudMysqlInstanceList \
    --zoneCode KR-1 \
    --vpcNo 98765432 \
    --subnetNo 23456789 \
    --cloudMysqlServiceName test-mysql \
    --cloudMysqlInstanceNoList 12345678 \
    --cloudMysqlServerName testmysql-001-97mj \
    --cloudMysqlServerInstanceNoList 34567890 \
    --generationCode G2 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMysqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMysqlInstanceList": [
      {
        "cloudMysqlInstanceNo": "17234567",
        "cloudMysqlServiceName": "test-mysql",
        "cloudMysqlInstanceStatusName": "running",
        "cloudMysqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudMysqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "isHa": true,
        "isMultiZone": true,
        "generationCode": "G2",
        "cloudMysqlServerInstanceList": [
          {
            "cloudMysqlServerInstanceNo": "34567890",
            "cloudMysqlServerName": "testmysql-001-97mj",
            "cloudMysqlServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "cloudMysqlServerInstanceStatusName": "running",
            "cloudMysqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "98765432",
            "subnetNo": "23456789",
            "privateIp": "10.0.0.6",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          },
          {
            "cloudMysqlServerInstanceNo": "34567891",
            "cloudMysqlServerName": "testmysql-002-97mk",
            "cloudMysqlServerRole": {
              "code": "H",
              "codeName": "Standby Master"
            },
            "cloudMysqlServerInstanceStatusName": "running",
            "cloudMysqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMysqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "98765432",
            "subnetNo": "23456790",
            "privateIp": "10.0.1.6",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}