最近更新时间:2026-11-18 14:05:03
ListAsyncProcess接口用于列举视频转码任务,使用该接口的用户必须是主账号或具有ks3:ListAsyncProcess 权限的其他用户。
GET /?asyncProcess&processType=mediaConvert&prefix={prefix}&status={status}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: {bucket}.{endpoint}
Authorization: KSS {accessKey}:{signature}参数名称 | 描述 | 是否必选 |
|---|---|---|
asyncProcess | 列举异步任务的标识。 | 是 |
processType | 查询的任务类型,固定取值:mediaConvert。
| 否 |
prefix | 按对象前缀筛选。
| 否 |
status | 按状态筛选。
| 否 |
maxResults | 单次返回结果列表中最大任务数量。
默认返回1000条任务。 | 否 |
nextToken | 翻页标记。
1. 当任务总数大于设置的maxResults时,可使用nextToken实现翻页功能。 2. 每次LIST操作会返回本次任务列表的最后一个任务ID作为nextToken,在下一次LIST时传入该值,即可接续上一次LIST的内容继续LIST,用于分页。 | 否 |
该接口仅使用公共请求头。
该接口不使用请求体。
该接口仅返回公共响应头部。
响应体为一段描述视频转码任务列表的JSON:
{
"asyncProcess": [
{
"processId": "MediaConvert-b3b70350-abce-4f46-80f1-db5bdbe9****",
"status": "Failed",
"code": "BadRequest",
"message": "Unsupported media format(codec) or file corrupt.",
"processType": "MediaConvert",
"startTime": "2026-06-04T10:04:04.422Z",
"endTime": "2026-06-04T10:04:05.02Z",
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4",
"params": {
"f": "mp4",
"vcodec": "h264",
"acodec": "aac",
"s": "1280×720"
},
"saveAs": {
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4",
"storageClass": "STANDARD"
},
"outputs": [
{
"bucketName": "output-bucket",
"objectKey": "output/video.mp4"
}
],
"callbackUrl": "http://10.1.2.3"
},
{
"processId": "MediaConvert-b3b70350-abce-4f46-80f1-db5bdbe9****",
"status": "Failed",
"code": "BadRequest",
"message": "Unsupported media format(codec) or file corrupt.",
"processType": "MediaConvert",
"startTime": "2026-06-04T10:04:04.422Z",
"endTime": "2026-06-04T10:04:05.02Z",
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4",
"params": {
"f": "mp4",
"vcodec": "h264",
"acodec": "aac",
"s": "1280×720"
},
"saveAs": {
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4"
},
"outputs": [
{
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4"
}
],
"callbackUrl": "http://10.1.2.3"
}
],
"requestId": "72351134-4088-53A-AA71-87B914126B3E",
"nextToken": "****",
"maxResults": "2"
}响应体的具体参数描述如下所示:
参数名称 | 说明 |
|---|---|
asyncProcess | 任务列表,包含符合条件的所有转码任务信息。 |
processId | 任务ID,创建转码任务成功后,KS3将返回该字段。 |
status | 任务状态。
|
code | 错误码,仅在任务失败时返回,用于标识具体错误类型。 |
message | 错误描述信息,仅在任务失败时返回,详细说明失败原因。 |
processType | 任务类型,标识执行的操作类型。
|
startTime | 任务开始时间,采用 ISO 8601 格式的 UTC 时间。
|
endTime | 任务结束时间,采用 ISO 8601 格式的 UTC 时间。
|
bucketName | 源文件所在的存储桶名称。 |
objectKey | 源文件在存储桶中的对象键(Key)。
|
params | 转码参数对象,包含视频和音频的编码设置。 |
f | 输出文件格式。
|
vcodec | 视频编码格式。
|
acodec | 音频编码格式。
|
s | 目标分辨率,格式为
不返回时默认为原视频宽高。 |
saveAs | 输出文件的保存位置配置。 |
bucketName | 输出文件所在的存储桶名称。 |
objectKey | 输出文件在存储桶中的对象键(Key)。
|
storageClass | 输出文件的存储类型,创建任务时如果不选择该请求头,文件存储类型默认跟随桶的存储类型,此时查看或获取任务列表时不展示该字段。 |
outputs | 输出文件列表,可能包含多个输出。 |
bucketName | 单个输出文件所在的存储桶名称。 |
objectKey | 单个输出文件在存储桶中的对象键(Key)。 |
callbackUrl | 回调 URL,任务完成后会向该地址发送通知。 |
requestId | 请求唯一标识符,用于追踪和调试。 |
NextToken | 分页令牌,用于获取下一页数据,当还有更多数据时返回该参数。 |
MaxResults | 本次返回的最大任务数量。 |
GET /?asyncProcess&processType=mediaConvert&prefix=test&status=Failed&maxResults=500&nextToken=process-1234567890 HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Authorization: authorization string{
"asyncProcess": [
{
"processId": "MediaConvert-b3b70350-abce-4f46-80f1-db5bdbe9a57d",
"status": "Failed",
"code": "BadRequest",
"message": "Unsupported media format(codec) or file corrupt.",
"processType": "MediaConvert",
"startTime": "2026-06-04T10:04:04.422Z",
"endTime": "2026-06-04T10:04:05.02Z",
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4",
"params": {
"f": "mp4",
"vcodec": "h264",
"acodec": "aac",
"s": "1280×720"
},
"saveAs": {
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4",
"storageClass": "STANDARD"
},
"outputs": [
{
"bucketName": "output-bucket",
"objectKey": "output/video.mp4"
}
],
"callbackUrl": "http://10.1.2.3"
},
{
"processId": "MediaConvert-b3b70350-abce-4f46-80f1-db5bdbe9a57d",
"status": "Failed",
"code": "BadRequest",
"message": "Unsupported media format(codec) or file corrupt.",
"processType": "MediaConvert",
"startTime": "2026-06-04T10:04:04.422Z",
"endTime": "2026-06-04T10:04:05.02Z",
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4",
"params": {
"f": "mp4",
"vcodec": "h264",
"acodec": "aac",
"s": "1280×720"
},
"saveAs": {
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4"
},
"outputs": [
{
"bucketName": "bucketname",
"objectKey": "prefix/video.mp4"
}
],
"callbackUrl": "http://10.1.2.3"
}
],
"requestId": "72351134-4088-53A-AA71-87B914126B3E",
"nextToken": "****",
"maxResults": "2"
}HTTP 状态码 | 错误码 | 描述 |
|---|---|---|
400 Bad Request | InvalidArgument | 参数值不合法或无效。 |
400 Bad Request | InvalidRequest | 请求不合法 |
403 Forbidden | AccessDenied | 没有权限。 |
纯净模式
