1. 接口描述
接口请求域名： vod.tencentcloudapi.com 。
查询存储空间使用情况和文件数量。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeStorageData。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。 示例值：1250000001 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MediaCount | Integer | 当前媒体总量。 示例值：100 |
| TotalStorage | Integer | 当前总存储量，单位是字节。 示例值：4000000 |
| StandardStorage | Integer | 当前标准存储量，单位是字节。 示例值：2000000 |
| InfrequentStorage | Integer | 当前低频存储量，单位是字节。 示例值：0 |
| ArchiveStorage | Integer | 当前归档存储量，单位是字节。 示例值：1000000 |
| DeepArchiveStorage | Integer | 当前深度归档存储量，单位是字节。 示例值：1000000 |
| StorageStat | Array of StorageStatData | 各计费区域的存储用量。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询当前存储情况
查询当前存储情况
输入示例
https://vod.tencentcloudapi.com/?Action=DescribeStorageData
&<公共请求参数>输出示例
{
"Response": {
"MediaCount": 100,
"TotalStorage": 4700000,
"InfrequentStorage": 0,
"StandardStorage": 2000000,
"ArchiveStorage": 1500000,
"DeepArchiveStorage": 1200000,
"StorageStat": [
{
"Area": "Chinese Mainland",
"TotalStorage": 3800000,
"InfrequentStorage": 0,
"StandardStorage": 1800000,
"ArchiveStorage": 1000000,
"DeepArchiveStorage": 1000000
},
{
"Area": "Outside Chinese Mainland",
"TotalStorage": 900000,
"InfrequentStorage": 0,
"StandardStorage": 200000,
"ArchiveStorage": 500000,
"DeepArchiveStorage": 200000
}
],
"RequestId": "12345678-90ab-cdef-1234-567890abcdef"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.InvalidVodUser | 没有开通点播业务。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation | 未授权操作。 |