Alibaba Cloud Model Studio:Asynchronous task management API

Parameter passing

Field

Type

Required

Description

Example

Header

Authorization

String

Yes

API key in the format Bearer sk-xxx

Bearer sk-xxx

Path

task_id

String

Yes

The task ID to query.

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

Field

Type

Description

Example

request_id

String

The unique ID for this request.

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

output

Object

• If the task succeeds, output contains the result object generated by the model. The content varies by task type.

• If the task fails or partially fails, output returns the code and message fields that explain the failure reason.

• For tasks with multiple subtasks, output may contain both successful subtask results and error messages for failed ones.

-

output.task_id

String

The ID of the queried task.

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

output.task_status

String

The task status.

• For multi-subtask tasks, the task succeeds if at least one subtask succeeds.

• Failed subtasks show specific errors in the output.

Task status:

• PENDING

• RUNNING

• SUCCEEDED

• FAILED

• UNKNOWN

output.submit_time

String

The time the task was submitted.

2023-12-20 21:36:31.896

output.scheduled_time

String

The time the task was scheduled (when it started running).

2023-12-20 21:36:39.009

output.end_time

String

The time the task ended.

2023-12-20 21:36:45.913

output.code

String

The error code (returned only when the task fails).

-

output.message

String

The error message (returned only when the task fails).

-

output.task_metrics

Object

Task metrics including subtask status statistics.

{

"TOTAL": 4, // Total number of subtasks

"SUCCEEDED": 3, // Number of successful subtasks

"FAILED": 1 // Number of failed subtasks

}

usage

Object

The billing information for this request (varies by task).

"usage": {"image_count": 1}

Parameter passing

Field

Type

Required

Description

Example

Header

Authorization

String

Yes

The API key, in the format Bearer sk-xxx.

Bearer sk-xxx

Params

task_id

String

No

The task ID to query. Specify a task_id to return only that task's status, or omit it to query multiple tasks.

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

start_time

String

No

Query start time in the format YYYYMMDDhhmmss. Defaults to 24 hours before end_time (if end_time is specified), or to the last 24 hours (if neither time is specified). Maximum range: 24 hours.

20230420193058 represents 19:30:58 on April 20, 2023.

end_time

String

No

Query end time in the format YYYYMMDDhhmmss. Defaults to 24 hours after start_time (if start_time is specified). Maximum range: 24 hours.

model_name

String

No

The model name.

wanx-v1

status

String

No

The task status:

• PENDING

• RUNNING

• SUCCEEDED

• FAILED

• CANCELED

• UNKNOWN

page_no

Integer

No

The page number of the results to return. Default: 1.

-

page_size

Integer

No

The number of entries per page. Default: 10.

-

Field

Type

Description

Example

request_id

String

The unique ID for this request.

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

data

Array

A list of query results.

"data": [
    {
        "api_key_id": "235",
        "caller_uid": "1808342417264262",
        "end_time": 1682527200093,
        "gmt_create": 1682514589152,
        "model_name": "paraformer-16k-1",
        "region": "cn-hangzhou",
        "request_id": "32b67b58-xxxx-xxxx-xxxx-230f0aee64d9",
        "start_time": 1682515862179,
        "status": "FAILED",
        "task_id": "cf52b16b-xxxx-xxxx-xxxx-17f9c211440c",
        "user_api_unique_key": "apikey:v1:audio:asr:transcription:paraformer-16k-1"
    }
]

data[].api_key_id

String

The API key ID.

data[].caller_parent_id

String

The Alibaba Cloud account ID.

data[].caller_uid

String

The Alibaba Cloud account ID.

data[].gmt_create

Long

The task creation time (milliseconds since the epoch).

data[].start_time

Long

The time the task started, in milliseconds since the epoch.

data[].end_time

Long

The time the task ended, in milliseconds since the epoch.

data[].region

String

The region. Example: cn-hangzhou

data[].request_id

String

The request ID for the task submission.

data[].status

String

The task status:

• PENDING

• RUNNING

• SUCCEEDED

• FAILED

• CANCELED

• UNKNOWN

data[].task_id

String

The task ID.

data[].user_api_unique_key

String

A unique API key generated from the model's API parameters at task submission.

data[].model_name

String

The model name.

page_no

Integer

The current page number.

"page_no": 1

page_size

Integer

The number of entries per page.

"page_size": 10

total_page

Integer

The total number of pages.

"total_page": 4

total

Integer

The total number of entries.

"total": 39

code

String

The error code returned when the call fails.

"code": "Throttling.RateQuota"

message

String

The error message returned when the call fails.

"message": "Requests rate limit exceeded, please try again later."

Parameter passing

Field

Type

Required

Description

Example

Header

Authorization

String

Yes

The API key, in the format Bearer sk-xxx.

Bearer sk-xxx

Path

task_id

String

Yes

The ID of the task to cancel.

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

Field

Type

Description

Example

request_id

String

The unique ID for this request.

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

code

String

The error code returned when the call fails.

"code": "Throttling.RateQuota"

message

String

The error message returned when the call fails.

"message": "Requests rate limit exceeded, please try again later."