Destroy Instance (Pay per Use)

Last updated: 2017-12-14 10:04:51

1. API Description

This API (CloseCdbHour) is used to terminate instances with pay by usage mode. The instances will be isolated after being terminated. You can use API DescribeCdbInstances to query isolated instances.
Domain for API request: cdb.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is CloseCdbHour.

Parameter Name Required Type Description
cdbInstanceIds.n Yes String One or more instance IDs (n represents array subscript starting with 0). Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the Cloud Database console page and can be obtained using API Query List of Instances. Its value equals to the uInstanceId field value in the output parameter.
instanceRole No String Instance type. Default is master. Possible values include: master - master instance/disaster recovery instance; ro - read-only instance.

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.
codeDesc String Error description
data Array Returned data

Parameter data is composed of the following parameters:

Parameter Name Type Description
instanceRole String Instance type. Default is master. Possible values include: master - master instance/disaster recovery instance; ro - read-only instance.
cdbInstanceIds Array List of the result of terminating instances

Parameter cdbInstanceIds is composed of the following parameters:

Parameter Name Type Description
code Int Execution result. Possible returned values include: 0 - Succeeded; other values - Failed
message String Error description. Valid only if code is not 0
cdbInstanceId String Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the Cloud Database console page and can be obtained using API Query List of Instances. Its value equals to the uInstanceId field value in the output parameter.

4. Error Codes

The following error codes only include the business logic error codes for this API.

Error Code Error Message Error Description
9003 InvalidParameter Incorrect parameter
9006 InternalError Database internal error
9572 InstanceNotExists Instance does not exist
9501 InternalError Instances offline failed
9648 InternalError.TranIdNotExist TranId does not exist
9300 OperationDenied Order system error

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=CloseCdbHour
&<Common request parameters>
&cdbInstanceIds.0=cdb-c1nl9rpv
&instanceRole=master

Output

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":{
        "cdbInstanceIds":[
            {
                "code":"0",
                "message":"",
                "cdbInstanceId":"cdb-c1nl9rpv"
            }
        ],
        "instanceRole":"master"
    }
}