1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
查询Notebook实例详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNotebookInstance。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NotebookInstanceName | 是 | String | Notebook实例名称 规则:“^[a-zA-Z0-9](-*[a-zA-Z0-9])*$” |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NotebookInstanceName | String | Notebook实例名称 |
InstanceType | String | Notebook算力资源类型 注意:此字段可能返回 null,表示取不到有效值。 |
RoleArn | String | 角色的资源描述 注意:此字段可能返回 null,表示取不到有效值。 |
DirectInternetAccess | String | 外网访问权限 注意:此字段可能返回 null,表示取不到有效值。 |
RootAccess | String | Root用户权限 注意:此字段可能返回 null,表示取不到有效值。 |
SubnetId | String | 子网ID 注意:此字段可能返回 null,表示取不到有效值。 |
VolumeSizeInGB | Integer | 数据卷大小(GB) 注意:此字段可能返回 null,表示取不到有效值。 |
FailureReason | String | 创建失败原因 注意:此字段可能返回 null,表示取不到有效值。 |
CreationTime | Timestamp | Notebook实例创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
LastModifiedTime | Timestamp | Notebook实例最近修改时间 注意:此字段可能返回 null,表示取不到有效值。 |
LogUrl | String | Notebook实例日志链接 注意:此字段可能返回 null,表示取不到有效值。 |
NotebookInstanceStatus | String | Notebook实例状态 Pending: 创建中 Inservice: 运行中 Stopping: 停止中 Stopped: 已停止 Failed: 失败 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceId | String | Notebook实例ID 注意:此字段可能返回 null,表示取不到有效值。 |
LifecycleScriptsName | String | notebook生命周期脚本名称 注意:此字段可能返回 null,表示取不到有效值。 |
DefaultCodeRepository | String | 默认存储库名称 可以是已创建的存储库名称或者已https://开头的公共git库 注意:此字段可能返回 null,表示取不到有效值。 |
AdditionalCodeRepositories | Array of String | 其他存储库列表 每个元素可以是已创建的存储库名称或者已https://开头的公共git库 注意:此字段可能返回 null,表示取不到有效值。 |
ClsAccess | String | 是否开启CLS日志服务 注意:此字段可能返回 null,表示取不到有效值。 |
Prepay | Boolean | 是否预付费实例 注意:此字段可能返回 null,表示取不到有效值。 |
Deadline | Timestamp | 实例运行截止时间 注意:此字段可能返回 null,表示取不到有效值。 |
StoppingCondition | StoppingCondition | 自动停止配置 注意:此字段可能返回 null,表示取不到有效值。 |
ClsConfig | ClsConfig | Cls配置 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Notebook实例
输入示例
https://tione.tencentcloudapi.com/?Action=DescribeNotebookInstance
&NotebookInstanceName=test
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "b869fa8e-f3b8-449b-a356-83e44204942b",
"NotebookInstanceName": "test",
"InstanceType": "TI.SMALL2.1core2g",
"RoleArn": "qcs::cam::uin/20548499:roleName/TIONE_QCSRole",
"DirectInternetAccess": "Enabled",
"RootAccess": "Enabled",
"SubnetId": "subnet-xxx",
"VolumeSizeInGB": 10,
"FailureReason": "InternalError.GetRoleError-[QC_STS] role not exist",
"CreationTime": "2019-11-22 10:15:52",
"LastModifiedTime": "2019-11-22 10:17:48",
"LogUrl": "https://console.cloud.tencent.com/cls/search?region=ap-guangzhou&logset_id=e9c9d84c-b9bc-4b08-a7c5-93441ce4e790&topic_id=29728e56-8076-4100-808e-c22bf69d4c47&product=tione&start_time=2019-11-21+10%3A31%3A21&end_time=2019-11-22+10%3A31%3A21&query=app%3Anotebook-fzdfj62ktj",
"NotebookInstanceStatus": "Failed",
"InstanceId": "notebook-fzdfj62ktj",
"LifecycleScriptsName": "aaa",
"ClsAccess": "Enabled"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |