查询交互式 session详情信息

最近更新时间:2025-04-25 01:26:39

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

本接口(DescribeNotebookSession)用于查询交互式 session详情信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNotebookSession。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
SessionId String Session唯一标识
示例值:d3018ad4-9a7e-4f64-a3f4-f38507c69742

3. 输出参数

参数名称 类型 描述
Session NotebookSessionInfo Session详情信息
示例值:复杂类型
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeNotebookSession

查询交互式 session详情信息

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotebookSession
<公共请求参数>

{
    "SessionId": "d3018ad4-9a7e-4f64-a3f4-f38507c69742"
}

输出示例

{
    "Response": {
        "RequestId": "********-****-****-****-7d00a55746d9",
        "Session": {
            "AppInfo": [],
            "Arguments": [
                {
                    "Key": "dlc.eni",
                    "Value": ""
                },
                {
                    "Key": "dlc.role.arn",
                    "Value": "00.1737099520.29eb837f.-.0.SPARK.00058.MTFiNWZmMDSPRH8hPPbkFHj1FdFTQTmwDnW7BR5i1THufNXmuXjyoQ=="
                }
            ],
            "CreateTime": "1737099521000",
            "DataEngineName": "cls-*******",
            "DriverSize": "small",
            "ExecutorMaxNumbers": 1,
            "ExecutorNumbers": 1,
            "ExecutorSize": "small",
            "Kind": "sql",
            "Name": "session1",
            "ProxyUser": "root",
            "ProgramArchives": null,
            "ProgramDependentFiles": null,
            "ProgramDependentJars": null,
            "ProgramDependentPython": null,
            "SessionId": "livy-session-***********",
            "SessionType": "",
            "SparkAppId": "spark-**********",
            "SparkUiUrl": "https://*******/jobs/",
            "State": "dead",
            "TimeoutInSecond": 90
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.InvalidSQL SQL解析失败。
InvalidParameter.ParameterNotFoundOrBeNone 找不到参数或参数为空
ResourceNotFound 资源不存在。
ResourceNotFound.SessionNotFound session不存在。
ResourceNotFound.SessionStateDead session已消亡。