Help & DocumentationCloud Block StorageAPI DocumentationCloud Disk APIsDetachDisks

DetachDisks

Last updated: 2019-09-09 20:17:33

PDF

Contents：

1. API Description

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

This API (DetachDisks) is used to unmount one or more cloud disks from a CVN instance.

  • Batch operations are supported. You can unmount multiple cloud disks from one CVM. 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.

Default request rate limit: 20/sec.

Note: This API supports finance AZs. As finance AZs and non-finance AZs are isolated, when accessing the services in a finance AZ (with the common parameter Region specifying a financial availability zone), it is necessary to specify a domain name with the finance AZ, preferably in the same region as specified in Region.

2. Input Parameters

The list below contains only the API request parameters and certain 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, see 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 Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Unmounting a Cloud Disk

Input Sample Code

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

Output Sample Code

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

5. Resources for Developers

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 comes with SDKs that support multiple programming languages and make it easier to call the APIs.

Command line tools

6. Error Codes

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

Error Code Description
InternalError.ResourceOpFailed The operation performed on the resource failed. For the specific error information, please see the Message field in the error description. Try again later or contact the customer service for help.
InvalidDisk.NotPortable Non-elastic cloud disks are not supported.
InvalidDisk.NotSupported This operation is not supported for cloud disks.
InvalidDisk.TypeError Invalid cloud disk type
InvalidDiskId.NotFound The DiskId does not exist.
InvalidParameterValue Invalid parameter value. Parameter value is in an incorrect format or is not supported.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
MissingParameter Missing parameter. A required parameter is missing in the request.