# 查询会话列表 - ListOpsSession #### 功能介绍 该接口用于查询会话列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-agentarts/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | agentarts::listOpsSession | List | - | - | - | - apm:apm2TraceEvents:get - apm:apm2Service:get | #### URI POST /v1/ops/observation/sessions #### 请求参数 表1请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 否 | Long | **参数解释**： 查询指标的开始时间，用于指定查询时间范围的起始时间点，Unix时间戳，单位为ms。 **约束限制**： 必须为有效的Unix时间戳。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | end_time | 否 | Long | **参数解释**： 查询指标的截止时间，用于指定查询时间范围的结束时间点，Unix时间戳，单位为ms。 **约束限制**： 必须为有效的Unix时间戳，单位为毫秒。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | resource_id | 否 | String | **参数解释**： 应用ID，用于筛选指定应用的调用链数据，可通过查询应用列表接口获取。 **约束限制**： 长度限制为1\~64个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | resource_type | 否 | String | **参数解释**： 资源类型，用于筛选指定类型的资源会话数据。 **约束限制**： 不涉及。 **取值范围**： - agent：单智能体； - multiagents：多智能体； - workflow：工作流。 **默认取值**： 不涉及。 | | filter | 否 | Array of [ListFilterParam] objects | **参数解释**： 过滤条件，用于多条件组合筛选会话数据。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | label_filter | 否 | Array of [FilterParam] objects | **参数解释**： 标签过滤条件，用于按标签筛选会话数据。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | page_no | 否 | Integer | **参数解释**： 页码，用于分页查询，指定返回第几页的数据。 **约束限制**： 必须为正整数。 **取值范围**： 大于等于1的整数。 **默认取值**： 1。 | | page_size | 否 | Integer | **参数解释**： 每页条数，用于分页查询，指定每页返回的数据条数。 **约束限制**： 必须为正整数。 **取值范围**： 1\~1000。 **默认取值**： 10。 | 表2ListFilterParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 过滤名，指定要过滤的字段名称，如resource_id、resource_type等。 **约束限制**： 长度限制为1\~64个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | value | 否 | String | **参数解释**： 过滤值，指定要过滤的字段值，需与name字段配合使用。 **约束限制**： 长度限制为1\~64个字符。 **取值范围**： 根据name字段确定。 **默认取值**： 不涉及。 | | operator | 否 | String | **参数解释**： 操作类型。 **约束限制**： 不涉及。 **取值范围**： - equal：等于。 - like：包含。 - not_like：不包含。 - empty：为空。 - not_empty：不为空。 - greater_than：大于等于。 - less_than：小于等于。 - in：属于。 - not_in：不属于。 **默认取值**： 不涉及。 | 表3FilterParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | label_name | 否 | String | **参数解释**： 标签名。 **约束限制**： 长度限制为1\~64个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | label_value | 否 | String | **参数解释**： 标签值。 **约束限制**： 长度限制为1\~128个字符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | operator | 否 | String | **参数解释**： 操作类型。 **约束限制**： 不涉及。 **取值范围**： - equal：等于。 - like：包含。 - not_like：不包含。 - empty：为空。 - not_empty：不为空。 - greater_than：大于等于。 - less_than：小于等于。 - in：属于。 - not_in：不属于。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**： 查询到的会话数据总数。 **取值范围**： 不涉及。 | | session_list | Array of [OpsSessionDetail] objects | **参数解释**： 会话列表。 **取值范围**： 不涉及。 | 表5OpsSessionDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | session_id | String | **参数解释**： 会话ID，唯一标识一个会话，可通过ListOpsSession接口获取。 **取值范围**： 不涉及。 | | latency | Number | **参数解释**： 耗时，会话的总执行时长，单位为ms。 **取值范围**： 大于等于0的数值。 | | tokens | Number | **参数解释**： Tokens消耗，会话消耗的总Token数量，单位为个。 **取值范围**： 大于等于0的数值。 | | input_tokens | Number | **参数解释**： Input Tokens消耗，会话输入部分消耗的Token数量，单位为个。 **取值范围**： 大于等于0的数值。 | | output_tokens | Number | **参数解释**： Output Tokens消耗，会话输出部分消耗的Token数量，单位为个。 **取值范围**： 大于等于0的数值。 | | trace_num | Number | **参数解释**： 调用链数量。 **取值范围**： 不涉及。 | | user_id | String | **参数解释**： 用户ID，用于标识查询数据的所属用户，获取方式通过在控制台右上角"我的凭证"中复制得到。 **取值范围**： 不涉及。 | | call_type | String | **参数解释**： 调用类型。 **取值范围**： 不涉及。 | | start_time | Long | **参数解释**： 查询指标的开始时间，会话开始的时间戳，单位为毫秒。 **取值范围**： 不涉及。 | | domain_id | String | **参数解释**： 租户DomainID。 **取值范围**： 不涉及。 | | resource_id | String | **参数解释**： 资源ID。 **取值范围**： 不涉及。 | | resource_name | String | **参数解释**： 资源名称。 **取值范围**： 不涉及。 | | resource_type | String | **参数解释**： 资源类型。 **取值范围**： - agent：单智能体； - multiagents：多智能体； - workflow：工作流。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | encoded_authorization_message | String | **参数解释**： 编码后的授权信息，用于客户端解析权限问题。 **取值范围**： 不涉及。 | | details | Array of [OpsObserverCommonError] objects | **参数解释**： 赖的下游服务错误信息列表。 **取值范围**： 不涉及。 | 表8OpsObserverCommonError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | #### 请求示例 ``` POST https://api.example.com/v1/ops/observation/sessions { "page_no" : 1, "page_size" : 20, "filter" : [ ] } ``` #### 响应示例 **状态码：200** **参数解释**： 响应码，用于标识接口调用结果。 **取值范围**： 200表示成功，其他值表示失败，具体参见错误码文档。 ``` { "session_list" : [ { "session_id" : "test111", "latency" : 5, "tokens" : 0, "input_tokens" : 0, "output_tokens" : 0, "trace_num" : 1, "user_id" : "319c74a30677464db04f25ffd55ae3c8", "call_type" : "debug", "start_time" : 1775271188055, "resource_id" : "b0fd244b-c5c8-4ef7-97b6-645a1b03edc6" } ], "total" : 10 } ``` **状态码：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表示内部服务器错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。