Queries the properties of a component.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes GetInventorySchema

The operation that you want to perform. Set the value to GetInventorySchema.
Aggregator Boolean Yes false

Specifies whether only to return a combination of specified properties.

Valid values:

  • true: only returns a combination of specified properties
  • false: returns all properties of the component
TypeName String Yes ACS:Application

The name of the component. Valid values:

  • ACS:InstanceInformation
  • ACS:Application
  • ACS:File
  • ACS:Network
  • ACS:WindowsRole
  • ACS:Service
  • ACS:WindowsUpdate
  • ACS:WindowsRegistry
RegionId String No cn-hangzhou

The ID of the region.
MaxResults Integer No 50

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

NextToken String No gAAAAABfh8MVLQI9AuKGACLgjbsXbWs-Mna47IDM6tr6wK7TZ1

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

Response parameters

Parameter Type Example Description
NextToken String gAAAAABfh8MVLQI9AuKGACLgjbsXbWs-Mna47IDM6tr6wK7TZ1

The token that is used to retrieve the next page of results.
RequestId String 89117642-7167-4F4D-B7F1-876582279E3E

The ID of the request.
Schemas Array of Schema

The detailed configurations of the component.
Attributes Array of Attribute

The properties of component.
DataType String STRING

The data type of the property.
Name String ApplicationType

The name of the property.
TypeName String ACS:Application

The name of the component.
Version String 1.0

The version of the component.

Examples

Sample requests

http(s)://[Endpoint]/? Aggregator=false
&TypeName=ACS:Application
&<Common request parameters>

Sample success responses

XML format 

<RequestId>4C7475E8-6B0C-4550-B39F-A2A237863E1E</RequestId>
<Schemas>
    <TypeName>ACS:Application</TypeName>
    <Version>1.0</Version>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>Name</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>ApplicationType</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>Publisher</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>Version</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>InstalledTime</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>Architecture</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>URL</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>Summary</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>PackageId</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>Release</Name>
    </Attributes>
    <Attributes>
        <DataType>STRING</DataType>
        <Name>Epoch</Name>
    </Attributes>
</Schemas>

JSON format 

{
	"RequestId": "4C7475E8-6B0C-4550-B39F-A2A237863E1E",
	"Schemas": [
		{
			"TypeName": "ACS:Application",
			"Version": "1.0",
			"Attributes": [
				{
					"DataType": "STRING",
					"Name": "Name"
				},
				{
					"DataType": "STRING",
					"Name": "ApplicationType"
				},
				{
					"DataType": "STRING",
					"Name": "Publisher"
				},
				{
					"DataType": "STRING",
					"Name": "Version"
				},
				{
					"DataType": "STRING",
					"Name": "InstalledTime"
				},
				{
					"DataType": "STRING",
					"Name": "Architecture"
				},
				{
					"DataType": "STRING",
					"Name": "URL"
				},
				{
					"DataType": "STRING",
					"Name": "Summary"
				},
				{
					"DataType": "STRING",
					"Name": "PackageId"
				},
				{
					"DataType": "STRING",
					"Name": "Release"
				},
				{
					"DataType": "STRING",
					"Name": "Epoch"
				}
			]
		}
	]
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter The parameter is invalid. The error message returned because the specified parameter is invalid.

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