tencent cloud

APIs

DescribeStorageDetails

下载
聚焦模式
字号
最后更新时间: 2026-09-18 16:00:08

1. API Description

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

This API is used to return the VOD storage space used within a specified time range, in bytes.

  1. Storage usage data is reserved on the system side for 13 months. You can only query usage data from the most recent 365 days through the API. If you need to call historical usage data beyond 365 days, contact us;
  2. The query time span should not exceed 90 days.
  3. The query span at a minute granularity should not exceed 7 days.

A maximum of 100 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: DescribeStorageDetails.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
StartTime Yes String Start time in ISO 8601 format. See ISO date format description.
EndTime Yes String End time, which should be greater than the start date. Format according to the ISO 8601 standard. For details, see ISO date format description.
SubAppId No Integer VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
Interval No String Statistical time granularity. Valid values:
  • Minute: 5 minutes.
  • Day: By day.

  • The granularity is determined by the time span by default. If the time span is less than or equal to 1 day, the granularity is 5 minutes. If the time span is greater than 1 day, the granularity is 1 day.
    StorageType No String Storage type for query. Valid values:
  • TotalStorage: total stored amount, the sum of standard, infrequent, archive, and deep archive storage capacity, excluding early deletion amount.
  • StandardStorage: standard storage.
  • InfrequentStorage: infrequent storage.
  • ArchiveStorage: archive storage.
  • DeepArchiveStorage: DEEP_ARCHIVE.
  • DeletedInfrequentStorage: Early deletion amount for infrequent storage.
  • DeletedArchiveStorage: early deletion amount for archive.
  • DeletedDeepArchiveStorage: early deletion amount for deep archive.
  • ArchiveStandardRetrieval: Archive standard retrieval amount.
  • ArchiveExpeditedRetrieval: Archive quick retrieval volume.
  • ArchiveBulkRetrieval: Archive batch retrieval amount.
  • DeepArchiveStandardRetrieval: Deep archive standard retrieval volume.
  • DeepArchiveBulkRetrieval: Deep archive batch retrieval amount.
  • InfrequentRetrieval: Infrequent storage retrieval volume.

  • Default value: TotalStorage.
    Area No String Storage region for query. Valid values:
  • Chinese Mainland: within the Chinese mainland (excluding Hong Kong (China), Macao (China), and Taiwan (China)).
  • Outside Chinese Mainland: outside the Chinese mainland.

  • Default value: Chinese Mainland.

    3. Output Parameters

    Parameter Name Type Description
    Data Array of StatDataItem Storage statistics data, one record every 5 minutes or every day.
    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 VOD Storage Statistics

    Query storage space data from December 1, 2018 (inclusive) to December 7, 2018 (inclusive).

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeStorageDetails
    &StartTime=2018-12-01T00:00:00+08:00
    &EndTime=2018-12-07T00:00:00+08:00
    &Area=Chinese Mainland
    &<Common request parameters>

    Output Example

    {
        "Response": {
            "Data": [
                {
                    "Time": "2018-12-01T00:00:00+08:00",
                    "Value": 1000000
                },
                {
                    "Time": "2018-12-02T00:00:00+08:00",
                    "Value": 1500000
                },
                {
                    "Time": "2018-12-03T00:00:00+08:00",
                    "Value": 1500000
                },
                {
                    "Time": "2018-12-04T00:00:00+08:00",
                    "Value": 1500000
                },
                {
                    "Time": "2018-12-05T00:00:00+08:00",
                    "Value": 1500000
                },
                {
                    "Time": "2018-12-06T00:00:00+08:00",
                    "Value": 1500000
                },
                {
                    "Time": "2018-12-07T00:00:00+08:00",
                    "Value": 1500000
                }
            ],
            "RequestId": "requestId"
        }
    }

    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
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InternalError.TimeParseError Time parsing error.
    InvalidParameter Parameter error.
    InvalidParameterValue.Area Area parameter error.
    InvalidParameterValue.EndTime Parameter value error: EndTime is invalid.
    InvalidParameterValue.StartTime Parameter value error: StartTime is invalid.
    InvalidParameterValue.StorageType Parameter value error: StorageType.
    InvalidParameterValue.TimeType Parameter value error: TimeType.
    UnauthorizedOperation Unauthorized operation.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈