tencent cloud

피드백

GetSnapOverview

마지막 업데이트 시간:2023-06-21 15:01:13

1. API Description

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

This API is used to get snapshot overview information.

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: GetSnapOverview.
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.

3. Output Parameters

Parameter Name Type Description
TotalSize Float The total snapshot size of the user
RealTradeSize Float The total billed snapshot size of the user
FreeQuota Float Free tier of snapshot
TotalNums Integer Total number of snapshots
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the snapshot overview information of the current user

Input Example

https://cbs.tencentcloudapi.com/?Action=GetSnapOverview
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884cc"
    }
}

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
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter.