1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
本接口(DescribeNotebookSessions)用于查询交互式 session列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNotebookSessions。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DataEngineName | 是 | String | DLC Spark作业引擎名称 示例值:data_engine_1 |
State.N | 否 | Array of String | Session状态,包含:not_started(未启动)、starting(已启动)、idle(等待输入)、busy(正在运行statement)、shutting_down(停止)、error(异常)、dead(已退出)、killed(被杀死)、success(正常停止) 示例值:[“not_started”] |
SortFields.N | 否 | Array of String | 排序字段(默认按创建时间) 示例值:["createTime"] |
Asc | 否 | Boolean | 排序字段:true:升序、false:降序(默认) 示例值:true |
Limit | 否 | Integer | 分页参数,默认10 示例值:10 |
Offset | 否 | Integer | 分页参数,默认0 示例值:10 |
Filters.N | 否 | Array of Filter | 过滤类型,支持如下的过滤类型,传参Name应为以下其中一个, engine-generation - String(引擎时代: supersql:supersql引擎,native:标准引擎):notebook-keyword - String(数据引擎名称或sessionid或sessionname的模糊搜索) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalElements | Integer | session总数量 示例值:20 |
TotalPages | Integer | 总页数 示例值:2 |
Page | Integer | 当前页码 示例值:1 |
Size | Integer | 当前页数量 示例值:10 |
Sessions | Array of NotebookSessions | session列表信息 示例值:复杂类型 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询交互式 session列表
查询交互式 session列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotebookSessions
<公共请求参数>
{
"DataEngineName": "abc",
"State": [
"abc"
],
"SortFields": [
"abc"
],
"Asc": true,
"Limit": 1,
"Offset": 1
}
输出示例
{
"Response": {
"Sessions": [
{
"Kind": "spark",
"Name": "session1",
"ProxyUser": "root",
"State": "not_started",
"SessionId": "d3018ad4-9a7e-4f64-a3f4-f38507c69742",
"SparkAppId": "spark-4ke6a46618d24e9c7yh2b62f0ddebdks",
"CreateTime": "2006-01-02 15:04:05",
"DataEngineName": "data_engin_1",
"LastRunningTime": "2006-01-02 15:04:05",
"SparkUiUrl": "http://xx",
"Creator": "232132443"
}
],
"TotalPages": 2,
"TotalElements": 20,
"Page": 1,
"RequestId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1",
"Size": 10
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.InternalSystemException | 业务系统异常,请重试或提工单联系我们。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidSQL | SQL解析失败。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.UnauthorizedOperationCode_NoEngineCamPermissions | 无引擎cam权限 |