DocsICP FilingConsole
Documentation

ListCustomizedVoiceJobs

Updated at:
Copy as MD
Product
My Favorites

Lists all voice cloning training tasks for the current user.

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

list

*All Resource

*

 None 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. Maximum value: 100.

10
Type

string

No

The type (edition) of the voice cloning task. Valid values:

  • Basic: Basic Edition.

  • Standard: Standard Edition.

Important If you do not specify this parameter, Basic Edition tasks are queried by default.

Standard

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

******3B-0E1A-586A-AC29-742247******
Data

object

The response data.

CustomizedVoiceJobList

array<object>

The list of voice cloning tasks.

object

The voice cloning task.

JobId

string

The ID of the voice cloning task.

2245ab99a7fd4116a4fd3f499b7a56c5
VoiceId

string

The ID of the voice.

xiaozhuan
Status

string

The status of the task. Valid values:

  • Initialization: Initialized.

  • AudioDetecting: Audio detection in progress.

  • PreTraining: Submitted and pending training.

  • Training: Training in progress.

  • Success: Training succeeded.

  • Fail: Training failed.

Success
Message

string

The additional description of the status.

Successful training
VoiceName

string

The name of the voice, which is typically in Chinese.

  • The name cannot exceed 32 characters in length.

Small Special
VoiceDesc

string

The description of the voice.

  • The description cannot exceed 256 characters in length.

This is the description of this voice
Type

string

The voice type. Valid values:

  • Basic: Basic edition.

  • Standard: Standard edition.

Standard
Gender

string

The gender. Valid values:

  • female: Female.

  • male: Male.

female
Scenario

string

The scenario. Valid values:

  • story: Story.

  • interaction: Interaction.

  • navigation: Navigation.

story
CreateTime

string

The time when the task was created. The time is in UTC.

2023-04-01T06:23:59Z
GmtCreate

string

The creation time.

2022-06-27T02:42:28Z
TotalCount

integer

The total number of entries.

271
Success

boolean

Indicates whether the operation was successful. Valid values:

  • true: Successful.

  • false: Failed.

true

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Data": {
    "CustomizedVoiceJobList": [
      {
        "JobId": "2245ab99a7fd4116a4fd3f499b7a56c5",
        "VoiceId": "xiaozhuan",
        "Status": "Success",
        "Message": "Successful training",
        "VoiceName": "Small Special",
        "VoiceDesc": "This is the description of this voice",
        "Type": "Standard",
        "Gender": "female",
        "Scenario": "story",
        "CreateTime": "2023-04-01T06:23:59Z",
        "GmtCreate": "2022-06-27T02:42:28Z"
      }
    ],
    "TotalCount": 271
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.