CreateLifecyclePolicy - 创建生命周期管理策略

更新时间:
复制 MD 格式

创建一个生命周期管理策略。

接口说明

  • 仅通用型 NAS 文件系统和 CPFS 智算版支持创建生命周期管理策略。

  • 每个 CPFS 智算版文件系统最多创建 10 个 Auto 类型 和 100 个 OnDemand 类型的生命周期管理策略。

  • 每个地域可以创建 20 个通用型 NAS 的生命周期管理策略。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:CreateLifecyclePolicy

create

*LifecyclePolicy

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

请求参数

名称

类型

必填

描述

示例值

FileSystemId

string

文件系统 ID。

31a8e4****

LifecyclePolicyName

string

生命周期管理策略名称。 长度为 3~64 个字符,必须以大写字母或小写字母开头,可以包含英文字母、数字、下划线(_)或者短划线(-)。

说明

通用型 NAS 必须传入,CPFS 智算版无需填入。

lifecyclepolicy_01

Path

string

生命周期管理策略关联目录的绝对路径。仅支持通用型 NAS。

  • 通用型 NAS 仅支持关联单个目录。必须以正斜线(/)开头,并且是挂载点中真实存在的路径。

说明

仅支持通用型 NAS。通用型 NAS 建议您配置 Paths.N,可以同时关联多个目录。

  • Path 和 Paths 有且只能存在一个入参。

/pathway/to/folder

LifecycleRuleName

string

生命周期管理策略关联的管理规则。仅通用型 NAS 支持。

取值:

  • DEFAULT_ATIME_14:距今 14 天未访问的文件。

  • DEFAULT_ATIME_30:距今 30 天未访问的文件。

  • DEFAULT_ATIME_60:距今 60 天未访问的文件 。

  • DEFAULT_ATIME_90:距今 90 天未访问的文件。

  • DEFAULT_ATIME_180:距今 180 天未访问的文件。仅当 StorageType=Archive 时,支持 DEFAULT_ATIME_180。

说明
  • 如果该目录已经设置了低频策略,再次设置归档策略的时候,归档策略的时间要比低频策略设置的长。

  • 仅通用型 NAS 支持该参数。

枚举值:

  • DEFAULT_ATIME_14 :

    距今 14 天未访问的文件

  • DEFAULT_ATIME_90 :

    距今 90 天未访问的文件

  • DEFAULT_ATIME_60 :

    距今 60 天未访问的文件

  • DEFAULT_ATIME_180 :

    距今 180 天未访问的文件

  • DEFAULT_ATIME_30 :

    距今 30 天未访问的文件

DEFAULT_ATIME_14

StorageType

string

分级存储类型。

  • InfrequentAccess:低频存储。

  • Archive:归档存储。

说明

通用型 NAS 支持 InfrequentAccess 和 Archive; CPFS 智算版仅支持 InfrequentAccess。

枚举值:

  • Archive :

    归档存储

  • InfrequentAccess :

    低频存储

InfrequentAccess

Paths

array

生命周期管理策略关联目录的绝对路径。

"/path1", "/path2"

string

生命周期管理策略关联目录的绝对路径。

支持关联多个目录。必须以正斜线(/)开头,并且是挂载点中真实存在的路径,N 的取值范围为 1~10。

说明
  • CPFS 智算版必填。

“/path1"

Description

string

生命周期策略描述。

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

说明

仅 CPFS 智算版支持。

描述

LifecyclePolicyType

string

策略类型

  • Auto(默认):自动执行。

  • OnDemand:按需执行。

枚举值:

  • Auto :

    自动执行

  • OnDemand :

    按需执行

Auto

TransitRules

array<object>

文件数据转储规则,最多配置 1 个。

说明

仅 CPFS 智算版文件系统的 LifecyclePolicyType=Auto 时支持

object

文件数据转储规则,最多配置 1 个。

说明

仅 CPFS 智算版文件系统的 LifecyclePolicyType=Auto 时支持

Attribute

string

规则的属性。

取值:

  • Atime: 文件的访问时间。

枚举值:

  • Atime :

    文件的访问时间

Atime

Threshold

string

规则的阈值。

取值:

  • 当 Attribute 为 Atime 时,表示多少天未访问的文件,取值范围[0,365]

3

RetrieveRules

array<object>

文件数据取回规则,最多配置 1 个。

说明

仅 CPFS 智算版文件系统支持。

说明

LifecyclePolicyType 为 OnDemand,主动沉降(TransitRules)/取回规则(RetrieveRules)必须至少选填一个。

object

文件数据取回规则,最多配置 1 个。

Attribute

string

规则的属性,取值:

  • RetrieveType: 取回方式

枚举值:

  • RetrieveType :

    取回方式

RetrieveType

Threshold

string

规则的阈值,取值:

  • RetrieveType
    • AfterVisit: LifecyclePolicyType=Auto 支持,代表尽力 recall on visit

    • All: LifecyclePolicyType=OnDemand 支持,代表取回所有

枚举值:

  • All :

    代表取回所有

  • AfterVisit :

    代表尽力 recall on visit

All

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

Success

boolean

请求状态。

包括:

  • true:请求成功。

  • false:请求失败。

true

LifecyclePolicyId

string

生命周期策略的 ID

lsp-bp1234567890ab****

示例

正常返回示例

JSON格式

{
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "Success": true,
  "LifecyclePolicyId": "lsp-bp1234567890ab****"
}

错误码

HTTP status code

错误码

错误信息

描述

400 OperationDenied.FileSystemNotSupportedForLifecycle The file system does not support lifecycle. 指定的文件系统不支持生命周期管理。
400 OperationDenied.EncryptedFileSystemNotSupportedForLifecycle The encrypted file system does not support lifecycle. 加密的文件系统不支持生命周期管理。
400 OperationDenied.LifecyclePolicyCountLimitExceeded The maximum number of LifecyclePolicies is exceeded. 生命周期策略数量达到上限。
400 InvalidLifecyclePolicy.AlreadyExist The specified LifecyclePolicy already exists. 指定的生命周期策略已存在。
400 InvalidParameter.PathsNumberExceed The maximum number of Path.N for this operation is 10. 每个策略最多允许关联10个路径。
400 InvalidFilesystemType.NotSupport The API operation does not support the file system type. 当前接口不支持该类型文件系统。
400 InvalidParameter.PathOrPaths Either Path or Paths.N must be specified. Path 和 Paths.N参数必须指定其中一个,并且不能同时指定。
400 MissingFileSystemId FileSystemId is mandatory for this action. 未指定FileSystemId参数。
400 Lifecycle.Count.Exceeded The lifecycle policy count exceeds the max limit per type per filesystem. 生命周期策略超过限制。
403 OperationDenied.NotSupportPaths.N Your request does not meet the gray condition. The Paths.N parameter is not supported. 当前请求未通过灰度策略,不持支Paths.N参数。
404 InvalidFileSystem.NotFound The specified file system does not exist. 指定的文件系统不存在。
404 InvalidParameter.PathNotExist The specified path does not exist. 指定的路径不存在。

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

变更历史

更多信息,参考变更详情