You need to enable JavaScript to run this app.
导航
查询异步批量处理任务详情
最近更新时间:2024.04.19 11:54:58首次发布时间:2023.12.25 18:52:45

本接口支持通过异步批处理任务 ID,获取异步批处理查询详情,包括:任务状态、资源地址和任务失败时回调详情。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 超时时间:超时时间约为 10 秒
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=GetBatchTaskInfo&Version=2023-05-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringGetBatchTaskInfo接口名称。当前 API 的名称为 GetBatchTaskInfo
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01
TaskIdString92830H07WJS28370异步任务 ID,传入 CreateBatchProcessTask 获取的异步任务 ID。

ServiceId

String

f0**5k

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
DataArray of Data-异步批处理任务详情
CallbackStringhttp://info.com 传入的回调地址

CallbackBody

String

{
  "param1": "value1",
  "param2": "value2"
}

传入的回调内容

CallbackBodyTypeStringapplication/json 传入的回调内容格式

Status

String

Failed

任务状态,取值如下所示:

  • Running:进行中
  • Pending:排队中
  • Failed:失败
  • Success:成功
ErrStringexist fail url错误信息。仅当Status取值Failed时,有返回值。
CodeInteger644001错误码。仅当Status取值Failed时,有返回值。
TaskIdString92830H07WJS28370 异步任务 ID

Data

参数类型示例值描述
UrlString http://test.com/tos-cn-i-f0**5k/demo.png资源 URL
SizeInteger230000该资源对应的文件大小,单位为 byte。
ErrStringfail to get url,err no useful response got该资源执行批处理操作时的错误描述
StatusCodeInteger0访问该资源时返回的 HTTP 状态码

Action

String

meta

该资源使用的批处理能力,取值如下所示:

  • meta:获取资源元信息
  • preload:源站图片预热

请求示例

GET https://imagex.volcengineapi.com/?Action=GetBatchTaskInfo&Version=2023-05-01&ServiceId=f0**5k

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetBatchTaskInfo",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "Url": "http://test.com/tos-cn-i-f0**5k/demo.png",
                "Size": 600900,
                "Err":"fail to get url,err no useful response got",
                "StatusCode": 0,
                "Action": "meta"
            }
        ],
        "Callback": "http://info.com",
        "CallbackBody": "{
            "param1": "value1", 
            "param2": "value2" 
            }",
        "CallbackBodyType": "application/json",
        "Status": "Failed",
        "Err": "exist fail url",
        "Code": 644001
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码

服务端 SDK

veImageX 提供了配套的开发工具集 SDK,已支持 Java SDK,帮助您更方便的调用 API。