全部产品
Search
文档中心

云服务器 ECS:DescribeAutoSnapshotPolicyEx - 查询已创建的自动快照策略

更新时间:Feb 04, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeAutoSnapshotPolicyExRead
  • AutoSnapshotPolicy
    acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/*
  • AutoSnapshotPolicy
    acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#snapshotpolicyId}
  • ecs:tag

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
AutoSnapshotPolicyIdstring

自动快照策略 ID。

sp-bp67acfmxazb4ph****
AutoSnapshotPolicyNamestring

自动快照策略的名称。

TestName
PageNumberinteger

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

起始值:1。

默认值:1。

1
PageSizeinteger

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

最大值:100。

默认值:10。

10
Tagobject []

标签列表。

Keystring

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

TestKey
Valuestring

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

TestValue
ResourceGroupIdstring

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

说明 不支持默认资源组过滤。
rg-aek2kkmhmhs****

返回参数

名称类型描述示例值
object
PageSizeinteger

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

10
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

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

1
TotalCountinteger

自动快照策略的总个数。

1
AutoSnapshotPoliciesobject []

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

TimePointsstring

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

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

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

["1"]
CreationTimestring

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

2019-12-10T16:00Z
Statusstring

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

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

自动快照策略的名称。

testAutoSnapshotPolicyName
TargetCopyRegionsstring
说明 该参数正在邀测中,暂未开放使用。
test
CopiedSnapshotsRetentionDaysinteger
说明 该参数正在邀测中,暂未开放使用。
0
AutoSnapshotPolicyIdstring

自动快照策略 ID。

sp-bp67acfmxazb4ph****
RetentionDaysinteger

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

  • -1:永久保存。
  • 1~65536:指定保存天数。
7
RegionIdstring

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

cn-hangzhou
DiskNumsinteger

启用该策略的云盘数量。

1
EnableCrossRegionCopyboolean
说明 该参数正在邀测中,暂未开放使用。
false
RepeatWeekdaysstring

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

["6"]
VolumeNumsinteger

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

2
ResourceGroupIdstring

资源组 ID。

rg-aek2kkmhmhs****
Tagsobject []

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

TagValuestring

自动快照策略的标签值。

TestValue
TagKeystring

自动快照策略的标签键。

TestKey
Typestring

自动快照策略类型。

  • Custom:用户定义的快照策略。
  • System:系统定义的快照策略。
Custom

示例

正常返回示例

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"
            }
          ]
        },
        "Type": "Custom"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。
400InvalidTag.MismatchThe specified Tag.n.Key and Tag.n.Value are not match.指定的 Tag.N.Key 和 Tag.N.Value 不匹配。
400InvalidTagCountThe specified tags are beyond the permitted range.指定的标记超出取值范围。

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

变更历史

变更时间变更内容概要操作
2024-02-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更