对指定区域下的组件和环境及其探针情况进行搜索 - SearchApplication

功能介绍

对指定区域下的组件和环境及其探针情况进行搜索。

调用方法

请参见如何调用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 /v1/apm2/openapi/apm-service/app-mgr/search

请求参数

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

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

响应参数

状态码： 200

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

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

请求示例

搜索Region ID为cn-north-4，应用id为6的探针情况，并设定页码为1，单页大小为10。

/v1/apm2/openapi/apm-service/app-mgr/search

{
  "business_id" : 6,
  "region" : "xx-xxxx-xxx",
  "keyword" : "",
  "page" : 1,
  "page_size" : 10
}

响应示例

状态码： 200

OK，请求响应成功。

{
  "app_info_list" : [ {
    "env_name" : "beta",
    "env_id" : 1,
    "app_name" : "application_name",
    "app_id" : 2,
    "online_count" : 2,
    "disable_count" : 1,
    "offline_count" : 1
  } ],
  "app_total_count" : 4,
  "app_info_map" : {
    "additionalProp1" : {
      "env_name" : "string",
      "env_id" : 0,
      "app_name" : "string",
      "app_id" : 0,
      "online_count" : 0,
      "disable_count" : 0,
      "offline_count" : 0
    },
    "additionalProp2" : {
      "env_name" : "string",
      "env_id" : 0,
      "app_name" : "string",
      "app_id" : 0,
      "online_count" : 0,
      "disable_count" : 0,
      "offline_count" : 0
    },
    "additionalProp3" : {
      "env_name" : "string",
      "env_id" : 0,
      "app_name" : "string",
      "app_id" : 0,
      "online_count" : 0,
      "disable_count" : 0,
      "offline_count" : 0
    }
  }
}

状态码

状态码	描述
200	OK，请求响应成功。
400	Bad Request，语义或参数有误。
401	Unauthorized，没有权限。
403	Forbidden，禁止访问。
404	Not Found，没有找到要请求的资源。