DescribeAutoSnapshotPolicies - 查询已创建的自动快照策略

查询已创建的自动快照策略。

接口说明

调试

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

授权信息

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

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

请求参数

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

自动快照策略 ID。

sp-extreme-233e6****
PageSizeinteger

每个分页包含的自动快照策略的个数。

取值范围:1~100

默认值:10

10
PageNumberinteger

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

起始值(默认值):1

1
FileSystemTypestring

文件系统类型。

取值:extreme(极速型 NAS)

extreme

返回参数

名称类型描述示例值
object
TotalCountinteger

自动快照策略的总个数。

2
RequestIdstring

请求 ID。

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

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

10
PageNumberinteger

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

1
AutoSnapshotPoliciesarray<object>

自动快照策略详情集合。

AutoSnapshotPolicyobject
TimePointsstring

自动快照的创建时间点。

单位:小时

包括:0~23,表示从00:00~23:00共 24 个时间点。1 代表在 01:00 时间点。最多 24 个时间点,用半角逗号(,)隔开。

4,19
Statusstring

自动快照策略状态。

包括:

  • Creating:创建中
  • Available:正常可用
Available
RepeatWeekdaysstring

自动快照的重复日期。

重复周期:星期

取值范围:1~7,例如:1 表示周一。

1,5
AutoSnapshotPolicyNamestring

自动快照策略的名称。

FinanceJoshua
CreateTimestring

创建时间。

按照 ISO8601 标准表示,并使用 UTC 时间,格式为yyyy-MM-ddTHH:mm:ssZ

2014-04-21T12:08:52Z
AutoSnapshotPolicyIdstring

自动快照策略 ID。

sp-extreme-233e6****
RetentionDaysinteger

自动快照的保留时间。

单位:天

包括:

  • -1:永久保存,当快照数量达到额度上限后被自动删除。
  • 1~65536:指定保存天数,保留时间到期后快照会被自动释放。
30
FileSystemNumsinteger

启用该策略的文件系统数量。

2
RegionIdstring

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

cn-hangzhou
FileSystemTypestring

文件系统类型。

extreme

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 10,
  "PageNumber": 1,
  "AutoSnapshotPolicies": {
    "AutoSnapshotPolicy": [
      {
        "TimePoints": "4,19",
        "Status": "Available",
        "RepeatWeekdays": "1,5",
        "AutoSnapshotPolicyName": "FinanceJoshua",
        "CreateTime": "2014-04-21T12:08:52Z",
        "AutoSnapshotPolicyId": "sp-extreme-233e6****",
        "RetentionDays": 30,
        "FileSystemNums": 2,
        "RegionId": "cn-hangzhou",
        "FileSystemType": "extreme"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-10OpenAPI 返回结构发生变更查看变更详情