tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Block Storage
    Documentation
    Download PDF

    DescribeAutoSnapshotPolicies

    Last updated: 2023-06-21 15:01:13
    Download PDF

    1. API Description

    Domain name for API request: cbs.tencentcloudapi.com.

    This API is used to query scheduled snapshot policies.

    • You can filter scheduled snapshot policies by ID, name, state, etc. The relationship between different filters is logical AND. For details on filters, see Filter.
    • If no parameter is specified, a certain number of scheduled snapshot policies under the current account will be returned. The number is specified by Limit and is 20 by default.

    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: DescribeAutoSnapshotPolicies.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    AutoSnapshotPolicyIds.N No Array of String List of scheduled snapshot policy IDs to be queried. The parameter does not support specifying both SnapshotIds and Filters.
    Filters.N No Array of Filter Filter conditions. Specification of both the AutoSnapshotPolicyIds and Filters parameters is not supported.
  • auto-snapshot-policy-id - Array of String - Required or not: No - (Filter condition) Filters according to the scheduled snapshot policy ID. The format of the scheduled snapshot policy ID is as follows: asp-11112222.
  • auto-snapshot-policy-state - Array of String - Required or not: No - (Filter condition) Filters according to the status of the scheduled snapshot policy. The format of the scheduled snapshot policy ID is as follows: asp-11112222. (NORMAL: normal | ISOLATED: isolated)
  • auto-snapshot-policy-name - Array of String - Required or not: No - (Filter condition) Filters according to the name of the scheduled snapshot policy.
    		•
    Limit No Integer Number of results to be returned. Default is 20. Maximum is 100. For more information on Limit, please see relevant sections in API Introduction.
    Offset No Integer Offset. Default is 0. For more information on Offset, please see relevant sections in API Introduction.
    Order No String Outputs the ordering of the scheduled snapshot lists. Value range:
  • ASC: Ascending order
  • DESC: Descending order.
    		•
    OrderField No String The sorting filter applied to the scheduled snapshot list. Value range: <Sort by creation time of scheduled snapshot. By default, this is sorted by creation time.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The quantity of valid scheduled snapshot policies.
    AutoSnapshotPolicySet Array of AutoSnapshotPolicy List of scheduled snapshot policies.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying scheduled snapshot policies in the NORMAL status

    This example shows you how to query scheduled snapshot policies in the NORMAL status

    Input Example

    POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAutoSnapshotPolicies
<Common request parameters>

{
    "Filters": [
        {
            "Name": "auto-snapshot-policy-state",
            "Values": [
                "NORMAL"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "AutoSnapshotPolicySet": [
            {
                "DiskIdSet": [],
                "IsActivated": true,
                "AdvancedRetentionPolicy": null,
                "IsCopyToRemote": 0,
                "IsPermanent": false,
                "AutoSnapshotPolicyState": "NORMAL",
                "Tags": [],
                "NextTriggerTime": "2023-03-03 07:00:00",
                "AutoSnapshotPolicyName": "default-policy",
                "AutoSnapshotPolicyId": "asp-3stvwfxx",
                "CopyFromAccountUin": null,
                "InstanceIdSet": [],
                "RetentionAmount": 0,
                "RetentionDays": 15,
                "Policy": [
                    {
                        "DayOfWeek": [
                            6,
                            5
                        ],
                        "Hour": [
                            7
                        ]
                    }
                ],
                "RetentionMonths": 0,
                "CreateTime": "2022-05-16 14:00:48",
                "CopyToAccountUin": null
            }
        ],
        "TotalCount": 1,
        "RequestId": "9c112e22-96c6-4300-831e-5d52c8d361fc"
    }
}

    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
    InvalidFilter The specified Filter is not supported.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter.
    UnsupportedOperation Unsupported operation
    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy