获取实例信息列表
功能介绍
获取实例信息列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm:application:getInstance
Read
-
g:EnterpriseProjectId
apm:apm2BusinessInstance:get
-
URI
POST /v1/apm2/openapi/view/mainview/get-env-instance-list
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 |
x-business-id | 是 | Long | 应用id。 |
响应参数
状态码: 200
参数 | 参数类型 | 描述 |
|---|---|---|
instance_info_list | Array of MainViewInstanceInfo objects | 实例信息列表。 |
total_count | Integer | 实例总数。 |
online_count | Integer | 在线实例总数。 |
offline_count | Integer | 离线实例总数。 |
disable_count | Integer | 停止实例总数。 |
请求示例
分页查询环境ID为11的实例信息列表。
/v1/apm2/openapi/view/mainview/get-env-instance-list
{
"env_id" : "11",
"page" : 1,
"page_size" : 10
} 响应示例
状态码: 200
OK,请求响应成功。
{
"instance_info_list" : [ {
"instance_id" : 15,
"host_name" : "apm2-apm-pu-task-6b5bbfc84d-rxlhr",
"instance_name" : "default",
"ip_address" : "172.16.3.39",
"agent_version" : "2.2.8",
"last_heartbeat" : 1666682386000,
"register_time" : 1666664387000,
"instance_status" : 0,
"last_modify_time" : 0
}, {
"instance_id" : 16,
"host_name" : "apm2-apm-pu-task-6b5bbfc84d-gtrrs",
"instance_name" : "default",
"ip_address" : "172.16.3.7",
"agent_version" : "2.2.8",
"last_heartbeat" : 1666682377000,
"register_time" : 1666664436000,
"instance_status" : 0,
"last_modify_time" : 0
} ],
"total_count" : 2,
"online_count" : 0,
"offline_count" : 0,
"disable_count" : 0
} 状态码
状态码 | 描述 |
|---|---|
200 | OK,请求响应成功。 |
400 | Bad Request,语义或参数有误。 |
401 | Unauthorized,没有权限。 |
403 | Forbidden,禁止访问。 |
404 | Not Found,没有找到要请求的资源。 |
错误码
请参见错误码。

