DocsICP FilingConsole
Documentation

ListInstancePatchStates

Updated at:
Copy as MD
Product
My Favorites

Retrieves patch information for 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 region ID.

cn-hangzhou
MaxResults

integer

No

The number of entries per page.

50
NextToken

string

No

The pagination token.

-
InstanceIds

string

No

The IDs of ECS instances. The value is a JSON array that consists of up to 100 instance IDs. Separate multiple IDs with commas (,).

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

string

No

123456789

Response elements

Element

Type

Description

Example

object

NextToken

string

The pagination token.

-
RequestId

string

The request ID.

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

integer

The number of entries per page.

50
InstancePatchStates

array<object>

The patch information of instances.

object

MissingCount

string

The number of patches that are not installed.

0
OperationEndTime

string

The time when the operation ended.

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

string

The owner information.

“”
InstalledOtherCount

string

The number of patches that do not meet the baseline.

0
InstanceId

string

The ECS instance ID.

i-bp1jaxa2bs4bps7*****
OperationType

string

The operation type.

scan
OperationStartTime

string

The time when the operation started.

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

string

The number of patches that failed to be installed.

0
BaselineId

string

The patch baseline ID.

pb-f9393021b7a049e1b34e
InstalledPendingRebootCount

string

The number of installed patches that are pending a restart.

0
InstalledRejectedCount

string

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

0
PatchGroup

string

The patch group.

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.