GetInventorySchema - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Queries the properties of a configuration list.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Aggregator	boolean	No	Specifies whether to return only properties that support the aggregate feature in the configuration list. Valid values: true: only returns properties that support the aggregate feature in the configuration list. false: returns all properties in the configuration list.	false
TypeName	string	No	The configuration list type name. Valid values: ACS:InstanceInformation ACS:Application ACS:File ACS:Network ACS:WindowsRole ACS:Service ACS:WindowsUpdate ACS:WindowsRegistry	ACS:Application
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 50.	50
NextToken	string	No	A pagination token. It can be used in the next request to retrieve a new page of results.	gAAAAABfh8MVLQI9AuKGACLgjbsXbWs-Mna47IDM6tr6wK7TZ1

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	The pagination token that was used in the next request to retrieve a new page of results.	gAAAAABfh8MVLQI9AuKGACLgjbsXbWs-Mna47IDM6tr6wK7TZ1
RequestId	string	The request ID.	89117642-7167-4F4D-B7F1-876582279E3E
MaxResults	string	The number of entries per page.	1
Schemas	object []	The detailed configurations of the configuration list.
Version	string	The version of the configuration list.	1.0
TypeName	string	The name of the configuration list.	ACS:Application
Attributes	object []	The properties of the configuration list.
Name	string	The name of the property.	ApplicationType
DataType	string	The data type of the property.	STRING

Examples

Sample success responses

JSONformat

{
  "NextToken": "gAAAAABfh8MVLQI9AuKGACLgjbsXbWs-Mna47IDM6tr6wK7TZ1",
  "RequestId": "89117642-7167-4F4D-B7F1-876582279E3E",
  "MaxResults": "1",
  "Schemas": [
    {
      "Version": "1.0",
      "TypeName": "ACS:Application",
      "Attributes": [
        {
          "Name": "ApplicationType",
          "DataType": "STRING"
        }
      ]
    }
  ]
}

Error codes

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