Retrieve & Filter Inventory Data via OOS SearchInventory API - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Retrieves detailed or aggregated inventory information.

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

get

*All Resource

*

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
NextToken	string	No	The token used to retrieve the next page of results.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 50.	50
Filter	array<object>	No	The filter rules for the component.
	object	No
Value	array	No	The values to match against the component property.	i-bp1cpoxxxxxxxxxxxxxx
	string	No	A value to match against the component property.	i-bp1cpoxxxxxxxxxxxxxx
Operator	string	No	The comparison operator for the property value. You can specify up to five filters. Valid values: Equal NotEqual BeginWith LessThan GreaterThan	Equal
Name	string	No	The component property name. Up to five filters can be specified. Property names vary by component. For example, the ACS:InstanceInformation component has the InstanceId property. For this component, set this parameter to ACS:InstanceInformation.InstanceId.	ACS:InstanceInformation.InstanceId
Aggregator	array	No	The aggregator. One or more aggregators can be used to query aggregated instance information. Valid values: ACS:Application.Name ACS:Application.Version	ACS:Application.Name
	string	No	The aggregator.	ACS:Application.Name

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token used to retrieve the next page of results.	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestId	string	The request ID.	A81E4B2E-6B33-4BAE-9856-55DB7C893E01
MaxResults	integer	The number of entries per page.	50
Entities	array<object>	The entities.
	object	Detailed inventory or aggregated information about the component.	[ { "ACS:InstanceInformation": { "CaptureTime": "2020-10-13T08:55:06Z", "SchemaVersion": "1.0", "Content": { "PlatformName": "ubuntu", "PlatformVersion": "20.04", "Status": "Running", "InstanceId": "i-bp1cpoxxxxxxxxxxxxxx", "AgentVersion": "v1.5", "ComputerName": "iZbp1cpoxxxw111jcv94drZ", "IpAddress": "192.168.10.245", "AgentName": "oosutil", "PlatformType": "linux" }, "RegionId": "cn-hangzhou" }, "Id": "i-bp1cpoxxxxxxxxxxxxxx" } ]}

Examples

Success response

JSON format

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
  "MaxResults": 50,
  "Entities": [
    {
      "test": "test",
      "test2": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.