查询定期快照策略
最近更新时间: 2024-10-18 10:38:45
1. 接口描述
接口请求域名: cbs.api3.fincloud.tencent.cn。
本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
- 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器
Filter
。 - 如果参数为空,返回当前用户一定数量(
Limit
所指定的数量,默认为20)的定期快照策略表。
默认接口请求频率限制:20次/秒。
接口更新时间:2023-12-12 10:43:53。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeAutoSnapshotPolicies |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
AutoSnapshotPolicyIds | 否 | 否 | Array of String | 要查询的定期快照策略ID列表。参数不支持同时指定AutoSnapshotPolicyIds 和Filters 。 |
Filters | 否 | 否 | Array of Filter | 过滤条件。参数不支持同时指定AutoSnapshotPolicyIds 和Filters 。<br><li>auto-snapshot-policy-id - Array of String - 是否必填:否 -(过滤条件)按定期快照策略ID进行过滤。定期快照策略ID形如:asp-11112222 。<br><li>auto-snapshot-policy-state - Array of String - 是否必填:否 -(过滤条件)按定期快照策略的状态进行过滤。定期快照策略ID形如:asp-11112222 。(NORMAL:正常 | ISOLATED:已隔离。)<br><li>auto-snapshot-policy-name - Array of String - 是否必填:否 -(过滤条件)按定期快照策略名称进行过滤。 |
Limit | 否 | 否 | Uint64 | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API [简介]中的相关小节。 |
Offset | 否 | 否 | Uint64 | 偏移量,默认为0。关于Offset 的更进一步介绍请参考API[简介]中的相关小节。 |
Order | 否 | 否 | String | 输出定期快照列表的排列顺序。取值范围:<br><li>ASC:升序排列<br><li>DESC:降序排列。 |
OrderField | 否 | 否 | String | 定期快照列表排序的依据字段。取值范围:<br><li>CREATETIME:依据定期快照的创建时间排序<br>默认按创建时间排序。 |
TryCreateDefaultAutoSnapshotPolicy | 否 | 否 | Bool | 此参数对外不可见。 传入此参数时则会尝试创建默认的定期快照策略。如果用户已有定期快照策略,则不会创建 |
InnerSearch | 否 | 否 | String | 模糊搜索参数 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Uint64 | 有效的定期快照策略数量。 |
AutoSnapshotPolicySet | AutoSnapshotPolicy | 定期快照策略列表。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
MissingParameter | |
InvalidFilter | |
InvalidParameterValue |