获取已纳管/未纳管实例信息，信息中包含ECS信息
接口说明
当前接口获取的实例列表是已经被 SysOM 纳管的机器列表，如果某个 ECS 实例存在但是没有被 SysOM 纳管，则不会出现在列表当中。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
sysom:ListInstancesWithEcsInfo |
get |
*全部资源
|
无 | 无 |
请求语法
GET /api/v1/am/instance/listInstancesWithEcsInfo HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| region |
string |
是 |
通过区域过滤实例 |
cn-shenzhen |
| instance_id |
string |
否 |
指定本字段，则过滤出指定实例的 Agent 安装情况 |
i-bp118piqcio9tiwgh84b |
| instance_name |
string |
否 |
组件实例名称。 |
block-load-balancer-hjdm9 |
| instance_id_name |
string |
否 |
通过实例名称或者实例 id 过滤，支持模糊查询 |
84b |
| is_managed |
integer |
否 |
通过实例的纳管状态过滤 |
1 |
| instance_tag |
object |
否 |
通过实例标签过滤 |
|
| key |
string |
否 |
标签 key 值。 |
feature_dim_radar_chart |
| value |
string |
否 |
标签 value 值 |
test |
| public_ip |
string |
否 |
通过公网 ip 地址过滤实例 |
1.1.1.1 |
| private_ip |
string |
否 |
通过私网 ip 地址过滤实例 |
1.1.1.1 |
| resource_group_name |
string |
否 |
通过资源组名称过滤实例 |
default resource group |
| resource_group_id |
string |
否 |
通过资源组 ID 过滤实例 |
rg-xxxxxxx |
| resource_group_id_name |
string |
否 |
通过资源组名称或者资源组 id 过滤，支持模糊查询 |
default |
| health_status |
string |
否 |
通过健康状态过滤实例 |
healthy |
| os_name |
string |
否 |
通过实例操作系统名称过滤 |
Alibaba Cloud Linux 3.2104 LTS 64bit |
| current |
integer |
否 |
页码分页时存在该字段，表示当前页 |
1 |
| pageSize |
integer |
否 |
每页大小，默认值为 10 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| code |
string |
状态码。 |
Success |
| data |
array<object> |
返回数据。 |
|
|
array<object> |
返回结果 |
||
| cluster_id |
string |
集群 ID |
cbf7a37bc905d4682a3338b3744810269 |
| instance_id |
string |
实例 ID |
i-bp118piqcio9tiwgh84b |
| instance_name |
string |
实例名称。 |
allowed-repos-r2tzl |
| instance_tag |
array<object> |
实例标签 |
|
|
object |
|||
| tag_key |
string |
标签的名称。 |
test_tag_key |
| tag_value |
string |
标签值。 |
test_tag_value |
| kernel_version |
string |
内核版本 |
5.10.134-14.an8.x86_64 |
| os_arch |
string |
ECS 实例的架构 |
x86 |
| os_health_score |
string |
实例的健康分 |
100 |
| os_name |
string |
实例的操作系统名称 |
Alibaba Cloud Linux 3.2104 LTS 64bit |
| private_ip |
string |
实例私网 ip |
1.1.1.1 |
| public_ip |
string |
实例公网 ip |
1.1.1.1 |
| resource_group_id |
string |
资源组 ID。 |
rg-xxxxxx |
| resource_group_name |
string |
资源组名称 |
default resource group |
| status |
string |
实例的运行状态，取值：
说明
处于 Offline 状态的实例代表节点到 SysOM 服务端的心跳丢失，并不代表对应的 ECS 实例没有运行。 |
Running |
| message |
string |
错误信息，空代表数据已经读取完毕 |
result: code=1 msg=(Request failed, status_code != 200) |
| request_id |
string |
请求 RequestId |
35F91AAB-5FDF-5A22-B211-C7C6B00817D0 |
| total |
integer |
总记录数 |
319 |
示例
正常返回示例
JSON格式
{
"code": "Success",
"data": [
{
"cluster_id": "cbf7a37bc905d4682a3338b3744810269",
"instance_id": "i-bp118piqcio9tiwgh84b",
"instance_name": "allowed-repos-r2tzl",
"instance_tag": [
{
"tag_key": "test_tag_key",
"tag_value": "test_tag_value"
}
],
"kernel_version": "5.10.134-14.an8.x86_64",
"os_arch": "x86",
"os_health_score": "100",
"os_name": "Alibaba Cloud Linux 3.2104 LTS 64bit",
"private_ip": "1.1.1.1",
"public_ip": "1.1.1.1",
"resource_group_id": "rg-xxxxxx",
"resource_group_name": "default resource group",
"status": "Running"
}
],
"message": "result: code=1 msg=(Request failed, status_code != 200)",
"request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
"total": 319
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。