1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (DescribeUserTotalResources) is used to query the user's number of cloud disks, number of snapshots, and quotas across all regions.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-08-28 18:25:05.
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: DescribeUserDiskResources |
| 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 |
| Regions | No | No | Array of String | It specifies the region to query. Multiple regions can be specified. If this parameter is not input, all regions will be queried by default. Example: region1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ResourcesDetailSet | Array of ResourcesDetail | Description of resource details in the Nth region. Example:View |
| DiskOverview | DiskOverview | It describes the overall usage of the cloud disk in the specified region. Example:View |
| SnapOverview | SnapOverview | It describes overall usage of snapshots in the specified region. 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. |