查询定期快照策略

最近更新时间: 2026-09-17 00:00:49

1. 接口描述

接口请求域名： cbs.api3.fincloud.tencent.cn。

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

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

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

接口更新时间：2024-08-16 06:42:32。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAutoSnapshotPolicies
Version	是	否	String	公共参数，本接口取值：2017-03-12
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
AutoSnapshotPolicyIds	否	否	Array of String	要查询的定期快照策略ID列表。参数不支持同时指定`AutoSnapshotPolicyIds`和`Filters`。示例值： ["asp-c9m1berf"]
Filters	否	否	Array of Filter	过滤条件。参数不支持同时指定`AutoSnapshotPolicyIds`和`Filters`。 auto-snapshot-policy-id - Array of String - 是否必填：否 -（过滤条件）按定期快照策略ID进行过滤。定期快照策略ID形如：`asp-11112222`。 auto-snapshot-policy-state - Array of String - 是否必填：否 -（过滤条件）按定期快照策略的状态进行过滤。定期快照策略ID形如：`asp-11112222`。(NORMAL：正常
Limit	否	否	Uint64	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介]中的相关小节。示例值： 20
Offset	否	否	Uint64	偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介]中的相关小节。示例值： 0
Order	否	否	String	输出定期快照列表的排列顺序。取值范围： ASC：升序排列 DESC：降序排列。示例值： ASC
OrderField	否	否	String	定期快照列表排序的依据字段。取值范围： CREATETIME：依据定期快照的创建时间排序默认按创建时间排序。示例值： CREATETIME
TryCreateDefaultAutoSnapshotPolicy	否	否	Bool	传入此参数时则会尝试创建默认的定期快照策略。如果用户已有定期快照策略，则不会创建示例值： true
InnerSearch	否	否	String	模糊搜索参数示例值： asp-asgag224

3. 输出参数

参数名称	类型	描述
TotalCount	Uint64	有效的定期快照策略数量。示例值： 0
AutoSnapshotPolicySet	Array of AutoSnapshotPolicy	定期快照策略列表。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
MissingParameter	参数缺失。请求没有带必选参数。
InvalidFilter	指定的Filter不被支持。
InvalidParameterValue	无效参数值。参数值格式错误或者参数值不被支持等。

5. 示例

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

输入示例

https://cbs.api3.fincloud.tencent.cn/?Action=DescribeAutoSnapshotPolicies
&Filters.0.Name=auto-snapshot-policy-state
&Filters.0.Values.0=NORMAL
&Limit=3
&Offset=0
&<公共请求参数>

输出示例

{
    "Response": {
        "AutoSnapshotPolicySet": [
            {
                "DiskIdSet": [],
                "IsActivated": 1,
                "AutoSnapshotPolicyState": "NORMAL",
                "AutoSnapshotPolicyName": "快照策略1",
                "IsPermanent": 0,
                "NextTriggerTime": "2017-12-04 12:00:00",
                "AutoSnapshotPolicyId": "asp-lfp6fi4f",
                "Policy": [
                    {
                        "DayOfWeek": [
                            1,
                            4
                        ],
                        "Hour": [
                            12
                        ]
                    }
                ],
                "CreateTime": "2017-11-01 10:46:22",
                "RetentionDays": 7
            },
            {
                "DiskIdSet": [],
                "IsActivated": 1,
                "AutoSnapshotPolicyState": "NORMAL",
                "AutoSnapshotPolicyName": "快照策略2",
                "IsPermanent": 0,
                "NextTriggerTime": "2017-12-03 10:00:00",
                "AutoSnapshotPolicyId": "asp-nqu08k2l",
                "Policy": [
                    {
                        "DayOfWeek": [
                            0
                        ],
                        "Hour": [
                            10
                        ]
                    }
                ],
                "CreateTime": "2017-11-17 15:01:25",
                "RetentionDays": 7
            }
        ],
        "TotalCount": 2,
        "RequestId": "701c8a35-ed66-fc79-3795-5a1fa72cdbf1"
    }
}