tencent cloud

APIs

DokumentasiAPIsCloud Block StorageSnapshot APIsDescribeAutoSnapshotPolicies

DescribeAutoSnapshotPolicies

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-12 19:37:30

1. API Description

Domain name for API request: cbs.intl.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 Yes String Common Params. For more information, please see the list of regions supported by the product.
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 criteria. AutoSnapshotPolicyIds and Filters cannot be specified at the same time.
  • auto-snapshot-policy-id - Array of String - required: no - (filter condition) filter by regular snapshot policy id. regular snapshot policy id such as: asp-3stvwfxx.
    • .
  • AutoSnapshotPolicyState - Array of String - required: no - (filter condition) filters by the status of the regular snapshot policy. regular snapshot policy ID format: asp-3stvwfxx. (NORMAL: NORMAL
    		•
    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 Specifies the output order of the regular snapshot list. valid values:
  • ASC: ascending order
  • DESC: descending order.
    • .
    OrderField No String The sorting filter applied to the scheduled snapshot list. Value range: <sort 362="" by="" creation="" time="" of="" scheduled="" snapshot.="" default,="" this="" is="" sorted="" time.=""

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

    Input Example

    POST / HTTP/1.1
Host: cbs.intl.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
    Topik sebelumnya: CreateAutoSnapshotPolicyTopik selanjutnya: BindAutoSnapshotPolicy

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan