调用DescribeAutoSnapshotPolicyEx查询指定地域的自动快照策略详细信息列表-云服务器 ECS-阿里云-云服务器 ECS(ECS)-阿里云帮助中心

本接口用于查询指定地域下已创建的自动快照策略详细信息列表。

调试

您可以在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	否	自动快照策略的名称。长度为 2~128 个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。	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 个字符，不能包含 http://或者 https://。	TestValue
ResourceGroupId	string	否	资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。说明不支持默认资源组过滤。	rg-aek2kkmhmhs****

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	分页展示返回的自动快照策略时的每页行数。	10
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	自动快照策略列表的页码。	1
TotalCount	integer	自动快照策略的总个数。	1
AutoSnapshotPolicies	object
AutoSnapshotPolicy	array<object>	自动快照策略详情集合。
	array<object>	自动快照策略详情。
AutoSnapshotPolicyId	string	自动快照策略 ID。	sp-bp67acfmxazb4ph****
RegionId	string	自动快照策略所属的地域 ID。	cn-hangzhou
RepeatWeekdays	string	指定自动快照的重复日期。选定周一到周日中需要创建快照的日期，参数为 1~7 的数字，如 1 表示周一。允许选择多个日期。	["6"]
TimePoints	string	指定自动快照的创建时间点。使用 UTC +8 时间，单位为小时。从 00:00~23:00 共 24 个时间点可选，参数为 0~23 的数字，如：1 代表在 01:00 时间点。可以选定多个时间点。传递参数为 JSON 数组格式：`["0", "1", ... "23"]`，最多 24 个时间点，用半角逗号字符（,）隔开。	["1"]
RetentionDays	integer	指定自动快照的保留时间，单位为天。可能值： -1：永久保存。 1~65536：指定保存天数。	7
CreationTime	string	创建时间。按照ISO 8601标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-12-10T16:00Z
Status	string	自动快照策略状态。可能值： Normal：正常。 Expire：由于账号欠费无法使用该策略。	Normal
AutoSnapshotPolicyName	string	自动快照策略的名称。	testAutoSnapshotPolicyName
EnableCrossRegionCopy	boolean	说明该参数正在邀测中，暂未开放使用。	false
TargetCopyRegions	string	说明该参数正在邀测中，暂未开放使用。	test
CopiedSnapshotsRetentionDays	integer	说明该参数正在邀测中，暂未开放使用。	0
CopyEncryptionConfiguration	object	快照跨地域复制加密参数对象。
Encrypted	boolean	是否开启快照跨地域加密复制。取值范围： true：是。 false：否。默认值：false。	false
KMSKeyId	string	快照跨地域加密复制使用的 KMS 密钥 ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
DiskNums	integer	启用该策略的云盘数量。说明该参数仅包含关联类型为 AssociatedWithDisk 的云盘数量。	1
VolumeNums	integer	启用该策略的拓展卷数量。	2
ResourceGroupId	string	资源组 ID。	rg-aek2kkmhmhs****
Tags	object
Tag	array<object>	自动快照策略的标签键值集合。
	object	自动快照策略的标签键值集合。
TagKey	string	自动快照策略的标签键。	TestKey
TagValue	string	自动快照策略的标签值。	TestValue
AssociationType	string	自动快照策略与目标资源的关联类型。可能值： AssociatedWithDisk：关联云盘 AssociatedWithInstanceTag：关联实例标签	AssociatedWithDisk
TargetTags	object
TargetTag	array<object>	目标资源标签列表。自动快照策略根据标签匹配目标资源。
	object	目标资源标签。
TagKey	string	标签键。	env
TagValue	string	标签值。	test
Type	string	自动快照策略类型。 Custom：用户定义的快照策略。 System：系统定义的快照策略。	Custom

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "AutoSnapshotPolicies": {
    "AutoSnapshotPolicy": [
      {
        "AutoSnapshotPolicyId": "sp-bp67acfmxazb4ph****",
        "RegionId": "cn-hangzhou",
        "RepeatWeekdays": "[\"6\"]",
        "TimePoints": "[\"1\"]",
        "RetentionDays": 7,
        "CreationTime": "2019-12-10T16:00Z",
        "Status": "Normal",
        "AutoSnapshotPolicyName": "testAutoSnapshotPolicyName",
        "EnableCrossRegionCopy": false,
        "TargetCopyRegions": "test",
        "CopiedSnapshotsRetentionDays": 0,
        "CopyEncryptionConfiguration": {
          "Encrypted": false,
          "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****"
        },
        "DiskNums": 1,
        "VolumeNums": 2,
        "ResourceGroupId": "rg-aek2kkmhmhs****",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "AssociationType": "AssociatedWithDisk",
        "TargetTags": {
          "TargetTag": [
            {
              "TagKey": "env",
              "TagValue": "test"
            }
          ]
        },
        "Type": "Custom"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidRegionId.NotFound	The specified RegionId does not exist. Please call DescribeRegions to query the supported regions and try again.
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.	指定的标记超出取值范围。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。