# 查询智能体列表 - ListOpsAgentObservation #### 功能介绍 在观测页面查询智能体列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-agentarts/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | agentarts::listOpsAgentObservation | List | - | - | - | - | #### URI GET /v1/ops/observation/agents 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | agent_id | 否 | String | **参数解释**： 智能体ID，获取方式通过查询智能体列表接口获取。 **约束限制**： 长度限制为1\~64个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | page | 是 | Integer | **参数解释**： 页码。 **约束限制**： 不涉及。 **取值范围**： 1\~10000。 **默认取值**： 默认值为1。 | | page_size | 是 | Integer | **参数解释**： 查询结果每页最多显示的条数。 **约束限制**： 不涉及。 **取值范围**： 1\~1000。 **默认取值**： 默认值为10。 | | agent_name | 否 | String | **参数解释**： 智能体名称。 **约束限制**： 长度限制为1\~64。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | agent_type | 否 | String | **参数解释**： 智能体类型。 **约束限制**： 不涉及。 **取值范围**： - agent：单智能体； - multiagents：多智能体； - workflow：工作流； - all：全部。 **默认取值**： 不涉及。 | | source | 否 | String | **参数解释**： 智能体的创建来源，用于按来源筛选智能体。 **约束限制**： 不涉及。 **取值范围**： - studio：通过智果平台创建； - agentrun：通过AgentRun运行； - api：通过API调用创建。 **默认取值**： 不涉及。 | | time_order | 否 | Boolean | **参数解释**： 是否按创建时间倒序排列。 **约束限制**： 不涉及。 **取值范围**： - true：按创建时间倒序排列； - false：按创建时间正序排列。 **默认取值**： 默认值为false。 | | start_time | 否 | Long | **参数解释**： 查询指标的起始时间，格式为Unix时间戳，单位为ms，例如1700000000000。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | end_time | 否 | Long | **参数解释**： 查询指标的截止时间，格式为Unix时间戳，单位为ms。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | data_type | 否 | String | **参数解释**： 是否返回已删除的数据。 **约束限制**： 不涉及。 **取值范围**： - deleted：返回已删除数据； - active返回未删除数据； - all返回全部数据。 **默认取值**： 默认值为all。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_info_list | Array of [AgentInfo] objects | **参数解释**： 智能体列表，列表元素为AgentInfo对象，包含智能体的来源、ID、名称、类型等信息。 **取值范围**： 不涉及。 | | total_count | Integer | **参数解释**： 智能体在库总数。 **取值范围**： 不涉及。 | 表3AgentInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source | String | **参数解释**： 智能体来源类型，用于标识智能体的创建来源渠道。 **取值范围**： - studio：通过智果平台创建； - agentrun：通过AgentRun运行； - api：通过API调用创建。 | | agent_id | String | **参数解释**： 智能体ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 智能体名称。 **取值范围**： 不涉及。 | | agent_type | String | **参数解释**： 智能体类型。 **取值范围**： - agent：单智能体； - multiagents：多智能体； - workflow：工作流。 | | create_time | Long | **参数解释**： 创建时间，使用Unix时间戳格式，单位为毫秒(ms)。 **取值范围**： 不涉及。 | | total_token | Double | **参数解释**： 按照给定时间计算出tokens消耗，单位为token。 **取值范围**： 不涉及。 | | avg_request_count | Double | **参数解释**： 每分钟的平均请求次数，单位为次/分钟。 **取值范围**： 不涉及。 | | avg_duration_time | Double | **参数解释**： 平均延迟时间，延迟时间总和除以请求次数，单位为毫秒(ms)。 **取值范围**： 不涉及。 | | avg_fail_count | Double | **参数解释**： 每分钟的平均请求失败次数，单位为次/分钟。 **取值范围**： 不涉及。 | | apm_app_id | String | **参数解释**： 应用性能管理（Application Performance Management，APM）的应用标识，用于关联APM应用监控。 **取值范围**： 不涉及。 | | aom_prom_id | String | **参数解释**： 应用运维管理（Application Operations Management，AOM）的普罗ID，用来关联AOM普罗实例。 **取值范围**： 不涉及。 | | apm_app_token | String | **参数解释**： 应用性能管理（Application Performance Management，APM）token，加密存储。 **取值范围**： 不涉及。 | | aom_access_code | String | **参数解释**： 应用运维管理（Application Operations Management，AOM）的访问验证码，用于AOM数据上报时的身份验证，加密存储以保障安全。 **取值范围**： 不涉及。 | | lts_group_id | String | **参数解释**： 日志服务（Log Tank Service，LTS）日志组标识，用于关联日志上报的日志组。 **取值范围**： 不涉及。 | | lts_stream_id | String | **参数解释**： 日志服务（Log Tank Service，LTS）的日志流标识，用于关联日志上报的日志流。 **取值范围**： 不涉及。 | | lts_label_name | String | **参数解释**： 用于过滤日志服务（Log Tank Service，LTS）日志标签。 **取值范围**： 不涉及。 | | apm_exporter_endpoint | String | **参数解释**： 应用性能管理（Application Performance Management，APM）的数据上报地址。 **取值范围**： 不涉及。 | | aom_exporter_endpoint | String | **参数解释**： 应用运维管理（Application Operations Management，AOM）的数据上报地址。 **取值范围**： 不涉及。 | | deleted | Integer | **参数解释**： 智能体是否已被删除，0表示未删除，1表示已删除。 **取值范围**： 不涉及。 | **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | **状态码：403** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | encoded_authorization_message | String | **参数解释**： 编码后的授权信息，用于客户端解析权限问题。 **取值范围**： 不涉及。 | | details | Array of [OpsObserverCommonError] objects | **参数解释**： 赖的下游服务错误信息列表。 **取值范围**： 不涉及。 | 表6OpsObserverCommonError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://api.example.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" } ] } ``` **状态码：400** **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 400表示请求参数不正确。 ``` { "error_code" : "AgentArts.05001003", "error_msg" : "请求参数不正确" } ``` **状态码：403** **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 403表示权限不足，拒绝访问。 ``` { "error_code" : "AgentArts.05004003", "error_msg" : "权限不足，拒绝访问", "encode_authorization_message" : "eyJIcnJvciI6ICJVbmF1dGhvcm16ZWQifQ==", "details" : [ { "error_code" : "AgentArts.05001003" }, { "error_msg" : "请求参数不正确" } ] } ``` **状态码：500** **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 500表示内部服务器错误。 ``` { "error_code" : "AgentArts.05005000", "error_msg" : "内部服务器错误" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 200表示成功，其他值表示失败，具体参见错误码文档。 | | 400 | **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 400表示请求参数不正确。 | | 403 | **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 403表示权限不足，拒绝访问。 | | 500 | **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 500表示内部服务器错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。