1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API (DescribeDiskAssociatedSnapshots) is used to query snapshots associated with a cloud disk.
Default interface request rate limit: 20 times per second.
Interface update time: 2024-07-16 06:42:29.
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: DescribeDiskAssociatedSnapshots |
| 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 |
| DiskId | Yes | No | String | ID of the cloud disk to be queried. Example: "disk-7q2iy7gp" |
| Offset | No | No | Uint64 | Offset. The default value is 0. Example: 0 |
| Limit | No | No | Uint64 | Number of returned values. The default value is 20, and the maximum value is 100. Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| SnapshotSet | Array of Snapshot | List of Snapshots Associated with Cloud Disk Example:View |
| TotalSnapSize | Uint64 | Total Size of Snapshots Associated with Cloud Disk Example: 100 |
| TotalCount | Uint64 | Total Number of Snapshots Associated with Cloud Disk Example: 1 |
| 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. |