Use ListInventoryEntries to query ECS instance inventory configurations - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

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

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:ListInventoryEntries

get

*All Resource

*

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	i-bp1cpoxxxwxxxxxxxxxx
TypeName	string	Yes	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
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 50.	50
NextToken	string	No	A pagination token for retrieving the next page of results. You do not need to specify this parameter for the first request.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
Filter	array<object>	No	The filter rules for the component.
	object	No
Value	array	No	The values of properties. Valid values of the first N: 1 to 5. Valid values of the second N: 1 to 20.	test
	string	No	The value of the component property.	ubuntu
Operator	string	No	The comparison operator for filtering property values. Valid values of N: 1 to 5. Valid values: Equal NotEqual BeginWith LessThan GreaterThan	Equal
Name	string	No	The name of the component property. Valid values of N: 1 to 5.	PlatformName
RegionId	string	No	The ID of the region where the instance resides.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
NextToken	string	A pagination token that can be used in the next request to retrieve a new page of results.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestId	string	The ID of the request.	A81E4B2E-6B33-4BAE-9856-55DB7C893E01
SchemaVersion	string	The version number of the component.	1.0
MaxResults	integer	The number of entries returned per page.	50
CaptureTime	string	The time when the request was sent.	2020-09-17T12:28:13Z
TypeName	string	The name of the component.	ACS:InstanceInformation
InstanceId	string	The ID of the ECS instance.	i-bp1cpoxxxwxxxxxxxxxx
Entries	array<object>	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.