All Products
Search
Document Center

Intelligent Media Services:ListAvatars

Last Updated:Dec 16, 2024

Queries a list of trained digital humans.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:ListAvatarslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNointegerNo
  • The page number.
  • Default value: 1.
1
PageSizeintegerNo
  • The number of entries per page.
  • Default value: 10.
10
AvatarTypestringNo
  • The type of the digital human.
  • 2DAvatar
2DAvatar

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The data returned.

AvatarListarray<object>

The queried digital humans.

Avatarobject
AvatarIdstring

The ID of the digital human.

Avatar-XXX
AvatarNamestring

The name of the digital human.

AvatarDescriptionstring

The description of the digital human.

AvatarTypestring

The type of the digital human.

2DAvatar
Thumbnailstring

The thumbnail URL.

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

The media asset ID of the portrait image.

****571c704445f9a0ee011406c2****
Transparentboolean

Indicates whether the digital human image supports the alpha channels.

true
TotalCountlong

The total number of entries returned.

1
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Data": {
    "AvatarList": [
      {
        "AvatarId": "Avatar-XXX",
        "AvatarName": "",
        "AvatarDescription": "",
        "AvatarType": "2DAvatar",
        "Thumbnail": "https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png",
        "Portrait": "****571c704445f9a0ee011406c2****",
        "Transparent": true
      }
    ],
    "TotalCount": 1
  },
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history