AsyncExportInventoryAsset

Updated at:
Copy as MD

Asynchronously submits a full asset export task for an inventory table.

Operation description

Submits an asynchronous export task using the same filter conditions as SearchInventoryAsset or ExportInventoryAsset. The operation immediately returns an exportTaskId (status=RUNNING). After the backend generates an XLSX file and uploads it to OSS, 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 of asset information such as table names.

order

SortBy

string

No

The field by which to sort the results. Valid values:

  • confidence

  • 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 returned data.

ExportTaskId

integer

The ID of the asynchronous export task, which is used to poll the task status by calling GetInventoryExportTaskStatus.

3b5ab724e92f4a0ba890c95fc459636f

Status

string

The task status. The value is RUNNING when the task is submitted successfully.

RUNNING

FileName

string

The suggested file name for saving the exported file.

/crm-order-biz%3Bsrc%3Bmain%3Bresources%3Bmybatis%3Bmappers%3Brrscrm%3BOrderOutCountMapper.xml

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "ExportTaskId": 0,
    "Status": "RUNNING",
    "FileName": "/crm-order-biz%3Bsrc%3Bmain%3Bresources%3Bmybatis%3Bmappers%3Brrscrm%3BOrderOutCountMapper.xml"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.