GetCustomizedVoiceJob

更新时间:
复制 MD 格式

Queries the information about a human voice cloning job.

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 human voice cloning job.

****20b48fb04483915d4f2cd8ac****

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

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

Data

object

The data returned if the request was successful.

CustomizedVoiceJob

object

The information about the human voice cloning job.

JobId

string

The ID of the human voice cloning job.

****571c704445f9a0ee011406c2****

VoiceId

string

The voice ID.

xiaozhuan

Status

string

The job state. Valid values:

  • Initialization

  • AudioDetecting

  • PreTraining

  • Training

  • Success

  • Fail

Fail

Message

string

The status description.

Training Failed

Type

string

The type of the human voice cloning job. Valid values:

  • Basic

  • Standard

Standard

VoiceName

string

The voice name.

Xiao Zhuan

VoiceDesc

string

The voice description.

This is an exclusive voice

Scenario

string

The scenario. Valid values:

  • story

  • interaction

  • navigation

story

Gender

string

The gender. Valid values:

  • female

  • male

female

CreateTime

string

The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2023-06-07T02:27:08Z

Success

boolean

Indicates whether the request was successful. Valid values:

  • true

  • false

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": "Specialist",
      "VoiceDesc": "This is an exclusive 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.