Call ListInstancePatchReports to query the list of instance compliance reports.

Usage notes

The target instance has been scanned for patch status, or scanned with patches installed. For details, refer to CreatePatchPlan - Creates a patch plan.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: ListInstancePatchReports

The operation that you want to perform. Value: ListInstancePatchReports.

Version string required Sample value: 2020-04-01

The API version. Value: 2020-04-01.

InstanceIds string[] Optional Sample value: ["i-abc123"]

The list of instance IDs. You can obtain matching instance IDs by calling DescribeInstances. Value:

Separate multiple patch baselines by ',' (English commas).

You can pass in up to 20 instance IDs in a single request.

NextToken string Optional Sample value: token-abc123

The pagination token used to mark the pagination position. For the current query, use the NextToken value returned by the previous API call.

If a token is passed in the call, the returned value is derived from the current page results.

If no token is passed in this call:

If more pages are available, a valid pagination token is returned in the response.

If the current page is the last page (no more data), an empty string is returned as the token.

MaxResults integer Optional Sample value: 10

The number of entries on each page in a pagination query. Value:

Default value: 10

Value range: 1 to 100.

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

NextToken string Sample value: token-abc123

The query token returned by this call. Value:

If a token is passed in the call, the returned value is derived from the current page results.

If no token is passed in this call:

If more pages are available, a valid pagination token is returned in the response.

If the current page is the last page (no more data), an empty string is returned as the token.

InstancePatchReports object[] Sample value: --

The list of instance patch reports.

InstalledOtherCount integer Sample value: 1

The number of patches not compliant with the baseline.

MissingCount integer Sample value: 11

The number of patches that are not installed.

InstalledCount integer Sample value: 5

The number of installed patches.

PatchPlanId string Sample value: pp-yecrlep6z8ffaj3w****

The ID of the patch plan.

InstanceId string Sample value: i-yee25xg1ds7fzxcl****

The instance ID.

BaselineId string Sample value: bl-yee2zezsaq9vq62****

The ID of the patch baseline.

OperationType string Sample value: Scan

The operation type. Valid values:

Scan: Only scan patches.

Install: Scan and install patches.

PatchPlanName string Sample value: PlanName

The name of the patch plan.

OperationEndTime string Sample value: 2025-12-09T20:45Z

The time when the command, patch installation, or configuration operations executed on the target instance are fully completed.

OperationStartTime string Sample value: 2025-12-09T20:45Z

The time when the execution starts for commands, patch installation, or configuration operations on the target instance.

AvailableSecurityUpdateCount integer Sample value: 12

The number of available security-related patches that have not yet been approved by the patch baseline.

tip

Such patches are not approved usually because they do not meet the baseline rules. For example, an updated version was released before the specified automatic approval deadline.

OwnerInformation string Sample value: 210000****

The account ID, the unique identifier of the VolcanoEngine root user.

OperationSystem string Sample value: Ubuntu

The operating system type. Value:

Ubuntu

Debian

NotApplicableCount integer Sample value: 7

The number of patches from the patch baseline that are not installed because they are not applicable to the instance (the patches do not match the current instance environment).

OtherNonCompliantCount integer Sample value: 6

The number of patches specified as non-Critical or non-Security but not compliant with the patch baseline.

SecurityNonCompliantCount integer Sample value: 65

The number of uninstalled patches marked as Security in the patch compliance report.

tip

Such patches may be missing, installation-failed, rejected, or installed but pending a restart to take effect.

CriticalNonCompliantCount integer Sample value: 33

The number of uninstalled patches marked as Critical in the compliance report from the patch baseline.

tip

Such patches may be missing, installation-failed, rejected, or installed but pending a restart to take effect.

FailedCount integer Sample value: 1

The number of patches for which installation failed.

InstalledPendingRebootCount integer Sample value: 1

The number of patches installed but pending a restart.

InstalledRejectedCount integer Sample value: 1

The number of patches that are installed despite being rejected by the user.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	InvalidArgument	The specified argument is invalid.	The specified parameter is invalid.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service