tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

TerminateDisks

Last updated: 2023-03-16 16:17:27

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: TerminateDisks.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
DiskIds.N Yes Array of String List of cloud disk IDs required to be returned.
DeleteSnapshot No Integer Delete the associated non-permanently reserved snapshots upon deletion of the source cloud disk. 0: No (default). 1: Yes. To check whether a snapshot is permanently reserved, refer to the IsPermanent field returned by the DescribeSnapshots API.

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 returning cloud disks

This example shows you how to terminate two cloud disks.

Input Example

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TerminateDisks
<Common request parameters>

{
    "DiskIds": [
        "disk-g27hqeo2",
        "disk-lzrg2pwi"
    ]
}

Output Example

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

5. Developer Resources

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.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter.
ResourceBusy The resource is busy. Try again later.
ResourceInsufficient.OverRefundQuota The number of returned cloud disks has reached the limit and no more cloud disks can be returned.
ResourceUnavailable.Expire The cloud disk has expired.
ResourceUnavailable.NotSupportRefund Cloud disks cannot be returned.
ResourceUnavailable.NotSupported The resource does not support this operation.
ResourceUnavailable.RepeatRefund The cloud disk has been repossessed.
TradeDealConflict Order conflict.
UnsupportedOperation Unsupported operation
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy