1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
本接口(CreateNotebookSession)用于创建交互式session(notebook)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateNotebookSession。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Name | 是 | String | Session名称 示例值:session1 |
Kind | 是 | String | 类型,当前支持:spark、pyspark、sparkr、sql 示例值:spark |
DataEngineName | 是 | String | DLC Spark作业引擎名称 示例值:data_engine_1 |
ProgramDependentFiles.N | 否 | Array of String | session文件地址,当前支持:cosn://和lakefs://两种路径 示例值:[cosn://xxx] |
ProgramDependentJars.N | 否 | Array of String | 依赖的jar程序地址,当前支持:cosn://和lakefs://两种路径 示例值:[cosn://xxx] |
ProgramDependentPython.N | 否 | Array of String | 依赖的python程序地址,当前支持:cosn://和lakefs://两种路径 示例值:[cosn://xxx] |
ProgramArchives.N | 否 | Array of String | 依赖的pyspark虚拟环境地址,当前支持:cosn://和lakefs://两种路径 示例值:[cosn://xxx] |
DriverSize | 否 | String | 指定的Driver规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu) 示例值:small |
ExecutorSize | 否 | String | 指定的Executor规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu) 示例值:small |
ExecutorNumbers | 否 | Integer | 指定的Executor数量,默认为1 示例值:1 |
Arguments.N | 否 | Array of KVPair | Session相关配置,当前支持: 1. dlc.eni: 用户配置的eni网关信息,可以通过该字段设置; 2. dlc.role.arn: 用户配置的roleArn鉴权策略配置信息,可以通过该字段设置; 3. dlc.sql.set.config: 用户配置的集群配置信息,可以通过该字段设置; 示例值:["eni":"test_eni"] |
ProxyUser | 否 | String | 代理用户,默认为root 示例值:root |
TimeoutInSecond | 否 | Integer | 指定的Session超时时间,单位秒,默认3600秒 示例值:3600 |
ExecutorMaxNumbers | 否 | Integer | 指定的Executor数量(最大值),默认为1,当开启动态分配有效,若未开启,则该值等于ExecutorNumbers 示例值:1 |
SparkImage | 否 | String | 指定spark版本名称,当前任务使用该spark镜像运行 示例值:pyspark 3.2 |
IsInherit | 否 | Integer | 是否继承集群的资源类配置:0:自定义(默认),1:继承集群; 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SessionId | String | Session唯一标识 示例值:d3018ad4-9a7e-4f64-a3f4-f38507c69742 |
SparkAppId | String | Spark任务返回的AppId 注意:此字段可能返回 null,表示取不到有效值。 示例值:spark-4ke6a46618d24e9c7yh2b62f0ddebdks |
State | String | Session状态,包含:not_started(未启动)、starting(已启动)、idle(等待输入)、busy(正在运行statement)、shutting_down(停止)、error(异常)、dead(已退出)、killed(被杀死)、success(正常停止) 示例值:not_started |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建交互式session(notebook)
创建交互式session(notebook)
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNotebookSession
<公共请求参数>
{
"Kind": "spark",
"Name": "session1",
"ProxyUser": "root",
"ProgramDependentPython": [
"cosn://xxx"
],
"ProgramDependentFiles": [
"cosn://xxx"
],
"ExecutorSize": "small",
"ExecutorNumbers": 1,
"ExecutorMaxNumbers": 1,
"DataEngineName": "data_engine_1",
"ProgramDependentJars": [
"cosn://xxx"
],
"Arguments": [
{
"Value": "eni",
"Key": "test_eni"
}
],
"TimeoutInSecond": 3600,
"ProgramArchives": [
"cosn://xxx"
],
"DriverSize": "small"
}
输出示例
{
"Response": {
"SessionId": "abc",
"SparkAppId": "abc",
"State": "abc",
"RequestId": "abc"
}
}
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 | 操作失败。 |
FailedOperation.NoPermissionToUseTheDataEngine | 用户没有指定引擎的使用权限 |
InternalError | 内部错误。 |
InternalError.InternalSystemException | 业务系统异常,请重试或提工单联系我们。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DataEngineOnlySupportSparkBatch | 当前任务仅支持Spark批作业引擎运行 |
InvalidParameter.ImageEngineTypeNotMatch | 指定引擎类型不匹配,当前仅支持: SparkSQL, PrestoSQL, SparkBatch |
InvalidParameter.ImageIsPublicNotMatch | 指定isPublic不匹配,当前仅支持: 1:公共, 2:私有 |
InvalidParameter.ImageParameterSubmitMethodNotMatch | 指定集群镜像ParameterSubmitMethod不匹配,当前仅支持: User, BackGround |
InvalidParameter.ImageParameterTypeNotMatch | 指定集群镜像ParameterType不匹配,当前仅支持: 1: session , 2: common, 3: cluster |
InvalidParameter.ImageStateNotMatch | 指定state不匹配,当前仅支持: 1:初始化, 2:上线, 3:下线 |
InvalidParameter.ImageUserRecordsTypeNotMatch | 指定集群镜像UserRecords不匹配,当前仅支持: 1: parentVersion, 2: childVersion, 3: pySpark |
InvalidParameter.InvalidDriverSize | 当前DriverSize规格仅支持: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge |
InvalidParameter.InvalidDynamicAllocationMaxExecutors | 指定Excutor动态数量必须为当前最大值 |
InvalidParameter.InvalidExecutorSize | 当前ExecutorSize规格仅支持: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge |
InvalidParameter.InvalidFileCompressionFormat | 指定的文件压缩格式不合规,当前仅支持: tar.gz/tar/tgz |
InvalidParameter.InvalidFilePathFormat | 指定的文件路径格式不合规,当前仅支持:cosn://或lakefs:// |
InvalidParameter.InvalidSQL | SQL解析失败。 |
InvalidParameter.InvalidSessionKindType | 当前Session仅支持: spark/pyspark/sparkr/sql类型 |
InvalidParameter.InvalidWhiteListKey | 获取白名单错误,请重试,或者提交工单联系我们 |
InvalidParameter.NumberOfSQLExceedsTheLimit | 提交的SQL数量范围限制为1~50 |
InvalidParameter.ParameterNotFoundOrBeNone | 找不到参数或参数为空 |
InvalidParameter.SQLBase64DecodeFail | SQL脚本Base64解析失败 |
InvalidParameter.SQLParameterPreprocessingFailed | SQL参数预处理失败 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.DataEngineNotActivity | 指定集群未处于运行状态 |
ResourceNotFound.DataEngineNotFound | 指定的引擎不存在 |
ResourceNotFound.DataEngineNotUnique | 指定的引擎已存在 |
ResourceNotFound.ImageSessionConfigNotFound | 指定集群镜像Session配置不存在 |
ResourceNotFound.ImageSessionConfigNotUnique | 指定集群镜像Session配置已存在 |
ResourceNotFound.ImageVersionNotFound | 指定集群镜像版本不存在 |
ResourceNotFound.ImageVersionNotUnique | 指定集群镜像版本已存在 |
ResourceNotFound.RoleArnResourceNotFound | 指定RoleArn不存在 |
ResourceNotFound.SessionInsufficientResources | 当前无资源创建session,请稍后重试或使用包年包月集群。 |
ResourceNotFound.ShuffleDirNotFound | 找不到Spark Shuffle存储路径,请到控制台->数据探索页面->存储配置中设置 |
ResourceNotFound.WarehouseDirNotFound | 找不到Warehouse存储路径,请到控制台->数据探索页面->存储配置中设置 |
UnauthorizedOperation.UnauthorizedOperationCode_NoEngineCamPermissions | 无引擎cam权限 |