文档

DescribeVodStorageData - 查询存储用量

调用DescribeVodStorageData查询媒资管理(存储空间、存储流出流量)的用量。

接口说明

  • 目前服务地址仅支持:华东 2(上海)
  • 当结束时间间隔在 7 天以内时,返回小时粒度的数据。当结束时间间隔大于 7 天时,返回天粒度的数据,最大间隔为 31 天。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:DescribeVodStorageDataRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
StartTimestring

获取数据起始时间点。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-02-01T14:00:00Z
EndTimestring

获取数据结束时间点,需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-02-01T15:00:00Z
Regionstring

存储地域。默认返回所有地域。支持批量查询,多个区域用半角逗号(,)分隔。取值:

  • cn-shanghai:上海。
  • cn-beijing:北京。
  • eu-central-1:德国。
  • ap-southeast-1:新加坡。
cn-shanghai
StorageTypestring

存储类型。固定取值:OSS

OSS
Storagestring

存储名称(阿里云 OSS 存储 Bucket 名称),默认返回所有存储。支持批量查询,多个用半角逗号(,)分隔。

bucket
AppIdstring

应用 ID。若已开通多应用,传入此参数,可以查询指定应用下的存储用量。不传,则默认返回所有应用的转码用量总数据。本参数值可以从 CreateAppInfo 接口的返回参数AppId获取。更多信息,请参见多应用体系

app-1000000

返回参数

名称类型描述示例值
object
DataIntervalstring

返回数据的时间颗粒度。取值:

  • hour:小时数据。
  • day:天数据。
day
RequestIdstring

请求 ID。

C370DAF1-C838-4288-****-9A87633D248E
StorageDataarray<object>

存储用量数据。

object
TimeStampstring

时间片起始时刻。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-02-01T15:00:00Z
StorageUtilizationstring

存储用量数据。单位:byte。

111111
NetworkOutstring

存储流出流量。单位:byte。此流量指直接访问存储地址产生的流量,未经 CDN 加速。

111111

示例

正常返回示例

JSON格式

{
  "DataInterval": "day",
  "RequestId": "C370DAF1-C838-4288-****-9A87633D248E",
  "StorageData": {
    "StorageDataItem": [
      {
        "TimeStamp": "2019-02-01T15:00:00Z",
        "StorageUtilization": "111111",
        "NetworkOut": "111111"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-04-02OpenAPI 错误码发生变更查看变更详情
2024-04-02OpenAPI 错误码发生变更查看变更详情

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
ThrottlingRequest was denied due to request throttling.503请求被流量控制限制。
OperationDeniedYour account does not open VOD service yet.403未开通 VOD 服务。
OperationDeniedYour VOD service is suspended.403VOD 服务已被停止。
InvalidParameterInvalid Parameter.400参数错误。
InvalidParameterAliUidInvalid Parameter AliUid.400AliUid 参数错误。
InvalidParameterStartTimeInvalid Parameter StartTime.400StartTime 参数错误。
InvalidParameterEndTimeInvalid Parameter EndTime.400EndTime 参数错误。
InvalidTimeRangeStartTime and EndTime range should less than 1 month.400EndTime 和 StartTime 差值不能超过 31 天。
InvalidParameterRegionInvalid Parameter Region.400Region 参数错误。