deleteCloudDBServerInstance
- Print
- PDF
deleteCloudDBServerInstance
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Deletes the CloudDB instance.
Requests
Request headers
Header name | Description |
---|---|
x-ncp-apigw-timestamp | It indicates the time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds and the request is considered invalid if the time difference from the API Gateway server is greater than 5 minutes.x-ncp-apigw-timestamp:{Timestamp} |
x-ncp-apigw-api-key | Key value issued by APIGW; api-key is not used when using v2.x-ncp-apigw-api-key:{API Gateway API Key} |
x-ncp-iam-access-key | Access key ID value issued by the NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Signature encrypted with the Access Key ID value and Secret Keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
Content-Type | Specify the request body content type as application/jsonContent-Type: application/json |
Request body
For API request, field names are case-sensitive.
Parameter name | Requirement status | Type | Restrictions | Description |
---|---|---|---|---|
cloudDBServerInstanceNo | Y | String | When entering the CloudDB server instance number and master server instance number, it deletes the entire cluster. When entering other server instance numbers, it will delete only the relevant server. | |
responseFormatType | N | String | Sets the results format of the response |
cloudDBServerInstanceNo
- The instance number of the CloudDB to delete. This number is unknown in the MC console. You need to find the server instance number of CloudDB you want to delete from the response result by executing the getCloudDBInstanceList API.
responseFormatType
- Determines the format to receive API execution results as a response. You may select between XML and JSON.
Response
Field name | Type | Description | Remarks |
---|---|---|---|
returnCode | Integer | Response code value | |
returnMessage | String | Response message | |
totalRows | Integer | Number of rows in response results | |
cloudDBInstanceList[] | String | Created Cloud DB Instance information |
Examples
Request examples
curl -X POST "https://ncloud.apigw.ntruss.com/clouddb/v2/deleteCloudDBServerInstance"
-H "accept: application/json"
-H "Content-Type: application/x-www-form-urlencoded"
-H "x-ncp-apigw-api-key: 25bpuog9sz"
-H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
-H "x-ncp-apigw-timestamp: 1545985588464"
-H "x-ncp-apigw-signature-v2: 8AjXzJBJ/7AZ+u2Er007Pvq2cr6Md/ySH3YrDvd9dHY="
-d "cloudDBServerInstanceNo=882618&responseFormatType=json"
https://ncloud.apigw.ntruss.com/clouddb/v2/deleteCloudDBServerInstance
Request sample
- Delete MySQL server
{
"cloudDBServerInstanceNo": "882618",
"responseFormatType": "json"
}
Response examples
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
{
"deleteCloudDBServerInstanceResponse": {
"returnCode": "0",
"returnMessage": "success",
"totalRows": 1,
"cloudDBInstanceList": [
{
"cloudDBInstanceNo": "882617",
"cloudDBServiceName": "test",
"dbKindCode": "MYSQL",
"engineVersion": "MYSQL5.7.19",
"cpuCount": 2,
"memorySize": 4294967296,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"licenseCode": "GPL",
"cloudDBPort": 3306,
"isHa": true,
"cloudDBInstanceStatusName": "deleting",
"collation": "",
"createDate": "2018-12-28T14:37:00+0900",
"cloudDBImageProductCode": "SPSWMYSQLLINUX01",
"cloudDBProductCode": "SPSVRDBAAS000001",
"isCloudDBConfigNeedReboot": false,
"isCloudDBNeedReboot": false,
"zone": {
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "가산 zone",
"regionNo": "1"
},
"region": {
"regionNo": "1",
"regionCode": "KR",
"regionName": "Korea"
},
"cloudDBConfigList": [],
"cloudDBConfigGroupList": [],
"accessControlGroupList": [
{
"accessControlGroupConfigurationNo": "23949",
"accessControlGroupName": "cloud-db-ix15",
"accessControlGroupDescription": "Group for cloud DB service 'test' (automatically created)",
"isDefault": false,
"createDate": "2018-12-28T14:37:29+0900"
}
],
"cloudDBServerInstanceList": [
{
"cloudDBServerInstanceNo": "882618",
"cloudDBServerInstanceStatusName": "deleting",
"cloudDBServerName": "test-001",
"cloudDBServerRole": {
"code": "M",
"codeName": "Master"
},
"privateDnsName": "db-qttq.beta-cdb.ntruss.com",
"publicDnsName": "",
"dataStorageSize": 10737418240,
"usedDataStorageSize": 0,
"createDate": "2018-12-28T14:37:00+0900",
"uptime": "2018-12-28T17:21:00+0900"
},
{
"cloudDBServerName": "test-002",
"cloudDBServerRole": {
"code": "H",
"codeName": "Hidden Master"
}
}
]
}
]
}
}
Errors
If the Cloud DB API request fails or an error has occurred while processing, a success or failure is returned with the HTTP status code and a detailed message is returned in JSON format.
The errors are divided into two, "common error code" of the Cloud DB API and "API Gateway error code."
Errors | Response message | Description |
---|---|---|
200 | Ok | |
500 | Server Error |
Was this article helpful?