异步任务管理 API

传参方式

字段

类型

必选

描述

示例值

Header

Authorization

String

是

API-Key，例如：Bearer sk-xxx

Bearer sk-xxx

Path

task_id

String

是

需查询的任务ID

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

字段

类型

描述

示例值

request_id

String

本次请求的系统唯一码

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

output

Object

• 任务成功时，output 包含模型生成的结果对象，具体内容因任务类型而异

• 任务失败或部分失败时，output 会返回对应的 code 和 message，说明失败原因

• 对于包含多个子任务的任务，output 可能同时包含成功的子任务结果和失败的错误信息

-

output.task_id

String

查询任务的 task_id

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

output.task_status

String

任务状态

• 对于包含多个子任务的任务，只要有一个子任务成功，整个任务会被标记为成功

• 对于失败的子任务，会在 output 中展示具体报错

任务状态：

• PENDING：任务排队中

• RUNNING：任务处理中

• SUCCEEDED：任务执行成功

• FAILED：任务执行失败

• UNKNOWN：任务不存在或状态未知

output.submit_time

String

任务提交时间

2023-12-20 21:36:31.896

output.scheduled_time

String

任务调度时间，即开始执行时间

2023-12-20 21:36:39.009

output.end_time

String

任务结束时间

2023-12-20 21:36:45.913

output.code

String

错误码，仅在任务失败时返回

-

output.message

String

错误信息，仅任务失败时返回

-

output.task_metrics

Object

任务指标，包含子任务状态的统计信息

{

"TOTAL": 4, //子任务总数

"SUCCEEDED": 3, //子任务成功数

"FAILED": 1 //子任务失败数

}

usage

Object

本次请求产生的计量信息，根据实际任务的不同，相关的计量信息也有所不同

"usage": {"image_count": 1}

传参方式

字段

类型

必选

描述

示例值

Header

Authorization

String

是

API-Key，例如：Bearer sk-xxx

Bearer sk-xxx

Params

task_id

String

否

需要查询任务的 task_id

若指定task_id，接口仅返回该任务的状态信息；若需批量查询多个任务状态，请勿传入此参数

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

start_time

String

否

任务开始时间，格式为：YYYYMMDDhhmmss

• 若未指定开始时间（start_time为空），系统将查询指定结束时间（end_time）前24小时的数据

• 若开始和结束时间均未指定（均为空），系统默认查询最近24小时的数据。

• 请确保您设定的开始和结束时间的差距不超过24小时

20230420193058 代表 2023 年 4 月 20 日 19 点 30 分 58 秒

end_time

String

否

任务结束时间，格式为：YYYYMMDDhhmmss

• 若未指定结束时间（end_time为空），系统将查询指定开始时间（start_time）后24小时的数据。

• 请确保您设定的开始和结束时间的差距不超过24小时

model_name

String

否

模型名称

wanx-v1

status

String

否

任务状态：

• PENDING：任务排队中

• RUNNING：任务处理中

• SUCCEEDED：任务执行成功

• FAILED：任务执行失败

• CANCELED：任务取消成功

• UNKNOWN：任务不存在或状态未知

page_no

Integer

否

当前页，默认查询第1页

-

page_size

Integer

否

每页查询条数，默认查询10条

-

字段

类型

描述

示例值

request_id

String

本次请求的系统唯一码

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

data

Array

查询结果列表

"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

API Key的id

data[].caller_parent_id

String

阿里云主账号ID

data[].caller_uid

String

阿里云账号ID

data[].gmt_create

Long

任务创建时间，Date时间毫秒数

data[].start_time

Long

任务开始时间，Date时间毫秒数

data[].end_time

Long

任务结束时间，Date时间毫秒数

data[].region

String

地域，例如：cn-hangzhou

data[].request_id

String

提交任务的请求id

data[].status

String

任务状态：

• PENDING：任务排队中

• RUNNING：任务处理中

• SUCCEEDED：任务执行成功

• FAILED：任务执行失败

• CANCELED：任务取消成功

• UNKNOWN：任务不存在或状态未知

data[].task_id

String

任务id

data[].user_api_unique_key

String

API 的唯一key（提交任务时，模型API的各要素唯一索引）

data[].model_name

String

模型名称

page_no

Integer

当前页

"page_no": 1

page_size

Integer

每页查询条数

"page_size": 10

total_page

Integer

总页数

"total_page": 4

total

Integer

总条数

"total": 39

code

String

调用失败的时候返回的错误码

"code": "Throttling.RateQuota"

message

String

调用失败的时候返回的错误信息

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

传参方式

字段

类型

必选

描述

示例值

Header

Authorization

String

是

API-Key，例如：Bearer sk-xxx

Bearer sk-xxx

Path

task_id

String

是

待取消的任务 task_id

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

字段

类型

描述

示例值

request_id

String

本次请求的系统唯一码

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

code

String

调用失败的时候返回的错误码

"code": "Throttling.RateQuota"

message

String

调用失败的时候返回的错误信息

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