All Products
Search
Document Center

Intelligent Media Services:GetAvatar

Last Updated:Dec 16, 2024

Queries the information about a trained digital human.

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:GetAvatarget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AvatarIdstringYes
  • The ID of the digital human.
Avatar-XXXX

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The data returned.

Avatarobject

The information about the digital human.

AvatarIdstring

The ID of the digital human.

Avatar-XXXX
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 supports alpha channels.

true
Widthinteger

The width of the digital human image in pixels.

1080
Heightinteger

The height of the digital human image in pixels.

1920
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-09-13The response structure of the API has changedView Change Details