获取视频列表
功能介绍
获取生成的视频列表。
URI
GET https://{endpoint}/v1/{project_id}/digital-human/video?name={name}&offset={offset}&limit={limit}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
endpoint |
是 |
String |
终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，CBS服务在“华北-北京四”区域的“endpoint”为“cbs-ext.cn-north-4.myhuaweicloud.com”。 |
project_id |
是 |
String |
项目ID，用于资源隔离。请参见获取项目ID。 |
limit |
是 |
Integer |
一页显示的视频个数。 取值范围：大于等于1。 默认值：10。 |
name |
是 |
String |
视频名称，长度小于63。 |
offset |
是 |
Integer |
偏移量。 取值范围：大于等于0。 默认值：0。 |
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
quota |
Integer |
配额。 |
total |
Integer |
总数。 |
offset |
Integer |
偏移量。 |
count |
Integer |
返回数量。 |
videos |
Array of Vedio objects |
视频列表。 |
参数 |
参数类型 |
描述 |
|---|---|---|
create_time |
String |
创建时间。 |
update_time |
String |
更新时间。 |
error_msg |
String |
错误信息 。如: {"error_code":"0001","error_msg":"播报内容超过10分钟，请重新调整播报内容。"}。 |
id |
String |
视频ID。 |
name |
String |
视频名称。 |
progress |
Integer |
视频生成进度。取值范围：0~100。 |
status |
Integer |
视频状态。取值范围：
|
subtitle_url |
String |
字幕地址。 |
video_url |
String |
视频的obs地址，当视频生成成功时返回。 |
video_shot |
String |
视频截图地址，jpg格式，分辨率480 * 270。 当status=2表示生成成功时返回。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 CBS.XXXX。 |
error_msg |
String |
错误详情。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 CBS.XXXX。 |
error_msg |
String |
错误详情。 |
请求示例
获取数字人视频列表
GET https://{endpoint}/v1/{project_id}{project_id}/digital-human/video?offset=0&limit=1
响应示例
状态码： 200
OK
{
"quota" : 1000,
"total" : 808,
"offset" : 0,
"count" : 1,
"videos" : [
{
"id" : "c8a50ddd-67b7-46a2-xxx",
"status" : 2,
"name" : "1029-11",
"create_time" : "2022-10-28T16:28:35Z",
"update_time" : "2022-10-28T17:01:35Z",
"video_shot" : "https://cbs-digital-human-cn-north-4.obs.xxxxx.myhuaweicloud.com",
"video_url" : "https://cbs-digital-human-cn-north-4.obs.xxxxx.myhuaweicloud.com",
"subtitle_url" : "https://cbs-digital-human-cn-north-4.obs.xxxxx.myhuaweicloud.com"
} ]
}
状态码： 400
Bad Request
{
"error_code" : "CBS.0003",
"error_msg" : "This resource Id:[33dbe0e2-bb9b-4efc-xxx] does not exist."
}
状态码： 500
Internal Server Error
{
"error_code" : "CBS.0004",
"error_msg" : "Internal Server Error"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。
