DescribeLifecyclePolicies - File Storage NAS - Alibaba Cloud Documentation Center

Queries lifecycle policies.

Operation description

Only General-purpose NAS and CPFS for Lingjun file systems support this operation.

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:DescribeLifecyclePolicies	get	*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 naming rules are as follows: 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 Optional for General-purpose NAS file systems. If this parameter is provided, it takes precedence over LifecyclePolicyId. If left empty, LifecyclePolicyId is used.	lifecyclepolicy_01
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
StorageType	string	No	The storage class. InfrequentAccess: the Infrequent Access (IA) storage class. Archive: the Archive storage class. Note If StorageType is not specified, all lifecycle policies are returned.	InfrequentAccess
LifecyclePolicyId	string	No	The ID of the lifecycle policy.	lc-xxx
LifecyclePolicyType	string	No	The type of the lifecycle policy. Valid values: Auto: The job is automatically triggered. OnDemand: On-demand execution. Note Only CPFS for Lingjun supports this parameter.	Auto
Description	string	No	The description of the policy. Note Only CPFS for Lingjun supports this parameter.	Description
Path	string	No	Filter by path. Note Only CPFS for Lingjun supports this parameter.	/abc/

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of lifecycle policies.	10
RequestId	string	The request ID.	BC7C825C-5F65-4B56-BEF6-98C56C7C****
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
LifecyclePolicies	array<object>	The queried lifecycle policies.
LifecyclePolicy	object
FileSystemId	string	The ID of the file system.	31a8e4****
LifecycleRuleName	string	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. DEFAULT_ATIME_30: Files that are not accessed in the last 30 days. DEFAULT_ATIME_60: Files that are not accessed in the last 60 days. DEFAULT_ATIME_90: Files that are not accessed in the last 90 days.	DEFAULT_ATIME_14
CreateTime	string	The time when the lifecycle policy was created. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format.	2019-10-30T10:08:08Z
Path	string	The absolute path of a directory with which the lifecycle policy is associated.	/pathway/to/folder
StorageType	string	The storage class. InfrequentAccess: the IA storage class. Archive: the Archive storage class.	InfrequentAccess
LifecyclePolicyName	string	The name of the lifecycle policy.	lifecyclepolicy_01
Paths	array	The absolute paths of directories with which the lifecycle policy is associated.
Path	string	The absolute paths of directories with which the lifecycle policy is associated.	["/path1","/path2"]
LifecyclePolicyId	string	The ID of the lifecycle policy.	lc-xxx
Description	string	Description	Description
LifecyclePolicyType	string	The type of the lifecycle policy.	Auto
TransitRules	array<object>	Data transition rules.
Rule	object	The data transition rule.
Attribute	string	Attribute of the rule.	Atime
Threshold	string	Threshold for the rule.	3
RetrieveRules	array<object>	File data retrieval rules.
Rule	object	The file data retrieval rule.
Attribute	string	Attribute of the rule.	RetrieveType
Threshold	string	Threshold for the rule.	All

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "PageSize": 10,
  "PageNumber": 1,
  "LifecyclePolicies": [
    {
      "FileSystemId": "31a8e4****",
      "LifecycleRuleName": "DEFAULT_ATIME_14",
      "CreateTime": "2019-10-30T10:08:08Z",
      "Path": "/pathway/to/folder",
      "StorageType": "InfrequentAccess",
      "LifecyclePolicyName": "lifecyclepolicy_01",
      "Paths": [
        [
          "/path1",
          "/path2"
        ]
      ],
      "LifecyclePolicyId": "lc-xxx",
      "Description": "Description\n",
      "LifecyclePolicyType": "Auto",
      "TransitRules": [
        {
          "Attribute": "Atime",
          "Threshold": 3
        }
      ],
      "RetrieveRules": [
        {
          "Attribute": "RetrieveType",
          "Threshold": "All"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system 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-03-25	The Error code has changed. The request parameters of the API has changed	View Change Details