查询视频制作任务列表
功能介绍
该接口用于查询视频制作任务列表。可查询分身数字人视频制作列表,照片数字人视频制作列表等。
-
默认查询最近一个月任务记录。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/digital-human-videos
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
每页显示的条目数量。 取值范围: 1-100 默认取值: 10 |
state |
否 |
String |
任务状态,默认所有状态。 可多个状态查询,使用英文逗号分隔。 如state=CREATING,PUBLISHED |
sort_key |
否 |
String |
排序字段,支持的排序方式有:
|
sort_dir |
否 |
String |
排序方式。
默认asc升序。 |
create_until |
否 |
String |
过滤创建时间<=输入时间的记录。 |
create_since |
否 |
String |
过滤创建时间>=输入时间的记录。 |
fuzzy_query_field |
否 |
Array of strings |
使用模糊查询的字段 |
script_id |
否 |
String |
剧本ID。 |
asset_name |
否 |
String |
输出视频资产名称。 |
job_type |
否 |
String |
任务类型。
|
job_id |
否 |
String |
任务ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
参数解释: 视频制作任务总数。 取值范围: 0-2147483647 |
jobs |
Array of DigitalHumanVideo objects |
视频制作任务列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID。 |
state |
String |
任务的状态。
|
job_type |
String |
任务类型。
|
start_time |
String |
数字人视频制作开始时间。 |
end_time |
String |
数字人视频制作结束时间。 |
duration |
Float |
参数解释: 数字人视频内容时长。 取值范围: 0-2147483647 |
output_asset_config |
OutputAssetInfo object |
输出资产信息。 |
error_info |
ErrorResponse object |
错误信息。 |
create_time |
String |
任务创建时间。 |
lastupdate_time |
String |
任务更新时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
asset_id |
String |
输出视频资产ID。 |
asset_name |
String |
输出视频资产名称。 |
cover_url |
String |
视频封面URL。 |
preview_video_url |
String |
预览视频下载URL。URL有效期24小时。
说明:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
BadRequest |
AnyType |
请求传参异常,包含错误码及对应描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
Unauthorized |
AnyType |
未鉴权或鉴权失败。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
NotFound |
AnyType |
无内容。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
InternalServiceError |
AnyType |
内部服务错误。 |
请求示例
GET https://{endpoint}/v1/0d697589d98091f12f92c0073501cd79/digital-human-videos
响应示例
状态码: 200
处理成功返回。
{ "count" : 1, "jobs" : [ { "job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "state" : "SUCCEED", "start_time" : "2022-01-18T16:29:36Z", "end_time" : "2022-01-18T16:30:36Z", "duration" : 60, "output_asset_config" : { "asset_id" : "942e65a5fd219a2e01fb08d881cfadb9", "asset_name" : "One Day", "cover_url" : "https://{endpoint}/0d697589d98091f12f92c0073501cd79/942e65a5fd219a2e01fb08d881cfadb9/20d367508e62d3d4ad608cedbe81bd35.png?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241457&Signature=zVGMVbI5ji9rr8epD1Cir5OGIRk%3D" }, "error_info" : null, "create_time" : "2022-11-30T06:59:56Z", "lastupdate_time" : "2022-11-30T07:00:09Z" } ] }
状态码: 400
请求传参异常,包含错误码及对应描述。
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码: 401
未鉴权或鉴权失败。
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
状态码: 404
无内容。
{ "error_code" : "MSS.00000002", "error_msg" : "Not Found" }
状态码: 500
内部服务错误。
{ "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion; import com.huaweicloud.sdk.metastudio.v1.*; import com.huaweicloud.sdk.metastudio.v1.model.*; public class ListDigitalHumanVideoSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MetaStudioClient client = MetaStudioClient.newBuilder() .withCredential(auth) .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>")) .build(); ListDigitalHumanVideoRequest request = new ListDigitalHumanVideoRequest(); try { ListDigitalHumanVideoResponse response = client.listDigitalHumanVideo(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmetastudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = MetaStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDigitalHumanVideoRequest() response = client.list_digital_human_video(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := metastudio.NewMetaStudioClient( metastudio.MetaStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDigitalHumanVideoRequest{} response, err := client.ListDigitalHumanVideo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
404 |
无内容。 |
500 |
内部服务错误。 |
错误码
请参见错误码。