DescribeVodStorageData - 查询存储用量

更新时间:
复制 MD 格式

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

接口说明

  • 目前服务地址仅支持:华东 2(上海)

  • 当结束时间间隔在 7 天以内时,返回小时粒度的数据。当结束时间间隔大于 7 天时,返回天粒度的数据,最大间隔为 31 天。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:DescribeVodStorageData

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

StartTime

string

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

2019-02-01T14:00:00Z

EndTime

string

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

2019-02-01T15:00:00Z

Region

string

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

  • cn-shanghai:上海。

  • cn-beijing:北京。

  • eu-central-1:德国。

  • ap-southeast-1:新加坡。

cn-shanghai

StorageType

string

存储类型。固定取值:OSS

OSS

Storage

string

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

bucket

AppId

string

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

app-1000000

返回参数

名称

类型

描述

示例值

object

DataInterval

string

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

  • hour:小时数据。

  • day:天数据。

day

RequestId

string

请求 ID。

C370DAF1-C838-4288-****-9A87633D248E

StorageData

object

StorageDataItem

array<object>

存储用量数据。

object

TimeStamp

string

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

2019-02-01T15:00:00Z

StorageUtilization

string

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

111111

NetworkOut

string

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

111111

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidEndTime.Malformed Specified EndTime is malformed. 结束时间格式错误。
400 InvalidParameterType The specified Type is invalid. 指定的Type参数错误,请根据文档修改传入的Type参数。
400 InvalidTimeSpan The time span exceeds the limit. 时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400 InvalidParameter Invalid input parameter. 输入参数错误。
400 InvalidTime.Malformed The specified Time is malformed. 指定的时间格式错误,请根据文档描述,修改正确的入参格式。
400 InvalidParameterInterval The specified Interval is invalid. 指定的时间粒度无效,请根据API文档输入所需的时间粒度。

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

变更历史

更多信息,参考变更详情