查询智能体列表 - ListOpsAgent
功能介绍
在观测页面查询智能体列表。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
GET /v1/ops/observation/agents
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| agent_id | 否 | String | 参数解释: 智能体ID。 约束限制: 长度限制1-64位。 取值范围: 不涉及。 默认取值: 不涉及。 |
| page | 是 | Integer | 参数解释: 页码。 约束限制: 不涉及。 取值范围: 取值范围1-10000。 默认取值: 不涉及。 |
| page_size | 是 | Integer | 参数解释: 查询结果每页最多显示的条数。 约束限制: 不涉及。 取值范围: 取值范围1-1000。 默认取值: 不涉及。 |
| agent_name | 否 | String | 参数解释: 智能体名称。 约束限制: 长度限制1-64。 取值范围: 不涉及。 默认取值: 不涉及。 |
| agent_type | 否 | String | 参数解释: 智能体类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| source | 否 | String | 参数解释: 来源。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| time_order | 否 | Boolean | 参数解释: 默认创建时间倒序排列。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| start_time | 否 | Long | 参数解释: 开始时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: Unix时间戳,单位为ms。 |
| end_time | 否 | Long | 参数解释: 截止时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: Unix时间戳,单位为ms。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| app_info_list | Array of AgentInfo objects | 参数解释: 智能体列表。 取值范围: 不涉及。 |
| total_count | Integer | 参数解释: 智能体在库总数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| source | String | 参数解释: 智能体来源。 取值范围: |
| agent_id | String | 参数解释: 智能体ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 智能体名称。 取值范围: 不涉及。 |
| agent_type | String | 参数解释: 智能体类型。 取值范围: |
| create_time | Long | 参数解释: 创建时间。 取值范围: 不涉及。 |
| total_token | Double | 参数解释: 按照给定时间计算出tokens消耗。 取值范围: 不涉及。 |
| avg_request_count | Double | 参数解释: 平均请求次数 单位为分钟。 取值范围: 不涉及。 |
| avg_duration_time | Double | 参数解释: 平均延迟时间 延迟时间总和除以次数。 取值范围: 不涉及。 |
| avg_fail_count | Double | 参数解释: 平均请求失败次数 单位为分钟。 取值范围: 不涉及。 |
| apm_app_id | String | 参数解释: apm的app_id,非必填。 取值范围: 不涉及。 |
| aom_prom_id | String | 参数解释: aom的app_id,非必填。 取值范围: 不涉及。 |
| apm_app_token | String | 参数解释: apm token,加密存储,非必填。 取值范围: 不涉及。 |
| aom_access_code | String | 参数解释: aom access_code,加密存储,非必填。 取值范围: 不涉及。 |
| lts_group_id | String | 参数解释: lts_group_id,非必填。 取值范围: 不涉及。 |
| lts_stream_id | String | 参数解释: lts_stream_id,非必填。 取值范围: 不涉及。 |
| lts_label_name | String | 参数解释: 用于过滤lts日志标签。 取值范围: 不涉及。 |
| apm_exporter_endpoint | String | 参数解释: apm上报地址。 取值范围: 不涉及。 |
| aom_exporter_endpoint | String | 参数解释: aom上报地址。 取值范围: 不涉及。 |
| deleted | Integer | 参数解释: 是否被刪除。 取值范围: 不涉及。 |
请求示例
GET https://*.com/v1/ops/observation/agents?page=1&page_size=1000&agent_type=agent
响应示例
状态码:200
参数解释:
响应码,用于标识接口调用结果。
取值范围:
200表示成功,其他值表示失败,具体参见错误码文档。
{
"total_count" : 1,
"app_info_list" : [ {
"agent_id" : "000b2b01-6279-4c7a-a4e5-08fdca69cc66",
"agent_type" : "agent",
"create_time" : 1775728318359,
"name" : "testagent"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 200表示成功,其他值表示失败,具体参见错误码文档。 |
错误码
请参见错误码。