1. 接口描述
本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
- 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器
Filter
。 - 如果参数为空,返回当前用户一定数量(
Limit
所指定的数量,默认为20)的定期快照策略表。
接口请求域名: cbs.tencentcloudapi.com 。
默认接口请求频率限制: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 。 |
Filters.N | 否 | Array of Filter | 过滤条件。参数不支持同时指定AutoSnapshotPolicyIds 和Filters 。asp-11112222 。asp-11112222 。(NORMAL:正常 | ISOLATED:已隔离。) |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考API简介中的相关小节。 |
Order | 否 | String | 输出定期快照列表的排列顺序。取值范围: |
OrderField | 否 | String | 定期快照列表排序的依据字段。取值范围: 默认按创建时间排序。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 有效的定期快照策略数量。 |
AutoSnapshotPolicySet | Array of AutoSnapshotPolicy | 定期快照策略列表。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询状态为NORMAL的定期快照策略
输入示例
https://cbs.tencentcloudapi.com/?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"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidFilter | 指定的Filter不被支持。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnsupportedOperation | 操作不支持。 |