服务端 API 文档

查询存储空间数据详情

最近更新时间:2021-08-06 08:10:10

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

该接口返回查询时间范围内使用的点播存储空间,单位:字节。

1. 可以查询最近365天内的存储空间数据;
2. 查询时间跨度不超过90天;
3. 分钟粒度查询跨度不超过7天;

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStorageDetails。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
StartTime String 起始时间,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明
EndTime String 结束时间,需大于开始日期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明
Interval String 统计时间粒度,有效值:
  • Minute:以5分钟为粒度。
  • Day:以天为粒度。

  • 默认按时间跨度决定,小于等于1天以5分钟为粒度,大于1天则以天为粒度。
    StorageType String 查询的存储类型,有效值:
  • TotalStorage:存储总量,标准、低频、归档和深度归档存储量之和,不含提前删除量。
  • StandardStorage:标准存储。
  • InfrequentStorage:低频存储。
  • ArchiveStorage:归档存储。
  • DeepArchiveStorage:深度归档存储。
  • DeletedInfrequentStorage:低频存储提前删除量。
  • DeletedArchiveStorage:归档提前删除量。
  • DeletedDeepArchiveStorage:深度归档提前删除量。
  • ArchiveStandardRetrieval:归档标准取回量。
  • ArchiveExpeditedRetrieval:归档快速取回量。
  • ArchiveBulkRetrieval:归档批量取回量。
  • DeepArchiveStandardRetrieval:深度归档标准取回量。
  • DeepArchiveBulkRetrieval:深度归档批量取回量。

  • 默认值为 TotalStorage。
    SubAppId Integer 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。
    当该字段为1时,表示以管理员身份查询所有子应用(含主应用)的用量合计。
    Area String 查询的存储区域,有效值:
  • Chinese Mainland:中国境内(不包含港澳台)。
  • Outside Chinese Mainland:中国境外。

  • 默认值为 Chinese Mainland。

    3. 输出参数

    参数名称 类型 描述
    Data Array of StatDataItem 存储统计数据,每5分钟或每天一条数据。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询点播存储统计数据

    查询2018年12月1日(含)到2018年12月7日(含)的存储空间数据。

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribeStorageDetails
    &StartTime=2018-12-01T00:00:00+08:00
    &EndTime=2018-12-07T00:00:00+08:00
    &Area=Chinese Mainland
    &<公共请求参数>

    输出示例

    {
    "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.InvalidVodUser 没有开通点播业务。
    InternalError 内部错误。
    InternalError.TimeParseError 时间解析错误。
    InvalidParameter 参数错误。
    InvalidParameterValue.Area Area 参数错误。
    InvalidParameterValue.EndTime 参数值错误:EndTime 无效。
    InvalidParameterValue.StartTime 参数值错误:StartTime 无效。
    InvalidParameterValue.StorageType 参数值错误:StorageType。
    InvalidParameterValue.TimeType 参数值错误:TimeType。
    UnauthorizedOperation 未授权操作。
    目录