tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSnapshotPolicies

Last updated: 2024-11-25 20:07:42

    1. API Description

    Domain name for API request: vpc.intl.tencentcloudapi.com.

    This API is used to query snapshot policies.

    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: DescribeSnapshotPolicies.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    SnapshotPolicyIds.N No Array of String Snapshot policy IDs
    Filters.N No Array of Filter Filter conditions. SnapshotPolicyIds and Filters cannot be both specified.
  • snapshot-policy-id - String - Snapshot policy ID
  • snapshot-policy-name - String - Snapshot policy name
    		•
    Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 200.

    3. Output Parameters

    Parameter Name Type Description
    SnapshotPolicySet Array of SnapshotPolicy Snapshot policies
    TotalCount Integer The number of eligible objects.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Queries snapshot policies

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=DescribeSnapshotPolicies
&Offset=0
&Limit=2
&Filters.0.Name=snapshot-policy-id
&Filters.0.Values.0=sspolicy-g6jwvm35
&<Common request parameters>

    Output Example

    {
    "Response": {
        "SnapshotPolicySet": [
            {
                "SnapshotPolicyId": "sspolicy-g6jwvm35",
                "SnapshotPolicyName": "test2",
                "KeepTime": 180,
                "CosRegion": "ap-guangzhou",
                "CosBucket": "test1-251197522",
                "CreateTime": "2021-10-08 16:09:46",
                "Enable": true,
                "BackupType": "operate",
                "CreateNewCos": false
            }
        ],
        "TotalCount": 1,
        "RequestId": "a38579de-a046-4d68-b24a-b629c8d0ae57"
    }
}

    5. Developer Resources

    SDK

    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
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.NotUtf8EncodingError
    InvalidParameterValue.Range The parameter value is not in the specified range.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy