文档首页/ AI开发平台ModelArts/ API参考/ 开发环境管理/ 查询Notebook支持的有效规格列表
更新时间：2025-08-19 GMT+08:00
查看PDF
分享

查询Notebook支持的有效规格列表

功能介绍

查询Notebook支持的有效规格列表接口用于获取运行Notebook实例时可使用的规格选项。该接口适用于以下场景：用户需要了解Notebook实例支持的配置选项时，可通过此接口查询可用的规格列表。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例的权限。调用该接口后，系统将返回Notebook实例支持的有效规格列表，包括内存、CPU等配置信息。若用户无权限访问指定实例或Notebook实例未运行，接口将返回相应的错误信息。

接口约束

暂无约束。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/notebooks/flavors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：用户项目ID，获取方法请参见获取项目ID和名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

category

否

String

参数解释：规格处理器类型。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

  • CPU

  • GPU

  • ASCEND

默认取值：不涉及。

limit

否

Integer

参数解释：每一页显示的有效规格数量，默认不限制。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

offset

否

Integer

参数解释：分页记录的起始位置偏移量。

约束限制：不涉及。

取值范围：不涉及。

默认取值：0。

type

否

String

参数解释：集群类型。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

  • MANAGED：公共集群

  • DEDICATED：专属集群

默认取值：不涉及。

sort_dir

否

String

参数解释：排序方式。

约束限制：不涉及。

取值范围：枚举类型，取值如下：

  • ASC：升序

  • DESC：降序

默认取值：DESC。

sort_key

否

String

参数解释：排序的字段，多个字段使用(“,”)逗号分隔。

约束限制：不涉及。

取值范围：长度限制为128个字符，支持大小写字母、数字、中划线、下划线和逗号。

默认取值：不涉及。

flavor_type

否

String

参数解释：资源类型

约束限制：不涉及。

取值范围：枚举类型，取值如下：

-ASCEND_SNT9

-ASCEND_SNT9B

-ASCEND_SNT3

默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

current

Integer

参数解释：当前页数。

取值范围：正整数。

data

Array of NotebookFlavor objects

参数解释：分页数据。

flavors

Array of NotebookFlavor objects

参数解释：支持切换的规格列表。

pages

Integer

参数解释：总的页数。

取值范围：正整数。

size

Integer

参数解释：每一页的数量。

取值范围：正整数。

total

Long

参数解释：总的记录数量。

取值范围：非负整数。
表4 NotebookFlavor

参数

参数类型

描述

arch

String

参数解释：架构类型。

取值范围：枚举类型，取值如下：

  • X86_64

  • AARCH64

ascend

AscendInfo object

参数解释：NPU信息。

billing

BillingInfo object

参数解释：话单信息。

category

String

参数解释：规格处理器类型。

取值范围：枚举类型，取值如下：

  • CPU

  • GPU

  • ASCEND

description

String

参数解释：规格描述信息。

取值范围：不涉及。

feature

String

参数解释：实例类别。

取值范围：枚举类型，取值如下：

  • DEFAULT：CodeLab免费规格实例，每个用户最多只能创建一个。

  • NOTEBOOK：计费规格实例。

free

Boolean

参数解释：是否为免费规格。

取值范围：布尔类型：

  • true：免费规格。

  • false：不是免费规格。

gpu

GPUInfo object

参数解释：GPU信息。

id

String

参数解释：规格ID。

取值范围：不涉及。

memory

Long

参数解释：内存大小。

取值范围：不涉及。

name

String

参数解释：规格名称。

取值范围：不涉及。

sold_out

Boolean

参数解释：资源是否充足。

取值范围：布尔类型：

  • true 资源不足

  • false 资源充足

storages

Array of strings

参数解释：规格支持的存储类型。枚举类型，取值如下：

  • EFS

  • EVS

vcpus

Integer

参数解释：CPU核数。

取值范围：不涉及。
表5 AscendInfo

参数

参数类型

描述

npu

Integer

参数解释：NPU数量。

取值范围：不涉及。

npu_memory

String

参数解释：NPU内存。

取值范围：不涉及。

type

String

参数解释：NPU类型。

取值范围：不涉及。
表6 BillingInfo

参数

参数类型

描述

code

String

参数解释：计费码。

取值范围：不涉及。

unit_num

Integer

参数解释：计费单元。

取值范围：不涉及。
表7 GPUInfo

参数

参数类型

描述

gpu

Integer

参数解释：GPU卡数。

取值范围：不涉及。

gpu_memory

String

参数解释：GPU内存。

取值范围：不涉及。

type

String

参数解释：GPU类型。

取值范围：不涉及。

请求示例

GET https://{endpoint}/v1/{project_id}/notebooks/flavors

响应示例

状态码：200

OK。

{
  "current" : 1,
  "data" : [ {
    "arch" : "x86_64",
    "billing" : {
      "code" : "modelarts.vm.cpu.2u",
      "unit_num" : 1
    },
    "category" : "CPU",
    "description" : "Intel CPU通用规格，用于快速数据探索和实验",
    "feature" : "NOTEBOOK",
    "free" : false,
    "id" : "modelarts.vm.cpu.2u",
    "memory" : 8388608,
    "name" : "CPU: 2核 8GB",
    "sold_out" : false,
    "storages" : [ "EVS", "OBSFS", "EFS", "OBS" ],
    "vcpus" : 2
  } ],
  "pages" : 1,
  "size" : 1,
  "total" : 1
}

状态码

状态码

描述

200

OK。

401

Unauthorized。

403

Forbidden。

404

Not Found。

错误码

请参见错误码。

父主题： 开发环境管理