UpdateLifecyclePolicy - File Storage NAS - Alibaba Cloud Documentation Center

Updates the rules of a lifecycle management policy. This operation is supported only by CPFS for Lingjun. UpdateLifecyclePolicy uses the overwrite semantics. If a non-required parameter is left empty, the corresponding field is deleted. To append a lifecycle rule, call the DescribeLifecyclePolicies operation to obtain the current lifecycle rule configuration, append the new lifecycle rule configuration, and then call the UpdateLifecyclePolicy operation to update the lifecycle rule configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:UpdateLifecyclePolicy

update

*LifecyclePolicy

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system. The ID must start with bmcpfs-, such as bmcpfs-290w65p03ok64ya****. To use CPFS for Lingjun, you must first submit a ticket to apply for the service whitelist and then create a file system in the NAS console. > This parameter is supported only when LifecyclePolicyType is set to OnDemand in the lifecycle management policy of a CPFS for Lingjun file system.	bmcpfs-290w65p03ok64y*****
StorageType	string	No	The tiered storage type. Valid values: InfrequentAccess: IA storage class. This is the default value. Archive: Archive storage class. Valid values: Archive : Archive storage class. InfrequentAccess : IA storage class.	InfrequentAccess
LifecyclePolicyId	string	Yes	The ID of the lifecycle policy. > This parameter is required for CPFS for Lingjun file systems.	lsp-bp1234567890ab****
Description	string	No	The description of the lifecycle policy. Format: The description must be 3 to 64 characters in length. It must start with a letter and can contain letters, digits, underscores (_), and hyphens (-). > This parameter is supported only by CPFS for Lingjun.	Lifecycle policy description
Paths	array	No	The absolute path of the directory associated with the lifecycle management policy. This parameter is required when FileSystemId starts with bmcpfs-.
	string	No	The absolute path of the directory associated with the lifecycle management policy. You can associate multiple directories. The path must start with a forward slash (/) and must be a valid path in the mount target. N ranges from 1 to 10.	/path1
TransitRules	array<object>	No	The file data transition rule. You can configure up to one rule. > This parameter is supported only when LifecyclePolicyType is set to Auto for a CPFS for Lingjun file system.
	object	No	The file data transition rule.
Attribute	string	No	The attribute of the rule. Valid values: Atime: the access time of the file.	Atime
Threshold	string	No	The threshold of the rule. Valid values: When Attribute is set to Atime, this parameter specifies the number of days a file has not been accessed. Valid values: 1 to 365.	3
RetrieveRules	array<object>	No	The file data retrieval rule. You can configure up to one rule. > This parameter is supported only by CPFS for Lingjun file systems.
	object	No	The file data retrieval rule.
Attribute	string	No	The attribute of the rule. Valid values: RetrieveType: the retrieval method.	RetrieveType
Threshold	string	No	The threshold of the rule. Valid values: RetrieveType: AfterVisit: supported when LifecyclePolicyType is set to Auto. This value indicates best-effort recall on visit. All: supported when LifecyclePolicyType is set to OnDemand. This value indicates that all data is retrieved. Valid values: All : All AfterVisit : AfterVisit	All
DeleteRules	array<object>	No	The file data expiration and deletion rule.
	object	No	The file data expiration and deletion rule.
Attribute	string	No	The attribute of the rule. Valid values: Atime: the access time of the file. Valid values: Atime : The access time of the file.	Atime
Threshold	string	No	The threshold of the rule. Valid values: When Attribute is set to Atime, this parameter specifies the number of days a file has not been accessed. Valid values: 1 to 365.	4

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
Success	boolean	The request status. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidLifecyclePolicy.NotFound	The specified LifecyclePolicy does not exist.	The specified LifecyclePolicy does not exist.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.