获取数据导出进度

Get export progress 获取数据导出进度

请求数据格式

请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要验证. 必填.
ID integer 导出任务 ID. 要求以地址一部分的形式应用 (非 GET参数). 见下例.

示例URL:

https://api.esv2.com/v2/Api/Exports/23?apiKey=test_api_key1

应答

接口会返回一个信息描述所建立导出任务的状态。如若已完成,则除了返回值外,还将返回一个URL链接可供下载导出的文件.
应答数据元素:
元素/属性 类型 描述
Status string 导出状态. 以下任一种:

    • Queued 排队等候 – 导出任务还未开始,在等待执行中.
    • InProgress 正在进行 – 导出任务正在进行中.
    • Completed 已完成 – 导出任务已经完成,文件可供下载。
    • Error 发送错误 – 导出任务失败
DownloadUrl string URL,即导出结果文件可供下载的地址。只有当 Status=Completed 才会被返回.

示例

请求:
GET https://api.esv2.com/v2/Api/Exports/23?apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com
应答:
 HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Server: Microsoft-IIS/7.5 
X-AspNetMvc-Version: 3.0 
X-AspNet-Version: 4.0.30319 
X-Powered-By: ASP.NET 
Date: Mon, 25 Nov 2013 18:50:13 GMT 
Content-Length: 259<ApiResponse
xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>

 <Data>
  <Status>Completed</Status>
  <DownloadUrl>http://api.esv2.com/v2/Api/DownloadFile/23?apiKey=test_api_key1</DownloadUrl>
 </Data>
</ApiResponse>