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:CreateLifecyclePolicycreate
*LifecyclePolicy
acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

请求参数

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

文件系统 ID。

31a8e4****
LifecyclePolicyNamestring

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

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

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

  • 通用型 NAS 仅支持关联单个目录。必须以正斜线(/)开头,并且是挂载点中真实存在的路径。
说明 仅支持通用型 NAS。通用型 NAS 建议您配置 Paths.N,可以同时关联多个目录。
  • Path 和 Paths 有且只能存在一个入参。
  • /pathway/to/folder
    LifecycleRuleNamestring

    生命周期管理策略关联的管理规则。仅通用型 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
    StorageTypestring

    分级存储类型。

    • InfrequentAccess:低频存储。
    • Archive:归档存储。
    说明 通用型 NAS 支持 InfrequentAccess 和 Archive; CPFS 智算版仅支持 InfrequentAccess。
    InfrequentAccess
    Pathsarray

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

    string

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

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

    说明
  • Path 和 Paths 有且只能存在一个入参。
  • “/path1"
    Descriptionstring

    生命周期策略描述。

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

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

    策略类型

    • Auto(默认):自动执行。
    • OnDemand:按需执行。
    Auto
    TransitRulesarray<object>

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

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

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

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

    规则的属性。

    取值:

    • Atime: 文件的访问时间。
    Atime
    Thresholdstring

    规则的阈值。

    取值:

    • 当 Attribute 为 Atime 时,表示多少天未访问的文件,取值范围[1,365]
    3
    RetrieveRulesarray<object>

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

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

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

    Attributestring

    规则的属性,取值:

    • RetrieveType: 取回方式
    RetrieveType
    Thresholdstring

    规则的阈值,取值:

    • RetrieveType
      • AfterVisit: LifecyclePolicyType=Auto 支持,代表尽力 recall on visit
      • All: LifecyclePolicyType=OnDemand 支持,代表取回所有
    All

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    请求状态。

    包括:

    • true:请求成功。
    • false:请求失败。
    true
    LifecyclePolicyIdstring

    生命周期策略的 ID

    lsp-bp1234567890ab****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400OperationDenied.FileSystemNotSupportedForLifecycleThe file system does not support lifecycle.指定的文件系统不支持生命周期管理。
    400OperationDenied.EncryptedFileSystemNotSupportedForLifecycleThe encrypted file system does not support lifecycle.加密的文件系统不支持生命周期管理。
    400OperationDenied.LifecyclePolicyCountLimitExceededThe maximum number of LifecyclePolicies is exceeded.生命周期策略数量达到上限。
    400InvalidLifecyclePolicy.AlreadyExistThe specified LifecyclePolicy already exists.指定的生命周期策略已存在。
    400InvalidParameter.PathsNumberExceedThe maximum number of Path.N for this operation is 10.每个策略最多允许关联10个路径。
    400InvalidFilesystemType.NotSupportThe API operation does not support the file system type.当前接口不支持该类型文件系统。
    400InvalidParameter.PathOrPathsEither Path or Paths.N must be specified.Path 和 Paths.N参数必须指定其中一个,并且不能同时指定。
    400MissingFileSystemIdFileSystemId is mandatory for this action.未指定FileSystemId参数。
    400Lifecycle.Count.ExceededThe lifecycle policy count exceeds the max limit per type per filesystem.生命周期策略超过限制。
    403OperationDenied.NotSupportPaths.NYour request does not meet the gray condition. The Paths.N parameter is not supported.当前请求未通过灰度策略,不持支Paths.N参数。
    404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。
    404InvalidParameter.PathNotExistThe specified path does not exist.指定的路径不存在。

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

    变更历史

    变更时间变更内容概要操作
    2026-01-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-09-05OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更查看变更详情
    2024-03-25OpenAPI 错误码发生变更查看变更详情