查询智能体列表 - ListOpsAgentObservation

功能介绍

在观测页面查询智能体列表。

调用方法

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
agentarts::listOpsAgentObservation	List	-	-	-	-

URI

GET /v1/ops/observation/agents

表1 Query参数
参数	是否必选	参数类型	描述
agent_id	否	String	参数解释：智能体ID。约束限制：长度限制1-64位。取值范围：不涉及。默认取值：不涉及。
page	是	Integer	参数解释：页码。约束限制：不涉及。取值范围：取值范围1-10000。默认取值：不涉及。
page_size	是	Integer	参数解释：查询结果每页最多显示的条数。约束限制：不涉及。取值范围：取值范围1-1000。默认取值：不涉及。
agent_name	否	String	参数解释：智能体名称。约束限制：长度限制1-64。取值范围：不涉及。默认取值：不涉及。
agent_type	否	String	参数解释：智能体类型。约束限制：不涉及。取值范围： agent：单智能体。 multiagents：多智能体。 workflow：工作流。 all：全部。默认取值： agent

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	参数解释：消息体编码格式。用于告知服务端请求体（Body）所采用的主体数据类型，以便服务端正确解析。约束限制：不涉及。取值范围： application/json。默认取值： application/json。
Authorization	是	String	参数解释：签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。约束限制： SDK自动填充,格式为SDK-HMAC-SHA256。取值范围：符合签名规范的字符串。默认取值：不涉及。
X-Sdk-Date	是	String	参数解释：请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。约束限制：符合ISO 8601格式。取值范围：格式为YYYYMMDDTHHMMSSZ,如20240416T095341Z。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
app_info_list	Array of AgentInfo objects	参数解释：智能体列表。取值范围：不涉及。
total_count	Integer	参数解释：智能体在库总数。取值范围：不涉及。

表4 AgentInfo
参数	参数类型	描述
agent_id	String	参数解释：智能体ID。取值范围：不涉及。
name	String	参数解释：智能体名称。取值范围：不涉及。
agent_type	String	参数解释：智能体类型。取值范围： agent：单智能体。 multiagents：多智能体。 workflow：工作流。
create_time	Long	参数解释：创建时间。取值范围：不涉及。

请求示例

GET https://*.com/v1/ops/observation/agents?page=1&page_size=1000&agent_type=agent

Content-Type:application/json
X-Sdk-Date:20240416T095341Z
Authorization:SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

响应示例

状态码：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表示成功，其他值表示失败，具体参见错误码文档。