tencent cloud



Last updated: 2023-12-04 16:31:51

    1. API Description

    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.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    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.
  • snapshot-id
  • Filter by snapshot ID.
    Type: String
    Required: no
  • disk-id
  • Filter by disk ID.
    Type: String
    Required: no
  • snapshot-name
  • Filter by snapshot name.
    Type: String
    Required: no
  • instance-id
  • Filter by instance ID.
    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.

    3. Output Parameters

    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.

    4. Example

    Example1 Querying snapshot list

    Input Example

    &<Common request parameters>

    Output Example

        "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"

    5. Developer Resources


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    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
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support