查询topn智能体列表 - ListOpsAgentObservationTopN
功能介绍
该接口用于查询今日有调用量的topn智能体列表,返回指定时间范围内调用量、会话数、用户数等核心指标的智能体列表。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::listOpsAgentObservationTopN | List | - | - | - |
|
URI
POST /v1/ops/observation/agents/topn
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| start_time | 是 | Long | 参数解释: 查询指标的开始时间,Unix时间戳,单位为ms。 约束限制: 必须与end_time同时使用且start_time不能晚于end_time。 取值范围: 0~4110338427000。 默认取值: 不涉及。 |
| end_time | 是 | Long | 参数解释: 查询指标的结束时间,Unix时间戳,单位为ms。 约束限制: 必须与start_time同时使用且end_time不能早于start_time。 取值范围: 0~4110338427000。 默认取值: 不涉及。 |
| top_number | 否 | Integer | 参数解释: topN智能体个数。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 默认值为10。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| agent_list | Array of AgentTopNInfo objects | 参数解释: 智能体详情列表,元素类型为AgentTopNInfo对象,包含资源ID、名称和类型等信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 参数解释: 资源ID,用于唯一标识智能体。 取值范围: 不涉及。 |
| runtime_id | String | 参数解释: 运行时ID。agentrun类型的智能体resource_id和runtime_id一样。 取值范围: 不涉及。 |
| resource_name | String | 参数解释: 资源名称,智能体的显示名称。 取值范围: 不涉及。 |
| resource_type | String | 参数解释: 资源类型。 取值范围: |
| create_time | Long | 参数解释: 智能体的创建时间,Unix时间戳,单位为ms。 取值范围: 不涉及。 |
| source | String | 参数解释: 智能体来源。 取值范围: |
| calls_total | Long | 参数解释: 智能体调用量,指定时间范围内的总调用次数。 取值范围: 不涉及。 |
| sessions_total | Long | 参数解释: 智能体会话数,指定时间范围内的总会话数。 取值范围: 不涉及。 |
| users_total | Long | 参数解释: 智能体用户数,指定时间范围内的去重用户数。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: 不涉及。 |
| details | Array of OpsObserverCommonError objects | 参数解释: 依赖的下游服务错误信息列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
POST https://api.example.com/v1/ops/observation/agents/topn
{
"start_time" : 1754364381000,
"end_time" : 1754450781000,
"top_number" : 10
} 响应示例
状态码:200
{
"agent_list" : [ {
"resource_id" : "000b2b01-6279-4c7a-a4e5-08fdca69cc66",
"runtime_id" : "2eb9046d-7d8f-4593-b549-38f4a283e4cf",
"resource_name" : "天气智能体",
"resource_type" : "agent",
"create_time" : 1773104973000,
"source" : "studio",
"calls_total" : 10,
"sessions_total" : 5,
"users_total" : 3
} ]
} 状态码:400
{
"error_code" : "AgentArts.05001003",
"error_msg" : "请求参数不正确"
} 状态码:403
{
"error_code" : "AgentArts.05004003",
"error_msg" : "权限不足,拒绝访问",
"encoded_authorization_message" : "eyJIcnJvciI6ICJVbmF1dGhvcm16ZWQifQ==",
"details" : [ {
"error_code" : "AgentArts.05001003",
"error_msg" : "请求参数不正确"
} ]
} 状态码:429
{
"error_code" : "AgentArts.05008004",
"error_msg" : "请求过多,触发流控"
} 状态码:500
{
"error_code" : "AgentArts.05005000",
"error_msg" : "内部服务器错误"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 200表示成功,其他值表示失败,具体参见错误码文档。 |
| 400 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 400表示请求参数不正确。 |
| 403 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 403表示权限不足,拒绝访问。 |
| 429 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 429表示请求过多,触发流控。 |
| 500 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 500表示内部服务器错误。 |
错误码
请参见错误码。