Queries 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

Default value: 10

PageNumber Integer No 1

The number of the page to return.

Pages start from page 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 lifecycle management policy was created.

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

FileSystemId String 31a8e4****

The ID of the file system.

LifecyclePolicyName String lifecyclepolicy_01

The name of the lifecycle management policy.

LifecycleRuleName String DEFAULT_ATIME_14

The rules in the lifecycle management policy.

Valid values:

  • DEFAULT_ATIME_14: Files that are not accessed in the last 14 days will be dumped to the IA storage medium.
  • DEFAULT_ATIME_30: Files that are not accessed in the last 30 days will be dumped to the IA storage medium.
  • DEFAULT_ATIME_60: Files that are not accessed in the last 60 days will be dumped to the IA storage medium.
  • DEFAULT_ATIME_90: Files that are not accessed in the last 90 days will be dumped to the IA storage medium.
Path String /pathway/to/folder

The absolute path of a directory with which the lifecycle management policy is associated.

Paths List ["/path1", "/path2"]

The list of absolute paths for multiple directories. In this case, you can associate a lifecycle management policy with each directory.

StorageType String InfrequentAccess

The storage type of the data that is dumped to the IA storage medium.

Default value: InfrequentAccess (IA).

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>
<RequestId>BC7C825C-5F65-4B56-BEF6-98C56C7C****</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<LifecyclePolicies>
    <Path>/pathway/to/folder</Path>
    <LifecyclePolicyName>lifecyclepolicy_01</LifecyclePolicyName>
    <StorageType>InfrequentAccess</StorageType>
    <LifecycleRuleName>DEFAULT_ATIME_14</LifecycleRuleName>
    <CreateTime>2019-10-30T10:08:08Z</CreateTime>
    <FileSystemId>31a8e4****</FileSystemId>
    <Paths> ["/path1", "/path2"]</Paths>
</LifecyclePolicies>

JSON format

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

Error codes

HttpCode Error code Error message Description
404 InvalidFileSystem.NotFound The specified file system does not exist. The error message returned because the specified file system does not exist.

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