云硬盘查询定期快照策略-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cbs.tencentcloudapi.com 。

本接口（DescribeAutoSnapshotPolicies）用于查询定期快照策略。

可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器Filter。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的定期快照策略表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAutoSnapshotPolicies。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
AutoSnapshotPolicyIds.N	否	Array of String	要查询的定期快照策略ID列表。参数不支持同时指定`AutoSnapshotPolicyIds`和`Filters`。示例值：["asp-c9m1berf"]
Filters.N	否	Array of Filter	过滤条件。参数不支持同时指定`AutoSnapshotPolicyIds`和`Filters`。 <li>auto-snapshot-policy-id - Array of String - 是否必填：否 -（过滤条件）按定期快照策略ID进行过滤。定期快照策略ID形如：`asp-11112222`。 <li>auto-snapshot-policy-state - Array of String - 是否必填：否 -（过滤条件）按定期快照策略的状态进行过滤。定期快照策略ID形如：`asp-11112222`。(NORMAL：正常 \| ISOLATED：已隔离。) <li>auto-snapshot-policy-name - Array of String - 是否必填：否 -（过滤条件）按定期快照策略名称进行过滤。示例值：[{"Name":"auto-snapshot-policy-state","Values":["NORMAL"]}]
Limit	否	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：20
Offset	否	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考API简介中的相关小节。示例值：0
Order	否	String	输出定期快照列表的排列顺序。取值范围： <li>ASC：升序排列 <li>DESC：降序排列。示例值：ASC
OrderField	否	String	定期快照列表排序的依据字段。取值范围： <li>CREATETIME：依据定期快照的创建时间排序默认按创建时间排序。示例值：CREATETIME

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	有效的定期快照策略数量。示例值：0
AutoSnapshotPolicySet	Array of AutoSnapshotPolicy	定期快照策略列表。示例值：[]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询状态为NORMAL的定期快照策略

查询状态为NORMAL的定期快照策略

输入示例

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAutoSnapshotPolicies
<公共请求参数>

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

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidFilter	指定的Filter不被支持。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
UnsupportedOperation	操作不支持。

查询定期快照策略

本页目录：