getCloudMssqlTargetVpcList

Prev Next

VPC環境で利用できます。

使用できる VPCリストを照会します。

コマンド

コマンド構文は、次のとおりです。

ncloud vmssql getCloudMssqlTargetVpcList [regionCode] [output]

パラメータ

パラメータについての説明は、次のとおりです。

パラメータ タイプ 要否 説明 制約事項
regionCode String N リージョンコード
- regionCodeは、getRegionListアクションを通じて取得
- default: getRegionList照会結果の最初のリージョンを選択		 -
output String N レスポンス結果のフォーマットタイプ
- options: xml | json
- default: json		 -

レスポンス

レスポンスデータのタイプ

  • TargetVpcListタイプ

    TargetVpcList extends CommonResponse 説明
    private Integer totalRows; 照会されたリストの総数
    private List<TargetVpc> targetVpcList = new ArrayList<>(); VPCリスト

  • TargetVpcタイプ

    TargetVpc 説明
    private String vpcNo; VPC番号
    private String vpcName; VPC名
    private String ipv4Cidr; VPC説明
    private String regionCode; VPCが位置するリージョンコード
    private Date createdDate; 作成日

例

呼び出しとレスポンス例を説明します。

呼び出し例

呼び出し例は、次のとおりです。

ncloud vmssql getCloudMssqlTargetVpcList --regionCode KR

レスポンス例

レスポンス例は、次のとおりです。

レスポンス結果フォーマットタイプ(output)が jsonの場合

レスポンス結果フォーマットタイプ(output)が jsonの場合は、次のとおりです。

{
  "getCloudMssqlTargetVpcListResponse": {
    "requestId": "4ea62ae7-b127-4c02-9a71-2a36f3190a55",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "targetVpcList": [
      {
        "vpcNo": "25****",
        "vpcName": "test-****",
        "ipv4Cidr": "192.168.0.0/16",
        "regionCode": "KR",
        "createdDate": "2022-03-24T18:00:00+0900"
      }
    ]
  }
}

レスポンス結果フォーマットタイプ(responseFormatType)が xmlの場合

レスポンス結果フォーマットタイプ(responseFormatType)が xmlの場合は、次のとおりです。

<getCloudMssqlTargetVpcListResponse>
    <requestId>4ea62ae7-b127-4c02-9a71-2a36f3190a55</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetVpcList>
        <targetVpc>
            <vpcNo>25****</vpcNo>
            <vpcName>test-****</vpcName>
            <ipv4Cidr>192.168.0.0/16</ipv4Cidr>
            <regionCode>KR</regionCode>
            <createdDate>2022-03-24T18:00:00+0900</createdDate>
        </targetVpc>
    </targetVpcList>
</getCloudMssqlTargetVpcListResponse>