ListInventoryJobs

Operation description

This operation maps to the /knowledge/job/inventory/list page in the console. It retrieves a paginated list of asset inventory jobs for the current tenant. You can filter the jobs by task ID, creator name keywords, or task status.

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

GET / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Query	string	No	A search keyword for fuzzy matching on the task ID or creator's name. A task ID can be a number or a string prefixed with `task_`.	task_1001
Status	integer	No	The task status to filter by.	1
Size	integer	No	The number of entries to return per page. Default: 20. Maximum: 100.	20
Offset	integer	No	The pagination offset. Default: 0.	0
SortBy	string	No	The sort field.	confidence
SortOrder	string	No	The sort order. Valid values: `asc` (ascending) and `desc` (descending). Default: `desc`.	desc

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	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 list of asset inventory jobs.
TotalCount	integer	The total count.	10
Items	array	The list of asset inventory jobs.
	KnowledgeJobInfoVO	An asset inventory job. Note	[]

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "TotalCount": 10,
    "Items": [
      {
        "JobId": 0,
        "ShowJobId": "",
        "Status": "",
        "Progress": 0,
        "TableCnt": 0,
        "KnowledgeCnt": 0,
        "Creator": "",
        "Description": "",
        "Supplement": "",
        "CreateTime": "",
        "EndTime": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.