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

1. 接口描述

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

更新Notebook实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateNotebookInstance。
Version String 公共参数,本接口取值:2019-10-22。
Region String 公共参数,详见产品支持的 地域列表
NotebookInstanceName String Notebook实例名称
规则:“^[a-zA-Z0-9](-*[a-zA-Z0-9])*$”
RoleArn String 角色的资源描述
RootAccess String Root访问权限
VolumeSizeInGB Integer 数据卷大小(GB)
InstanceType String 算力资源类型
LifecycleScriptsName String notebook生命周期脚本名称
DisassociateLifecycleScript Boolean 是否解绑生命周期脚本,默认 false。
该值为true时,LifecycleScriptsName将被忽略
DefaultCodeRepository String 默认存储库名称
可以是已创建的存储库名称或者已https://开头的公共git库
AdditionalCodeRepositories.N Array of String 其他存储库列表
每个元素可以是已创建的存储库名称或者已https://开头的公共git库
DisassociateDefaultCodeRepository Boolean 是否取消关联默认存储库,默认false
该值为true时,DefaultCodeRepository将被忽略
DisassociateAdditionalCodeRepositories Boolean 是否取消关联其他存储库,默认false
该值为true时,AdditionalCodeRepositories将被忽略
ClsAccess String 已弃用,请使用ClsConfig配置。是否开启CLS日志服务,可取值Enabled/Disabled
AutoStopping String 自动停止,可取值Enabled/Disabled
取值为Disabled的时候StoppingCondition将被忽略
取值为Enabled的时候读取StoppingCondition作为自动停止的配置
StoppingCondition StoppingCondition 自动停止配置,只在AutoStopping为Enabled的时候生效
ClsConfig ClsConfig 接入日志的配置,默认使用免费日志服务。

3. 输出参数

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

4. 示例

示例1 更新Notebook实例

输入示例

https://tione.tencentcloudapi.com/?Action=UpdateNotebookInstance
&NotebookInstanceName=apitest
&RoleArn=role_name
&RootAccess=Enabled
&VolumeSizeInGB=20
&LifecycleScriptsName=aaa
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "1ac85a52-fb9d-4b28-b0fa-1017b9ada1ac"
    }
}

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日志服务,请开前往开通。
FailedOperation.NotAllow 操作不允许。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ClsConfigRequired 请设置日志集、日志主题ID。
InvalidParameterValue.CodeRepoNotFound 存储库不存在。
InvalidParameterValue.LogSetNotFound 未找到当前日志集。
InvalidParameterValue.TopicNotFound 未找到当前日志主题。
InvalidParameterValue.VolumeShrinkNotAllow Notebook卷大小只能增加,如需减小容量请重新创建实例。
ResourceNotFound 资源不存在。
ResourceUnavailable.BillNotActivated 未开通该地域服务,请先开通。