查询配置清单的详细信息或聚合信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
oos:SearchInventory | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
NextToken | string | 否 | 翻页标记的 Token。 | gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC |
MaxResults | integer | 否 | 分页大小。取值范围:1-100。默认为 50。 | 50 |
Filter | array<object> | 否 | 组件过滤规则。 | |
object | 否 | |||
Value | array | 否 | 组件属性查询值列表。 | |
string | 否 | 组件属性查询值。 | i-bp1cpoxxxxxxxxxxxxxx | |
Operator | string | 否 | 组件属性查询值比较符(N 取值范围 1-5)。 取值范围:
| Equal |
Name | string | 否 | 组件的属性名称(N 取值范围 1-5)。不同的组件内部属性的名称不同。使用 GetInventorySchema 查询不同组件的属性名称。例如:组件 ACS:InstanceInformation 下有 InstanceId 这个属性,所以本参数则取值为 ACS:InstanceInformation.InstanceId。 | ACS:InstanceInformation.InstanceId |
Aggregator | array | 否 | 聚合器。可以使用一个或多个聚合器查询实例聚合信息。 取值范围:
| |
string | 否 | 聚合器。 | ACS:Application.Name |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
"RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
"MaxResults": 50,
"Entities": [
{
"test": "test",
"test2": 1
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-12-19 | OpenAPI 描述信息更新 | 查看变更详情 |
2024-07-01 | API 内部配置变更,不影响调用 | 查看变更详情 |