Help & DocumentationAPIsVideo on DemandStatistics APIsDescribeStorageDetails

DescribeStorageDetails

Last updated: 2020-03-27 18:45:26

1. API Description

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

This API is used to query the used VOD storage capacity in bytes within the specified time range.

  1. Only storage capacity usage data for the last 365 days can be queried.
  2. The query time range cannot be more than 90 days;
  3. The query time range at the minute granularity cannot be more than 5 days;
  4. The query time range at the hour granularity cannot be more than 10 days.

A maximum of 100 requests can be initiated per second for this API.

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: DescribeStorageDetails.
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.
StartTime Yes String Start time in ISO 8601 format. For more information, please see Notes on ISO Date Format.
EndTime Yes String End time in ISO 8601 format, which must be after the start time. For more information, please see Notes on ISO Date Format.
Interval No String Query time interval. Valid values:
  • Minute: once per minute.
  • Hour: once per hour.
  • Day: once per day.

    • The default value is determined by the time span. Minute will be used if the time span is less than 1 hour, Hour if less than or equal to 7 days, and Day if more than 7 days.
    StorageType No String Storage class to be queried. Valid values:
  • TotalStorage: total storage capacity.
  • StandardStorage: Standard storage.
  • InfrequentStorage: Standard_IA storage.

    • Default value: TotalStorage.
    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.
    When the value of this field is 1, the total usage of all subapplications (including primary application) are queried by an admin.

    3. Output Parameters

    Parameter Name Type Description
    Data Array of StatDataItem Storage statistics. One data entry per minute/hour/day.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying VOD storage usage statistics

    This example shows you how to query the storage capacity usage between December 1, 2018 (inclusive) and December 7, 2018 (inclusive).

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeStorageDetails
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-07T00:00:00+08:00
&<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

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.UserStatusInavlid The service has been suspended.
    InternalError Internal error.
    InternalError.TimeParseError An error occurred while parsing the time.
    InvalidParameter Invalid parameter.
    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.