getCloudMssqlConfigGroupList

VPC環境で利用できます。

使用可能な Cloud DB for MSSQL Config Groupリストを照会します。

コマンド

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

ncloud vmssql getCloudMssqlConfigGroupList [regionCode] [configGroupNo] [configGroupName] [cloudMssqlInstanceNo] [cloudMssqlServiceName] [output]

パラメータ

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

パラメータ	タイプ	要否	説明	制約事項
regionCode	String	N	リージョンコード - regionCodeは、getRegionListアクションを通じて取得 - default: getRegionList照会結果の最初のリージョンを選択	-
configGroupNo	String	N	Cloud DB for MSSQL Config Group番号	-
configGroupName	String	N	Cloud DB for MSSQL Config Group名	-
cloudMssqlInstanceNo	String	N	Cloud DB for MSSQLインスタンス番号 - cloudMssqlInstanceNoは、getCloudMssqlInstanceListアクションを通じて取得	-
cloudMssqlServiceName	String	N	Cloud DB for MSSQLサービス名	-
output	String	N	レスポンス結果のフォーマットタイプ - options: xml \| json - default: json	-

レスポンス

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

CloudMssqlConfigGroupListタイプ

CloudMssqlConfigGroupList extends CommonResponse	説明
private Integer totalRows;	照会されたリストの総数
private List<CloudMssqlConfigGroup> cloudMssqlConfigGroupList = new ArrayList<>();	Cloud DB for MSSQL Config Groupリスト

CloudMssqlConfigGroupタイプ

CloudMssqlConfigGroup	説明
private String configGroupNo;	Cloud DB for MSSQL Config Group番号
private String configGroupName;	Cloud DB for MSSQL Config Group名
private String configGroupDescription;	Cloud DB for MSSQL Config Groupの説明
private CommonCode configGroupType;	Cloud DB for MSSQL Config Groupタイプ
private String configGroupStatusName;	Cloud DB for MSSQL Config Group状態
private CommonCode configGroupStatus;	Cloud DB for MSSQL Config Groupステータス名
private Date createDate;	Cloud DB for MSSQL Config Group作成日
private Date modifyDate;	Cloud DB for MSSQL Config Group最終更新日
private List<Integer> cloudMssqlInstanceNoList;	Cloud DB for MSSQL Config Groupを使用している Cloud DB for MSSQL Instance番号リスト

例

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

呼び出し例

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

ncloud vmssql getCloudMssqlConfigGroupList --regionCode KR --cloudMssqlInstanceNo ****590

レスポンス例

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

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

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

{
  "getCloudMssqlConfigGroupListResponse": {
    "requestId": "f8883b8a-d4b0-486d-8c6f-163a76c62209",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 2,
    "cloudMssqlConfigGroupList": [
      {
        "configGroupNo": "0",
        "configGroupName": "mssql_2019_default",
        "configGroupType": {
          "code": "SYSTEM",
          "codeName": "Config Group System Type"
        },
        "configGroupStatusName": "running",
        "configGroupStatus": {
          "code": "RUN",
          "codeName": "CONFIG GROUP Running State"
        },
        "createDate": "2018-02-10T17:03:55+0900",
        "modifyDate": "2018-02-10T17:03:55+0900",
        "cloudMssqlInstanceNoList": [
          1698967
        ]
      },
      {
        "configGroupNo": "**9",
        "configGroupName": "cfg-***-test",
        "configGroupDescription": "ConfigGroup Description",
        "configGroupType": {
          "code": "USER",
          "codeName": "Config Group User Type"
        },
        "configGroupStatusName": "running",
        "configGroupStatus": {
          "code": "RUN",
          "codeName": "CONFIG GROUP Running State"
        },
        "createDate": "2021-03-04T11:49:55+0900",
        "modifyDate": "2021-03-04T11:49:55+0900"
      }
    ]
  }
}

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

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

<getCloudMssqlConfigGroupListResponse>
    <requestId>f8883b8a-d4b0-486d-8c6f-163a76c62209</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMssqlConfigGroupList>
        <CloudMssqlConfigGroup>
            <configGroupNo>0</configGroupNo>
            <configGroupName>mssql_2019_default</configGroupName>
            <configGroupType>
                <code>SYSTEM</code>
                <codeName>Config Group System Type</codeName>
            </configGroupType>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <createDate>2018-02-10T17:03:55+0900</createDate>
            <modifyDate>2018-02-10T17:03:55+0900</modifyDate>
            <cloudMssqlInstanceNoList>
                <int>1698967</int>
            </cloudMssqlInstanceNoList>
        </CloudMssqlConfigGroup>
        <CloudMssqlConfigGroup>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>cfg-***-test</configGroupName>
            <configGroupDescription>ConfigGroup Description</configGroupDescription>
            <configGroupType>
                <code>USER</code>
                <codeName>Config Group User Type</codeName>
            </configGroupType>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <createDate>2021-03-04T11:49:55+0900</createDate>
            <modifyDate>2021-03-04T11:49:55+0900</modifyDate>
        </CloudMssqlConfigGroup>
    </cloudMssqlConfigGroupList>
</getCloudMssqlConfigGroupListResponse>