查询链路追踪应用下的组件信息（V2） - SearchSkywalkingApps

功能介绍

查询链路追踪应用下的组件信息。

调用方法

请参见如何调用API。

授权信息

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

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

apm:application:getEnv

Read

-

g:EnterpriseProjectId

apm:apm2BusinessEnv:get

-

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

URI

POST /v2/apm-service/sw/app-mgr/search

请求参数

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

表2 请求Body参数
参数	是否必选	参数类型	描述
page	是	Integer	页码。
page_size	否	Integer	每页条数。
keyword	否	String	关键字。
business_id	是	Long	应用id。
region	是	String	区域名称。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
sw_app_info_list	Array of SwAppInfo objects	组件列表。
sw_app_total_count	Integer	组件总数目。
sw_app_info_map	Map<String,SwAppInfo>	组件名称和组件详情map表。

表4 SwAppInfo
参数	参数类型	描述
env_name	String	环境名称。
online_count	Integer	在线探针数。
env_id	Long	环境id。
disable_count	Integer	手动停止探针数。
app_name	String	组件名称。
offline_count	Integer	离线探针数。
app_id	Long	组件id。
app_type	String	应用类型。

请求示例

/v2/apm-service/sw/app-mgr/search

{
  "business_id" : 1189924,
  "region" : "cn-north-7",
  "keyword" : "",
  "page" : 1,
  "page_size" : 10
}

响应示例

状态码：200

{
  "sw_app_info_list" : [ {
    "env_name" : "dev",
    "online_count" : 0,
    "env_id" : 375760,
    "disable_count" : 0,
    "app_name" : "java",
    "offline_count" : 1,
    "app_id" : 610278,
    "app_type" : "JAVA"
  } ],
  "sw_app_total_count" : 1,
  "sw_app_info_map" : {
    "375760" : {
      "env_name" : "dev",
      "online_count" : 0,
      "env_id" : 375760,
      "disable_count" : 0,
      "app_name" : "java",
      "offline_count" : 1,
      "app_id" : 610278,
      "app_type" : "JAVA"
    }
  }
}