tencent cloud

Cloud Block Storage

DocumentaçãoCloud Block Storage

GetSnapOverview

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-12 19:37:24

1. API Description

This API will be disused soon.

Planned disuse time: 2025-09-04 11:47:32

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

This API is used to standardize API naming. This API will be decommissioned and replaced by the new API named DescribeSnapshotOverview.

This API is used to obtain snapshot overview information.

A maximum of 20 requests can be initiated per second for this API.

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 Yes String Common Params. For more information, please see the list of regions supported by the product.

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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the snapshot overview information of the current user

Input Example

https://cbs.intl.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.
Próximo: Introdução

Ajuda e Suporte

Esta página foi útil?

comentários