查询组件列表,包括工具,模型,skill列表 - ListOpsAgentMetricLabelValues
功能介绍
查询组件列表,包括工具,模型,skill列表。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
POST /v1/ops/observation/agents/metric/label-values
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| start_time | 是 | String | 参数解释: 查询的开始时间,用于指定查询时间范围的开始时间点,格式为Unix时间戳,单位为ms。 约束限制: 必须早于或等于end_time。 取值范围: 不涉及。 默认取值: 不涉及。 |
| end_time | 是 | String | 参数解释: 查询的结束时间,用于限定指标数据的时间范围,格式为Unix时间戳,单位为ms。 约束限制: 必须晚于或等于start_time,两者配合使用指定查询时间范围。 取值范围: 不涉及。 默认取值: 不涉及。 |
| resource_id | 是 | String | 参数解释: 应用ID,用于筛选指定应用的调用链数据,可通过查询应用列表接口获取。 约束限制: 长度固定为36字符,必须为UUID格式。 取值范围: 符合UUID格式,正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
| resource_type | 是 | String | 参数解释: 资源类型,标识查询的资源对象类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| metric_name | 否 | String | 参数解释: 用于指定需要查询的监控指标名称,可以通过查询时间范围内智能体的总数、草稿数、发布态数接口获取。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及。 |
| label_name | 是 | String | 参数解释: 指标维度标签名称,用于指定查询的指标维度,可通过查询指标维度接口获取。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及。 |
| filter | 否 | Array of MetricFilterParam objects | 参数解释: 过滤条件,用于对指标查询结果进行条件筛选。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| label_name | 否 | String | 参数解释: 指标维度标签名称,用于指定过滤条件的维度。标签名称与查询的指标相关,通过页面接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| label_value | 否 | String | 参数解释: 维度标签值,用于指定过滤条件的维度值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| operator | 否 | String | 参数解释: 过滤操作符,用于定义label_name与label_value之间的匹配关系。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data_list | Array of strings | 参数解释: 组件名称字符串列表。 取值范围: 不涉及。 |
| data_extend_list | Array of ComponentExtendInfo objects | 参数解释: 组件扩展属性列表,返回组件的ID和名称等扩展信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| component_id | String | 参数解释: 组件ID,标识一个具体组件(如模型、工具、Skill等),可通过AgentArts智能体控制台或相关查询接口获取,长度限制为1~128个字符。 取值范围: 不涉及。 |
| component_name | String | 参数解释: 组件名称,如模型名称、工具名称、Skill名称等,长度限制为1~128个字符。 取值范围: 不涉及。 |
状态码: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 | 参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
POST https://api.example.com/v1/ops/observation/agents/metric/label-values
Content-Type:application/json
X-Sdk-Date:20240416T095341Z
Authorization:SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
{
"start_time": "1782710764173",
"end_time": "1782714364173",
"resource_id": "57113f3b-3c43-453e-8f4a-cbc1e94bc7ab",
"resource_type": "agent",
"metric_name": "gen_ai_skill_call_count_total",
"label_name": "gen_ai_skill_name",
"filter": [
{
"label_name": "gen_ai_resource_id",
"label_value": "57113f3b-3c43-453e-8f4a-cbc1e94bc7ab",
"operator": "="
}
]
} 响应示例
状态码:200
参数解释:
响应码,用于标识接口调用结果。
取值范围:
200表示成功,其他值表示失败,具体参见错误码文档。
{
"data_extend_list" : [ ],
"data_list" : [ ]
} 状态码: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表示内部服务器错误。 |
错误码
请参见错误码。