AsyncExportInventoryKnowledge

Operation description

Submits an asynchronous export task by using the same filter conditions as SearchInventoryKnowledge or ExportInventoryKnowledge. The operation immediately returns an exportTaskId with status=RUNNING. After the XLSX file is generated and uploaded to OSS in the background, poll the task status by calling GetInventoryExportTaskStatus. When status=SUCCESS, a pre-signed downloadUrl is returned. Size and Offset are not required. A maximum of 50,000 records can be exported in a single request.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
JobId	integer	Yes	The ID of the inventory task.	1001
Query	string	No	The search keyword used for fuzzy matching against knowledge content.	订单
ShowType	string	No	The knowledge display type used to filter results, such as TABLE, COLUMN, SQL, SEG, LINEAGE, or TERM.	TABLE
SortBy	string	No	The field by which to sort the results. Valid values: confidence and entityId. Default value: confidence.	confidence
SortOrder	string	No	The sort order. Valid values: asc: ascending order. desc: descending order. Default value: desc.	desc

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	Id of the request	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The ID of the inventory task.
ExportTaskId	integer	The ID of the asynchronous export task. Use this ID to poll the task status by calling GetInventoryExportTaskStatus.	4b3a9729-bf4f-4a5f-ad34-579f06e45cc9
Status	string	The status of the task. The value is RUNNING when the task is submitted.	RUNNING
FileName	string	The suggested file name for saving the exported file.	insert.sql

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "ExportTaskId": 0,
    "Status": "RUNNING",
    "FileName": "insert.sql"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.