查询存储用量--视频点播-火山引擎

文档中心

立即注册

导航

查询存储用量

最近更新时间：2024.06.26 09:59:41首次发布时间：2023.10.16 10:38:47

此接口用于在指定空间维度下，查询一定时间范围内存储空间的用量。

注意事项

计费说明：媒资存储计费价格请参见按量计费
请求频率：单用户请求频率限制为 10 次/秒。
数据延迟：1 天。
时间范围：查询的时间跨度不超过 93 天。
权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeVodSpaceStorageData&Version=2023-07-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodSpaceStorageData`	接口名称。当前 API 的名称为 `DescribeVodSpaceStorageData`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceList	String	否	`test`	点播空间名列表。多个空间名之间用英文逗号 `,` 隔开。说明如果是 POST 请求，此参数类型为 Array of String。
StartTime	String	是	`2023-01-01T16:00:00Z`	查询的起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	是	`2023-01-02T16:00:00Z`	查询的结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。说明单次查询的时间跨度不可超过 93 天。
Aggregation	Integer	否	`86400`	聚合的时间粒度。单位为秒，目前仅支持取值为 `86400`，即 24 小时。
Type	String	否	`hot`	存储类型。默认查询全部存储类型的用量。取值如下： `hot`：标准存储。 `lowfreq`：低频存储。 `archive`：归档存储。 `punish`：低频存储提前删除量。 `archive_punish`：归档存储提前删除量。
RegionList	String	否	`cn-north-1`	区域列表。默认全选，多个用英文逗号 `,` 连接。取值如下： `cn-north-1`：华北 `ap-southeast-1`：亚太东南（柔佛）说明如果是 POST 请求类型为 Array of String 。视频点播亚太东南（柔佛）地域邀测中，仅针对企业用户开放。如您有相关需求，请联系您的商务经理申请，申请通过后即可正常使用。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
SpaceList	String[]	`["SpaceList"]`	点播空间名列表。
StartTime	String	`2023-01-01T16:00:00Z`	查询起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	`2023-01-02T16:00:00Z`	查询结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Aggregation	Integer	`86400`	聚合的时间粒度。
Type	String	`hot`	存储类型。取值如下： `hot`：标准存储。 `lowfreq`：低频存储。 `archive`：归档存储。 `punish`：低频存储提前删除量。 `archive_punish`：归档存储提前删除量。
LatestStorageData	Long	`123`	所选时间段的最新存储量。单位为字节。说明当 `Type` 参数取值为 `punish` 和 `archive_punish` 时，该 `LatestStorageData` 参数对应的内容为所选时间段的存储总量。
StorageDataList	Object[]	`-`	存储用量详细数据。
Time	String	`2023-01-01T16:00:00Z`	数据所在时间区间的开始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Storage	Long	`123`	存储量。单位为字节。
RegionList	String[]	`["cn-north-1"]`	区域列表。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceStorageData&Version=2023-07-01&Aggregation=86400&EndTime=2023-01-02T16:00:00Z&SpaceList=test&StartTime=2023-01-01T16:00:00Z&Type=hot&RegionList=cn-north-1

返回示例

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

{
  "ResponseMetadata": {
    "RequestId": "20201124165******22034080031B5",
    "Action": "DescribeVodSpaceStorageData",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "SpaceList":["test"],
    "StartTime":"2023-01-01T16:00:00Z",
    "EndTime":"2023-01-02T16:00:00Z",
    "Aggregation":86400,
    "Type":"hot",
    "RegionList": ["cn-north-1"]
    "LatestStorageData":"LatestStorageData",
    "StorageDataList":[
      {
        "Time":"2023-01-01T16:00:00Z",
        "Storage":1234
      }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

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