更新时间:2024-11-18 GMT+08:00
分享

查询视频驱动任务列表

功能介绍

该接口用于查询视频驱动任务列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/video-motion-capture-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

每页显示的条目数量。

取值范围:

1-100

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

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

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

total

Integer

视频驱动任务总数。

取值范围:

0-2147483647

video_motion_capture_jobs

Array of VideoMotionCaptureInfo objects

视频驱动任务列表。

表6 VideoMotionCaptureInfo

参数

参数类型

描述

motion_capture_mode

String

视频驱动模式。

  • HEAD:头部

  • HALF_BODY:半身

  • FULL_BODY:全身

  • AUTO:自动

默认取值:

AUTO

input_info

InputInfo object

输入信息。

output_info

OutputInfo object

输出信息。

job_id

String

视频驱动任务ID。

state

String

任务的状态。

  • WAITING:等待中

  • PROCESSING:处理中

  • SUCCEED:成功

  • FAILED:失败

start_time

String

任务开始时间,格式遵循:RFC 3339。 例 “2020-07-30T10:43:17Z”。

end_time

String

任务结束时间,格式遵循:RFC 3339。 例 “2020-07-30T10:43:17Z”。

表7 InputInfo

参数

参数类型

描述

rtc_room_info

RTCRoomInfoList object

RTC房间信息。

表8 RTCRoomInfoList

参数

参数类型

描述

app_id

String

RTC应用ID。

room_id

String

RTC房间ID。

users

Array of RTCUserInfo objects

加入RTC房间用户信息。

表9 RTCUserInfo

参数

参数类型

描述

user_type

String

用户类型。

  • CAPTURE: 直播助手,将摄像头获取视频流推送到RTC房间

  • ANIMATION: VDS服务,从RTC房间拉视频流生成动作数据

  • RENDER: 渲染服务,将动作数据渲染成数字人动画

  • PLAYER: 普通观看方,可选择原始视频流或者数字人动画视频流观看

  • INFERENCE_USER: 数字人推理端用户。从RTC房间接收音频流,并推送视频流到RTC房间

  • END_USER: 端侧用户。从推送音频流到RTC房间,并从RTC房间接收视频流

user_id

String

RTC用户ID。

signature

String

RTC鉴权token。

ctime

Long

有效期。时间戳,单位:秒。

取值范围:

0-4294967295

表10 OutputInfo

参数

参数类型

描述

face_addr

String

面部表情输入地址。

body_addr

String

身体动作输入地址。

audio_addr

String

音频输入地址。

session_id

Integer

会话ID。

取值范围:

0-4294967295

output_data_version

String

输出数据的格式版本,如请求中无此参数,则输出数据格式为1.0,可选值有:

1.0: 对应的输出为:

动作数据:75个骨骼旋转值

表情数据:52ARkit表情及参数

2.0: 对应的输出为:

动作数据:55个骨骼旋转值+骨骼3D坐标

表情数据:178个控制器的数据

状态码: 400

表11 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

请求传参异常,包含错误码及对应描述。

状态码: 500

表12 响应Body参数

参数

参数类型

描述

InternalServiceError

AnyType

内部服务错误。

请求示例

GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/f488337c31c8e4622f1590735b134c65/video-motion-capture-jobs

响应示例

状态码: 200

成功。

{
  "total" : 2,
  "video_motion_capture_jobs" : [ {
    "motion_capture_mode" : "AUTO",
    "input_info" : {
      "rtc_room_info" : {
        "app_id" : "62b41e4cfa163e19fe3012f4afb0254f",
        "room_id" : "038812f256464620b14545ed4208fd18",
        "users" : [ {
          "user_type" : "CAPTURE",
          "user_id" : "038812f256464620b14545ed4208fd18_capture",
          "signature" : "25bd86bf1ee9f3bdbd22b5a3bd68040f6e2ad997347a5486ca5890400f6d02cd",
          "ctime" : 1667899906
        }, {
          "user_type" : "ANIMATION",
          "user_id" : "038812f256464620b14545ed4208fd18_animation",
          "signature" : "f18be6172bec6aff1f75574160a0b7d58b6f82fb0b780598d113852b9d99552d",
          "ctime" : 1667899906
        }, {
          "user_type" : "RENDER",
          "user_id" : "038812f256464620b14545ed4208fd18_render",
          "signature" : "34557340ab070f0883c598809d41481964cc7fa74ec07566f2867ecd645ba186",
          "ctime" : 1667899906
        }, {
          "user_type" : "PLAYER",
          "user_id" : "038812f256464620b14545ed4208fd18_player",
          "signature" : "c32f43f8b319c2b4c9881b3928dedd0b9aae8fd2db305cbac92e4529f766f232",
          "ctime" : 166789990
        } ]
      }
    },
    "output_info" : {
      "face_addr" : "121.36.196.49:30002",
      "body_addr" : "121.36.196.49:30001",
      "session_id" : 918
    },
    "job_id" : "0a9aaff946cc49cd965ba533464a8db0",
    "state" : "PROCESSING"
  } ]
}

状态码: 400

请求传参异常,包含错误码及对应描述。

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码: 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 ListVideoMotionCaptureJobsSolution {

    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();
        ListVideoMotionCaptureJobsRequest request = new ListVideoMotionCaptureJobsRequest();
        try {
            ListVideoMotionCaptureJobsResponse response = client.listVideoMotionCaptureJobs(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 = ListVideoMotionCaptureJobsRequest()
        response = client.list_video_motion_capture_jobs(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.ListVideoMotionCaptureJobsRequest{}
	response, err := client.ListVideoMotionCaptureJobs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

成功。

400

请求传参异常,包含错误码及对应描述。

500

内部服务错误。

错误码

请参见错误码

相关文档