ListSmartSysAvatarModels

更新时间:
复制 MD 格式

Retrieves a paginated list of system digital avatars.

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

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

PageNo

integer

No

The page number. The default value is 1.

1

PageSize

integer

No

The number of items to return on each page. The default value is 10. The maximum value is 100.

10

SdkVersion

string

No

The SDK version.

Response elements

Element

Type

Description

Example

object

The data returned for the request.

RequestId

string

The request ID.

****63E8B7C7-4812-46AD-0FA56029AC86****

SmartSysAvatarModelList

array<object>

A list of system digital avatars.

object

A system digital avatar.

AvatarName

string

The digital avatar name.

Yun Qiao

AvatarId

string

The digital avatar ID. Use this ID when you submit a rendering job or use the digital avatar in an intelligent timeline.

yunqiao

CoverUrl

string

The URL of the sample cover for the digital avatar.

http://ice-pub-media.myalicdn.com/smart/avatarModel/coverDemo/yunqiao.mp4

VideoUrl

string

The URL of the sample video for the digital avatar.

http://ice-pub-media.myalicdn.com/smart/avatarModel/videoDemo/yunqiao.mp4

Width

integer

The video width.

1080

Height

integer

The video height.

1920

Bitrate

integer

The video bitrate.

4000

OutputMask

boolean

Indicates whether portrait mask rendering is supported.

false

TotalCount

integer

The total number of system digital avatars.

4

Examples

Success response

JSON format

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "SmartSysAvatarModelList": [
    {
      "AvatarName": "Yun Qiao",
      "AvatarId": "yunqiao",
      "CoverUrl": "http://ice-pub-media.myalicdn.com/smart/avatarModel/coverDemo/yunqiao.mp4",
      "VideoUrl": "http://ice-pub-media.myalicdn.com/smart/avatarModel/videoDemo/yunqiao.mp4",
      "Width": 1080,
      "Height": 1920,
      "Bitrate": 4000,
      "OutputMask": false
    }
  ],
  "TotalCount": 4
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.