getCloudMssqlInstanceList

VPC環境で利用できます。

Cloud DB for MSSQLインスタンスリストを照会します。

構文

getCloudMssqlInstanceList構文は次の通りです。

./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>]

オプション

getCloudMssqlInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getCloudMssqlInstanceListの必須オプションです。

任意オプション

getCloudMssqlInstanceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

共通オプション

vmssqlコマンドで共通して使用するオプションについては、Cloud DB for MSSQL (VPC)のオプションを参照してください。

例

Cloud DB for MSSQLインスタンスリストの照会リクエストが成功すると、各インスタンスの構成情報と状態が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "25280088",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created状態"
        },
        "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)サーバ Running状態"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Running状態"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC)サーバ Null OP"
            },
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}