ListAutoSnapshotPolicies - 列出自动快照策略

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

调试

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

授权信息

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

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

请求参数

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

所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
PageNumberinteger

分页查询时设置的页码。默认值:1。

1
PageSizeinteger

分页查询时设置的每页条数。默认值:10。

10
FilterKeystring

查询资源时的筛选键。

与 FilterValue 配合使用,取值必须为 PolicyId 或 PolicyName。

传入 PolicyId 则根据自动快照策略 ID 进行筛选,传入 PolicyName 则根据自动快照策略名称进行筛选。

PolicyName
FilterValuestring

查询自动快照策略时的筛选值。

与 FilterKey 配合使用。

policyTest

返回参数

名称类型描述示例值
object

返回结果。

PageNumberinteger

分页查询时设置的页码。默认值:1。

1
PageSizeinteger

分页查询时设置的每页条数。默认值:10。

10
TotalCountinteger

自动快照策略的总个数。

1
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
SnapshotPoliciesobject []

自动快照策略详情列表。

PolicyIdstring

自动快照策略 ID。

sp-z5siir3iq3m**********
PolicyNamestring

自动快照策略名称。

policyTest
AccountIdstring

账户 ID。

13523459********
RegionIdstring

所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
Statusstring

策略状态。

枚举值:
  • normalnormal
  • abnormalabnormal
normal
StatusDetailstring

若出现异常的状态信息详情,status 为 normal 时为空。

-
RetentionDaysinteger

快照保留天数(1-65535,NULL 为持续保存,直至快照数量达到额度上限后被自动删除)。

30
AppliedDbfsNumberinteger

设置该自动快照策略的数据库文件系统数量。

1
RepeatWeekdaysarray

自动快照的重复日期列表,单位为天,周期为星期。取值范围:1~7,例如 1 表示周一。格式说明:

  • 传入的参数需要保持 JSON 数组格式。例如,["1"]表示每周一重复创建自动快照。

  • 当一星期内需要创建多次自动快照时,可以传入多个时间点,时间点之间用半角逗号(,)隔开,最多传入 7 个时间点。例如,["1","3","5"]表示每周一、周三、周五重复创建自动快照。

string

自动快照的重复日期,周期为星期。

"1"
TimePointsarray

自动快照的创建时间点列表。使用 UTC +8 时间,单位为小时。取值范围:0~23,代表 00:00 至 23:00 共 24 个时间点,例如 01 表示 01:00。格式说明:

  • 传入的参数需要保持 JSON 数组格式。例如,["1"]表示 01:00 创建自动快照。

  • 当一天内需要创建多次自动快照时,可以传入多个时间点,时间点之间用半角逗号(,)隔开,最多传入 24 个时间点。例如,["01","03","15"]表示 01:00、03:00、15:00 时创建自动快照。

string

自动快照的创建时间点。

"01"
CreatedTimestring

创建时间。

1670998784000
LastModifiedstring

最后修改时间。

1670998784000

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "SnapshotPolicies": [
    {
      "PolicyId": "sp-z5siir3iq3m**********\n",
      "PolicyName": "policyTest",
      "AccountId": "13523459********",
      "RegionId": "cn-hangzhou",
      "Status": "normal",
      "StatusDetail": "-",
      "RetentionDays": 30,
      "AppliedDbfsNumber": 1,
      "RepeatWeekdays": [
        "\"1\""
      ],
      "TimePoints": [
        " \"01\""
      ],
      "CreatedTime": "1670998784000",
      "LastModified": "1670998784000"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。

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