getCloudDBConfigGroupList

Prev Next

Overview

Gets a list of available Cloud DB config groups.
Currently, it is available for MSSQL only.

Request

Request header

Header Description
x-ncp-apigw-timestamp It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key API key issued by API Gateway (not used in the API v2)
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key Access Key ID issued from the NAVER Cloud Platform portal.
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Signature encrypted with your Access Key ID and Secret Key.
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Set the request body content type to application/json.
Content-Type: application/json

Request parameters

Parameter Required Type Limitations Description
dbKindCode Y String MSSQL DB type code
responseFormatType N String Response format

  • dbKindCode

    • Cloud DB type to get. It is not available for MySQL, and currently it is available for MSSQL only.

  • responseFormatType

    • Response format. Select between xml and json.

Response

Field Type Description Note
requestId String Request ID
returnMessage String Response message
totalRows Integer Number of response result rows
cloudDBConfigGroupList[] String List of Cloud DB config groups

Examples

Request example

curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBConfigGroupList?dbKindCode=MSSQL&responseFormatType=json" 
-H "accept: application/json" 
-H "Content-Type: application/x-www-form-urlencoded" 
-H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM" 
-H "x-ncp-apigw-timestamp: 1546398302273" 
-H "x-ncp-apigw-signature-v2: VXjaLhHB2CdowCrqDNYg7w7GR3TYxZzM2eIZ+i3IH0Q="

https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBConfigGroupList?dbKindCode=MSSQL&responseFormatType=json

Request sample

  • Get a list of available Cloud DB for MSSQL config groups.
{
  "dbKindCode": "MSSQL",
  "responseFormatType": "json"
}

Response example

connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Mon, 24 Dec 2018 08:59:40 GMT 
server: nginx 
transfer-encoding: chunked 
x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2 

{
  "getCloudDBConfigGroupListResponse": {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 2,
    "cloudDBConfigGroupList": [
      {
        "configGroupNo": "0",
        "configGroupType": "system",
        "configGroupName": "mssql_2016_default"
      },
      {
        "configGroupNo": "91",
        "configGroupType": "user",
        "configGroupName": "test-group"
      }
    ]
  }
}

Error codes

If a Cloud DB API request is invalid or an error occurs while processing the request, the API returns an HTTP status code representing success or failure with a detailed message in JSON.

There are two types of error codes: “common error code” of the Cloud DB API and “API Gateway error code.”

Error code Response message Description
200 Ok
500 Server Error