查询指标的数据 - ShowOpsAgentMetricGauge

功能介绍

该接口用于查询智能体指标的数据信息。

调用方法

授权信息

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

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
agentarts::showOpsAgentMetricGauge	Read	-	-	-	apm:apm2TraceEvents:get apm:apm2Service:get aom:metric:list

URI

POST /v1/ops/observation/agents/metric/gauge

请求参数

表1 请求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。默认取值：不涉及。

表2 请求Body参数
参数	是否必选	参数类型	描述
group_by	否	Array of strings	参数解释：分组名。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
start_time	是	String	参数解释：开始时间。约束限制：不涉及。取值范围：不涉及。默认取值： Unix时间戳，单位为ms。
end_time	是	String	参数解释：截止时间。约束限制：不涉及。取值范围：不涉及。默认取值： Unix时间戳，单位为ms。
metric_name	否	String	参数解释：指标名。约束限制：长度限制1-64位。取值范围：不涉及。默认取值：不涉及。
resource_id	否	String	参数解释：智能体ID。约束限制：长度限制1-64位。取值范围：不涉及。默认取值：不涉及。
resource_type	否	String	参数解释：智能体类型。约束限制：不涉及。取值范围： agent：单智能体。 multiagents：多智能体。 workflow：工作流。默认取值：不涉及。
filter	否	Array of MetricFilterParam objects	参数解释：过滤条件。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
top_number	否	Integer	参数解释：待返回top数量。约束限制：正整数。取值范围： 0-100。默认取值：不涉及。

表3 MetricFilterParam
参数	是否必选	参数类型	描述
label_name	否	String	参数解释：标签名。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
label_value	否	String	参数解释：标签值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
operator	否	String	参数解释：操作类型。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
original_value	String	参数解释：当前区间的值。取值范围：不涉及。
day_compare_data	String	参数解释：日环比、今日新增。取值范围：不涉及。

请求示例

POST https://*.com/v1/ops/observation/agents/metric/gauge

Content-Type:application/json
X-Sdk-Date:20240416T095341Z
Authorization:SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
{
  "start_time": 1776129889733,
  "end_time": 1776133489733,
  "metric_name": "model_use_times",
  "resource_type": "agent",
  "filter": [
    {
      "label_name": "gen_ai_call_status",
      "label_value": "true",
      "operator": "="
    },
    {
      "label_name": "gen_ai_resource_type",
      "label_value": "agent",
      "operator": "="
    }
  ]
}

响应示例

状态码：200

参数解释：

响应码，用于标识接口调用结果。

取值范围：

200表示成功，其他值表示失败，具体参见错误码文档。

{
  "day_compare_data" : 6.6,
  "original_value" : 34.1
}

状态码

状态码	描述
200	参数解释：响应码，用于标识接口调用结果。取值范围： 200表示成功，其他值表示失败，具体参见错误码文档。