DescribeLifecyclePolicies - Apsara File Storage NAS - Alibaba Cloud Documentation Center

Queries lifecycle policies.

Operation description

Only General-purpose NAS file systems support this operation.

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

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 meet the following conventions: The name must be 3 to 64 characters in length and must start with a letter. It can contain letters, digits, underscores (_), and hyphens (-).	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

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	object []	The queried lifecycle policies.
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 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.	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 type of the data that is dumped to the IA storage medium. Default value: InfrequentAccess (IA).	InfrequentAccess
LifecyclePolicyName	string	The name of the lifecycle policy.	lifecyclepolicy_01
Paths	array
	string	The absolute paths of directories with which the lifecycle policy is associated.	["/path1","/path2"]

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\"]"
      ]
    }
  ]
}

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.