1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to mount a cloud disk.
- Batch operations are supported for mounting multiple cloud disks to the same CVM. If any one in multiple cloud disks cannot be mounted, 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 to mount a cloud disk, it indicates that the backend has initiated an operation to mount the cloud disk. The status of the corresponding cloud disk can be queried through the DescribeDisks API. If the status of the cloud disk changes from ATTACHING to ATTACHED, it indicates that the cloud disk is mounted successfully.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-08-28 01:23:24.
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: AttachDisks |
| 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 elastic cloud disk to be mounted. It can be queried through the DescribeDisks API. Up to 10 elastic cloud disks can be mounted in a single request. Example: ["disk-7q2iy7gp"] |
| InstanceId | Yes | No | String | ID of the CVM instance to which the cloud disk will be mounted. It can be queried through the DescribeInstances API. Example: ins-9oxguxa |
| AlignType | No | No | String | Optional. If this parameter is not input, only the mount operation will be performed. When this parameter is input, the lifetime of the cloud disk will be aligned with that of the host to be mounted when mounting. Value range: Example: AUTO_RENEW |
| DeleteWithInstance | No | No | Bool | Optional parameter. If this parameter is not input, only the mounting operation is executed. If True is input, the cloud disk will be destroyed with the cloud host upon successful mounting. It is only valid for pay-as-you-go cloud disks.Example: TRUE |
| InstanceIds | No | No | Array of String | Optional. This parameter is used for the console to batch mount shared disks to multiple CVMs by specifying the instance IDs. If multiple InstanceIds are input, all cloud disks specified in DisksId must be shared cloud disks; otherwise an error is returned. Example: ["ins-locaa0iu"] |
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 |
|---|---|
| ZoneNotMatch | The cloud disk and the instance are not in the same availability zone. |
| InvalidDisk.NotPortable | Non-elastic cloud disks are not supported. |
| InvalidDisk.TypeError | Incorrect cloud disk type. |
| InvalidInstance.NotSupported | The Cloud Virtual Machine does not support mounting a cloud disk. |
| InvalidInstanceId.NotFound | The input InstanceId does not exist. |
| InvalidParameterValue.LimitExceeded | The parameter value is out of range |
| InvalidDisk.Attached | The cloud disk has been mounted. |
| 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. |
| InvalidDiskId.NotFound | The input DiskId does not exist. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| InternalError.ComponentError | Third-party Component Error |