1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
Notebook详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNotebook。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Id | 是 | String | notebook id 示例值:nb-12345 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
NotebookDetail | NotebookDetail | 详情 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Notebook详情
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotebook
<公共请求参数>
{
"Id": "nb-1188508294472113920"
}
输出示例
{
"Response": {
"RequestId": "ecc8d2f6-9772-40df-856f-f6e48c6a7008",
"NotebookDetail": {
"ChargeType": "POSTPAID_BY_HOUR",
"AutomaticStopTime": 0,
"EndTime": "2024-11-14T17:22:16+08",
"ChargeStatus": "BILLING",
"Status": "Stopped",
"UpdateTime": "2024-11-14T17:17:51+08",
"DataSource": "CFS",
"Message": "test",
"VolumeSourceCFS": {
"Id": "cfs-9su5kqtv",
"Path": "/tione",
"Protocol": "NFS",
"MountType": "STORAGE"
},
"VolumeSourceType": "CFS",
"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",
"RegistryId": "",
"RegistryRegion": ""
},
"ImageType": "SYSTEM",
"DataConfigs": [
{
"MappingPath": "/home/tione/notebook",
"DataSourceType": "CFS",
"DataSourceUsage": "test",
"HDFSSource": {
"Id": "hd-sds",
"Path": "/date"
},
"CFSTurboSource": {
"Id": "cfs-14csdso5",
"Path": "/tione"
},
"CFSSource": {
"Id": "cfs-14cpoxo5",
"Protocol": "NFS",
"MountType": "STORAGE",
"Path": "/tione"
},
"COSSource": {
"Bucket": "harry-1318247806",
"Region": "ap-shanghai",
"Paths": [
"/test"
]
},
"GooseFSSource": {
"Id": "",
"Type": "",
"Path": "",
"NameSpace": ""
},
"LocalDiskSource": {
"InstanceId": ""
},
"CBSSource": {
"VolumeSizeInGB": 0
},
"DataSetSource": {
"Id": ""
}
}
],
"VpcId": "vpc-hb7u9q6e",
"Tags": [
{
"TagKey": "test-key",
"TagValue": "test-value"
}
],
"Id": "nb-1188508294472113920",
"ResourceGroupId": "trsg-dwpqnjmk",
"SubnetId": "subnet-58zkmdob",
"LifecycleScriptId": "ls-1007228485705742720",
"RootAccess": true,
"Name": "notebook-test",
"DefaultCodeRepoId": "cr-1000669213287070080",
"ResourceConf": {
"Gpu": 1,
"Cpu": 2018,
"GpuType": "V100",
"InstanceType": "TI.S.MEDIUM.POST",
"Memory": 4000
},
"AutoStopping": true,
"ResourceGroupName": "resource-test",
"LogEnable": true,
"BillingInfos": [
"info"
],
"InstanceTypeAlias": "2C4G",
"AdditionalCodeRepoIds": [
"cr-1000669213287070080"
],
"DirectInternetAccess": true,
"CreateTime": "2024-11-11T10:50:44+08",
"JobCreateTime": "2024-11-14T16:58:00+08",
"RuntimeInSeconds": 100,
"VolumeSizeInGB": 100,
"StartTime": "2024-11-14T19:50:10+08",
"PodName": "nb-1188501796310898048-912gqy8i0xvk",
"FailureReason": "no-msg",
"SubUin": "100032979603",
"LogConfig": {
"TopicId": "ea8048db-8f97-4abb-9668-f3532b9b61f8",
"LogsetId": "4dd0a097-f629-4afc-9b99-888ef99a178f"
}
}
}
}
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.QueryBindingTagsFailed | 查询资源标签失败。 |
FailedOperation.QueryPriceFailed | 查询计费价格失败。 |
FailedOperation.QueryResourceGroupNamesFailed | 查询资源组名称失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.NoPermission | 资源不属于当前登录用户主账号,无权限访问。 |
UnknownParameter | 未知参数错误。 |