Queries the configurations of an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListInventoryEntries

The operation that you want to perform. Set the value to ListInventoryEntries.

InstanceId String Yes i-bp1cpoxxxwxxxxxxxxxx

The ID of the instance.

TypeName String Yes ACS:InstanceInformation

The name of the component.

Valid values:

  • ACS:InstanceInformation
  • ACS:Application
  • ACS:File
  • ACS:Network
  • ACS:WindowsRole
  • ACS:Service
  • ACS:WindowsRegistry
  • ACS:WindowsUpdate
MaxResults Integer No 50

The number of entries to return on each page. Valid values: 1 to 100. Default value: 50.

NextToken String No MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA

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

Filter.N.Name String No DisplayName

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

Filter.N.Operator String No BeginWith

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

Valid values:

  • Equal
  • NotEqual
  • BeginWith
  • LessThan
  • GreaterThan
Filter.N.Value.N RepeatList No test

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

Response parameters

Parameter Type Example Description
CaptureTime String 2020-09-17T12:28:13Z

The time when the request was sent.

Entries List { "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" } ]}

The detailed configurations of the component.

InstanceId String i-bp1cpoxxxwxxxxxxxxxx

The ID of the ECS instance.

MaxResults Integer 50

The number of entries returned per page.

NextToken String gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC

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

RequestId String A81E4B2E-6B33-4BAE-9856-55DB7C893E01

The ID of the request.

SchemaVersion String 1.0

The version number of the component.

TypeName String ACS:InstanceInformation

The name of the component.

Examples

Sample requests

http(s)://[Endpoint]/? InstanceId=i-bp1cpoxxxwxxxxxxxxxx
&TypeName=ACS:InstanceInformation
&<Common request parameters>

Sample success responses

XML format

<TypeName>ACS:InstanceInformation</TypeName>
<CaptureTime>2020-09-17T12:28:13Z</CaptureTime>
<RequestId>F2727F63-CDC5-45A1-995E-4F1127E001CE</RequestId>
<SchemaVersion>1.0</SchemaVersion>
<InstanceId>i-bp1cpoxxxwxxxxxxxxxx</InstanceId>
<MaxResults>50</MaxResults>
<Entries>
    <PlatformName>centos</PlatformName>
    <PlatformVersion>8.2.2004</PlatformVersion>
    <Status>Running</Status>
    <InstanceId>i-bp1cpoxxxwxxxxxxxxxx</InstanceId>
    <AgentVersion>v1.0.4</AgentVersion>
    <ComputerName>i-bp1cpoxxxwxxxxxxxxxx</ComputerName>
    <IpAddress>192.168.00.000</IpAddress>
    <AgentName>oosutil</AgentName>
    <PlatformType>linux</PlatformType>
</Entries>

JSON format

{
	"TypeName": "ACS:InstanceInformation",
	"CaptureTime": "2020-09-17T12:28:13Z",
	"RequestId": "F2727F63-CDC5-45A1-995E-4F1127E001CE",
	"SchemaVersion": "1.0",
	"InstanceId": "i-bp1cpoxxxwxxxxxxxxxx",
	"MaxResults": 50,
	"Entries": [
		{
			"PlatformName": "centos",
			"PlatformVersion": "8.2.2004",
			"Status": "Running",
			"InstanceId": "i-bp1cpoxxxwxxxxxxxxxx",
			"AgentVersion": "v1.0.4",
			"ComputerName": "i-bp1cpoxxxwxxxxxxxxxx",
			"IpAddress": "192.168.00.000",
			"AgentName": "oosutil",
			"PlatformType": "linux"
		}
	]
}

Error codes

For a list of error codes, visit the API Error Center.