文档

QueryAvatar - 查询数字人资产详情

更新时间:

根据数字人code查询数字人资产详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
avatar:QueryAvatar
  • Asset
    acs:avatar::{#accountId}:asset/{#AssetId}

请求参数

名称类型必填描述示例值
TenantIdlong

从虚拟数字人开放平台中获取的 TenantId

9185
Codestring

在开放平台资产中心处查到的数字人形象 code。

CH_2d_xxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX
Codestring

返回错误码

10050008
Messagestring

错误消息

超过可同时生成的视频数上限
Successboolean

是否成功

true
Dataobject

调用返回数据

Namestring

人物名称

博远
Descriptionstring

人物描述

朝气蓬勃,富有感染力,适用于播音、传媒广电、企业宣传等场景
Portraitstring

人物头像

https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
Imagestring

人物缩略图

https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
AllLocateImagesobject

针对 3D 数字人的全分辨率、全机位、全角度的人物缩列图,适用于基于数字人平台 PAAS API 搭建自己的 SAAS 平台的客户。JSON 格式

{}
SupportedResolutionsobject

支持的分辨率

Offlineobject []

离线场景分辨率

Widthinteger

宽度,单位为像素(px)

1080
Heightinteger

高度,单位为像素(px)

1920
Descstring

分辨率描述

1080P竖向,分辨率1080*1920
Onlineobject []

实时场景分辨率

Widthinteger

宽度,单位为像素(px)

1080
Heightinteger

高度,单位为像素(px)

1920
Descstring

分辨率描述

1080P竖向,分辨率1080*1920
ModelTypestring

模型类型:

  • 2d 只查询 2d 人物
  • 3d 只查询 3d 人物
2d
AvatarTypestring

人物类型:

  • 0 官方人物
  • 1 定制化人物
0
MakeStatusstring

2D 自定义人物创建制作状态,目前仅针对于 2d 人物的查询

  • 1: 创建中
  • 2: 创建失败
  • 3: 创建成功
2
MakeFailReasonstring

2D 自定义人物创建制作失败原因,目前仅针对于 2d 人物的查询

当前视频时长:6(s),最小支持180(s)
MakeStagestring

2D 自定义人物创建制作阶段,目前仅针对于 2d 人物的查询

  • 1、系统检测
  • 2、人工审核
  • 3、训练中
  • 4、创建成功
1
Previewstring

2D 人物预览视频

https://xxx/xx/preview.webm

示例

正常返回示例

JSON格式

{
  "RequestId": "4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX",
  "Code": "10050008",
  "Message": "超过可同时生成的视频数上限",
  "Success": true,
  "Data": {
    "Name": "博远",
    "Description": "朝气蓬勃,富有感染力,适用于播音、传媒广电、企业宣传等场景",
    "Portrait": "https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
    "Image": "https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
    "AllLocateImages": {},
    "SupportedResolutions": {
      "Offline": [
        {
          "Width": 1080,
          "Height": 1920,
          "Desc": "1080P竖向,分辨率1080*1920\n"
        }
      ],
      "Online": [
        {
          "Width": 1080,
          "Height": 1920,
          "Desc": "1080P竖向,分辨率1080*1920"
        }
      ]
    },
    "ModelType": "2d",
    "AvatarType": "0",
    "MakeStatus": "2",
    "MakeFailReason": "当前视频时长:6(s),最小支持180(s)\n",
    "MakeStage": "1",
    "Preview": "https://xxx/xx/preview.webm"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)