getCloudMssqlConfigGroupList

Prev Next

VPC環境で利用できます。

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

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /getCloudMssqlConfigGroupList

リクエストヘッダ

Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Cloud DB for MSSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
configGroupNo String Optional Cloud DB for MSSQL Config Group番号
configGroupName String Optional Cloud DB for MSSQL Config Group名
cloudMssqlInstanceNo String Optional Cloud DB for MSSQLインスタンス番号
cloudMssqlServiceName String Optional Cloud DB for MSSQLサービス名
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlConfigGroupList
?regionCode=KR
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudMssqlConfigGroupListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

  • responseFormetType=jsonの場合

    {
    "getCloudMssqlConfigGroupListResponse": {
        "totalRows": 1,
        "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": [
                    "2501****",
                    "2517****",
                    "2522****"
                ]
            }
        ],
        "requestId": "be65476a-****-****-****-820c9f748a7f",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlConfigGroupListResponse>
    <requestId>be65476a-****-****-****-820c9f748a7f</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</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>
                <cloudMssqlInstanceNo>2501****</cloudMssqlInstanceNo>
                <cloudMssqlInstanceNo>2517****</cloudMssqlInstanceNo>
                <cloudMssqlInstanceNo>2522****</cloudMssqlInstanceNo>
            </cloudMssqlInstanceNoList>
        </cloudMssqlConfigGroup>
    </cloudMssqlConfigGroupList>
</getCloudMssqlConfigGroupListResponse>