更新时间:2023-08-02 GMT+08:00
对指定区域下的组件和环境及其探针情况进行搜索
功能介绍
对指定区域下的组件和环境及其探针情况进行搜索。
URI
POST /v1/apm2/openapi/apm-service/app-mgr/search
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
x-business-id |
是 |
Long |
应用id。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
business_id |
是 |
Long |
应用id。 |
region |
是 |
String |
区域名称。 |
page |
是 |
Integer |
页码。 |
page_size |
是 |
Integer |
每页条数。 |
keyword |
否 |
String |
关键字。 |
响应参数
状态码: 200
请求示例
搜索Region ID为ap-southeast-3,应用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,请求响应成功。 |
401 |
Unauthorized,没有权限。 |
403 |
Forbidden,禁止访问。 |
404 |
Not Found,没有找到要请求的资源。 |
错误码
请参见错误码。
父主题: APM