All Products
Search

This Product

    CloudOps Orchestration Service:ListInstancePatchStates

    Document Center

    CloudOps Orchestration Service:ListInstancePatchStates

    Last Updated:May 08, 2026

    Retrieves the patch state of one or more instances.

    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

    oos:ListInstancePatchStates

    list

    *All Resource

    *
    • oos:TLSVersion
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The ID of the region.

    cn-hangzhou
    MaxResults

    integer

    No

    The maximum number of entries to return on each page. The service may return fewer than this value.

    50
    NextToken

    string

    No

    The token returned from a previous call that is used to retrieve the next page of results.

    -
    InstanceIds

    string

    No

    A JSON array of up to 100 ECS instance IDs.

    ["i-bp1jaxa2bs4bps7*****", "i-bp67acfmxazb4p****", … "i-bp67acfmxazb4p****"]

    Response elements

    Element

    Type

    Description

    Example

    object

    NextToken

    string

    The token to use in a subsequent request to retrieve the next page of results. This value is null if all results have been returned.

    -
    RequestId

    string

    The request ID.

    9A47C086-E64D-52EE-8B2C-EFD23877C55E
    MaxResults

    integer

    The number of entries returned on the current page.

    50
    InstancePatchStates

    array<object>

    The patch states of the instances.

    object

    MissingCount

    string

    The number of missing patches.

    0
    OperationEndTime

    string

    The time when the operation ended.

    2021-09-10T11:42:22Z
    OwnerInformation

    string

    Information about the owner.

    “”
    InstalledOtherCount

    string

    The number of installed patches that do not comply with the patch baseline.

    0
    InstanceId

    string

    The ID of the ECS instance.

    i-bp1jaxa2bs4bps7*****
    OperationType

    string

    The type of operation performed. For example, scan.

    scan
    OperationStartTime

    string

    The time when the operation started.

    2021-09-10T11:42:22Z
    FailedCount

    string

    The number of patches that failed to install.

    0
    BaselineId

    string

    The ID of the patch baseline.

    pb-f9393021b7a049e1b34e
    InstalledPendingRebootCount

    string

    The number of installed patches that require a system reboot.

    0
    InstalledRejectedCount

    string

    The number of installed patches that were rejected by the user.

    0
    PatchGroup

    string

    The patch group to which the instance belongs.

    null
    InstalledCount

    string

    The number of installed patches.

    0

    Examples

    Success response

    JSON format

    {
  "NextToken": "-",
  "RequestId": "9A47C086-E64D-52EE-8B2C-EFD23877C55E",
  "MaxResults": 50,
  "InstancePatchStates": [
    {
      "MissingCount": "0",
      "OperationEndTime": "2021-09-10T11:42:22Z",
      "OwnerInformation": "“”",
      "InstalledOtherCount": "0",
      "InstanceId": "i-bp1jaxa2bs4bps7*****",
      "OperationType": "scan",
      "OperationStartTime": "2021-09-10T11:42:22Z",
      "FailedCount": "0",
      "BaselineId": "pb-f9393021b7a049e1b34e",
      "InstalledPendingRebootCount": "0",
      "InstalledRejectedCount": "0",
      "PatchGroup": "null",
      "InstalledCount": "0"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.