ListInstancesWithEcsInfo_操作系统智能运维平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
sysom:ListInstancesWithEcsInfo
Get
全部资源
*

请求语法

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

请求参数

字段名称字段详情
regionstring

通过区域过滤实例

示例值:cn-shenzhen
instance_idstring

指定本字段,则过滤出指定实例的 Agent 安装情况

示例值:i-bp118piqcio9tiwgh84b参考取值来源:
    ListPluginsInstances
instance_namestring

组件实例名称。

示例值:block-load-balancer-hjdm9参考取值来源:
    ListPluginsInstances
instance_id_namestring

通过实例名称或者实例 id 过滤,支持模糊查询

示例值:84b
is_managedinteger<int32>

通过实例的纳管状态过滤

示例值:1
instance_tagobject

通过实例标签过滤

public_ipstring

通过公网 ip 地址过滤实例

示例值:1.1.1.1
private_ipstring

通过私网 ip 地址过滤实例

示例值:1.1.1.1
resource_group_namestring

通过资源组名称过滤实例

示例值:default resource group
resource_group_idstring

通过资源组 ID 过滤实例

示例值:rg-xxxxxxx
resource_group_id_namestring

通过资源组名称或者资源组 id 过滤,支持模糊查询

示例值:default
health_statusstring

通过健康状态过滤实例

示例值:healthy
os_namestring

通过实例操作系统名称过滤

示例值:Alibaba Cloud Linux 3.2104 LTS 64bit
currentinteger<int32>

页码分页时存在该字段,表示当前页

示例值:1
pageSizeinteger<int32>

每页大小,默认值为 10

示例值:10

返回参数

字段名称字段详情
codestring

状态码。

示例值:Success
messagestring

错误信息,空代表数据已经读取完毕

示例值:result: code=1 msg=(Request failed, status_code != 200)
dataarray<object>

返回数据。

request_idstring

请求 RequestId

示例值:35F91AAB-5FDF-5A22-B211-C7C6B00817D0
totalinteger<int64>

总记录数

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:319

返回示例

变更历史

变更时间变更内容概要操作
2025-03-12
变更返回参数
2025-02-17
新增OpenAPI,获取包含ECS信息的实例列表

相关示例

2024年08月20日