文档中心 > API类目 > 天猫国际API

tmall.tkof.contract.progress.query (异步任务进度查询)

异步任务进度查询

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
task_id	String	必须	tkof-async-task$startSign$1703227280034$236bbf13-0de4-4c92-bb34-7cfd164e6114		任务id

响应参数

名称	类型	示例值	描述
result	Result		结果
data TaskInfoDTO 任务信息 └ data String 34343123 实际接口返回值，json字符串 └ extra String {} extra └ task_id String tkof-async-task$startSign$1703227280034$236bbf13-0de4-4c92-bb34-7cfd164e6114 任务id └ error_msg String 当前合同类型不存在错误信息 └ status String DONE 任务状态，SUBMIT,PROCESSING,DONE,ERROR，当返回DONE或ERROR时表示任务已结束 └ success Boolean true 是否调用成功 └ error_message String 接口异常错误内容 └ error_code String invoke.error 错误码

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallTkofContractProgressQueryRequest req = new TmallTkofContractProgressQueryRequest();
req.setTaskId("tkof-async-task$startSign$1703227280034$236bbf13-0de4-4c92-bb34-7cfd164e6114");
TmallTkofContractProgressQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<tmall_tkof_contract_progress_query_response>
    <result>
        <data>
            <data>34343123</data>
            <extra>{}</extra>
            <task_id>tkof-async-task$startSign$1703227280034$236bbf13-0de4-4c92-bb34-7cfd164e6114</task_id>
            <error_msg>当前合同类型不存在</error_msg>
            <status>DONE</status>
        </data>
        <success>true</success>
        <error_message>接口异常</error_message>
        <error_code>invoke.error</error_code>
    </result>
</tmall_tkof_contract_progress_query_response>

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部