Get export status
Updated at:
Query the export task status and download link. Downloadable only when export_status is success and link is non-null.
Prerequisites
Configure the endpoint and authentication first. See API overview and authentication.
Endpoint
GET /export_status
Query the export task status and download link. Downloadable only when export_status is success and link is non-null.
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
export_id | Yes | integer | Export task ID, from the export alerts response |
Request example
curl -X GET "$BASE_URL/export_status?export_id=131231" \
-H "Authorization: Bearer $BAILIAN_API_KEY"
BASE_URL is https://{workspace_id}.cn-beijing.maas.aliyuncs.com/api/v1/agentstudio/security, and BAILIAN_API_KEY is your Alibaba Cloud Bailian API Key.
Response body
| Field | Type | Description |
|---|---|---|
export_status | string | init / exporting / success. Downloadable only when success and link is non-null |
progress | integer | Export progress percentage, 0-100 |
current_count | integer | Number of records exported so far |
total_count | integer | Total number of records in the export task |
link | string | Excel download link, null when the task is incomplete or failed |
message | string | Result message, fixed to success on completion |
Response example
{
"success": true,
"data": {
"export_status": "exporting",
"progress": 20,
"current_count": 20,
"total_count": 100,
"link": null,
"message": null
}
}
Is this page helpful?