云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器云服务器ECSAPI参考快照自动快照策略DescribeAutoSnapshotPolicy - 查询自动快照策略
复制全文
下载 pdfDescribeAutoSnapshotPolicy - 查询自动快照策略
文档反馈
问问助手调用DescribeAutoSnapshotPolicy接口，查询您在某个地域下，所有已创建的符合查询条件的自动快照策略。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeAutoSnapshotPolicy
要执行的操作，取值：DescribeAutoSnapshotPolicy。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
PageSize integer 可选 示例值：10
页大小，最大100默认15。
PageNumber integer 可选 示例值：1
起始页码，默认为1。
TagFilters.N.Key string[] 可选 示例值：TagFilters.1.Key=tag
根据标签查询资源时指定的标签键。说明如下：
- TagFilters.N.Key：N表示标签键的序号。取值范围：1～10。
- 多个标签键之间用&分隔，不允许重复。
- 不传入该参数则表示查询所有标签。
- 传入空字符串时，则返回错误码InvalidTagFilterKey.Malformed。
TagFilters.N.Values.N string[] 可选 示例值：TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test
根据标签查询资源时指定的标签值。说明如下：
- TagFilters.N.Values.N：第一个N表示标签键的序号。取值范围：1～10。
- TagFilters.N.Values.N：第二个N表示标签值的序号。取值范围：1～3。
- 多个标签值之间用&分隔。
- 如果传入该参数，则必须先传入TagFilters.N.Key。
- 不传入该参数则表示查询同一标签键下的所有标签值。
- 传入空字符串时，表示查询标签值为空的标签。
AutoSnapshotPolicyIds.N string[] 可选 示例值：AutoSnapshotPolicyIds.1=asp-anj249wubz9kakc8**** AutoSnapshotPolicyIds.2=asp-ancejlwubz9kakc8\*\*\*\*
待查询的自动快照策略ID列表。
ProjectName string 可选 示例值：default
自动快照策略所属项目。
返回参数
PageSize integer 示例值：15
页大小。
PageNumber integer 示例值：1
页码。
TotalCount integer 示例值：3
自动快照策略的总数量。
AutoSnapshotPolicies object[] 示例值：-
自动快照策略列表。
AutoSnapshotPolicyId string 示例值：asp-anj249wubz9kakc8****
自动快照策略ID。
Status string 示例值：/
保留参数。
RepeatDays integer 示例值：2
按天重复创建快照，即间隔一定的天数创建快照。
UpdatedAt string 示例值：2021-06-28T15:10:47+08:00
自动快照策略的更新时间。
CreatedAt string 示例值：2021-06-28T15:10:47+08:00
自动快照策略的创建时间。
ProjectName string 示例值：default
自动快照策略所属项目。
TimePoints string[] 示例值："2", "8", "9"
自动快照的创建时间点。
RepeatWeekdays string[] 示例值："3", "5", "7"
按周重复创建快照，即在周一至周日之间选择一个或多个日期创建快照。
RetentionDays integer 示例值：50
自动快照的保留时间，单位为天，取值说明如下：
- -1：永久保存。
- 1~65536：指定保存天数。
VolumeNums integer 示例值：1
云盘总数。
AutoSnapshotPolicyName string 示例值：testName
自动快照策略的名称。
Tags object[] 示例值：/
标签。
Key string 示例值：tag
自动快照策略的标签键。
Value string 示例值：test
自动快照策略的标签值。
请求示例
GET /?Action=DescribeAutoSnapshotPolicy&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs
返回示例
{
"ResponseMetadata": {
"RequestId": "2022050518000501021206303202BF****",
"Action": "DescribeAutoSnapshotPolicy",
"Version": "2020-04-01",
"Service": "storage_ebs",
"Region": "cn-beijing"
},
"Result": {
"AutoSnapshotPolicies": [
{
"AccountId": "200000****",
"AutoSnapshotPolicyId": "asp-anj1nuju6w9gsaqi****",
"AutoSnapshotPolicyName": "modify_****autosanpshot_policy",
"CreatedAt": "2022-04-28T18:46:36+08:00",
"ProjectName": "default",
"RepeatWeekdays": [
"3",
"5",
"7"
],
"RetentionDays": 50,
"Status": "",
"TimePoIntegers": [
"2",
"8",
"9"
],
"UpdatedAt": "2022-04-28T18:46:37+08:00",
"VolumeNums": 0
},
{
"AccountId": "200000****",
"AutoSnapshotPolicyId": "asp-anj2a9gwj49gsbso****",
"AutoSnapshotPolicyName": "****test",
"CreatedAt": "2022-04-28T14:49:01+08:00",
"ProjectName": "",
"RepeatWeekdays": [
"1"
],
"RetentionDays": -1,
"Status": "",
"TimePoIntegers": [
"0"
],
"UpdatedAt": "2022-04-28T14:49:01+08:00",
"VolumeNums": 0
}
],
"PageNumber": 1,
"PageSize": 10,
"RequestId": "2022050518000501021206303202BFE158-cc****",
"TotalCount": 2
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidRequest | The operation is not permitted due to the request is invalid. | 无效的请求。 |
400 | ErrMaximumTagFilterKeys | too many tag filter keys | 标签过滤键超出限制。 |
400 | ErrTagFilterKeyConflict | tag filter key conflict | 标签过滤器键冲突。 |
400 | ErrInvalidTagFilterKey | tag filter key invalid | 标签过滤键无效。 |
400 | ErrMaximumTagFilterValues | too many tag filter value | 标签过滤值超出限制。 |
400 | ErrInvalidTagFilterValue | tag filter value invalid | 标签过滤器值无效。 |
400 | ErrInvalidAccountId | account id invalid | 账号ID无效。 |
最近更新时间：2026.01.08 11:19:59
这个页面对您有帮助吗？
有用
有用
无用
无用