SearchInventoryAsset

Operation description

This operation retrieves a paginated list of table-level assets generated by a specific inventory task. It corresponds to the /knowledge/job/inventory/asset page in the console and supports keyword filtering and sorting.

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 inventory task ID.	1001
Query	string	No	The keyword for a fuzzy search of asset information, such as table names.	order
Size	integer	No	The number of items to return on each page. Default: 20. Maximum: 100.	20
Offset	integer	No	The pagination offset. Default: 0.	0
SortBy	string	No	The sort field. Valid values: `confidence` and `entityId`. The default value is `confidence`.	confidence
SortOrder	string	No	The sort order. Valid values: `asc` for ascending order and `desc` for descending order. The default value is `desc`.	desc

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The 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 succeeded. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The paginated result for table assets.
TotalCount	integer	The total count.	50
Items	array	A list of table assets.
	TableKnowledgeVO	The details of a single table asset. For the object's structure, refer to the response example. Note	[]

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "TotalCount": 50,
    "Items": [
      {
        "TableId": 0,
        "TableName": "",
        "DbId": 0,
        "DbName": "",
        "DbType": "",
        "InstanceId": 0,
        "InstanceName": "",
        "SchemaName": "",
        "EnvType": "",
        "Description": "",
        "AssetDescription": "",
        "Summary": "",
        "Title": "",
        "AssetCreatedGmt": "",
        "AssetModifiedGmt": "",
        "Size": 0,
        "NumRows": 0,
        "Level": 0,
        "HotLevel": 0,
        "LevelType": "",
        "Logic": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.