1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to unmount a cloud disk.
- Batch operations are supported for unmounting multiple cloud disks from the same CVM. If any one in multiple cloud disks cannot be unmounted, the operation will not be executed and a specific error code will be returned.
- This API is asynchronous. When a successful response is returned for a request, the cloud disk is not immediately unmounted from the CVM. The status of the corresponding cloud disk can be queried through the DescribeDisks API. If the status of the cloud disk changes from ATTACHED to UNATTACHED, it indicates that the cloud disk is unmounted successfully.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-04-03 18:30:31.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DetachDisks |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| DiskIds | Yes | No | Array of String | ID of the cloud disk to be unmounted. It can be queried through the DescribeDisks API. Up to 10 elastic cloud disks can be unmounted in a single request. Example: ["disk-l7mxecdc"] |
| InstanceId | No | No | String | For non-shared cloud disks, this parameter will be ignored. For shared cloud disks, this parameter indicates from which CVM instance the cloud disk will be unmounted. Example: ins-arxix3xm |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidDiskId.NotFound | The input DiskId does not exist. |
| InvalidDisk.TypeError | Incorrect cloud disk type. |
| InvalidDisk.NotPortable | Non-elastic cloud disks are not supported. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InternalError.ResourceOpFailed | The operation on the resource failed. For specific error information, view the Message field in the error description. Try again later or contact customer service for help. |
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| InvalidParameterValue.LimitExceeded | The parameter value is out of range |
| ResourceUnavailable.TypeError | Disk type error. |