tencent cloud



Last updated: 2023-07-04 17:29:54

1. API Description

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

This API is used to update a scheduled snapshot 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: UpdateAutoSnapshotPolicy.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
AutoSnapshotPolicyId Yes String Snapshot policy ID
PolicyName No String Snapshot policy name
DayOfWeek No String The day of the week on which to regularly back up the snapshot
Hour No String The hour of a day at which to regularly back up the snapshot
AliveDays No Integer Snapshot retention period
IsActivated No Integer Whether to activate the scheduled snapshot feature
DayOfMonth No String The specific day of the month on which to create a snapshot. This parameter is mutually exclusive with DayOfWeek.
IntervalDays No Integer The snapshot interval. This parameter is mutually exclusive with DayOfWeek and DayOfMonth.

3. Output Parameters

Parameter Name Type Description
AutoSnapshotPolicyId String Snapshot policy ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 UpdateAutoSnapshotPolicy

This example shows you how to update the snapshot policy of a file system.

Input Example

Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateAutoSnapshotPolicy
<Common request parameters>

    "AutoSnapshotPolicyId": "asp-12345",
    "PolicyName": "abc"

Output Example

    "Response": {
        "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
        "AutoSnapshotPolicyId": "asp-12345"

5. Developer Resources


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

Command Line Interface

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.UnauthorizedOperation Request unauthorized.
InvalidParameter Invalid parameter.
InvalidParameter.AutoPolicyNotFound The snapshot policy was not found.
InvalidParameter.InvalidParamDayofWeek The scheduled day of the week parameter is invalid.
InvalidParameter.InvalidParamHour The value of the scheduled hour parameter is incorrect.
InvalidParameter.InvalidSnapPolicyStatus The snapshot policy is invalid.
InvalidParameter.InvalidSnapshotPolicyName The file system snapshot policy name is invalid.
InvalidParameter.MissingPolicyParam The policy parameter is missing.
InvalidParameter.SnapshotPolicyNameLimitExceeded The file system snapshot policy name exceeds the limit.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.MissingPolicyParam Snapshot policy parameters missing.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
UnsupportedOperation.UnauthorizedCfsQcsRole The CFS role was not authorized.
UnsupportedOperation.UnverifiedUser Unverified user.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support