tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeAutoSnapshotPolicies

最后更新时间：2023-07-04 17:29:55

1. API Description

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

This API is used to query the list of scheduled snapshot policies of a 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: DescribeAutoSnapshotPolicies.
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 No String Snapshot policy ID
Offset No Integer Page offset
Limit No Integer Page length
Filters.N No Array of Filter Filters
Order No String Ascending or descending order
OrderField No String Sorting field

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of snapshot policies
AutoSnapshotPolicies Array of AutoSnapshotPolicyInfo Snapshot policy information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying snapshot policies

Input Example

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

{
    "AutoSnapshotPolicyId": "asp-12345"
}

Output Example

{
    "Response": {
        "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
        "TotalCount": 1,
        "AutoSnapshotPolicies": [
            {
                "AutoSnapshotPolicyId": "asp-12345",
                "PolicyName": "Unnamed",
                "RegionName": "ap-guangzhou",
                "CreationTime": "2021-08-26 15:19:46",
                "AliveDays": 1,
                "DayOfWeek": "1",
                "Hour": "1",
                "IsActivated": 0,
                "AppId": 1255558577,
                "FileSystemNums": 0,
                "Status": "available",
                "NextActiveTime": "2021-11-22 01:00:00",
                "FileSystems": []
            }
        ]
    }
}

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
AuthFailure.UnauthorizedOperation Request unauthorized.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.AutoPolicyNotFound The snapshot policy was not found.
InvalidParameterValue The parameter value is incorrect.
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款