tencent cloud

文档反馈

CreateSnapshotPolicies

最后更新时间:2023-07-11 17:48:31

1. API Description

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

This API is used to create snapshot policies.

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: CreateSnapshotPolicies.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
SnapshotPolicies.N Yes Array of SnapshotPolicy Details of a snapshot policy

3. Output Parameters

Parameter Name Type Description
SnapshotPolicies Array of SnapshotPolicy Snapshot policies
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating snapshot policies

Input Example

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

{
    "SnapshotPolicies": [
        {
            "KeepTime": "180",
            "CosRegion": "ap-guangzhou",
            "CosBucket": "test-12345678",
            "CreateNewCos": "true",
            "SnapshotPolicyName": "test_name",
            "BackupType": "operate"
        }
    ]
}

Output Example

{
    "Response": {
        "SnapshotPolicies": [
            {
                "SnapshotPolicyId": "sspolicy-n08du1g3",
                "SnapshotPolicyName": "test_name",
                "KeepTime": 180,
                "CosRegion": "ap-guangzhou",
                "CosBucket": "test-12345678",
                "Enable": true,
                "BackupType": "operate",
                "CreateNewCos": true
            }
        ],
        "RequestId": "fdba6828-e317-4bd8-940f-6e12b09ecf1b"
    }
}

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

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
InternalError.ModuleError Internal module error
InvalidParameterValue.Duplicate The input parameter already exists.
InvalidParameterValue.Empty Missing parameters.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.Range The parameter value is not in the specified range.
LimitExceeded Quota limit is reached.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.