GetFetchTask--对象存储-火山引擎

文档中心

立即注册

导航

对象存储

GetFetchTask

最近更新时间：2024.08.01 20:30:33首次发布时间：2024.04.26 11:58:13

功能描述

调用 GetFethTask 接口查询异步任务的详细信息，包括任务状态、回调信息等。

注意事项

GetFethTask 接口仅支持查询 72 小时内的异步任务，超过72小时，将无法查询。

请求消息样式

GET /?fetchTask&taskId=da62d05e-e6e4-4bad-924a-ed4ab98ae17a HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: GMT Date
Authorization: authorization string

请求参数和消息头

名称	位置	参数类型	是否必选	示例值	说明
fetchTask	Query	String	是	-	代表 GetFetchTask 请求的特殊标识。
taskId	Query	String	是	fac10613-4cfa-4689-bffd-8360b7dd0d38	异步任务 ID。

请求元素

该请求不使用消息元素。

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

响应元素

该请求会返回异步任务当前状态。

名称	参数类型	示例值	说明
State	String	Success	任务状态，取值说明如下： `Running`：执行中， `Success` ：成功， `FetchSuccessCallBackError` ：抓取成功，回调失败， `Failed` ：失败
Err	String	fetch failed reason:back-to-source failed. the reason is mirror-back: unexpected status code 404	任务失败的原因。说明仅当 `Status` 为 `Failed` 或 `FetchSuccessCallBackError` 状态时，`Err` 参数才会返回任务失败原因。
Task	Array	-	任务详情。具体请参见下表 Task 结构。

名称

参数类型

示例值

说明

State

String

Success

任务状态，取值说明如下：

Running：执行中，
Success ：成功，
FetchSuccessCallBackError ：抓取成功，回调失败，
Failed ：失败

Err

String

fetch failed reason:back-to-source failed. the reason is mirror-back: unexpected status code 404

任务失败的原因。

说明

仅当 Status 为 Failed 或 FetchSuccessCallBackError 状态时，Err 参数才会返回任务失败原因。

Task

Array

任务详情。具体请参见下表 Task 结构。

Task 结构

名称	参数类型	示例值	说明
URL	String	http://abc.123/	抓取的 URL。
IgnoreSameKey	String	true	存储桶中存在同名文件时的抓取策略，取值说明如下： `true`：如果存储桶中已存在同名文件，则放弃本次抓取。 `false`：如果存储桶中已存在同名文件，仍然会抓取对象，并且上传该对象时会覆盖存储桶中原对象。
ContentMD5	String	XrY7u+Ae7tCTyyK7j1rNww==	上传的文件 MD5 的 base64 值。
Bucket	String	test	存储桶名称。
Object	String	data.jpg	对象名称。
CallbackURL	String	http://domainname.com/callback	回调请求的 URL。
CallbackHost	String	alternative-domainname.com	回调请求发送时的 HOST 头域。
CallbackBody	String	{"bucket" : ${bucket}, "object" : ${object}, "key1" : ${x:key1}, "key2" : ${x:key2}}	回调请求发送时的消息体。
CallbackBodyType	String	application/json	回调请求的消息体类型。
StorageClass	String	STANDARD	目的对象的存储类型。
Acl	String	private	对象的访问权限。
GrantFullControl	String	id=账号1	创建对象时，使用此头域授权用户具有对象的读（READ）、读（READ） ACP、写（WRITE） ACP 的权限。格式：id=账号1,id=账号2。
GrantRead	String	id=账号1	允许被授权者读取对象和对象元数据的权限。格式：id=账号1,id=账号2。
GrantReadAcp	String	id=账号1	允许被授权者读取对象 ACL。格式：id=账号1,id=账号2。
GrantWriteAcp	String	id=账号1	允许被授权者修改对象 ACL。格式：id=账号1,id=账号2。
SSECAlgorithm	String	AES256	SSE-C 加密对象使用的算法。
SSECKey	String	YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWE=	SSE-C 加密对象的密钥。
SSECKeyMd5	String	0gYVWExOAz67jX5A6qY4+A==	SSE-C 加密对象使用的密钥的MD5值。
UserMeta	Array	-	加入的自定义元数据。具体请参见下表 UserMeta 结构。

UserMeta 结构

名称	参数类型	示例值	说明
Key	String	key	自定义元数据的 key。
Value	String	value	自定义元数据的 value。

请求示例

GET /?fetchTask&taskId=da62d05e-e6e4-4bad-924a-ed4ab98ae17a HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: Fri, 30 Jul 2021 13:53:55 +0000
Authorization: authorization string

响应示例

任务成功的响应示例

HTTP/1.1 200 OK
Date: Fri, 30 Jul 2021 13:53:55 GMT
Server: TosServer
x-tos-id-2: 1e89f203jld00006-a444fd0
x-tos-request-id: 1e89f203b2d00006-a444ed0
Content-Length: 143
{
    "State": "Success",
    "Task":{
        "URL": "http://abc.123/",
        "IgnoreSameKey": false,
        "Bucket": "bucketname",
        "Object": "objectName"
    }
}

任务失败的响应示例

HTTP/1.1 200 OK
Date: Fri, 30 Jul 2021 13:53:55 GMT
Server: TosServer
x-tos-id-2: 1e89f203jld00006-a444fd0
x-tos-request-id: 1e89f203b2d00006-a444ed0
Content-Length: 143
{
    "State": "Failed",
    "Err": "fetch failed reason:back-to-source failed. the reason is mirror-back: unexpected status code 404",
    "Task":{
        "URL": "http://abc.123/",
        "IgnoreSameKey": false,
        "Bucket": "bucketname",
        "Object": "objectName"
    }
}