修改Notebook

最近更新时间:2026-01-08 03:06:50

我的收藏

1. 接口描述

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

修改Notebook

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

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

2. 输入参数

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

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

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: ModifyNotebook
<公共请求参数>

{
    "Id": "nb-32178932173972137",
    "Name": "liming-notebook",
    "ChargeType": "POSTPAID_BY_HOUR",
    "ResourceConf": {
        "Cpu": 2000,
        "Memory": 4096,
        "Gpu": 1,
        "GpuType": "V100",
        "InstanceType": "TI.GN10.2XLARGE40.POST"
    },
    "ResourceGroupId": "trsg-dwpqnjmk",
    "VpcId": "vpc-4kq8vlym",
    "SubnetId": "subnet-58zkmdob",
    "VolumeSourceType": "CFS",
    "VolumeSizeInGB": 1,
    "VolumeSourceCFS": {
        "Id": "cfs-9su5kqtv",
        "Path": "/tione"
    },
    "LogEnable": true,
    "LogConfig": {
        "LogsetId": "4dd0a097-f629-4afc-9b99-888ef99a178f",
        "TopicId": "ea8048db-8f97-4abb-9668-f3532b9b61f8"
    },
    "RootAccess": true,
    "LifecycleScriptId": "ls-1007228485705742720",
    "DefaultCodeRepoId": "cr-1000669213287070080",
    "AdditionalCodeRepoIds": [
        "cr-1000669213287070081"
    ],
    "AutoStopping": true,
    "AutomaticStopTime": 1,
    "Tags": [
        {
            "TagKey": "test-key",
            "TagValue": "test-value"
        }
    ],
    "DirectInternetAccess": true,
    "DataConfigs": [
        {
            "MappingPath": "/home/tione/notebook",
            "DataSourceType": "CLOUD_PREMIUM",
            "CBSSource": {
                "VolumeSizeInGB": 50
            }
        }
    ],
    "ImageInfo": {
        "ImageType": "SYSTEM",
        "ImageUrl": "tione.tencentcloudcr.com/qcloud-ti-platform/llm-train:24.03-gpu-py310-cu124-tilearn-llm-v1.8.0",
        "ImageName": "tilearn-llm0.9-torch2.3-py3.10-cuda12.4-gpu"
    },
    "ImageType": "SYSTEM"
}

输出示例

{
    "Response": {
        "RequestId": "27103821308080d8sgdsggdsgd"
    }
}

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.ModifyResourceBillingTagsFailed 修改计费统计的资源关联标签失败
FailedOperation.NotAllow 操作不允许。
FailedOperation.UnBindingTagsFailed 解绑标签失败。
FailedOperation.UnauthorizedOperation 无操作权限
InternalError 内部错误。
InternalError.BindingTagsFailed 绑定标签失败
InternalError.CreateCustomSecretFailed 创建自定义密钥失败
InternalError.DeleteCustomSecretFailed 删除自定义密钥失败
InternalError.DescribeCustomSecretFailed 查询自定义密钥失败
InternalError.DescribeSubuinDependencyAccessibilityFailed 获取用户依赖权限失败
InternalError.ModifyCustomSecretFailed 修改自定义密钥失败
InvalidParameter 参数错误。
InvalidParameter.UnsupportedMultiLocalDisk 不支持使用多个本地磁盘
InvalidParameterValue.CcnHasNoAttachedVpc 云联网未被关联VPC
InvalidParameterValue.CodeRepoNotFound 存储库不存在。
InvalidParameterValue.DataConfigNumLimitExceeded 数据配置数量超过最大限制
InvalidParameterValue.DuplicateName 实例名称冲突,请更换名称后重试。
InvalidParameterValue.ImageAddressIllegal 镜像地址不合法,请重新填写
InvalidParameterValue.ImageIllegal 镜像地址不合法
InvalidParameterValue.InvalidImageName 非法镜像
InvalidParameterValue.InvalidResourceSpec 非法资源规格
InvalidParameterValue.LifecycleNotFound 生命周期脚本无效。
InvalidParameterValue.PathIllegal 本地盘路径不合法
InvalidParameterValue.SubnetNotFound 子网不存在。
InvalidParameterValue.TopicNotFound 未找到当前日志主题。
InvalidParameterValue.VolumeShrinkNotAllow Notebook卷大小只能增加,如需减小容量请重新创建实例。
OperationDenied.ForbidModifyVpcAndSubnet vpc 和 子网 禁止修改
OperationDenied.WhitelistQuotaExceed 白名单免费配额不足。
ResourceNotFound 资源不存在。
ResourceNotFound.ResourceGroupNotFound 资源组不存在
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermission 资源不属于当前登录用户主账号,无权限访问。
UnknownParameter 未知参数错误。