ListAllInstances - 获取所有实例及其完整信息 - Alibaba Cloud Linux

此接口用于获取已纳管/未纳管实例列表并带有实例信息

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sysom:ListAllInstances

list

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
region	string	否	地域 ID。	cn-hangzhou
instanceType	string	否	实例类型。	ecs
managedType	string	否	纳管类型	managed
filters	string	否	过滤信息列表	{}
current	string	否	当前所在分页	1
pageSize	string	否	每页返回数目，默认 pageSize=10	10
pluginId	string	否	插件 ID	01fc4a0b-f199-4885-9861-b4054a310fe7
maxResults	integer	否	一次获取的最大记录数	100
nextToken	string	否	分页游标。说明如果该参数不为空，表示还有更多数据。	U+w1wv2R4ZWR5oZLXD0+Dp4dD+2BRJj42DLT6GrZysw=
X-Debug-Id	string	否
x-sysom-invoke-source	string	否

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822
code	string	状态码	Success
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	instance not exists
total	integer	查询结果总数。	2
data	array<object>	返回数据
	array<object>	返回结果。
instanceId	string	实例 ID	i-bp17uabeke9v7n30abm2
osHealthScore	integer	操作系统健康分	100
resourceGroupName	string	资源组名称	xxxx
instanceName	string	实例名称。	test
installType	string	安装类型	console
instanceType	string	实例类型	ecs
installLevel	string	安装级别	Cluster
attributes	array<object>	扩展信息。
	object	扩展信息。
infoValue	string	信息值	diagnosis
infoType	string	信息类型	instance_tag
infoKey	string	信息键	sysom
resourceGroupId	string	资源组 ID。	3b24a621-acb3-11ef-8c90-00163e1029af
osName	string	操作系统名称	alios
status	string	实例的运行状态，取值： Running：正在运行 Offline：离线说明处于 Offline 状态的实例代表节点到 SysOM 服务端的心跳丢失，并不代表对应的 ECS 实例没有运行。	Running
clusterId	string	集群 id	3b24a621-acb3-11ef-8c90-00163e1029af
osArch	string	操作系统架构	x86_64
kernelVersion	string	内核版本	5.10.134-18.al8.x86_64
imageId	string	镜像 ID。	aliyun_3_x64_20G_alibase_20250117.vhd
manageType	string	纳管类型	managed
manageLevel	string	纳管级别	cluster
clusterName	string	集群名称	zjk_vpc_domain_1
publicIp	string	公网 IP 地址。	47.98.215.58
privateIp	string	私网 IP 地址。	172.21.172.7
agentConfigId	string	agent 配置 ID	test_id
agentConfigName	string	agent 配置名称	test_name
maxResults	integer	最大返回数量	20
nextToken	string	分页游标。说明不为空表示有更多数据。	c2f78a783f49457caba6bace6f6f79e4

示例

正常返回示例

JSON格式

{
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n",
  "code": "Success",
  "message": "instance not exists",
  "total": 2,
  "data": [
    {
      "instanceId": "i-bp17uabeke9v7n30abm2",
      "osHealthScore": 100,
      "resourceGroupName": "xxxx",
      "instanceName": "test",
      "installType": "console",
      "instanceType": "ecs",
      "installLevel": "Cluster",
      "attributes": [
        {
          "infoValue": "diagnosis",
          "infoType": "instance_tag",
          "infoKey": "sysom"
        }
      ],
      "resourceGroupId": "3b24a621-acb3-11ef-8c90-00163e1029af",
      "osName": "alios",
      "status": "Running",
      "clusterId": "3b24a621-acb3-11ef-8c90-00163e1029af",
      "osArch": "x86_64",
      "kernelVersion": "5.10.134-18.al8.x86_64",
      "imageId": "aliyun_3_x64_20G_alibase_20250117.vhd",
      "manageType": "managed",
      "manageLevel": "cluster",
      "clusterName": "zjk_vpc_domain_1",
      "publicIp": "47.98.215.58",
      "privateIp": "172.21.172.7",
      "agentConfigId": "test_id",
      "agentConfigName": "test_name"
    }
  ],
  "maxResults": 20,
  "nextToken": "c2f78a783f49457caba6bace6f6f79e4"
}

错误码

HTTP status code	错误码	错误信息	描述
400	Sysom.ServerError	Server error, please correct the code according to the error message. %s.	服务端错误，请根据错误提示信息修正代码

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

变更历史

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