有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

创建Notebook实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateNotebookInstance。
Version String 公共参数,本接口取值:2019-10-22。
Region String 公共参数,详见产品支持的 地域列表
NotebookInstanceName String Notebook实例名称,不能超过63个字符
规则:“^[a-zA-Z0-9](-*[a-zA-Z0-9])*$”
InstanceType String Notebook算力类型
参考https://cloud.tencent.com/document/product/851/41239
VolumeSizeInGB Integer 数据卷大小(GB)
用户持久化Notebook实例的数据
DirectInternetAccess String 外网访问权限,可取值Enabled/Disabled
开启后,Notebook实例可以具有访问外网80,443端口的权限
RootAccess String Root用户权限,可取值Enabled/Disabled
开启后,Notebook实例可以切换至root用户执行命令
SubnetId String 子网ID
如果需要Notebook实例访问VPC内的资源,则需要选择对应的子网
LifecycleScriptsName String 生命周期脚本名称
必须是已存在的生命周期脚本,具体参考https://cloud.tencent.com/document/product/851/43140
DefaultCodeRepository String 默认存储库名称
可以是已创建的存储库名称或者已https://开头的公共git库
参考https://cloud.tencent.com/document/product/851/43139
AdditionalCodeRepositories.N Array of String 其他存储库列表
每个元素可以是已创建的存储库名称或者已https://开头的公共git库
参考https://cloud.tencent.com/document/product/851/43139
ClsAccess String 已弃用,请使用ClsConfig配置。
是否开启CLS日志服务,可取值Enabled/Disabled,默认为Disabled
开启后,Notebook运行的日志会收集到CLS中,CLS会产生费用,请根据需要选择
StoppingCondition StoppingCondition 自动停止配置
选择定时停止Notebook实例
AutoStopping String 自动停止,可取值Enabled/Disabled
取值为Disabled的时候StoppingCondition将被忽略
取值为Enabled的时候读取StoppingCondition作为自动停止的配置
ClsConfig ClsConfig 接入日志的配置,默认接入免费日志

3. 输出参数

参数名称 类型 描述
NotebookInstanceName String Notebook实例名字
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个Notebook实例

输入示例

https://tione.tencentcloudapi.com/?Action=CreateNotebookInstance
&NotebookInstanceName=test
&InstanceType=TI.SMALL2.1core2g
&DirectInternetAccess=Enabled
&RootAccess=Enabled
&SubnetId=subnet-xxx
&VolumeSizeInGB=10
&LifecycleScriptsName=abc
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "fe8f6fd2-1f51-4699-b19d-efa8b6efde8a",
        "NotebookInstanceName": "test"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.ClsServiceNotActived 尚未开通CLS日志服务,请开前往开通。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ClsConfigRequired 请设置日志集、日志主题ID。
InvalidParameterValue.CodeRepoNotFound 存储库不存在。
InvalidParameterValue.DuplicateName 实例名称冲突,请更换名称后重试。
InvalidParameterValue.LogSetNotFound 未找到当前日志集。
InvalidParameterValue.SubnetNotFound 子网不存在。
InvalidParameterValue.TopicNotFound 未找到当前日志主题。
LimitExceeded 超过配额限制。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.BillNotActivated 未开通该地域服务,请先开通。
UnauthorizedOperation 未授权操作。