ModifyFileSystemAutoScaleUpRule

Download PDF

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

ModifyFileSystemAutoScaleUpRule

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

Download PDF

1. API Description

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

This API is used to set the file system scaling policy. It supports only the turbo file system.

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: ModifyFileSystemAutoScaleUpRule.
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.
FileSystemId	Yes	String	File system ID, which can be obtained by querying the file system list; DescribeCfsFileSystems.
ScaleUpThreshold	Yes	Integer	Threshold for triggering scaling. Value range: 10-90
TargetThreshold	Yes	Integer	Target threshold after expansion. value range: 10-90. the value must be less than ScaleUpThreshold.
Status	No	Integer	Rule status 0: turn off, 1: turn on; keep the original status if not specified.

3. Output Parameters

Parameter Name	Type	Description
FileSystemId	String	File system ID
Status	Integer	Rule status 0: turn off, 1: turn on.
ScaleUpThreshold	Integer	Expansion threshold. value range: 10-90.
TargetThreshold	Integer	Reach the threshold after expansion. value range: [10-90].
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 Updating File System Auto Scale-Out Policy

Update file system auto scale-out policy

Input Example

POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCFSFileSystemAutoScaleRule
<Common request parameters>

{
    "FileSystemId": "cfs-agaga",
    "Status": 1,
    "ScaleUpThreshold": 85,
    "TargetThreshold": 70
}

Output Example

{
    "Response": {
        "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
        "FileSystemId": "cfs-agaga",
        "Status": 1,
        "ScaleUpThreshold": 85,
        "TargetThreshold": 70
    }
}

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
AuthFailure.GetRoleFailed	Failed to get the CFS service role.
InvalidParameterValue.InvalidAutoScaleUpParams	Invalid scaling policy parameters.
InvalidParameterValue.InvalidFsStatus	Invalid file system status.
ResourceNotFound.FsNotExist	The file system does not exist.
ResourceNotFound.ResourcePackageNotFound	The resource does not exist: The resource ID cannot be found.
UnsupportedOperation	Unsupported operation.

Was this page helpful?

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

Yes

Feedback

tencent cloud