GetAvatar - 查询数字人

调用本接口,可以查询某个已经训练成功的数字人的详细信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
AvatarIdstring
  • 数字人 ID
Avatar-XXXX

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

******11-DB8D-4A9A-875B-275798******
Dataobject

响应数据

Avatarobject

数字人

AvatarIdstring

数字人 ID

Avatar-XXXX
AvatarNamestring

数字人名称

小数
AvatarDescriptionstring

数字人描述

这是一个数字人,用于某某场景。
AvatarTypestring

数字人类型

2DAvatar
Thumbnailstring

缩略图 URL

https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png
Portraitstring

头像图片媒资 ID

****571c704445f9a0ee011406c2****
Transparentboolean

用于标识当前数字人是否支持透明通道

true
Widthinteger

数字人形象的宽(单位:像素)

1080
Heightinteger

数字人形象的高(单位:像素)

1920
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Data": {
    "Avatar": {
      "AvatarId": "Avatar-XXXX",
      "AvatarName": "小数",
      "AvatarDescription": "这是一个数字人,用于某某场景。",
      "AvatarType": "2DAvatar",
      "Thumbnail": "https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png",
      "Portrait": "****571c704445f9a0ee011406c2****",
      "Transparent": true,
      "Width": 1080,
      "Height": 1920
    }
  },
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-13OpenAPI 返回结构发生变更查看变更详情