1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (DescribeInstancesDiskNum) is used to query the number of cloud disks mounted on an instance.
- It supports batch operation. When multiple Cloud Virtual Machine instance IDs are input, the results will list the number of cloud disks mounted to each Cloud Virtual Machine.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-08-28 17:51:25.
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: DescribeInstancesDiskNum |
| 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 |
| InstanceIds | Yes | No | Array of String | CVM instance ID. It can be queried through the DescribeInstances API. Example: ["ins-9w5d2buw","ins-jw0vit58"] |
| AttachMode | No | Yes | String | Mounting mode for I/O virtualization. Example: “VF” |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AttachDetail | Array of AttachDetail | Number of elastic cloud disks that are already mounted and can be mounted on each Cloud Virtual Machine. Example:View |
| 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 |
|---|---|
| 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. |