文档

SearchInventory - 查询配置清单的详细信息或聚合信息

更新时间:

查询配置清单的详细信息或聚合信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:SearchInventoryget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
NextTokenstring

翻页标记的 Token。

gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
MaxResultsinteger

分页大小。取值范围:1-100。默认为 50。

50
Filterarray<object>

组件过滤规则。

object
Valuearray

组件属性查询值列表。

string

组件属性查询值。

i-bp1cpoxxxxxxxxxxxxxx
Operatorstring

组件属性查询值比较符(N 取值范围 1-5)。 取值范围:

  • Equal
  • NotEqual
  • BeginWith
  • LessThan
  • GreaterThan
Equal
Namestring

组件的属性名称(N 取值范围 1-5)。不同的组件内部属性的名称不同。使用 GetInventorySchema 查询不同组件的属性名称。例如:组件 ACS:InstanceInformation 下有 InstanceId 这个属性,所以本参数则取值为 ACS:InstanceInformation.InstanceId。

ACS:InstanceInformation.InstanceId
Aggregatorarray

聚合器。可以使用一个或多个聚合器查询实例聚合信息。 取值范围:

  • ACS:Application.Name
  • ACS:Application.Version
string

聚合器。

ACS:Application.Name

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的 Token

gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestIdstring

请求 ID

A81E4B2E-6B33-4BAE-9856-55DB7C893E01
MaxResultsinteger

分页大小

50
Entitiesarray<object>
Entityobject

组件查询的详细配置清单,或聚合信息。

[ { "ACS:InstanceInformation": { "CaptureTime": "2020-10-13T08:55:06Z", "SchemaVersion": "1.0", "Content": { "PlatformName": "ubuntu", "PlatformVersion": "20.04", "Status": "Running", "InstanceId": "i-bp1cpoxxxxxxxxxxxxxx", "AgentVersion": "v1.5", "ComputerName": "iZbp1cpoxxxw111jcv94drZ", "IpAddress": "192.168.10.245", "AgentName": "oosutil", "PlatformType": "linux" }, "RegionId": "cn-hangzhou" }, "Id": "i-bp1cpoxxxxxxxxxxxxxx" } ]}

示例

正常返回示例

JSON格式

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "A81E4B2E-6B33-4BAE-9856-55DB7C893E01",
  "MaxResults": 50,
  "Entities": [
    {
      "test": "test",
      "test2": 1
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-01API 内部配置变更,不影响调用查看变更详情