All Products
Search
Document Center

CloudOps Orchestration Service:GetInventorySchema

Last Updated:Oct 14, 2024

Queries the properties of a configuration list.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oos:GetInventorySchemaget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
AggregatorbooleanNo

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
TypeNamestringNo

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
MaxResultsintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 50.

50
NextTokenstringNo

A pagination token. It can be used in the next request to retrieve a new page of results.

gAAAAABfh8MVLQI9AuKGACLgjbsXbWs-Mna47IDM6tr6wK7TZ1

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The pagination token that was used in the next request to retrieve a new page of results.

gAAAAABfh8MVLQI9AuKGACLgjbsXbWs-Mna47IDM6tr6wK7TZ1
RequestIdstring

The request ID.

89117642-7167-4F4D-B7F1-876582279E3E
MaxResultsstring

The number of entries per page.

1
Schemasarray<object>

The detailed configurations of the configuration list.

Schemaobject
Versionstring

The version of the configuration list.

1.0
TypeNamestring

The name of the configuration list.

ACS:Application
Attributesarray<object>

The properties of the configuration list.

Attributeobject
Namestring

The name of the property.

ApplicationType
DataTypestring

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.

Change history

Change timeSummary of changesOperation
No change history