更新时间:2024-05-27 GMT+08:00
分享

查询数字人名片制作任务详情

功能介绍

该接口用于查询数字人名片制作任务详情。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/digital-human-business-cards/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

job_id

String

任务ID。

请求参数

表2 请求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

表3 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表4 响应Body参数

参数

参数类型

描述

job_info

DigitalHumanBusinessCardJobInfo object

数字人名片制作任务信息。

card_templet_asset_id

String

数字人名片模板资产ID。

card_text_config

BusinessCardTextConfig object

用户输入的数字人名片信息。实际可以填写哪些字段取决于名片模板。

card_image_url

BusinessCardImageUrl object

用于制作数字人名片的图片下载URL。

introduction_type

String

自我介绍驱动方式。

  • TEXT: 文本驱动,即通过TTS合成语音

  • AUDIO: 语音驱动,需要在资产库中先上传语音资产

introduction_text

String

自我介绍文本,用于驱动数字人口型。

voice_asset_id

String

音色资产ID。

introduction_audio_asset_id

String

自我介绍语音资产ID,用于驱动数字人口型。

说明:
  • 介绍语音需要作为asset_type=AUDIO资产先上传至资产库。

gender

String

性别。

  • MALE:男性

  • FEMALE:女性

表5 DigitalHumanBusinessCardJobInfo

参数

参数类型

描述

job_id

String

任务ID。

state

String

任务的状态。

  • WAITING: 等待

  • PROCESSING: 处理中

  • SUCCEED: 成功

  • FAILED: 失败

  • CANCELED: 取消

  • BLOCK: 冻结

start_time

String

数字人名片制作开始时间。

end_time

String

数字人名片制作结束时间。

output_asset_config

OutputAssetInfo object

输出资产信息配置。

error_info

ErrorResponse object

错误信息。

create_time

String

任务创建时间。

lastupdate_time

String

任务更新时间。

business_card_type

String

数字人名片类型。

  • 2D_DIGITAL_HUMAN_CARD:分身数字人名片

表6 OutputAssetInfo

参数

参数类型

描述

asset_id

String

输出视频资产ID。

asset_name

String

输出视频资产名称。

cover_url

String

视频封面URL。

preview_video_url

String

预览视频下载URL。URL有效期24小时。

说明:
  • 分身数字人视频制作不支持预览。

表7 ErrorResponse

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

表8 BusinessCardTextConfig

参数

参数类型

描述

name

String

姓名。

company

String

企业或组织名称。

title

String

职位名称。

mobile_phone

String

手机号码。

phone

String

固话号码。

mail

String

电子邮件地址。

address

String

地址。

other1

String

其他信息1。可填写一些公司广告语等

other2

String

其他信息2。可填写一些公司广告语等

other3

String

其他信息3。可填写一些公司广告语等

表9 BusinessCardImageUrl

参数

参数类型

描述

human_image_url

String

任务照片下载URL。

logo_image

String

Logo图片下载URL。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-business-cards/26f06524-4f75-4b3a-a853-b649a21aaf66

响应示例

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

    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();
        ShowDigitalHumanBusinessCardRequest request = new ShowDigitalHumanBusinessCardRequest();
        request.withJobId("{job_id}");
        try {
            ShowDigitalHumanBusinessCardResponse response = client.showDigitalHumanBusinessCard(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

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = ShowDigitalHumanBusinessCardRequest()
        request.job_id = "{job_id}"
        response = client.show_digital_human_business_card(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
38
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.ShowDigitalHumanBusinessCardRequest{}
	request.JobId = "{job_id}"
	response, err := client.ShowDigitalHumanBusinessCard(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

处理成功返回。

400

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

401

未鉴权或鉴权失败。

404

无内容。

500

内部服务错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品