CreateAutoSnapshotPolicy

Last updated: 2025-11-13 20:46:41

CreateAutoSnapshotPolicy

Last updated: 2025-11-13 20:46:41

1. API Description

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

This API is used to create 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: CreateAutoSnapshotPolicy.
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.
Hour	Yes	String	The time point when to repeat the snapshot operation
PolicyName	No	String	Policy name
DayOfWeek	No	String	The day of the week on which to repeat the snapshot operation
AliveDays	No	Integer	Snapshot retention period
DayOfMonth	No	String	The specific day (day 1 to day 31) of the month on which to automatically create a snapshot.
IntervalDays	No	Integer	The snapshot interval, in days.

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 Creating a file system snapshot policy

This example shows you how to create a file system snapshot policy.

Input Example

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

{
    "DayOfWeek": "\"1,2\"",
    "Hour": "\"2,3\""
}

Output Example

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

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.UnauthorizedOperation	Request unauthorized.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameter.InvalidAlivedDays	The snapshot retention period is invalid.
InvalidParameter.InvalidParamDayofWeek	The scheduled day of the week parameter is invalid.
InvalidParameter.InvalidParamHour	The value of the scheduled hour parameter is incorrect.
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.AutoPolicyNotFound	Auto-scaling policy does not exist.
InvalidParameterValue.InvalidAliveDays	Invalid AliveDays value error
InvalidParameterValue.InvalidParamDayOfMonth	Invalid value of `DayOfMonth`.
InvalidParameterValue.InvalidParamDayOfWeek	Invalid parameter: DayOfWeek
InvalidParameterValue.InvalidParamIntervalDays	Invalid value of `IntervalDays`.
InvalidParameterValue.InvalidSnapPolicyStatus	Invalid snapshot policy status
InvalidParameterValue.InvalidSnapshotName	Invalid snapshot name
InvalidParameterValue.InvalidSnapshotPolicyName	Invalid snapshot policy name
InvalidParameterValue.MissingSnapNameOrAliveDay	Missing parameter(s): Snapshot Name or aliveDays
InvalidParameterValue.SnapshotNameLimitExceeded	Snapshot name exceeds the limit. The name length must not exceed 64 characters.
InvalidParameterValue.SnapshotPolicyNameLimitExceeded	Snapshot policy name exceeds the 64-character limit.
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.

Was this page helpful?

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

Yes

Feedback

tencent cloud