获取异步抓取任务详情--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取异步抓取任务详情

最近更新时间：2024.09.12 17:46:28首次发布时间：2023.03.30 17:42:24

本接口支持通过异步任务 ID，获取异步任务详情，包括：任务状态、资源地址和任务失败时回调详情。

注意事项

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

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetUrlFetchTask&Version=2018-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetUrlFetchTask`	接口名称。当前 API 的名称为 `GetUrlFetchTask`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
Id	String	是	`92830H07WJS28370`	异步任务 ID，您可通过调用 FetchImageUrl接口获取该 ID。
ServiceId	String	是	`7j**0w`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

返回参数

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

参数	类型	示例值	描述
Id	String	`92830H07WJS28370`	异步任务 ID
Status	String	`Success`	任务状态，取值如下所示： `Running`：进行中 `Pending`：排队中 `Failed`：失败 `Success`：成功
Url	String	`https://test.org/con.jpg`	资源下载链接
StoreUri	String	`tos-cn-i-7j**0w/test.png`	资源上传后的资源 URI
Callback	String	`http://test.com`	传入的回调地址，仅当`Status`取值`Failed`时有返回值。
CallbackBody	String	`{ "param1": "value1", "param2": "value2" }`	传入的回调内容，仅当`Status`取值`Failed`时有返回值。
CallbackBodyType	String	`application/json`	传入的回调内容类型，仅当`Status`取值`Failed`时有返回值。
Err	String	`抓取失败`	错误信息，仅当`Status`取值`Failed`时有返回值。
Code	Integer	`604624`	错误码，仅当`Status`取值`Failed`时有返回值。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetUrlFetchTask&Version=2018-08-01&Id=92830H07WJS28370

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetUrlFetchTask",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "92830H07WJS28370",
        "Status": "Success",
        "Url": "https://test.org/con.jpg",
        "StoreUri": "tos-cn-i-7j**0w/test.png"
    }
}

错误码

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

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：