All Products
Search
Document Center

CloudOps Orchestration Service:ListInventoryEntries

Last Updated:Dec 15, 2023

Queries the configurations of an Elastic Compute Service (ECS) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:ListInventoryEntriesLIST
  • All Resources
    acs:oos:{#regionId}:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

i-bp1cpoxxxwxxxxxxxxxx
TypeNamestringYes

The name of the component. Valid values:

  • ACS:InstanceInformation
  • ACS:Application
  • ACS:File
  • ACS:Network
  • ACS:WindowsRole
  • ACS:Service
  • ACS:WindowsRegistry
  • ACS:WindowsUpdate
ACS:InstanceInformation
MaxResultsintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 50.

50
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
Filterobject []No

The filter rules for the component.

ValuearrayNo

The values of properties. Valid values of the first N: 1 to 5. Valid values of the second N: 1 to 20.

stringNo

The value of the component property.

ubuntu
OperatorstringNo

The comparison operator that is used to filter property values. Valid values of N: 1 to 5. Valid values:

  • Equal
  • NotEqual
  • BeginWith
  • LessThan
  • GreaterThan
Equal
NamestringNo

The name of the component property. Valid values of N: 1 to 5.

PlatformName
RegionIdstringNo

The ID of the region in which the instance resides.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.

gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestIdstring

The ID of the request.

A81E4B2E-6B33-4BAE-9856-55DB7C893E01
SchemaVersionstring

The version number of the component.

1.0
MaxResultsinteger

The number of entries returned per page.

50
CaptureTimestring

The time when the request was sent.

2020-09-17T12:28:13Z
TypeNamestring

The name of the component.

ACS:InstanceInformation
InstanceIdstring

The ID of the ECS instance.

i-bp1cpoxxxwxxxxxxxxxx
Entriesobject []

The configurations of the component.

object

The detailed configurations of the component.

{ "RequestId": "1DF96445-5E18-4524-A4AE-3A218D0C345A", "Entries": [ { "PlatformName": "ubuntu", "PlatformVersion": "20.04", "Status": "Running", "InstanceId": "i-bp1cpoxxxwxxxxxxxxxx", "AgentVersion": "v1.5", "ComputerName": "i-bp1cpoxxxwxxxxxxxxxx", "IpAddress": "192.000.00.000", "AgentName": "oosutil", "PlatformType": "linux" } ]}

Examples

Sample success responses

JSONformat

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
  "SchemaVersion": "1.0",
  "MaxResults": 50,
  "CaptureTime": "2020-09-17T12:28:13Z",
  "TypeName": "ACS:InstanceInformation",
  "InstanceId": "i-bp1cpoxxxwxxxxxxxxxx",
  "Entries": [
    {
      "RequestId": "1DF96445-5E18-4524-A4AE-3A218D0C345A",
      "Entries": [
        {
          "PlatformName": "ubuntu",
          "PlatformVersion": "20.04",
          "Status": "Running",
          "InstanceId": "i-bp1cpoxxxwxxxxxxxxxx",
          "AgentVersion": "v1.5",
          "ComputerName": "i-bp1cpoxxxwxxxxxxxxxx",
          "IpAddress": "192.000.00.000",
          "AgentName": "oosutil",
          "PlatformType": "linux"
        }
      ]
    }
  ]
}

Error codes

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