Queries lifecycle 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
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
TotalCount Integer 10

The total number of lifecycle policies.

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

The ID of the request.

PageSize Integer 10

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

LifecyclePolicies Array of LifecyclePolicy

The list of lifecycle policies.

FileSystemId String 31a8e4****

The ID of the file system.

LifecycleRuleName String DEFAULT_ATIME_14

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.
CreateTime String 2019-10-30T10:08:08Z

The time when the lifecycle policy was created.

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

Path String /pathway/to/folder

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

StorageType String InfrequentAccess

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

Default value: InfrequentAccess (IA).

LifecyclePolicyName String lifecyclepolicy_01

The name of the lifecycle policy.

Paths Array of String ["/path1", "/path2"]

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

Examples

Sample requests

http(s)://[Endpoint]/?FileSystemId=31a8e4****
&PageSize=10
&PageNumber=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 error message returned because the specified file system does not exist.

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