ApplyPathLifecyclePolicy

Download PDF

Last updated:2026-03-11 22:54:47

ApplyPathLifecyclePolicy

Last updated: 2026-03-11 22:54:47

Download PDF

1. API Description

Domain name for API request: cfs.intl.tencentcloudapi.com.

Configure the directory list associated with the lifecycle policy.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ApplyPathLifecyclePolicy.
Version	Yes	String	Common Params. The value used for this API: 2019-07-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
LifecyclePolicyID	Yes	String	Lifecycle management policy ID.
Paths.N	No	Array of PathInfo	List of absolute paths for directories associated with the lifecycle management policy.

3. Output Parameters

Parameter Name	Type	Description
CheckResults	Array of CheckResult	Returns existing rule information if there is a rule conflict. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Configure the Directory Associated with the Lifecycle Policy

Input Example

https://cfs.intl.tencentcloudapi.com/?Action=ApplyPathLifecyclePolicy
&LifecyclePolicyID=policy-ek8aw4id
&Paths.0.FileSystemId=cfs-4030acd30
&Paths.0.Path=/data
&<Common request parameters>

Output Example

{
    "Response": {
        "CheckResults": [
            {
                "LifecyclePolicyID": "policy-4cqyxcma",
                "FileSystemId": "cfs-5ajk45jk8",
                "Path": "/data/home/user00/",
                "LifecycleRules": [
                    {
                        "StorageType": "InfrequentAccess",
                        "Interval": "DEFAULT_ATIME_14",
                        "FileType": "All",
                        "Action": "Archive",
                        "FileMaxSize": "1G",
                        "FileMinSize": "1M"
                    }
                ],
                "TargetPath": "/data/home/user00/"
            }
        ],
        "RequestId": "a1b2c3-d4e5f6-g7h8j9"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameterValue.BindInfrequentaccessFirst	Parameter value error: bind the settlement rules before binding the archive rule.
InvalidParameterValue.ExternalStorageSupportDataflowOnly	ExternalStorage lifecycle mode supports only data flow.
InvalidParameterValue.InvalidPolicyFsPath	The directory path contains an invalid character.
InvalidParameterValue.PathUsedInDataflow	The file system directory has configured data flow. configure another rule.
ResourceInsufficient.PolicyFsLimitExceeded	The number of file systems bound to the policy exceeds the limit.
ResourceInsufficient.PolicyFsPathLimitExceeded	The number of policy binding paths exceeds the limit.
ResourceInsufficient.PolicyLimitExceeded	The user's lifecycle policy count has reached the maximum limit.
UnsupportedOperation	Unsupported operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud