getCloudMssqlInstanceList

Available in VPC

Get the list of Cloud DB for MSSQL instances.

Syntax

The getCloudMssqlInstanceList syntax is as follows:

./ncloud vmssql getCloudMssqlInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudMssqlServiceName <service-name>] \
    [--cloudMssqlInstanceNoList <instance-no-list>] \
    [--cloudMssqlServerName <server-name>] \
    [--cloudMssqlServerInstanceNoList <server-instance-no-list>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getCloudMssqlInstanceList.

Required options

The following options are required for getCloudMssqlInstanceList.

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

Optional options

These are the optional options for getCloudMssqlInstanceList. 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 getCloudMssqlTargetVpcList.
`--subnetNo`	String	Optional	Subnet number See getCloudMssqlTargetSubnetList.
`--cloudMssqlServiceName`	String	Optional	Cloud DB for MSSQL service name
`--cloudMssqlInstanceNoList`	List	Optional	Cloud DB for MSSQL instance number list You can enter multiple items separated by spaces (e.g., `--cloudMssqlInstanceNoList 1234 2345`).
`--cloudMssqlServerName`	String	Optional	Cloud DB for MSSQL server name
`--cloudMssqlServerInstanceNoList`	List	Optional	Cloud DB for MSSQL server instance number list You can enter multiple items separated by spaces (e.g., `--cloudMssqlServerInstanceNoList 1234 2345`).
`--pageNo`	Integer	Optional	Page number `0`-N

Common options

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

Examples

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

Command

The command example is as follows:

./ncloud vmssql getCloudMssqlInstanceList \
    --zoneCode KR-1 \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudMssqlServiceName test-mssql-01 \
    --cloudMssqlInstanceNoList 25280088 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "25280088",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE (VPC) Created status"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "generationCode": "G2",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "25280089",
            "cloudMssqlServerName": "m-25280088-001",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296
          },
          {
            "cloudMssqlServerInstanceNo": "25280090",
            "cloudMssqlServerName": "m-25280088-002",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE (VPC) server Running status"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server null OP"
            },
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}