调用DescribeAutoSnapshotPolicyEX查询您在某个地域下,所有已创建的符合查询条件的自动快照策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAutoSnapshotPolicyEx

系统规定参数。取值:DescribeAutoSnapshotPolicyEx

RegionId String cn-hangzhou

要查询的自动快照策略所在的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

AutoSnapshotPolicyId String sp-bp67acfmxazb4ph****

自动快照策略ID。

AutoSnapshotPolicyName String TestName

自动快照策略的名称。

PageNumber Integer 1

自动快照策略返回结果分多页展示。

起始值:1。

默认值:1。

PageSize Integer 10

分页展示返回的自动快照策略时的每页行数。

最大值:100。

默认值:10。

Tag.N.Key String TestKey

自动快照策略的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

Tag.N.Value String TestValue

自动快照策略的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以acs:开头,不能包含http://或者https://。

ResourceGroupId String rg-aek2kkmhmhs****

资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。

说明 不支持默认资源组过滤。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

分页展示返回的自动快照策略时的每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

PageNumber Integer 1

自动快照策略列表的页码。

TotalCount Integer 1

自动快照策略的总个数。

AutoSnapshotPolicies Array of AutoSnapshotPolicy

自动快照策略详情AutoSnapshotPolicy组成的集合。

AutoSnapshotPolicy
TimePoints String ["1"]

指定自动快照的创建时间点。

使用UTC +8时间,单位为小时。从00:00~23:00共24个时间点可选,参数为0~23的数字,如:1代表在01:00时间点。可以选定多个时间点。

传递参数为JSON数组格式:["0", "1", ... "23"],最多24个时间点,用半角逗号字符(,)隔开。

CreationTime String 2019-12-10T16:00Z

创建时间。按照ISO 8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。

Status String Normal

自动快照策略状态。可能值:

  • Normal:正常。
  • Expire:由于账号欠费无法使用该策略。
AutoSnapshotPolicyName String testAutoSnapshotPolicyName

自动快照策略的名称。

TargetCopyRegions String test
说明 该参数正在邀测中,暂未开放使用。
CopiedSnapshotsRetentionDays Integer 0
说明 该参数正在邀测中,暂未开放使用。
AutoSnapshotPolicyId String sp-bp67acfmxazb4ph****

自动快照策略ID。

RetentionDays Integer 7

指定自动快照的保留时间,单位为天。可能值:

  • -1:永久保存。
  • 1~65536:指定保存天数。
RegionId String cn-hangzhou

自动快照策略所属的地域ID。

DiskNums Integer 1

启用该策略的云盘数量。

EnableCrossRegionCopy Boolean false
说明 该参数正在邀测中,暂未开放使用。
RepeatWeekdays String ["6"]

指定自动快照的重复日期。选定周一到周日中需要创建快照的日期,参数为1~7的数字,如1表示周一。允许选择多个日期。

VolumeNums Integer 2

启用该策略的拓展卷数量。

ResourceGroupId String rg-aek2kkmhmhs****

资源组ID。

Tags Array of Tag

自动快照策略的标签键值集合。

Tag
TagValue String TestValue

自动快照策略的标签值。

TagKey String TestKey

自动快照策略的标签键。

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=DescribeAutoSnapshotPolicyEx
&RegionId=cn-hangzhou
&AutoSnapshotPolicyId=sp-bp67acfmxazb4ph****
&AutoSnapshotPolicyName=p-23f2i9s4t
&PageNumber=1
&PageSize=1
&Tag=[{"Key":"TestKey","Value":"TestValue"}]
&ResourceGroupId=rg-aek2kkmhmhs****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAutoSnapshotPolicyExResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <AutoSnapshotPolicies>
        <TimePoints>["1"]</TimePoints>
        <CreationTime>2021-09-01 15:30:01</CreationTime>
        <Status>Normal</Status>
        <AutoSnapshotPolicyName>testAutoSnapshotPolicyName</AutoSnapshotPolicyName>
        <TargetCopyRegions>test</TargetCopyRegions>
        <CopiedSnapshotsRetentionDays>0</CopiedSnapshotsRetentionDays>
        <AutoSnapshotPolicyId>sp-bp67acfmxazb4ph****</AutoSnapshotPolicyId>
        <RetentionDays>7</RetentionDays>
        <RegionId>cn-hangzhou</RegionId>
        <DiskNums>1</DiskNums>
        <EnableCrossRegionCopy>false</EnableCrossRegionCopy>
        <RepeatWeekdays>["6"]</RepeatWeekdays>
        <VolumeNums>2</VolumeNums>
        <ResourceGroupId>rg-aek2kkmhmhs****</ResourceGroupId>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
    </AutoSnapshotPolicies>
</DescribeAutoSnapshotPolicyExResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "AutoSnapshotPolicies" : [ {
    "TimePoints" : "[\"1\"]",
    "CreationTime" : "2021-09-01 15:30:01",
    "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" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ]
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
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. 指定的标记超出取值范围。

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