tencent cloud



Last updated: 2022-08-23 16:02:44

1. API Description

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

This API is used to query the storage capacity usage and number of files.

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: DescribeStorageData.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required for this API.
SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
MediaCount Integer Total number of current media files.
TotalStorage Integer Total current storage capacity in bytes.
StandardStorage Integer Current Standard storage capacity in bytes.
InfrequentStorage Integer Current Standard_IA storage capacity in bytes.
ArchiveStorage Integer The current ARCHIVE storage usage in bytes.
DeepArchiveStorage Integer The current DEEP ARCHIVE storage usage in bytes.
StorageStat Array of StorageStatData Storage usage by billing region.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying current storage information

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "MediaCount": 100,
        "TotalStorage": 4700000,
        "InfrequentStorage": 0,
        "StandardStorage": 2000000,
        "ArchiveStorage": 1500000,
        "DeepArchiveStorage": 1200000,
        "StorageStat": [
                "Area": "Chinese Mainland",
                "TotalStorage": 3800000,
                "InfrequentStorage": 0,
                "StandardStorage": 1800000,
                "ArchiveStorage": 1000000,
                "DeepArchiveStorage": 1000000
                "Area": "Outside Chinese Mainland",
                "TotalStorage": 900000,
                "InfrequentStorage": 0,
                "StandardStorage": 200000,
                "ArchiveStorage": 500000,
                "DeepArchiveStorage": 200000
        "RequestId": "12345678-90ab-cdef-1234-567890abcdef"

5. Developer Resources


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
FailedOperation Operation failed.
FailedOperation.InvalidVodUser The VOD service is not activated.
InternalError Internal error.
InvalidParameter Invalid parameter.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support