# 获取链路追踪探针实例（V2） - SearchSkywalkingAgents #### 功能介绍 获取链路追踪探针实例。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-apm/apm_04_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apm/apm_04_0021.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | apm:application:getInstance | Read | - | g:EnterpriseProjectId | apm:apm2BusinessInstance:get | - | #### URI POST /v2/apm-service/sw/agent-mgr/search #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 | | x-business-id | 是 | Long | 应用id。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | page | 是 | Integer | 需要查询的页码，最小数为1。 | | page_size | 是 | Integer | 查询结果每页最多显示的条数。 | | keyword | 是 | String | 关键字。 | | env_id | 否 | Long | 环境id。 | | business_id | 是 | Long | 应用id。 | | status | 否 | String | 探针状态。 枚举值： online，表示探针启用。 disable，表示探针停用。 offline，表示探针离线。 | | region | 是 | String | region的英文名称。 | | order | 否 | String | 是否按照采集状态排序，不填则按照id升序排序，填y则按照状态升序排序。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_page | Integer | 总页数。 | | total_count | Integer | 总个数。 | | online_count | Integer | 正常个数。 | | offline_count | Integer | 离线个数。 | | disable_count | Integer | 被关闭的个数。 | | agent_info_list | Array of [SwInstanceInfo_AgentSearch] objects | agent实例列表。 | 表4SwInstanceInfo_AgentSearch | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | Long | 实例id。 | | app_type | String | 应用类型。 | | app_name | String | 组件名称。 | | last_heartbeat | Long | 最后心跳时间。 | | host_name | String | 主机名称。 | | ip_address | String | 主机ip地址。 | | env_id | Long | 环境ID。 | | register_time | Long | 注册时间。 | | instance_status | Integer | 实例状态，0表示启用，1表示停用，2表示离线。 | | last_modify_time | Long | 最后修改时间。 | | instance_name | String | 实例名称。 | | business_name | String | 应用名称。 | #### 请求示例 ``` /v2/apm-service/sw/agent-mgr/search { "page" : 1, "page_size" : 10, "keyword" : "", "business_id" : 1189733, "region" : "cn-north-4" } ``` #### 响应示例 **状态码：200** OK ``` { "total_page" : 1, "total_count" : 3, "online_count" : 0, "offline_count" : 3, "disable_count" : 0, "agent_info_list" : [ { "instance_id" : 170254, "app_type" : "JAVA", "app_name" : "java/dev", "last_heartbeat" : 1766744733000, "host_name" : "GPt6B", "ip_address" : "100.91.60.58", "env_id" : 375295, "register_time" : 1766744642000, "instance_status" : 2, "last_modify_time" : 1766744733000, "instance_name" : "GPt6B", "business_name" : "sky-demo" }, { "instance_id" : 170256, "app_type" : "JAVA", "app_name" : "java/dev", "last_heartbeat" : 1766746221000, "host_name" : "GPt6B", "ip_address" : "100.91.60.58", "env_id" : 375295, "register_time" : 1766744959000, "instance_status" : 2, "last_modify_time" : 1766746220000, "instance_name" : "GPt6B", "business_name" : "sky-demo" }, { "instance_id" : 170653, "app_type" : "JAVA", "app_name" : "java/dev10", "last_heartbeat" : 1767517140000, "host_name" : "GPt6B", "ip_address" : "100.91.60.58", "env_id" : 375649, "register_time" : 1767012119000, "instance_status" : 2, "last_modify_time" : 1767517140000, "instance_name" : "GPt6B", "business_name" : "sky-demo" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | | 400 | Bad Request。 | | 403 | Forbidden。 | | 429 | Too Many Requests。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-apm/ErrorCode.html)。