更新时间:2024-04-29 GMT+08:00
分享

获取实例信息列表

功能介绍

获取实例信息列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/apm2/openapi/view/mainview/get-env-instance-list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

x-business-id

Long

应用id。

表2 请求Body参数

参数

是否必选

参数类型

描述

env_id

Long

环境id。

page

Integer

当前页码。

page_size

Integer

每页数据容量。

keyword

String

关键字。

status

Integer

实例状态。

return_count

Boolean

是否返回计数结果。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

instance_info_list

Array of InstanceInfo objects

实例信息列表。

total_count

Integer

实例总数。

online_count

Integer

在线实例总数。

offline_count

Integer

离线实例总数。

disable_count

Integer

停止实例总数。

表4 InstanceInfo

参数

参数类型

描述

instance_id

Long

实例id。

business_name

String

应用名称。

business_id

Long

应用id。

app_name

String

组件名称。

host_name

String

主机名称。

instance_name

String

实例名称。

ip_address

String

主机ip地址。

env_id

Long

环境ID。

agent_version

String

Javaagent版本。

last_heartbeat

Long

最后心跳时间。

register_time

Long

注册时间。

last_modify_user_id

String

最后修改用户id。

instance_status

Integer

实例状态。

last_modify_user_name

String

最后修改用户名称。

last_modify_time

Long

最后修改时间。

请求示例

分页查询环境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,
    "business_name" : null,
    "business_id" : null,
    "app_name" : null,
    "host_name" : "apm2-apm-pu-task-6b5bbfc84d-rxlhr",
    "instance_name" : "default",
    "ip_address" : "*.*.*.*",
    "env_id" : null,
    "agent_version" : "2.2.8",
    "last_heartbeat" : 1666682386000,
    "register_time" : 1666664387000,
    "last_modify_user_id" : null,
    "instance_status" : 0,
    "last_modify_user_name" : null,
    "last_modify_time" : 0
  }, {
    "instance_id" : 16,
    "business_name" : null,
    "business_id" : null,
    "app_name" : null,
    "host_name" : "apm2-apm-pu-task-6b5bbfc84d-gtrrs",
    "instance_name" : "default",
    "ip_address" : "*.*.*.*",
    "env_id" : null,
    "agent_version" : "2.2.8",
    "last_heartbeat" : 1666682377000,
    "register_time" : 1666664436000,
    "last_modify_user_id" : null,
    "instance_status" : 0,
    "last_modify_user_name" : null,
    "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,没有找到要请求的资源。

错误码

请参见错误码

分享:

    相关文档

    相关产品