1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to obtain snapshot overview information.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-08-28 18:33:11.
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: GetSnapOverview |
| 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 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalSize | Float | Total Size of User Snapshots Example: 4.28 |
| RealTradeSize | Float | Total Size of User Snapshots (for Billing) Example: 4.28 |
| FreeQuota | Float | Snapshot Free Quota Example: 0.0 |
| TotalNums | Int64 | Total Number of Snapshots Example: 2 |
| 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 |
|---|---|
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |