获取链路追踪应用下环境的探针信息 - ListSkywalkingEnvInstances

功能介绍

获取链路追踪应用下环境的探针信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

apm:application:getInstance

Read

-

g:EnterpriseProjectId

apm:apm2BusinessInstance:get

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
apm:application:getInstance	Read	-	g:EnterpriseProjectId	apm:apm2BusinessInstance:get	-

URI

POST /v2/view/sw/mainview/get-env-instance-list

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token。
x-business-id	是	Long	应用id。

表2 请求Body参数
参数	是否必选	参数类型	描述
page	是	Integer	页码。
env_id	是	Long	环境id。
status	否	Integer	按探针状态进行过滤。枚举值： 0：在线状态 1：停止状态 2：离线状态
page_size	否	Integer	每页包含数据。
keyword	否	String	关键字。
return_count	否	Boolean	是否需要按状态进行统计。默认为false。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
disable_count	Integer	停止实例总数。
total_count	Integer	实例总数。
instance_info_list	Array of SwInstanceInfo objects	实例信息列表。
online_count	Integer	在线实例总数。
offline_count	Integer	离线实例总数。
cmdb_datasource_type	String	应用类型。

表4 SwInstanceInfo
参数	参数类型	描述
instance_id	Long	实例id。
app_type	String	应用类型。
business_id	Long	应用id。
app_name	String	组件名称。
last_heartbeat	Long	最后心跳时间。
host_name	String	主机名称。
ip_address	String	主机ip地址。
env_id	Long	环境ID。
register_time	Long	注册时间。
instance_status	Integer	实例状态，0表示启用，1表示停用，2表示离线。
last_modify_time	Long	最后修改时间。
instance_name	String	实例名称。
business_name	String	应用名称。

请求示例

/v2/view/sw/mainview/get-env-instance-list

{
  "page" : 1,
  "page_size" : 10,
  "status" : 0,
  "env_id" : 1628824,
  "keyword" : "",
  "return_count" : true
}

响应示例

状态码：200

{
  "disable_count" : 0,
  "total_count" : 1,
  "instance_info_list" : [ {
    "instance_id" : 171866,
    "last_heartbeat" : 1767752458000,
    "host_name" : "GPt6B",
    "ip_address" : "100.91.60.51",
    "register_time" : 1767751946000,
    "instance_status" : 0,
    "last_modify_time" : 0,
    "instance_name" : "GPt6B@100.91.60.51@d2ee1dfb686744a1b0"
  } ],
  "online_count" : 0,
  "offline_count" : 0,
  "cmdb_datasource_type" : "SKYWALKING"
}