1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (DescribeBlockStorages) is used to query the list of block storage, including both local disks and cloud disks.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-06-03 09:07:28.
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: DescribeBlockStorages |
| 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 |
| Limit | No | No | Uint64 | Number of returned values. The default value is 100, and the maximum value is 1000. For more information about Limit, refer to the relevant sections in API overview.Example: 20 |
| Offset | No | No | Uint64 | Offset. The default value is 0. For more information about offset, refer to the relevant sections in API overview. Example: 0 |
| DiskIds | No | No | Array of String | Query by one or more cloud disk IDs. Example: ["disk-6rag8jef"] |
| InnerSearch | No | No | String | Used to support search box search, internal parameters. Example: ins-9oxguxa |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Uint64 | Number of block storages that meet the criteria. Example: 0 |
| DiskSet | Array of BlockStorage | Detailed information list of block storage. 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. |