GetAvatar-阿里云帮助中心

Queries the information about a trained digital human.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:GetAvatar

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AvatarId	string	Yes	The ID of the digital human.	Avatar-XXXX

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Data	object	The data returned.
Avatar	object	The information about the digital human.
AvatarId	string	The ID of the digital human.	Avatar-XXXX
AvatarName	string	The name of the digital human.	Xiao Shu
AvatarDescription	string	The description of the digital human.	This is a digital human for certain scenarios.
AvatarType	string	The type of the digital human.	2DAvatar
Thumbnail	string	The thumbnail URL.	https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png
Portrait	string	The media asset ID of the portrait image.	**571c704445f9a0ee011406c2**
Transparent	boolean	Indicates whether the digital human supports alpha channels.	true
Width	integer	The width of the digital human image in pixels.	1080
Height	integer	The height of the digital human image in pixels.	1920
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Data": {
    "Avatar": {
      "AvatarId": "Avatar-XXXX",
      "AvatarName": "Decimal",
      "AvatarDescription": "This is a digital human for certain scenarios.",
      "AvatarType": "2DAvatar",
      "Thumbnail": "https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png",
      "Portrait": "****571c704445f9a0ee011406c2****",
      "Transparent": true,
      "Width": 1080,
      "Height": 1920
    }
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.