Help & DocumentationCloud Block StorageAPI DocumentationCloud Disk APIsDetachDisks

DetachDisks

Last updated: 2020-04-03 10:29:12

PDF

1. API Description

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

This API (DetachDisks) is used to unmount cloud disks.

  • Batch operations are supported. Multiple cloud disks mounted to the same CVM can be unmounted in batch. If there is a cloud disk that does not allow this operation, the operation is not performed and a specific error code is returned.
  • This API is an asynchronous API. When the request successfully returns results, the cloud disk is not unmounted from the CVM immediately. You can use the API DescribeDisks to query the cloud disk status. If the status changes from "ATTACHED" to "UNATTACHED", the cloud disk is unmounted.

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: DetachDisks.
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 ID of the cloud disk to be unmounted, which can be queried through the API DescribeDisks. A maximum of 10 elastic cloud disks can be unmounted in a single request.
InstanceId No String For a cloud disk that is not shared, this parameter is ignored. For a shared cloud disk, this parameter indicates which CVM instance the cloud disk is to be unmounted from.

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 Unmounting Single Cloud Disk

Input Example

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

Output Example

{
  "Response": {
    "RequestId": "aafa71a0-ed62-0fac-3ebf-5a1f808d1085"
  }
}

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
InternalError.ResourceOpFailed The operation performed on the resource failed. For error message, see the "Message" field in error description. Try again later or contact customer service.
InvalidDisk.NotPortable Non-elastic cloud disk not supported.
InvalidDisk.NotSupported Indicates that the operation is not supported for the cloud disk.
InvalidDisk.TypeError Invalid cloud disk type.
InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
InvalidParameterValue Invalid parameter value. Parameter value format error or parameter value not supported.
InvalidParameterValue.LimitExceeded Number of parameter values exceeds the limit.
MissingParameter Missing parameter. Request does not include the required parameter.
ResourceBusy The resource is busy. Try again later.