最近更新时间:2024.04.01 18:01:10
首次发布时间:2023.10.16 10:38:46
此接口用于查询指定时间范围内多媒体 AI 功能的用量。
请求地址:https://vod.volcengineapi.com?Action=DescribeVodSpaceAIStatisData&Version=2023-07-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVodSpaceAIStatisData | 接口名称。当前 API 的名称为 DescribeVodSpaceAIStatisData 。 |
Version | String | 是 | 2023-07-01 | 接口版本。当前 API 的版本为 2023-07-01 。 |
SpaceList | String | 否 |
| 点播空间名列表。多个空间名之间用英文逗号 , 隔开。 说明 如果是 POST 请求,此参数类型为 Array of String。 |
StartTime | String | 是 |
| 查询的起始时间。日期格式要求符合 RFC3339 规范。 说明 开始时间最早不早于当前时间的 366 天。 |
EndTime | String | 是 |
| 查询的结束时间。日期格式要求符合 RFC3339 规范。 说明 单次查询的时间跨度不可超过 93 天。 |
MediaAiType | String | 否 |
| 多媒体 AI 类型。默认全选。取值如下:
|
TaskStageList | String | 否 |
| 任务类型。多个任务类型之间用英文逗号 , 隔开。取值如下:
说明 如果是 POST 请求,此参数类型为 Array of String。 |
Aggregation | Long | 否 |
| 聚合的时间粒度。单位为秒。取值如下:
|
DetailFieldList | String | 否 |
| 详细字段列表。取值如下:
说明
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SpaceList | Array of String | ["test"] | 点播空间列表。 |
StartTime | String | 2022-04-18T20:00:00Z | 查询起始时间。 |
EndTime | String | 2022-04-18T22:00:00Z | 查询结束时间。 |
MediaAiType | String |
| 多媒体 AI 类型。取值如下:
|
TaskStageList | Array of String |
| 任务类型。取值如下:
|
Aggregation | Long |
| 聚合的时间粒度。单位为秒。取值如下:
|
DetailFieldList | Array of String |
| 详细字段列表。取值如下:
|
TotalAiUsageData | Long | 所选时间段的多媒体 AI 总用量。 | |
AiUsageDataList | Array of AiUsageDataList | - | 多媒体 AI 用量具体数据。 |
AiUsageDataDetailList | Array of AiUsageDataDetailList | - | 各种任务类型的多媒体 AI 用量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Time | String | 2022-04-18T20:00:00Z | 时间。日期格式要求符合 RFC3339 规范。 |
Duration | Long | 100 | 用量,单位为毫秒。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Space | String | test | 点播空间名。 |
TaskStage | String |
| 任务类型。取值如下:
|
AiUsageDataList | Array of AiUsageDataList | - | 多媒体 AI 用量具体数据。 |
https://vod.volcengineapi.com?Action=DescribeVodSpaceAIStatisData&Version=2023-07-01&Aggregation=3600&DetailFieldList=%5B%22TaskStage%22%5D&EndTime=2022-04-18T22%3A00%3A00Z&MediaAiType=VideoClassification&SpaceList=%5B%22test%22%5D&StartTime=2022-04-18T20%3A00%3A00Z&TaskStageList=%5B%22busy%22%2C%22free%22%5D
HTTP/1.1 200 OK Content-Length: 190 Content-Type: application/json { "ResponseMetadata": { "RequestId": "20201124165******22034080031B5", "Action": "DescribeVodSpaceAIStatisData", "Version": "2023-07-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "SpaceList": ["test"], "StartTime": "2022-04-18T20:00:00Z", "EndTime": "2022-04-18T22:00:00Z", "TaskStageList": ["busy", "free"], "MediaAiType": "VideoClassification", "DetailFieldList": ["TaskStage"], "Aggregation": 3600, "TotalAiData": 100, "AiUsageDataList": [ { "Time": "2022-04-18T20:00:00Z", "Duration": 100 } ], "AiUsageDetailDataList": [ { "TaskStage": "busy", "AiUsageDataList": [ { "Time": "2022-04-18T20:00:00Z", "Duration": 100 } ] }, { "TaskStage": "free", "AiUsageDataList": [ { "Time": "2022-04-18T20:00:00Z", "Duration": 100 } ] } ] } }
本接口无特有的错误码。更多信息请见公共错误码。
点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: