DescribeLifecyclePolicies - 查询生命周期管理策略列表

更新时间:
复制为 MD 格式

获取生命周期管理策略列表。

接口说明

仅通用型 NAS 文件系统和 CPFS 智算版支持该功能。

调试

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

授权信息

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

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

请求参数

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

文件系统 ID。

31a8e4****
LifecyclePolicyNamestring

生命周期策略名称。命名规则如下:

长度为 3-64 个字符,必须以大小字母开头,可以包含英文字母、数字、下划线(_)或者短划线(-)。

说明 通用型 NAS 文件系统选填,如果传入则以此为准,没有传入则以 LifecyclePolicyId 为准。
lifecyclepolicy_01
PageSizeinteger

每个分页包含的生命周期管理策略个数。

取值范围:1~100

默认值:10

10
PageNumberinteger

列表的分页页码。

起始值(默认值):1

1
StorageTypestring

分级存储类型。

  • InfrequentAccess:低频存储。
  • Archive:归档存储。
说明 如未指定 StorageType,则返回所有生命周期策略。
InfrequentAccess
LifecyclePolicyIdstring

生命周期策略的 ID。

lc-xxx
LifecyclePolicyTypestring

策略类型。

取值:

  • Auto:自动执行
  • OnDemand:按需执行
说明 仅 CPFS 智算版支持。
Auto
Descriptionstring

策略的描述。

说明 仅 CPFS 智算版支持。
描述
Pathstring

根据路径筛选。

说明 仅 CPFS 智算版支持。
/abc/

返回参数

名称类型描述示例值
object
TotalCountinteger

生命周期管理策略总数。

10
RequestIdstring

请求 ID。

BC7C825C-5F65-4B56-BEF6-98C56C7C****
PageSizeinteger

每个分页包含的生命周期管理策略个数。

10
PageNumberinteger

列表的分页页码。

1
LifecyclePoliciesarray<object>

生命周期管理策略信息集合。

LifecyclePolicyobject
FileSystemIdstring

文件系统 ID。

31a8e4****
LifecycleRuleNamestring

生命周期管理策略关联的管理规则。

包括:

  • DEFAULT_ATIME_14:距今 14 天未访问的文件
  • DEFAULT_ATIME_30:距今 30 天未访问的文件
  • DEFAULT_ATIME_60:距今 60 天未访问的文件
  • DEFAULT_ATIME_90:距今 90 天未访问的文件
DEFAULT_ATIME_14
CreateTimestring

生命周期管理策略创建的时间。

执行 ISO8601 标准表示,返回格式:yyyy-MM-ddTHH:mm:ssZ

2019-10-30T10:08:08Z
Pathstring

生命周期管理策略配置的单个目录的绝对路径。

/pathway/to/folder
StorageTypestring

分级存储类型。

  • InfrequentAccess:低频存储。
  • Archive:归档存储。
InfrequentAccess
LifecyclePolicyNamestring

生命周期管理策略名称。

lifecyclepolicy_01
Pathsarray

生命周期管理策略配置的多个目录的绝对路径列表。

Pathstring

生命周期管理策略配置的多个目录的绝对路径列表。

["/path1","/path2"]
LifecyclePolicyIdstring

生命周期策略的 ID

lc-xxx
Descriptionstring

描述

描述
LifecyclePolicyTypestring

策略类型

Auto
TransitRulesarray<object>

文件数据转储规则

Ruleobject

文件数据转储规则

Attributestring

转储规则的属性

Atime
Thresholdstring

转储规则的阈值

3
RetrieveRulesarray<object>

文件数据取回规则

Ruleobject

文件数据取回规则

Attributestring

取回规则的属性

RetrieveType
Thresholdstring

取回规则的阈值

All

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "PageSize": 10,
  "PageNumber": 1,
  "LifecyclePolicies": [
    {
      "FileSystemId": "31a8e4****",
      "LifecycleRuleName": "DEFAULT_ATIME_14",
      "CreateTime": "2019-10-30T10:08:08Z",
      "Path": "/pathway/to/folder",
      "StorageType": "InfrequentAccess",
      "LifecyclePolicyName": "lifecyclepolicy_01",
      "Paths": [
        [
          "/path1",
          "/path2"
        ]
      ],
      "LifecyclePolicyId": "lc-xxx",
      "Description": "描述",
      "LifecyclePolicyType": "Auto",
      "TransitRules": [
        {
          "Attribute": "Atime",
          "Threshold": 3
        }
      ],
      "RetrieveRules": [
        {
          "Attribute": "RetrieveType",
          "Threshold": "All"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。

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

变更历史

变更时间变更内容概要操作
2026-01-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-03-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情