TerminateDisks

Last updated: 2020-01-13 11:40:47

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API is used to return cloud disks.

  • You can use this API to return cloud disks you no longer need.
  • This API can be used to return pay-as-you-go cloud disks billed on hourly basis.
  • Batch operations are supported. The maximum number of cloud disks in each request is 50. If there is any specified cloud disk that cannot be returned, an error code will be returned.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: TerminateDisks
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DiskIds.N Yes Array of String List of cloud disk IDs required to be returned.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Batch Cloud Disk Return

Input Example

https://cbs.tencentcloudapi.com/?Action=TerminateDisks
&DiskIds.0=disk-lzrg2pwi
&DiskIds.1=disk-g27hqeo2
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "52c965d2-5deb-459a-8b5a-b3b9a1376544"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InsufficientRefundQuota Number of returned cloud disks has reached the limit and no more cloud disks can be returned.
InternalError.FailQueryResource Resource query failed.
InvalidDisk.Expire The cloud disk has expired.
InvalidDisk.NotSupportRefund Cloud disk return not supported.
InvalidDisk.RepeatRefund Cloud disk has already been returned and cannot be returned again.
InvalidParameterValue Invalid parameter value. Parameter value format error or parameter value not supported.
MissingParameter Missing parameter. Request does not include the required parameter.