GetAvatarTrainingJob-阿里云帮助中心

Queries the details of a single digital human task.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the digital human training task.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Data	object	The data returned upon a successful call.
AvatarTrainingJob	object	The digital human training task.
JobId	string	The ID of the digital human task.	**55d86f7f4587943ce7734d6b**
AvatarId	string	The ID of the digital human.	Avatar-XXXX
AvatarName	string	The name of the digital human.	Digital person Name
AvatarDescription	string	The description of the digital human.	This is a digital man, used in such and such a scene.
AvatarType	string	The type of the digital human.	2DAvatar
Status	string	The status of the digital human training task. Valid values: Init: initialized or draft Queuing: queuing Training: training Success: succeeded Fail: failed	Success
Message	string	The status description.	Successful training
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**
Video	string	The media asset ID of the training video.	**571c704445f9a0ee011406c2**
Transparent	boolean	Indicates whether the input video supports a transparent channel.	true
FirstTrainingTime	string	The time when the training was first initiated. The time is in UTC.	2020-12-23T13:33:40Z
LastTrainingTime	string	The time of the most recent training. The time is in UTC.	2020-12-23T13:33:40Z
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Data": {
    "AvatarTrainingJob": {
      "JobId": "****55d86f7f4587943ce7734d6b****",
      "AvatarId": "Avatar-XXXX",
      "AvatarName": "Digital person Name",
      "AvatarDescription": "This is a digital man, used in such and such a scene.",
      "AvatarType": "2DAvatar",
      "Status": "Success\n",
      "Message": "Successful training",
      "Thumbnail": "https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png",
      "Portrait": "****571c704445f9a0ee011406c2****",
      "Video": "****571c704445f9a0ee011406c2****",
      "Transparent": true,
      "FirstTrainingTime": "2020-12-23T13:33:40Z",
      "LastTrainingTime": "2020-12-23T13:33:40Z"
    }
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.