查询会话详情 - ShowOpsSession
功能介绍
该接口用于查询会话详情。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::showOpsSession | Read | - | - | - |
|
URI
GET /v1/ops/observation/sessions/{session_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| session_id | 是 | String | 参数解释: 会话ID,唯一标识一个会话,可通过ListOpsSession接口获取。 约束限制: 长度限制为1~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 资源类型。 取值范围: |
状态码: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/sessions/test111
响应示例
状态码:200
参数解释:
响应码,用于标识接口调用结果。
取值范围:
200表示成功,其他值表示失败,具体参见错误码文档。
{
"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"
} 状态码: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表示内部服务器错误。 |
错误码
请参见错误码。