tencent cloud

APIs

DocumentaçãoAPIsVideo on DemandData Statistics APIsDescribeStorageDetails

DescribeStorageDetails

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-19 15:02:47

1. API Description

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

This API is used to query the VOD storage space used within a specified time range. The measurement unit is byte.

  1. The system side reserves storage usage data for 13 months. You can be queried usage data within the most recent 365 days through the API. If needed to call historical usage data exceeding 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. Format according to ISO 8601. For details, see the ISO date format description.
EndTime Yes String End time, which must be greater than the start date. Format according to ISO 8601. For details, see the ISO date format description.
SubAppId No Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).
Interval No String Statistical time granularity. Valid values:
  • Minute: 5 minutes.
  • Day: day.

    • By default, the granularity is determined by the time span. It is 5 minutes for a duration of up to 1 day and day for over 1 day.
    StorageType No String Storage type for query. Valid values:
  • TotalStorage: Total stored amount, 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 storage.
  • DeletedInfrequentStorage: Early deletion amount of infrequent storage.
  • DeletedArchiveStorage: Early deletion amount of archive.
  • DeletedDeepArchiveStorage: Early deletion amount of deep archive.
  • ArchiveStandardRetrieval: Standard retrieval volume of archive.
  • ArchiveExpeditedRetrieval: Quick retrieval volume of archive.
  • ArchiveBulkRetrieval: Archive batch retrieval amount.
  • DeepArchiveStandardRetrieval: Deep archive standard retrieval.
  • DeepArchiveBulkRetrieval: Deep archive batch retrieval amount.
  • InfrequentRetrieval: Retrieval volume of infrequent storage.

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

    • Default value is Chinese Mainland.

    3. Output Parameters

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

    This example shows you how to query the storage usage between December 1, 2018 (inclusive) and 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 An error occurred while parsing the time.
    InvalidParameter Parameter error.
    InvalidParameterValue.Area Invalid Area.
    InvalidParameterValue.EndTime Incorrect parameter value: invalid EndTime.
    InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.
    InvalidParameterValue.StorageType Incorrect parameter value: StorageType.
    InvalidParameterValue.TimeType Incorrect parameter value: TimeType.
    UnauthorizedOperation Unauthorized operation.
    Anterior: DescribeReviewDetailsPróximo: DescribeMediaProcessUsageData

    Ajuda e Suporte

    Esta página foi útil?

    comentários