1. 接口描述
接口请求域名： tione.tencentcloudapi.com 。
启动Notebook
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：StartNotebook。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Id | 是 | String | notebook id 示例值：nb-1188415493581985152 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 启动Notebook
启动Notebook
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartNotebook
<公共请求参数>
{
"Id": "nb-1188415493581985152"
}输出示例
{
"Response": {
"RequestId": "f7df11d5-58c2-4767-956d-aa7158aab668"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| FailedOperation.ModifyBillingInstanceBatchFailed | 变更计费配置失败。 |
| FailedOperation.NotAllow | 操作不允许。 |
| FailedOperation.QueryResourceSpecFailed | 查询计费项详情失败。 |
| InternalError | 内部错误。 |
| InternalError.DescribeCustomSecretFailed | 查询自定义密钥失败 |
| InternalError.DescribeSubuinDependencyAccessibilityFailed | 获取用户依赖权限失败 |
| InternalError.ModifyCustomSecretFailed | 修改自定义密钥失败 |
| InternalError.QueryResourceGroupFailed | 查询预付费资源组详情失败。 |
| InternalError.QuerySubnetInfoFailed | 查询子网信息失败。 |
| InternalError.QueryUserTMPCredentialFailed | 查询用户临时密钥失败 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.UnsupportedMultiLocalDisk | 不支持使用多个本地磁盘 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.CcnHasNoAttachedVpc | 云联网未被关联VPC |
| InvalidParameterValue.DataConfigNumLimitExceeded | 数据配置数量超过最大限制 |
| InvalidParameterValue.GetCFSMountIPFailed | 获取CFS的挂载IP失败 |
| InvalidParameterValue.ImageAddressIllegal | 镜像地址不合法，请重新填写 |
| InvalidParameterValue.InvalidResourceSpec | 非法资源规格 |
| InvalidParameterValue.NotAllowedToCreateFreeVolumeNotebookWithBareMetalResourceGroup | 裸金属资源组不支持创建免费存储的Notebook |
| InvalidParameterValue.NotAllowedToCreateFreeVolumeNotebookWithSWResourceGroup | 纳管资源组不支持cbs存储，请使用CFS |
| InvalidParameterValue.NotAllowedToCreateNotebookWithBareMetalResourceGroup | 裸金属资源组不支持创建Notebook |
| InvalidParameterValue.PathIllegal | 本地盘路径不合法 |
| InvalidParameterValue.UnsupportedMultiCBSStorage | 不支持同一实例挂载多个CBS存储 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.BalanceInsufficient | 余额不足，创建/更新失败。 |
| OperationDenied.BillingStatusNotSupportWhitelistGPUType | 资源类型不支持，请检查白名单配置 |
| OperationDenied.BillingStatusResourceInsufficient | 按量计费资源售罄。 |
| OperationDenied.IpIllegal | IP不合法。 |
| OperationDenied.MIYINGBalanceInsufficient | 觅影资源包余额不足，请先充值。 |
| OperationDenied.NotAllow | 操作不允许 |
| OperationDenied.NotSupportCustomResource | 当前资源组已开启资源按GPU比例预设，仅支持提交含GPU资源的任务 |
| OperationDenied.ResourceGroupInsufficient | 预付费资源组余量不足。 |
| OperationDenied.WhitelistQuotaExceed | 白名单免费配额不足。 |
| ResourceInsufficient.SSHPortIsConsumedUp | SSH端口资源耗尽 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ResourceGroupNotFound | 资源组不存在 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermission | 资源不属于当前登录用户主账号，无权限访问。 |
| UnknownParameter | 未知参数错误。 |
