ListInstances - 获取纳管实例列表 - Alibaba Cloud Linux

获取实例列表

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sysom:ListInstances

list

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
current	integer	否	页码分页时存在该字段，表示当前页	1
pageSize	integer	否	每页大小，默认值为 20，取值范围【1,100】	10
instance	string	否	通过 ECS 实例 ID 过滤	i-8vbfd3g9vs32sfuvv38h
status	string	否	通过状态过滤实例	Running
region	string	否	通过区域过滤实例	cn-shenzhen
cluster_id	string	否	集群 ID	xxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	SysomOpenAPI.ServerError
data	array<object>	返回结果。
	object	返回结果。
cluster_id	string	集群 ID	c2218ca2b76ec45e7b7ee1693f6fcd374
instance	string	ECS 实例 ID	i-wz9d00ut2ska3mlyhn6j
kernel_version	string	实例当前的内核版本	5.10.134-16.1.an8.x86_64
meta	any	实例的元数据信息	{ "uname": "Linux", "oncpu": "off", "release": "5.10.134-16.3.al8.aarch64", "monitor": "on", "version_id": "3", "version": "3 (Soaring Falcon)", "podNs": [ ], "machine": "aarch64", "name": "Alibaba Cloud Linux", "sysak": "3.4.0-1", "id": "alinux", "region": "cn-hangzhou", "centos-release": "Alibaba Cloud Linux release 3 (Soaring Falcon)" }
os_arch	string	ECS 实例的架构	x86
os_health_score	string	实例的健康分	100
os_name	string	实例的操作系统名称（取自 /etc/os-release）	Anolis OS
os_name_id	string	实例的操作系统名称 ID（取自 /etc/os-release）	anolis
os_version	string	实例的操作系统版本（取自 /etc/os-release）	8.9
os_version_id	string	实例操作系统版本 ID（取自 /etc/os-release）	rhel fedora centos
region	string	实例所在区域	cn-hangzhou
status	string	实例的状态	Running
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	Requests for llm service failed
request_id	string	请求 RequestId	9515E5A0-8905-59B0-9BBF-5F0BE568C3A0
total	integer	总记录数	623

示例

正常返回示例

JSON格式

{
  "code": "SysomOpenAPI.ServerError\n",
  "data": [
    {
      "cluster_id": "c2218ca2b76ec45e7b7ee1693f6fcd374",
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "kernel_version": "5.10.134-16.1.an8.x86_64",
      "meta": "{\n    \"uname\": \"Linux\",\n    \"oncpu\": \"off\",\n    \"release\": \"5.10.134-16.3.al8.aarch64\",\n    \"monitor\": \"on\",\n    \"version_id\": \"3\",\n    \"version\": \"3 (Soaring Falcon)\",\n    \"podNs\": [\n\n    ],\n    \"machine\": \"aarch64\",\n    \"name\": \"Alibaba Cloud Linux\",\n    \"sysak\": \"3.4.0-1\",\n    \"id\": \"alinux\",\n    \"region\": \"cn-hangzhou\",\n    \"centos-release\": \"Alibaba Cloud Linux release 3 (Soaring Falcon)\"\n}",
      "os_arch": "x86",
      "os_health_score": "100",
      "os_name": "Anolis OS",
      "os_name_id": "anolis",
      "os_version": "8.9",
      "os_version_id": "rhel fedora centos",
      "region": "cn-hangzhou",
      "status": "Running"
    }
  ],
  "message": "Requests for llm service failed\n",
  "request_id": "9515E5A0-8905-59B0-9BBF-5F0BE568C3A0",
  "total": 623
}

错误码

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

变更历史

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