ListInstancesEcsInfoList - 获取实例的ecs信息的列表 - Alibaba Cloud Linux

接口说明

当前接口获取的实例列表是已经被 SysOM 纳管的机器列表，如果某个 ECS 实例存在但是没有被 SysOM 纳管，则不会出现在列表当中。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:ListInstancesEcsInfoList

get

*全部资源

*

无

请求语法

GET /api/v1/am/instance/listInstancesEcsInfoList HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
region	string	是	通过区域过滤实例	cn-shenzhen
info_type	string	是	需要获取的信息类型	ip
managed_type	string	否	实例的纳管状态	managed
instance_id	string	否	指定本字段，则过滤出指定实例的 Agent 安装情况	i-bp118piqcio9tiwgh84b
plugin_id	string	否	指定本参数则过滤出对应组件的实例信息列表	74a86327-3170-412c-8e67-da3389ec56a9

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	错误码	SysomOpenAPI.InvalidParameter
data	array<object>	返回数据。
	object	返回结果。
ip	string	机器的 IP 地址。	11.193.52.91
tag_key	string	标签的名称。	sysom
tag_value	string	标签值。	diagnosis
type	string	ip 类型	public
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	""

示例

正常返回示例

JSON格式

{
  "code": "SysomOpenAPI.InvalidParameter",
  "data": [
    {
      "ip": "11.193.52.91",
      "tag_key": "sysom",
      "tag_value": "diagnosis",
      "type": "public"
    }
  ],
  "message": "\"\""
}

错误码

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

变更历史

更多信息，参考变更详情。