getCloudMssqlConfigGroupList
- Print
- PDF
getCloudMssqlConfigGroupList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Get the list of config groups available to use in Cloud DB for MSSQL.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
GET, POST | /getCloudMssqlConfigGroupList |
Request headers
For headers common to all Cloud DB for MSSQL (VPC) APIs, see Cloud DB for MSSQL (VPC) headers.
Request parameter
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
regionCode | String | Optional | Region code of the Cloud DB for MSSQL instance to view
|
configGroupNo | String | Optional | Cloud DB for MSSQL config group number
|
configGroupName | String | Optional | Cloud DB for MSSQL config group name
|
cloudMssqlInstanceNo | String | Optional | Cloud DB for MSSQL instance number
|
cloudMssqlServiceName | String | Optional | Cloud DB for MSSQL service name
|
responseFormatType | String | Optional | Format of the response result
|
Request example
The following is a sample request.
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}'
Response
The following describes the response format.
Response body
See CloudMssqlConfigGroupList for the response body.
Response status codes
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Response example
The following is a sample response.
If
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" } }
If
responseFormetType=xml
(default)<?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>
Was this article helpful?