tencent cloud

DescribeOfficialOverview
Last updated: 2025-12-07 00:27:10
DescribeOfficialOverview
Last updated: 2025-12-07 00:27:10

1. API Description

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

This API is used to query overview data of official cloud disk instances.

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: DescribeOfficialOverview.
Version Yes String Common Params. The value used for this API: 2021-07-12.
Region No String Common Params. This parameter is not required for this API.

3. Output Parameters

Parameter Name Type Description
Quantity Integer Specifies the instance count of cloud disks.
Storage String Indicates the total storage already used in Bytes. since the number type has precision limitations, this field is a String type.
UserCount Integer Total number of users already allocated and used.
InternetTraffic String Public network downstream traffic this month in Bytes. since the number type has precision limitations, this field is a String type.
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 Official Instance Overview Data

Input Example

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

{}

Output Example

{
    "Response": {
        "Quantity": 1,
        "Storage": "1342177280",
        "UserCount": 4,
        "InternetTraffic": "6442450944",
        "RequestId": "0188bc60-7c75-4207-a457-898f114324a3"
    }
}

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 Internal error.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback