All Products
Search
Document Center

Intelligent Media Services:ListCustomizedVoiceJobs

Last Updated:Dec 06, 2024

Queries a list of human voice cloning jobs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:ListCustomizedVoiceJobslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNointegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Valid values: 1 to 100.

10
TypestringNo

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

  • Basic
  • Standard
Note : If you do not specify this parameter, the default value Basic is used.
Standard

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The data returned.

CustomizedVoiceJobListarray<object>

The queried human voice cloning jobs.

CustomizedVoiceJobobject

The queried human voice cloning job.

JobIdstring

The ID of the human voice cloning job.

2245ab99a7fd4116a4fd3f499b7a56c5
VoiceIdstring

The voice ID.

xiaozhuan
Statusstring

The job state. Valid values:

  • Initialization
  • AudioDetecting
  • PreTraining
  • Training
  • Success
  • Fail
Success
Messagestring

The returned message.

VoiceNamestring

The voice name.

  • The name can be up to 32 characters in length.
VoiceDescstring

The voice description.

  • The description can be up to 256 characters in length.
Typestring
  • The voice type. Valid values:

    • Basic
    • Standard
Standard
Genderstring

The gender. Valid values:

  • female
  • male
female
Scenariostring

The scenario. Valid values:

  • story
  • interaction
  • navigation
story
CreateTimestring
  • 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-04-01T06:23:59Z
GmtCreatestring

The time when the job was created.

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

The total number of entries returned.

271
Successboolean

Indicates whether the request was successful. Valid values: true false

true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-21The request parameters of the API has changed. The response structure of the API has changedView Change Details