查询时间范围内智能体的总数、草稿数、发布态数 - ShowOpsAgentMetric
功能介绍
该接口用于查询指定时间范围内智能体(单智能体、工作流、多智能体)的总数、草稿数、发布态数。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::showOpsAgentMetric | Read | - | - | - |
|
URI
GET /v1/ops/observation/agents/metric
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| start_time | 是 | Long | 参数解释: 查询指标的开始时间,用于指定查询时间范围的起始时间点,Unix时间戳,单位为ms。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| end_time | 是 | Long | 参数解释: 查询指标的截止时间,用于指定查询时间范围的截止时间点,Unix时间戳,单位为ms。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| metric_agent_list | Array of MetricResponse objects | 参数解释: 智能体指标响应体列表,包含指标名称及对应的智能体总数、草稿数、发布态数等信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| metric_name | String | 参数解释: 指标名。 取值范围: 不涉及。 |
| total | Integer | 参数解释: 查询到的智能体总数。 取值范围: 不涉及。 |
| draft_total | Integer | 参数解释: 草稿类型的总数。 取值范围: 不涉及。 |
| release_total | Integer | 参数解释: 已发布版本总数。 取值范围: 不涉及。 |
状态码: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 | 参数解释: 错误信息。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
GET https://api.example.com/v1/ops/observation/agents/metric?start_time=1775804870348&end_time=1775808470348
响应示例
状态码:200
参数解释:
响应码,用于标识接口调用结果。
取值范围:
200表示成功,其他值表示失败,具体参见错误码文档。
{
"metric_agent_list" : [ {
"draft_total" : 1,
"metric_name" : "multiagents_count_total",
"release_total" : 0,
"total" : 1
} ]
} 状态码: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表示内部服务器错误。 |
错误码
请参见错误码。