本接口用于查询指定地域下已创建的自动快照策略详细信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeAutoSnapshotPolicyEX | get | *AutoSnapshotPolicy acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/**AutoSnapshotPolicy acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 要查询的自动快照策略所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| AutoSnapshotPolicyId | string | 否 | 自动快照策略 ID。 | sp-bp67acfmxazb4ph**** |
| AutoSnapshotPolicyName | string | 否 | 自动快照策略的名称。 | TestName |
| PageNumber | integer | 否 | 自动快照策略返回结果分多页展示。 起始值：1。 默认值：1。 | 1 |
| PageSize | integer | 否 | 分页展示返回的自动快照策略时的每页行数。 最大值：100。 默认值：10。 | 10 |
| Tag | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| Key | string | 否 | 自动快照策略的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。 | TestKey |
| Value | string | 否 | 自动快照策略的标签值。N 的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以 acs:开头，不能包含 http://或者 https://。 | TestValue |
| ResourceGroupId | string | 否 | 资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。 说明
不支持默认资源组过滤。
| rg-aek2kkmhmhs**** |
返回参数
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 1,
"AutoSnapshotPolicies": {
"AutoSnapshotPolicy": [
{
"TimePoints": "[\"1\"]",
"CreationTime": "2019-12-10T16:00Z",
"Status": "Normal",
"AutoSnapshotPolicyName": "testAutoSnapshotPolicyName",
"TargetCopyRegions": "test",
"CopiedSnapshotsRetentionDays": 0,
"AutoSnapshotPolicyId": "sp-bp67acfmxazb4ph****",
"RetentionDays": 7,
"RegionId": "cn-hangzhou",
"DiskNums": 1,
"EnableCrossRegionCopy": false,
"RepeatWeekdays": "[\"6\"]",
"VolumeNums": 2,
"ResourceGroupId": "rg-aek2kkmhmhs****",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"CopyEncryptionConfiguration": {
"Encrypted": false,
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
},
"Type": "Custom"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域 ID 不存在。 |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定的 Tag.N.Key 和 Tag.N.Value 不匹配。 |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定的标记超出取值范围。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-02 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-02-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-02 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |