有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

创建Notebook

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateNotebook。
Version String 公共参数,本接口取值:2021-11-11。
Region String 公共参数,详见产品支持的 地域列表
Name String 名称。不超过60个字符,仅支持中英文、数字、下划线"_"、短横"-",只能以中英文、数字开头
示例值:a1
ChargeType String 计算资源付费模式 ,可选值为:
PREPAID:预付费,即包年包月
POSTPAID_BY_HOUR:按小时后付费
示例值:a1
ResourceConf ResourceConf 计算资源配置
LogEnable Boolean 是否上报日志
示例值:true
RootAccess Boolean 是否ROOT权限
示例值:true
AutoStopping Boolean 是否自动停止
示例值:true
DirectInternetAccess Boolean 是否访问公网
示例值:true
ResourceGroupId String 资源组ID(for预付费)
示例值:a1
VpcId String Vpc-Id
示例值:a1
SubnetId String 子网Id
示例值:a1
VolumeSourceType String 存储的类型。取值包含:
FREE:预付费的免费存储
CLOUD_PREMIUM:高性能云硬盘
CLOUD_SSD:SSD云硬盘
CFS:CFS存储
CFS_TURBO:CFS Turbo存储
GooseFSx:GooseFSx存储
示例值:CFS
VolumeSizeInGB Integer 云硬盘存储卷大小,单位GB
示例值:1
VolumeSourceCFS CFSConfig CFS存储的配置
LogConfig LogConfig 日志配置
LifecycleScriptId String 生命周期脚本的ID
示例值:a1
DefaultCodeRepoId String 默认GIT存储库的ID
示例值:a1
AdditionalCodeRepoIds.N Array of String 其他GIT存储库的ID,最多3个
AutomaticStopTime Integer 自动停止时间,单位小时
示例值:1
Tags.N Array of Tag 标签配置
DataConfigs.N Array of DataConfig 数据配置,只支持WEDATA_HDFS存储类型
示例值:[]
ImageInfo ImageInfo 镜像信息
ImageType String 镜像类型,包括SYSTEM、TCR、CCR
SSHConfig SSHConfig SSH配置信息
VolumeSourceGooseFS GooseFS GooseFS存储配置

3. 输出参数

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

4. 示例

示例1 创建Notebook

创建Notebook

输入示例

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

{
    "Name": "abc",
    "ChargeType": "abc",
    "ResourceConf": {
        "Cpu": 1,
        "Memory": 1,
        "Gpu": 1,
        "GpuType": "abc",
        "InstanceType": "abc"
    },
    "ResourceGroupId": "abc",
    "VpcId": "abc",
    "SubnetId": "abc",
    "VolumeSourceType": "abc",
    "VolumeSizeInGB": 1,
    "VolumeSourceCFS": {
        "Id": "abc",
        "Path": "abc"
    },
    "LogEnable": true,
    "LogConfig": {
        "LogsetId": "abc",
        "TopicId": "abc"
    },
    "RootAccess": true,
    "LifecycleScriptId": "abc",
    "DefaultCodeRepoId": "abc",
    "AdditionalCodeRepoIds": [
        "abc"
    ],
    "AutoStopping": true,
    "AutomaticStopTime": 1,
    "Tags": [
        {
            "TagKey": "abc",
            "TagValue": "abc"
        }
    ],
    "DirectInternetAccess": true,
    "DataConfigs": [
        {
            "MappingPath": "abc",
            "DataSourceType": "abc",
            "DataSetSource": {
                "Id": "abc"
            },
            "COSSource": {
                "Bucket": "abc",
                "Region": "abc",
                "Paths": [
                    "abc"
                ]
            },
            "CFSSource": {
                "Id": "abc",
                "Path": "abc"
            },
            "HDFSSource": {
                "Id": "abc",
                "Path": "abc"
            },
            "GooseFSSource": {
                "Id": "abc"
            }
        }
    ],
    "ImageInfo": {
        "ImageType": "abc",
        "ImageUrl": "abc",
        "RegistryRegion": "abc",
        "RegistryId": "abc"
    },
    "ImageType": "abc"
}

输出示例

{
    "Response": {
        "Id": "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。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.BindingTagsFailed 绑定标签失败。
FailedOperation.FreezeBillFailed 余额不足冻结失败。
FailedOperation.NotAllow 操作不允许。
InternalError 内部错误。
InternalError.QueryResourceGroupFailed 查询预付费资源组详情失败。
InternalError.QuerySubnetInfoFailed 查询子网信息失败。
InternalError.QueryUserTMPCredentialFailed 查询用户临时密钥失败
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.CodeRepoDuplicated 存储库重复配置,请移除重复的存储库配置后重试。
InvalidParameterValue.CodeRepoNotFound 存储库不存在。
InvalidParameterValue.DuplicateName 实例名称冲突,请更换名称后重试。
InvalidParameterValue.GetCFSMountIPFailed 获取CFS的挂载IP失败
InvalidParameterValue.GetGooseFSFailed 获取GooseFS实例失败
InvalidParameterValue.GooseFSConfigCannotEmpty GooseFS的配置不能为空
InvalidParameterValue.GooseFSNotExist 所选的GooseFS实例不存在
InvalidParameterValue.LifecycleNotFound 生命周期脚本无效。
InvalidParameterValue.NotAllowedToCreateFreeVolumeNotebookWithBareMetalResourceGroup 裸金属资源组不支持创建免费存储的Notebook
InvalidParameterValue.NotAllowedToCreateFreeVolumeNotebookWithSWResourceGroup 纳管资源组不支持cbs存储,请使用CFS
InvalidParameterValue.NotAllowedToCreateNotebookWithBareMetalResourceGroup 裸金属资源组不支持创建Notebook
InvalidParameterValue.ResourceConfigIllegal 资源配置不合法
InvalidParameterValue.SubnetNotFound 子网不存在。
InvalidParameterValue.TopicNotFound 未找到当前日志主题。
InvalidParameterValue.UnsupportedGooseFSConfig 不支持使用GooseFS实例
OperationDenied.BalanceInsufficient 余额不足,创建/更新失败。
OperationDenied.BillingStatusResourceInsufficient 按量计费资源售罄。
OperationDenied.IpIllegal IP不合法。
OperationDenied.MIYINGBalanceInsufficient 觅影资源包余额不足,请先充值。
OperationDenied.NetworkCidrIllegal 网段不合法。
OperationDenied.NotAllow 操作不允许
OperationDenied.ResourceGroupInsufficient 预付费资源组余量不足。
OperationDenied.WhitelistQuotaExceed 白名单免费配额不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermission 资源不属于当前登录用户主账号,无权限访问。
UnknownParameter 未知参数错误。