ExportInventoryAsset - Data Management - Alibaba Cloud Documentation Center

Operation description

Exports all inventory table assets based on the same filter criteria as SearchInventoryAsset. The server generates an XLSX file, uploads it to OSS, and returns a pre-signed download URL valid for 1 hour. No Size/Offset pagination parameters are 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ExportInventoryAsset

none

*All Resource

*

None

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 direction. Valid values: asc: ascending order. desc: descending order. Default value: desc.	desc

Response elements

Element	Type	Description	Example
	object	The response content.
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 paginated result of the inventory task list.
DownloadUrl	string	The temporary download URL for the XLSX file (OSS pre-signed URL).	https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1756865597&OSSAccessKeyId=LTAIuSosQIEgsbko&Signature=PbiIBNqP9jIBScrwQQFbgFPwNF4%3D
FileName	string	The suggested file name for saving the downloaded file.	insert.sql
ExpireTime	integer	The expiration time of the download URL (UNIX timestamp in milliseconds).	1766718830
TotalCount	integer	The total number of exported records.	10

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "DownloadUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1756865597&OSSAccessKeyId=LTAIuSosQIEgsbko&Signature=PbiIBNqP9jIBScrwQQFbgFPwNF4%3D",
    "FileName": "insert.sql",
    "ExpireTime": 1766718830,
    "TotalCount": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.