文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ APM/ 对指定区域下的组件和环境及其探针情况进行搜索
更新时间:2024-08-16 GMT+08:00
分享

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

功能介绍

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

调试

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

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,没有找到要请求的资源。

错误码

请参考错误码

相关文档