You need to enable JavaScript to run this app.
导航

查询存储用量

最近更新时间2023.07.12 17:56:38

首次发布时间2022.08.03 11:07:54

此接口用于查询指定时间范围内存储空间的用量。

请求说明

  • 接口名称:DescribeVodSpaceStorageData
  • 接口地址:http://vod.volcengineapi.com/?Action=DescribeVodSpaceStorageData&Version=2020-08-01
  • 请求频率:单用户请求频率限制为 10 次/秒
  • 数据延迟:1 天

请求参数

参数类型是否必选描述
ActionString接口名称。当前接口取值为 DescribeVodSpaceStorageData
VersionString接口版本。当前接口取值为 2020-08-01

SpaceList

Array of String

点播空间名列表。

说明

如果是 GET 请求,此参数类型为 String,多个空间名之间用 , 隔开。

StartTimeString查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

EndTime

String

查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

说明

单次查询的时间跨度不可超过 93 天。

AggregationInteger聚合的时间粒度。单位为秒。默认值为 86400,即 24 小时。

Type

String

存储类型。默认查询全部存储类型的用量。取值如下:

  • hot:标准存储。
  • lowfreq:低频存储。
  • archive:归档存储。
  • punish:低频存储提前删除量。
  • archive_punish:归档存储提前删除量。

返回参数

参数类型描述
ResponseMetadataResponseMetadata响应通用信息
ResultVodDescribeVodSpaceStorageDataResult响应结果

ResponseMetadata

参数类型描述
RequestIdString请求 ID
ActionString请求接口
VersionString版本
ServiceString服务
RegionString区域
ErrorResponseError异常信息

ResponseError

参数类型描述
CodeString错误码
MessageString详细错误信息

VodDescribeVodSpaceStorageDataResult

参数类型描述
SpaceListArray of String点播空间名列表。
StartTimeString查询起始时间。
EndTimeString查询结束时间。
AggregationInteger时间聚合粒度。

Type

String

存储类型。取值如下:

  • hot:标准存储。
  • lowfreq:低频存储。
  • archive:归档存储。
  • punish:低频存储提前删除量。
  • archive_punish:归档存储提前删除量。

LatestStorageData

int64(JSON 中为 String)

所选时间段的最新存储量。单位为字节。

说明

Type 参数取值为 punisharchive_punish 时, LatestStorageData 参数对应的内容为所选时间段的存储总量

StorageDataListArray of StorageData存储用量详细数据。

StorageData

参数类型描述
TimeString时间。
Storageint64(JSON 中为 String)存储量。单位为字节。

示例

请求示例

如果用 POST 方式发起请求,示例如下:

POST https://vod.volcengineapi.com?Action=DescribeVodSpaceStorageData&Version=2020-08-01 HTTP/1.1
Content-Type: application/json

{
  "SpaceList": ["test"],
  "StartTime":   "2006-01-02T15:04:05Z",
  "EndTime":     "2006-01-02T15:04:05Z",
  "Aggregation": "86400",
  "Type":"hot"
}

如果用 GET 方式发起请求,示例如下:

GET https://vod.volcengineapi.com?Action=DescribeVodSpaceStorageData&Version=2020-08-01&SpaceList=YourSpaceList&StartTime=2006-01-02T15:04:05Z&EndTime=2006-01-02T15:04:05Z&Aggregation=YourAggregation&Type=YourType HTTP/1.1

返回示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata": 
  {
    "RequestId": "20201124165******22034080031B5",
    "Action": "DescribeVodSpaceStorageData",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": 
  {
    "SpaceList":["SpaceList"
    ],
    "StartTime":"2019-10-12T07:20:50.52Z",
    "EndTime":"2019-10-12T07:20:50.52Z",
    "Aggregation":1,
    "Type":"Type",
    "LatestStorageData":"LatestStorageData",
    "StorageDataList":[
      {
        "Time":"2019-10-12T07:20:50.52Z",
        "Storage":"Storage"
      }
    ]
  }
}

错误码

详见视频点播公共错误码

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: