All Products
Search
Document Center

CloudOps Orchestration Service:ListInstancePatchStates

Last Updated:Oct 14, 2024

Queries the infromation about the patches of an instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oos:ListInstancePatchStateslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region in which the instance whose patches you want to query resides.

cn-hangzhou
MaxResultsintegerNo

The number of entries to return on each page.

50
NextTokenstringNo

The token that is used to retrieve the next page of results.

-
InstanceIdsstringNo

The ID of the Elastic Compute Service (ECS) instance. The value can be a JSON array that consists of up to 100 instance IDs. Separate the instance IDs with commas (,).

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

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token that is used to retrieve the next page of results.

-
RequestIdstring

The ID of the request.

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

The number of entries returned on each page.

50
InstancePatchStatesarray<object>

The details of patches of the instance.

InstancePatchStateobject
MissingCountstring

The number of patches that are not installed.

0
OperationEndTimestring

The time when the operation ended.

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

The information about the user.

“”
InstalledOtherCountstring

The number of patches that do not meet the baseline.

0
InstanceIdstring

The ID of the ECS instance.

i-bp1jaxa2bs4bps7*****
OperationTypestring

The operation type.

scan
OperationStartTimestring

The time when the operation was initiated.

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

The number of patches that failed to be installed.

0
BaselineIdstring

The ID of the patch baseline.

pb-f9393021b7a049e1b34e
InstalledPendingRebootCountstring

The number of patches that have been installed but require a restart to take effect.

0
InstalledRejectedCountstring

The number of patches that are rejected by the user.

0
PatchGroupstring

The patch group.

null
InstalledCountstring

The number of installed patches.

0

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history