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

1. 接口描述

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

查询Notebook实例列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNotebookInstances。
Version String 公共参数,本接口取值:2019-10-22。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 偏移量
Limit Integer 限制数目
SortOrder String 排序规则。默认取Descending
Descending 按更新时间降序
Ascending 按更新时间升序
Filters.N Array of Filter 过滤条件。
instance-name - String - 是否必填:否 -(过滤条件)按照名称过滤。
search-by-name - String - 是否必填:否 -(过滤条件)按照名称检索,模糊匹配。
lifecycle-name - String - 是否必填:否 -(过滤条件)按照生命周期脚本名称过滤。
default-code-repo-name - String - 是否必填:否 -(过滤条件)按照默认存储库名称过滤。
additional-code-repo-name - String - 是否必填:否 -(过滤条件)按照其他存储库名称过滤。
billing-status - String - 是否必填:否 - (过滤条件)按照计费状态过滤,可取以下值
StorageOnly:仅存储计费的实例
Computing:计算和存储都计费的实例
SortBy String 【废弃字段】排序字段

3. 输出参数

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

4. 示例

示例1 查询Notebook实例列表

输入示例

https://tione.tencentcloudapi.com/?Action=DescribeNotebookInstances
&Offset=0
&Limit=10
&SortOrder=Descending
&Filters.0.Name=instance-name
&Filters.0.Values.0=aaaafixa1
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "15838635149573473305",
        "TotalCount": 1,
        "NotebookInstanceSet": [
            {
                "CreationTime": "2020-03-06 12:40:35",
                "LastModifiedTime": "2020-03-06 12:43:39",
                "NotebookInstanceName": "aaaafixa1",
                "NotebookInstanceStatus": "Inservice",
                "InstanceType": "MEDIUM4",
                "InstanceId": "notebook-jq5r1whsjl"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。