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

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

异步任务进度查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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

FAQ

返回
顶部