文档中心 > API类目 > 万相台无界API

taobao.universalbp.report.async.download.find.task.page (查询异步下载任务列表)

查询异步下载任务列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 请求体
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
async_rpt_query_v_o AsyncRptQueryVo 可选 报表异步下载任务查询对象
  • └ task_id
  • Number
  • 可选
  • 111
  • 任务id
  • └ start_time
  • String
  • 必须
  • 2023-05-16
  • 开始时间
  • └ end_time
  • String
  • 必须
  • 2023-06-15
  • 结束时间
  • └ offset
  • Number
  • 可选
  • 0
  • 偏移量
  • └ page_size
  • Number
  • 可选
  • 20
  • 页面大小

响应参数

名称 类型 示例值 描述
result TopResult 结果体
  • info
  • TopInfo
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • top_async_rpt_v_o_top_bulk_data
  • TopBulkData
  • 结果集
  • top_async_rpt_v_o_list
  • TopAsyncRptVo []
  • 批量结果集
  • └ task_id
  • Number
  • 1111
  • 任务id
  • └ biz_code
  • String
  • bizCode
  • 场景id
  • └ file_name
  • String
  • 账户报表001
  • 文件名称
  • └ status
  • String
  • SUCCESS-生成成功, FAIL-生成失败(由于参数设置例如超过时间长度限度会生成失败
  • 任务状态
  • └ gmt_create
  • Date
  • 2023-06-13
  • 创建时间
  • └ gmt_modified
  • Date
  • 2023-06-13
  • 修改时间
  • └ download_url
  • String
  • xxxxx
  • 下载链接,仅获取下载链接接口返回
  • └ count
  • Number
  • 1
  • 数量

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpReportAsyncDownloadFindTaskPageRequest req = new UniversalbpReportAsyncDownloadFindTaskPageRequest();
UniversalbpReportAsyncDownloadFindTaskPageRequest.TopServiceContext obj1 = new UniversalbpReportAsyncDownloadFindTaskPageRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpReportAsyncDownloadFindTaskPageRequest.AsyncRptQueryVo obj2 = new UniversalbpReportAsyncDownloadFindTaskPageRequest.AsyncRptQueryVo();
obj2.setTaskId(111L);
obj2.setStartTime("2023-05-16");
obj2.setEndTime("2023-06-15");
obj2.setOffset(0L);
obj2.setPageSize(20L);
req.setAsyncRptQueryVO(obj2);
UniversalbpReportAsyncDownloadFindTaskPageResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_report_async_download_find_task_page_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <top_async_rpt_v_o_top_bulk_data>
            <top_async_rpt_v_o_list>
                <top_async_rpt_vo>
                    <task_id>1111</task_id>
                    <biz_code>bizCode</biz_code>
                    <file_name>账户报表001</file_name>
                    <status>SUCCESS-生成成功, FAIL-生成失败(由于参数设置例如超过时间长度限度会生成失败</status>
                    <gmt_create>2023-06-13</gmt_create>
                    <gmt_modified>2023-06-13</gmt_modified>
                    <download_url>xxxxx</download_url>
                </top_async_rpt_vo>
            </top_async_rpt_v_o_list>
            <count>1</count>
        </top_async_rpt_v_o_top_bulk_data>
    </result>
</universalbp_report_async_download_find_task_page_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

返回
顶部