Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to query the list of snapshots.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeSnapshots. |
Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
SnapshotIds.N | No | Array of String | List of IDs of snapshots to be queried. You cannot specify SnapshotIds and Filters at the same time. |
Filters.N | No | Array of Filter | Filter list. Type: String Required: no Type: String Required: no Type: String Required: no Type: String Required: no Each request can contain up to 10 Filters and 5 Filter.Values . You cannot specify both SnapshotIds and Filters at the same time. |
Offset | No | Integer | Offset. Default value: 0. |
Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of snapshots. |
SnapshotSet | Array of Snapshot | List of snapshot details. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://lighthouse.tencentcloudapi.com/?Action=DescribeSnapshots
&Filters.0.Name=disk-id
&Filters.0.Values.0=lhdisk-f71kc5bh
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"SnapshotSet": [
{
"SnapshotId": "lhsnap-nv6aqcv6",
"DiskUsage": "SYSTEM_DISK",
"DiskId": "lhdisk-f71kc5bh",
"DiskSize": 50,
"SnapshotName": "lighthouse-test1-0903145122",
"SnapshotState": "NORMAL",
"Percent": "100",
"LatestOperation": "RollbackInstanceSnapshot",
"LatestOperationState": "SUCCESS",
"LatestOperationRequestId": "96aee6e3-172c-4f0f-be7c-fc46b9865763",
"CreatedTime": "2020-09-03T06:51:23Z"
}
],
"RequestId": "95aacc96-b271-4d8b-bf83-019647952af9"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
InvalidParameter.FilterValueLimitExceeded | Invalid parameter: the number of Values in the Filter parameter exceeds the allowed maximum number. |
InvalidParameter.InvalidFilter | Invalid parameter: the Filter parameter is invalid. |
InvalidParameter.InvalidFilterInvalidKey | Invalid parameter: the value of Name in the Filter parameter is invalid. |
InvalidParameter.InvalidFilterInvalidNameNotStr | Invalid parameter: the value of Name in the Filter parameter is not a string. |
InvalidParameter.InvalidFilterInvalidValuesNotList | Invalid parameter: the Values in the Filter parameter is not a list. |
InvalidParameter.InvalidFilterNotDict | Invalid parameter: the Filter parameter is not a dictionary. |
InvalidParameter.InvalidFilterNotSupportedName | Invalid parameter: there are unsupported Name values in the Filter parameter. |
InvalidParameter.ParameterConflict | Invalid parameter: the parameters conflict. |
InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
InvalidParameterValue.InvalidDiskIdMalformed | Invalid parameter value: the disk ID format is invalid. |
InvalidParameterValue.LimitExceeded | Invalid parametric value: the number of parameter values exceeds the upper limit. |
InvalidParameterValue.Negative | Invalid parametric value: it cannot be negative. |
InvalidParameterValue.OutOfRange | Invalid parametric value: it is not within the valid range. |
InvalidParameterValue.SnapshotIdMalformed | Invalid parametric value: the snapshot ID format is invalid. |
InvalidParameterValue.SnapshotNameTooLong | Invalid parametric value: the length of the snapshot name exceeds the upper limit. |
UnauthorizedOperation.NoPermission | No permission |
Was this page helpful?