DescribeStorageData

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-02-23 16:18:57

Download PDF

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 parameter. The value used for this API: DescribeStorageData.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-17.
Region	No	String	Common parameter. This parameter is not required for this API.
SubAppId	No	Integer	Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; 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.
InfrequentStorage	Integer	Current Standard_IA storage capacity in bytes.
StandardStorage	Integer	Current Standard storage capacity 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

https://vod.tencentcloudapi.com/?Action=DescribeStorageData
&<Common request parameters>

Output Example

{
  "Response": {
    "MediaCount": 0,
    "TotalStorage": 2000000,
    "InfrequentStorage": 0,
    "StandardStorage": 2000000,
    "StorageStat": [
      {
        "Area": "Chinese Mainland",
        "TotalStorage": 1800000,
        "InfrequentStorage": 0,
        "StandardStorage": 1800000
      },
      {
        "Area": "Outside Chinese Mainland",
        "TotalStorage": 200000,
        "InfrequentStorage": 0,
        "StandardStorage": 200000
      }
    ],
    "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287s3"
  }
}

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

Tencent Cloud CLI 3.0

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.

Recent Pages