1. 接口描述
接口请求域名： tione.tencentcloudapi.com 。
Notebook列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeNotebooks。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Offset | 否 | Integer | 偏移量，默认为0 示例值：1 |
| Limit | 否 | Integer | 每页返回的实例数，默认为10 示例值：10 |
| Order | 否 | String | 输出列表的排列顺序。取值范围：ASC：升序排列 DESC：降序排列。默认为DESC 示例值：DESC |
| OrderField | 否 | String | 根据哪个字段排序，如：CreateTime、UpdateTime，默认为UpdateTime 示例值：CreateTime |
| Filters.N | 否 | Array of Filter | 过滤器，eg：[{ "Name": "Id", "Values": ["nb-123456789"] }] 取值范围 Name（名称）：notebook1 Id（notebook ID）：nb-123456789 Status（状态）：Starting / Running / Stopped / Stopping / Failed / SubmitFailed Creator（创建者 uin）：100014761913 ChargeType（计费类型）：PREPAID（预付费）/ POSTPAID_BY_HOUR（后付费） ChargeStatus（计费状态）：NOT_BILLING（未开始计费）/ BILLING（计费中）/ BILLING_STORAGE（存储计费中）/ARREARS_STOP（欠费停止） DefaultCodeRepoId（默认代码仓库ID）：cr-123456789 AdditionalCodeRepoId（关联代码仓库ID）：cr-123456789 LifecycleScriptId（生命周期ID）：ls-12312312311312 |
| TagFilters.N | 否 | Array of TagFilter | 标签过滤器，eg：[{ "TagKey": "TagKeyA", "TagValue": ["TagValueA"] }] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NotebookSet | Array of NotebookSetItem | 详情 |
| TotalCount | Integer | 总条数 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Notebook列表
Notebook列表
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotebooks
<公共请求参数>
{
"OrderField": "string",
"TagFilters": [
{
"TagValues": [
"string"
],
"TagKey": "string"
}
],
"Limit": 0,
"Filters": [
{
"Fuzzy": true,
"Values": [
"string"
],
"Name": "string",
"Negative": true
}
],
"Offset": 0,
"Order": "string"
}输出示例
{
"Response": {
"NotebookSet": [
{
"Id": "nb-1188508294472113920",
"Name": "notebook-test",
"ChargeType": "POSTPAID_BY_HOUR",
"ResourceConf": {
"Gpu": 1,
"Cpu": 2018,
"GpuType": "V100",
"InstanceType": "TI.S.MEDIUM.POST",
"Memory": 4000
},
"ResourceGroupId": "trsg-dwpqnjmk",
"VolumeSizeInGB": 100,
"BillingInfos": [
"info"
],
"Tags": [
{
"TagKey": "test-key",
"TagValue": "test-value"
}
],
"CreateTime": "2024-11-11T10:50:44+08",
"StartTime": "2024-11-11T10:51:44+08",
"UpdateTime": "2024-11-11T10:51:44+08",
"RuntimeInSeconds": 100,
"ChargeStatus": "BILLING",
"Status": "Stopped",
"FailureReason": "errMsg",
"EndTime": "2024-11-14T17:22:16+08",
"PodName": "nb-1188501796310898048-912gqy8i0xvk",
"InstanceTypeAlias": "2C4G",
"ResourceGroupName": "resource-test",
"AutoStopping": true,
"AutomaticStopTime": 100,
"VolumeSourceType": "CFS",
"VolumeSourceCFS": {
"Id": "cfs-9su5kqtv",
"Path": "/path",
"Protocol": "NFS",
"MountType": "STORAGE"
},
"Message": "message1",
"UserTypes": [
"AiMarket"
],
"SSHConfig": {
"Enable": true,
"PublicKey": "ssh-rsa AAAA*.00=",
"Port": 6001,
"LoginCommand": "ssh -p 127.0.0.1:6001"
}
}
],
"TotalCount": 1,
"RequestId": "ecc8d2f6-9772-40df-856f-f6e48c6a7008"
}
}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.CheckBillingWhiteListFailed | 查询计费白名单失败 |
| FailedOperation.QueryPriceFailed | 查询计费价格失败。 |
| FailedOperation.QueryResourceGroupNamesFailed | 查询资源组名称失败。 |
| FailedOperation.QueryResourceSpecFailed | 查询计费项详情失败。 |
| InternalError | 内部错误。 |
| InternalError.QueryBindingTagsFailed | 查询标签失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.FilterKeyStatusConflictWithChargeStatus | 接口过滤条件"运行状态"与"计费状态"不能同时存在。 |
| UnknownParameter | 未知参数错误。 |
