DocsICP FilingConsole
Documentation

GetCustomizedVoiceJob

Updated at:
Copy as MD
Product
My Favorites

Queries a single voice cloning 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:GetCustomizedVoiceJob

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
JobId

string

Yes

The ID of the voice cloning task.

****20b48fb04483915d4f2cd8ac****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

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

object

The data returned when the call is successful.

CustomizedVoiceJob

object

The voice cloning task.

JobId

string

The ID of the voice cloning task.

****571c704445f9a0ee011406c2****
VoiceId

string

The voice ID.

xiaozhuan
Status

string

The task status. Valid values:

  • Initialization: Initialized.

  • AudioDetecting: Audio detection is in progress.

  • PreTraining: Submitted for training and pending.

  • Training: Training is in progress.

  • Success: Training succeeded.

  • Fail: Training failed.

Fail
Message

string

The additional description of the status.

Training failed
Type

string

The type of the voice cloning task. Valid values:

  • Basic: Basic edition.

  • Standard: Standard edition.

Standard
VoiceName

string

The voice name.

The voice name.
VoiceDesc

string

The voice description.

This is an exclusive human voice
Scenario

string

The scenario. Valid values:

  • story: Story.

  • interaction: Interaction.

  • navigation: Navigation.

story
Gender

string

The gender. Valid values:

  • female: Female.

  • male: Male.

female
CreateTime

string

The creation time in UTC format.

2023-06-07T02:27:08Z
Success

boolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.

  • false: The call failed.

true

Examples

Success response

JSON format

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Data": {
    "CustomizedVoiceJob": {
      "JobId": "****571c704445f9a0ee011406c2****",
      "VoiceId": "xiaozhuan",
      "Status": "Fail",
      "Message": "Training failed",
      "Type": "Standard",
      "VoiceName": "The voice name.",
      "VoiceDesc": "This is an exclusive human voice",
      "Scenario": "story",
      "Gender": "female",
      "CreateTime": "2023-06-07T02:27:08Z"
    }
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.