Queries the list of lifecycle management policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLifecyclePolicies

The operation that you want to perform.

Set the value to DescribeLifecyclePolicies.

FileSystemId String Yes 31a8e4****

The ID of the file system.

PageSize Integer No 10

The number of entries to return on each page.

Valid values: 1 to 100.

PageNumber Integer No 1

The number of the page to return.

Minimum value: 1. Default value: 1.

Response parameters

Parameter Type Example Description
LifecyclePolicies Array of LifecyclePolicy

The list of lifecycle management policies.

CreateTime String 2019-10-30T10:08:08Z

The time when the policy was created.

The time follows the ISO8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

FileSystemId String 31a8e4****

The ID of the file system.

LifecyclePolicyName String lifecyclepolicy1

The name of the lifecycle management policy.

LifecycleRuleName String DEFAULT_ATIME_14

The name of the rule in the 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.
Path String /pathway/to/folder

The absolute path to the directory for which the policy is configured.

The path must start with a forward slash (/) and must be an existing path in the mount target.

StorageType String InfrequentAccess

The type of the storage.

Default value: InfrequentAccess.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String BC7C825C-5F65-4B56-BEF6-98C56C7C****

The ID of the request.

TotalCount Integer 10

The total number of lifecycle management policies.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeLifecyclePolicies
&FileSystemId=31a8e4****
&<Common request parameters>

Sample success responses

XML format

<TotalCount>10</TotalCount>
<PageSize>10</PageSize>
<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>
<PageNumber>1</PageNumber>
<LifecyclePolicies>
    <Path>/pathway/to/folder</Path>
    <LifecyclePolicyName>lifecyclepolicy1</LifecyclePolicyName>
    <StorageType>InfrequentAccess</StorageType>
    <LifecycleRuleName>DEFAULT_ATIME_14</LifecycleRuleName>
    <CreateTime>2019-10-30T10:08:08Z</CreateTime>
    <FileSystemId>31a8e4****</FileSystemId>
</LifecyclePolicies>

JSON format

{
    "TotalCount": 10,
    "PageSize": 10,
    "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
    "PageNumber": 1,
    "LifecyclePolicies": {
        "Path": "/pathway/to/folder",
        "LifecyclePolicyName": "lifecyclepolicy1",
        "StorageType": "InfrequentAccess",
        "LifecycleRuleName": "DEFAULT_ATIME_14",
        "CreateTime": "2019-10-30T10:08:08Z",
        "FileSystemId": "31a8e4****"
    }
}

Error codes

For a list of error codes, visit the API Error Center.