ListAvatars-阿里云帮助中心

Queries the details of all successfully trained digital humans under your account.

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:ListAvatars

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
AvatarType	string	No	The type of the digital human. Valid value: 2DAvatar.	2DAvatar

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Data	object	The response data.
AvatarList	array<object>	The list of digital humans.
	object
AvatarId	string	The ID of the digital human.	Avatar-XXX
AvatarName	string	The name of the digital human.	The name of the digital human.
AvatarDescription	string	The description of the digital human.	This is a digital human, intended for use in a certain scenario.
AvatarType	string	The type of the digital human.	2DAvatar
Thumbnail	string	The URL of the thumbnail.	https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png
Portrait	string	The media asset ID of the profile picture.	**571c704445f9a0ee011406c2**
Transparent	boolean	Indicates whether the current digital human image supports an alpha channel.	true
TotalCount	integer	The total number of records.	1
Success	boolean	Indicates whether the request is successful. Valid values: true: Successful. false: Failed.	true

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Data": {
    "AvatarList": [
      {
        "AvatarId": "Avatar-XXX",
        "AvatarName": "The name of the digital human.",
        "AvatarDescription": "This is a digital human, intended for use in a certain scenario.",
        "AvatarType": "2DAvatar",
        "Thumbnail": "https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png",
        "Portrait": "****571c704445f9a0ee011406c2****",
        "Transparent": true
      }
    ],
    "TotalCount": 1
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.