All Products
Search
Document Center

Apsara File Storage NAS:CreateLifecyclePolicy

Last Updated:Jan 24, 2024

Creates a lifecycle policy.

Operation description

  • You can create lifecycle policies only for General-purpose NAS file systems.
  • You can create up to 20 lifecycle policies in each region within an Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

31a8e4****
LifecyclePolicyNamestringYes

The name of the lifecycle policy. The name must be 3 to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

lifecyclepolicy_01
PathstringNo

The absolute path of the directory that is associated with the lifecycle policy.

If you specify this parameter, you can associate the lifecycle policy with only one directory. The path must start with a forward slash (/) and must be a path that exists in the mount target.

Note We recommend that you specify the Paths.N parameter so that you can associate the lifecycle policy with multiple directories.
/pathway/to/folder
LifecycleRuleNamestringYes

The management rule that is associated with the lifecycle policy.

Valid values:

  • DEFAULT_ATIME_14: Files that are not accessed in the last 14 days are dumped to the IA storage medium.
  • DEFAULT_ATIME_30: Files that are not accessed in the last 30 days are dumped to the IA storage medium.
  • DEFAULT_ATIME_60: Files that are not accessed in the last 60 days are dumped to the IA storage medium.
  • DEFAULT_ATIME_90: Files that are not accessed in the last 90 days are dumped to the IA storage medium.
Enumeration Value:
  • DEFAULT_ATIME_14
  • DEFAULT_ATIME_30
  • DEFAULT_ATIME_60
  • DEFAULT_ATIME_90
DEFAULT_ATIME_14
StorageTypestringYes

The storage type of the data that is dumped to the IA storage medium.

Default value: InfrequentAccess (IA).

InfrequentAccess
PathsarrayNo

The absolute paths of the directories that are associated with the lifecycle policy.

If you specify this parameter, you can associate the lifecycle policy with multiple directories. Each path must start with a forward slash (/) and must be a path that exists in the mount target. Valid values of N: 1 to 10.

stringNo

The absolute path of the directory that is associated with the lifecycle policy.

If you specify this parameter, you can associate the lifecycle policy with multiple directories. Each path must start with a forward slash (/) and must be a path that exists in the mount target. Valid values of N: 1 to 10.

“/path1", "/path2"

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

Indicates whether the request was successful.

Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400OperationDenied.FileSystemNotSupportedForLifecycleThe file system does not support lifecycle.The file system does not support lifecycle.
400OperationDenied.EncryptedFileSystemNotSupportedForLifecycleThe encrypted file system does not support lifecycle.The encrypted file system does not support lifecycle.
400OperationDenied.LifecyclePolicyCountLimitExceededThe maximum number of LifecyclePolicies is exceeded.The maximum number of LifecyclePolicies is exceeded.
400InvalidLifecyclePolicy.AlreadyExistThe specified LifecyclePolicy already exists.The specified LifecyclePolicy already exists.
400InvalidParameter.PathsNumberExceedThe maximum number of Path.N for this operation is 10.The maximum number of Path.N for this operation is 10.
400InvalidFilesystemType.NotSupportThe API operation does not support the file system type.The API operation does not support the file system type.
400InvalidParameter.PathOrPathsEither Path or Paths.N must be specified.Either Path or Paths.N must be specified.
403OperationDenied.NotSupportPaths.NYour request does not meet the gray condition. The Paths.N parameter is not supported.Your request does not meet the gray condition. The Paths.N parameter is not supported.
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
404InvalidParameter.PathNotExistThe specified path does not exist.The specified path does not exist.

For a list of error codes, visit the Service error codes.