You need to enable JavaScript to run this app.
Elastic Compute Service

Elastic Compute Service

Copy page
Download PDF
Patch management
ListInstancePatches - Queries the instance patch installation status
Copy page
Download PDF
ListInstancePatches - Queries the instance patch installation status
Call ListInstancePatches to query the instance patch installation status.​
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.
​
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: ListInstancePatches​
The operation that you want to perform. Valid value: ListInstancePatches.​
​
Version string required Sample value: 2020-04-01​
The API version. Value: 2020-04-01.​
​
Status string required Sample value: Pending​
The patch plan status. Value:​
  • Pending: Pending.​
  • Running: Running.​
  • Completed: Completed.​
  • Failed: Failed.​
  • Expired: Expired.​
  • Cancelled: Cancelled.​
​
Classification string Optional Sample value: Security​
The patch classification. Value:​
  • Security: Security patch.​
  • Other: Patches other than security patches.​
​
Name string Optional Sample value: UbuntuBaseline​
The patch name. Value:​
  • It must start with a letter or a Chinese character.​
  • It can contain only Chinese characters, letters, digits, underscores (_), hyphens (-), and English periods (.).​
  • It must be 1 to 128 characters in length.​
​
InstanceId string required Sample value: i-yee25xg1ds7fzxc****​
The instance ID.​
You can obtain matching instance IDs by calling DescribeInstances.​
​
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.​
  • 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.​
​
Patches object[] Sample value: --​
The patch list.​
Title string Sample value: [Security] Ubuntu & Debian Kernel CVE Patch – 2026-01​
The patch name.​
​
Description string Sample value: The description of patch.​
The patch description.​
​
Severity string Sample value: CRITICAL​
The compliance severity level. Value:​
  • CRITICAL: Highest compliance risk level.​
  • HIGH: High priority level.​
  • MEDIUM: Medium priority level for routine remediation.​
  • LOW: Low priority level for deferred remediation.​
  • INFORMATIONAL: Non-risk informational level.​
  • UNSPECIFIED: Temporary level for pending classification.​
​
Classification string Sample value: Security​
The patch classification. Valid values:​
  • Security: Security patch.​
  • Other: Patches other than security patches.​
​
Name string Sample value: nginx​
The patch package name.​
​
InstalledTime string Sample value: 2025-12-09T20:45Z​
The patch installation time.​
​
CveIds string[] Sample value: CVE-2026-1****​
The list of Common Vulnerabilities and Exposures (CVE) IDs of the patches.​
​
Status string Sample value: INSTALLED​
The patch installation status.​
  • INSTALLED: The patch has been installed and a restart is not required.​
  • MISSING: The patch has not been installed.​
  • INSTALLED_PENDING_REBOOT: The patch has been installed and a restart is required for the patch to take effect.​
  • FAILED: Patch installation failed.​
  • INSTALLED_OTHER: The patch has been installed, but does not comply with the baseline. A package in the "Rejected patches" list will be installed only if the package is a dependency of another package, and its status will be "Installed (does not meet the baseline)".​
  • INSTALLED_REJECTED: The patch has been installed, but it is a rejected patch. If a package was installed before it was added to the "Rejected patches", its status will be "Installed (rejected patch)".​
​
​
​
​
Sample request​
​
POST /?Version=2020-04-01&Action=ListInstancePatches HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
AccessKey: AK*****************​
SecretKey: TXpS***************​
ServiceName: ecs​
Region: cn-beijing​
X-Top-Account-Id: 21000*****​
Content-Type: application/json​
​
{​
"InstanceId": "i-instance001",​
"Status": "MISSING",​
"MaxResults": 50​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "20260122101414141****",​
"Action": "ListInstancePatches",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"Patches": [​
{​
"Name": "KB5005565",​
"Title": "Update: Upgrade utils/curl to 8.5.0 on Ubuntu 22.04",​
"Classification": "SecurityUpdates",​
"Severity": "Critical",​
"Status": "MISSING",​
"InstalledTime": "",​
"CveIds": [],​
"Description": "Fixes security vulnerabilities."​
},​
{​
"Name": "python3",​
"Title": "Interactive high-level object-oriented language",​
"Classification": "Security",​
"Severity": "Important",​
"Status": "MISSING",​
"CveIds": [],​
"InstalledTime": "",​
"Description": "Security update for Python3"​
}​
],​
"NextToken": ""​
}​
}​
​
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. Please try again. If multiple attempts fail, submit a ticket.​
​
Last updated: 2026.06.18 17:48:27