查询会话列表 - ListOpsSession
功能介绍
该接口用于查询会话列表。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::listOpsSession | List | - | - | - |
|
URI
POST /v1/ops/observation/sessions
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| start_time | 否 | Long | 参数解释: 开始时间,用于指定查询时间范围的起始时间点。 约束限制: 必须为有效的Unix时间戳。 取值范围: Unix时间戳,单位为ms。 默认取值: 不涉及。 |
| end_time | 否 | Long | 参数解释: 截止时间,用于指定查询时间范围的结束时间点。 约束限制: 必须为有效的Unix时间戳。 取值范围: Unix时间戳,单位为ms。 默认取值: 不涉及。 |
| resource_id | 否 | String | 参数解释: 应用ID,用于筛选指定应用的会话数据。 约束限制: 长度限制1-64位。 取值范围: 不涉及。 默认取值: 不涉及。 |
| resource_type | 否 | String | 参数解释: 资源类型,用于筛选指定类型的资源会话数据。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| filter | 否 | Array of ListFilterParam objects | 参数解释: 过滤条件,用于多条件组合筛选会话数据。 约束限制: 不涉及。 |
| label_filter | 否 | Array of FilterParam objects | 参数解释: 标签过滤条件,用于按标签筛选会话数据。 约束限制: 不涉及。 |
| page_no | 否 | Integer | 参数解释: 页码,用于分页查询,指定返回第几页的数据。 约束限制: 必须为正整数。 取值范围: 大于等于1的整数。 默认取值: 1。 |
| page_size | 否 | Integer | 参数解释: 每页条数,用于分页查询,指定每页返回的数据条数。 约束限制: 必须为正整数。 取值范围: 1-1000。 默认取值: 10。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 过滤名,指定要过滤的字段名称,如resource_id、resource_type等。 约束限制: 长度限制为1-64位。 取值范围: 不涉及。 默认取值: 不涉及。 |
| value | 否 | String | 参数解释: 过滤值,指定要过滤的字段值,需与name字段配合使用。 约束限制: 长度限制为1-64位。 取值范围: 根据name字段确定。 默认取值: 不涉及。 |
| operator | 否 | String | 参数解释: 操作类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总数。 取值范围: 不涉及。 |
| session_list | Array of OpsSessionDetail objects | 参数解释: 会话列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| session_id | String | 参数解释: 会话ID。 取值范围: 不涉及。 |
| latency | Number | 参数解释: 耗时,会话的总执行时长。 取值范围: 大于等于0的数值,单位为ms。 |
| 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 | 参数解释: 开始时间,会话开始的时间戳。 取值范围: Unix时间戳,单位为ms。 |
| domain_id | String | 参数解释: 租户DomainID。 取值范围: 不涉及。 |
| resource_id | String | 参数解释: 资源ID。 取值范围: 不涉及。 |
| resource_name | String | 参数解释: 资源名称。 取值范围: 不涉及。 |
| resource_type | String | 参数解释: 资源类型。 取值范围: |
请求示例
POST https://*.com/v1/ops/observation/sessions
Content-Type:application/json
X-Sdk-Date:20240416T095341Z
Authorization:SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
{
"page_no": like,
"page_size": 018e8d4f16496b9a,
"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,
"domain_id" : null,
"resource_id" : "b0fd244b-c5c8-4ef7-97b6-645a1b03edc6",
"resource_name" : null,
"resource_type" : null
} ],
"total" : 10
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: 响应码,用于标识接口调用结果。 取值范围: 200表示成功,其他值表示失败,具体参见错误码文档。 |
错误码
请参见错误码。