ListInstanceInspectionRuns - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the instance inspection history.

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

rocketmq:ListInstanceInspectionRuns

list

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request syntax

GET /api/v1/monitoring/instance-inspections/{instanceId}/runs HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance. Wildcards are not allowed.	rmq-cn-example

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	Yes	The region ID.	cn-hangzhou
templateCode	string	No	The code of the inspection item.	rmq.consumer-health
startTime	string	No	The start time for filtering by execution request time. The boundary is inclusive. Specify the time in ISO 8601 format with a time zone.	2026-09-01T00:00:00Z
endTime	string	No	The end time for filtering by execution request time. The boundary is inclusive. The value must be later than the value of startTime. Specify the time in ISO 8601 format with a time zone.	2026-09-08T00:00:00Z
status	string	No	The execution status of the instance task for filtering. Valid values: Pending, Running, Succeeded, PartiallySucceeded, and Failed. Valid values: Pending Running Succeeded PartiallySucceeded Failed	Succeeded
result	string	No	The inspection conclusion for filtering. If templateCode is specified, this parameter filters the conclusion of the specified item. Otherwise, it filters the conclusion of the instance report. Valid values: info risk	risk
reportStatus	string	No	The actual report generation status for filtering. Data is filtered before pagination. Valid values: NotRequired (no generation required), Pending (waiting for generation), Running (generating), Succeeded (generated), and Failed (generation failed). Valid values: NotRequired Pending Running Succeeded Failed	Succeeded
sortBy	string	No	The field by which to sort the results in descending order. Default value: requestedAt, which sorts by execution time. You can also set this parameter to reportFinishedAt to sort by report completion time. If you set this parameter to reportFinishedAt, you must also set reportStatus to Succeeded. If multiple records have the same time, they are sorted in descending order of report ID. Valid values: requestedAt reportFinishedAt	reportFinishedAt
maxResults	integer	No	The maximum number of entries to return on each page. Default value: 20. Valid values: 1 to 100.	20
nextToken	string	No	The pagination token returned from the previous page. Do not specify this parameter for the first query. When you turn the page, you must keep all filter conditions consistent.	eyJvZmZzZXQiOjIwfQ

Response elements

Element	Type	Description	Example
	object
maxResults	integer	The maximum number of results per page for the current request, which is not the actual number of returned entries.	20
data	array<object>	The historical inspection records on the current page.	[]
	array<object>
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The ID of the associated instance.	rmq-cn-example
instanceName	string	The name of the instance.	Order instance
runId	string	The ID of the instance inspection run.	inspection-run-001
triggerSource	string	The trigger source of the inspection. Valid values: manual and cron.	manual
status	string	The execution status of the inspection. Valid values: Pending, Running, Succeeded, PartiallySucceeded, and Failed. Valid values: Pending Running Succeeded PartiallySucceeded Failed	Succeeded
requestedAt	string	The time when the inspection was submitted, in ISO 8601 format.	2026-09-08T00:00:00Z
finishedAt	string	The time when the inspection was completed. This parameter is empty if the inspection is not completed.	2026-09-08T00:01:00Z
timeRange	object	The time range of the inspection.	{}
startTime	string	The start time of the actual inspection window, in ISO 8601 format.	2026-09-01T00:00:00Z
endTime	string	The end time of the actual inspection window, in ISO 8601 format.	2026-09-08T00:00:00Z
summary	object	The statistics of the inspection results. This parameter is empty if the inspection is not completed.	{}
result	string	The conclusion of the inspection. Valid values: info and risk. This parameter is empty if the inspection is not completed or fails. Valid values: info risk	risk
infoCount	integer	The number of normal inspection items.	2
riskCount	integer	The number of risky inspection items.	1
aiSummary	object	The summary of each inspection result generated by a large language model (LLM). This parameter includes the generation status and the original text upon success. It is empty if the summary is not generated.	{}
status	string	The generation status of the summary. Valid values: Pending, Running, Succeeded, and Failed. This status does not affect the inspection results. Valid values: Pending Running Succeeded Failed	Succeeded
text	string	The text generated by the model. This parameter is returned only when the generation succeeds. The text contains up to 200 characters and is not concatenated or truncated by the frontend.	No risks were found in this inspection, and the instance is running normally
notification	object	The event delivery status of cloud monitoring risk events.	{}
status	string	The notification status. Valid values: NotRequired, NotConfigured, Pending, Sent, and Failed. The Sent value only indicates that CloudMonitor has accepted the event. Valid values: NotRequired NotConfigured Pending Sent Failed	Sent
eventId	string	The stable ID of the CloudMonitor event. This parameter is empty if no event exists.	inspection-event-001
reportId	string	The ID of the risk diagnostic report. This parameter is empty if the report is not generated. Call the GetInstanceInspectionReport operation to obtain the report content when opening the report.	irpt-one
reportStatus	string	The generation status of the report, which is independent of the execution status. This parameter is empty if the status is not determined or the execution fails before entering the report generation phase. Valid values: NotRequired Pending Running Succeeded Failed	Succeeded
reportFinishedAt	string	The time when the report generation was completed, in ISO 8601 format with time zone. This parameter is returned only when the report is generated.	2026-10-15T10:00:00Z
total	integer	The total number of conditional history records.	5
nextToken	string	The cursor for the next page. This parameter is empty if the current page is the last page.	eyJvZmZzZXQiOjIwfQ

Examples

Success response

JSON format

{
  "maxResults": 20,
  "data": [
    {
      "regionId": "cn-hangzhou",
      "instanceId": "rmq-cn-example",
      "instanceName": "Order instance",
      "runId": "inspection-run-001",
      "triggerSource": "manual",
      "status": "Succeeded",
      "requestedAt": "2026-09-08T00:00:00Z",
      "finishedAt": "2026-09-08T00:01:00Z",
      "timeRange": {
        "startTime": "2026-09-01T00:00:00Z",
        "endTime": "2026-09-08T00:00:00Z"
      },
      "summary": {
        "result": "risk",
        "infoCount": 2,
        "riskCount": 1
      },
      "aiSummary": {
        "status": "Succeeded",
        "text": "No risks were found in this inspection, and the instance is running normally"
      },
      "notification": {
        "status": "Sent",
        "eventId": "inspection-event-001"
      },
      "reportId": "irpt-one",
      "reportStatus": "Succeeded",
      "reportFinishedAt": "2026-10-15T10:00:00Z"
    }
  ],
  "total": 5,
  "nextToken": "eyJvZmZzZXQiOjIwfQ"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.