CreateLifecyclePolicy - File Storage NAS - Alibaba Cloud Documentation Center

Creates a lifecycle policy.

Operation description

Only General-purpose NAS and CPFS for Lingjun file systems support this operation.
Up to 10 Auto and 100 OnDemand lifecycle policies can be created for each CPFS for Lingjun file system.
For general-purpose NAS file systems, up to 20 lifecycle policies can be created in each region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nas:CreateLifecyclePolicy	create	*LifecyclePolicy `acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system.	31a8e4****
LifecyclePolicyName	string	No	The name of the lifecycle policy. The name must be 3 to 64 characters in length and must start with a letter. It can contain letters, digits, underscores (_), and hyphens (-). Note Required for General-purpose NAS.	lifecyclepolicy_01
Path	string	No	The absolute path of the directory associated with the lifecycle policy. Only General-purpose NAS supports this parameter. Single value only. The path must start with a forward slash (/) and must be a path that exists in the mount target. Note We recommend configuring the Paths.N parameter so that you can associate the policy with multiple directories at a time. Path and Paths are mutually exclusive. You must specify one.	/pathway/to/folder
LifecycleRuleName	string	No	The management rule associated with the lifecycle policy. Only General-purpose NAS supports this parameter. Valid values: DEFAULT_ATIME_14: Files not accessed for 14 days. DEFAULT_ATIME_30: Files not accessed for 30 days. DEFAULT_ATIME_60: Files not accessed for 60 days. DEFAULT_ATIME_90: Files not accessed for 90 days. DEFAULT_ATIME_180: Files not accessed for 180 days. DEFAULT_ATIME_180 is supported only when the StorageType parameter is set to Archive. Note If an IA policy already exists for the directory, the new archive policy must have a longer transition period. Only General-purpose NAS supports this parameter. Enumeration Value: DEFAULT_ATIME_14 DEFAULT_ATIME_30 DEFAULT_ATIME_60 DEFAULT_ATIME_90 DEFAULT_ATIME_180	DEFAULT_ATIME_14
StorageType	string	Yes	The storage class. InfrequentAccess: the Infrequent Access (IA) storage class. Archive: the Archive storage class. Note General-purpose NAS supports InfrequentAccess and Archive. CPFS for Lingjun only supports InfrequentAccess.	InfrequentAccess
Paths	array	No	The absolute paths of the directories associated with the lifecycle policy.
	string	No	The absolute paths of the directories associated with the lifecycle policy. Supports associating 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. Note Path and Paths are mutually exclusive. You must specify one.	“/path1", "/path2"
Description	string	No	The description of the lifecycle policy. Format: The name must be 3 to 64 characters in length and must start with a letter. It can contain letters, digits, underscores (_), and hyphens (-). Note Only CPFS for Lingjun supports this parameter.	Description
LifecyclePolicyType	string	No	The policy type. Auto (default): The job is automatically triggered. OnDemand: On-demand execution.	Auto
TransitRules	array<object>	No	The data transition rule. Only one rule can be configured. Note Supported only for CPFS for Lingjun file systems with LifecyclePolicyType set to Auto.
	object	No	The data transition rule. Only one rule can be configured. Note Supported only for CPFS for Lingjun file systems with LifecyclePolicyType set to Auto.
Attribute	string	No	Attribute of the rule. Valid values: Atime: the access time of the file.	Atime
Threshold	string	No	Threshold for the rule. Valid values: If Attribute is set to Atime, this value represents the number of days since the file was last accessed. Valid values: [1, 365].	3
RetrieveRules	array<object>	No	The file data retrieval rule. Only one rule can be configured. Note Only CPFS for Lingjun supports this parameter.
	object	No	The file data retrieval rule. Only one rule can be configured.
Attribute	string	No	The attribute of the rule. Valid value: RetrieveType: the retrieval method.	RetrieveType
Threshold	string	No	The threshold of the rule. Valid values: RetrieveType AfterVisit: Supported when LifecyclePolicyType is Auto. Represents a best-effort recall on access. All: Supported when LifecyclePolicyType is OnDemand. Represents retrieving all data.	All

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	BC7C825C-5F65-4B56-BEF6-98C56C7C****
Success	boolean	Indicates whether the request is successful. Valid values: true false	true
LifecyclePolicyId	string	The ID of the lifecycle policy.	lsp-bp1234567890ab****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.FileSystemNotSupportedForLifecycle	The file system does not support lifecycle.	The file system does not support lifecycle.
400	OperationDenied.EncryptedFileSystemNotSupportedForLifecycle	The encrypted file system does not support lifecycle.	The encrypted file system does not support lifecycle.
400	OperationDenied.LifecyclePolicyCountLimitExceeded	The maximum number of LifecyclePolicies is exceeded.	The maximum number of LifecyclePolicies is exceeded.
400	InvalidLifecyclePolicy.AlreadyExist	The specified LifecyclePolicy already exists.	The specified LifecyclePolicy already exists.
400	InvalidParameter.PathsNumberExceed	The maximum number of Path.N for this operation is 10.	The maximum number of Path.N for this operation is 10.
400	InvalidFilesystemType.NotSupport	The API operation does not support the file system type.	The API operation does not support the file system type.
400	InvalidParameter.PathOrPaths	Either Path or Paths.N must be specified.	Either Path or Paths.N must be specified.
400	MissingFileSystemId	FileSystemId is mandatory for this action.	-
400	Lifecycle.Count.Exceeded	The lifecycle policy count exceeds the max limit per type per filesystem.	Lifecycle policy exceeds limit.
403	OperationDenied.NotSupportPaths.N	Your 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.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidParameter.PathNotExist	The specified path does not exist.	The specified path does not exist.

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

Change history

Change time	Summary of changes	Operation
2026-01-08	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-09-05	API Description Update. The API operation is not deprecated.. The Error code has changed	View Change Details
2024-03-25	The Error code has changed	View Change Details