查询应用下所有探针
功能介绍
该接口用于搜索应用下所有探针情况。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/apm2/openapi/apm-service/agent-mgr/search
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
|
x-business-id |
是 |
Long |
应用id。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
business_id |
是 |
Long |
应用id。 |
|
env_id |
否 |
Long |
环境id。 |
|
status |
否 |
String |
探针状态。 枚举值：
|
|
region |
是 |
String |
region英文名称。 |
|
order_by_status |
否 |
String |
是否按照采集状态排序，默认不填则不按状态排序，填y则按照状态排序。 |
|
page |
是 |
Integer |
需要查询的页码，最小数为1。 |
|
page_size |
否 |
Integer |
查询结果每页最多显示的条数。 |
|
keyword |
否 |
String |
关键字。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_page |
Integer |
总页数。 |
|
total_count |
Integer |
总个数。 |
|
online_count |
Integer |
正常个数。 |
|
offline_count |
Integer |
心跳异常个数。 |
|
disable_count |
Integer |
被关闭的个数。 |
|
agent_info_list |
Array of InstanceInfo objects |
agent地址列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
实例状态，0表示启用，1表示停用，2表示离线。 |
|
last_modify_user_name |
String |
最后修改用户名称。 |
|
last_modify_time |
Long |
最后修改时间。 |
请求示例
分页查询Region ID为cn-north-4，应用ID为6的所有探针情况。
/v1/apm2/openapi/apm-service/agent-mgr/search
{
"region" : "*.*.*.*",
"page" : 1,
"page_size" : 10,
"business_id" : 6
}
响应示例
状态码： 200
OK，请求响应成功。
{
"total_page" : 1,
"total_count" : 1,
"online_count" : 1,
"offline_count" : 0,
"disable_count" : 0,
"agent_info_list" : [ {
"instance_id" : 5298,
"business_name" : "LubanApm",
"business_id" : null,
"app_name" : "apm-data-deliver/xx-xxxx-xxx",
"host_name" : "szv*******1",
"instance_name" : "default",
"ip_address" : "*.*.*.*",
"env_id" : 1105,
"agent_version" : "2.1.16",
"last_heartbeat" : 1669684246000,
"register_time" : 1657762671000,
"last_modify_user_id" : "70iWY********VHVd",
"instance_status" : 0,
"last_modify_user_name" : "yWX",
"last_modify_time" : 1667839085000
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK，请求响应成功。 |
|
400 |
Bad Request，语义或参数有误。 |
|
401 |
Unauthorized，没有权限。 |
|
403 |
Forbidden，禁止访问。 |
|
404 |
Not Found，没有找到要请求的资源。 |
错误码
请参见错误码。
