查询Notebook支持的可切换规格列表
功能介绍
查询Notebook支持的可切换规格列表接口用于获取创建Notebook实例时可选择的规格选项。该接口适用于以下场景:用户需要了解Notebook实例支持的配置选项时,可通过此接口查询可用的规格列表。使用该接口的前提条件是用户已登录系统并具有创建Notebook实例的权限。调用该接口后,系统将返回Notebook实例支持的可切换规格列表,包括内存、CPU等配置信息。若用户无权限创建Notebook实例,接口将返回相应的错误信息。
接口约束
暂无约束。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/notebooks/{id}/flavors
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
参数解释:Notebook实例ID。ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID),可通过调用查询Notebook实例列表接口获取。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
project_id |
是 |
String |
参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释:每一页显示的有效规格数量,默认不限制。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
offset |
否 |
Integer |
参数解释:分页记录的起始位置偏移量。 约束限制:不涉及。 取值范围:不涉及。 默认取值:0。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
current |
Integer |
参数解释:当前页数。 取值范围:正整数。 |
data |
Array of NotebookFlavor objects |
参数解释:分页数据。 |
flavors |
Array of NotebookFlavor objects |
参数解释:支持切换的规格列表。 |
pages |
Integer |
参数解释:总的页数。 取值范围:正整数。 |
size |
Integer |
参数解释:每一页的数量。 取值范围:正整数。 |
total |
Long |
参数解释:总的记录数量。 取值范围:非负整数。 |
参数 |
参数类型 |
描述 |
---|---|---|
arch |
String |
参数解释:架构类型。 取值范围:枚举类型,取值如下:
|
ascend |
AscendInfo object |
参数解释:NPU信息。 |
billing |
BillingInfo object |
参数解释:话单信息。 |
category |
String |
参数解释:规格处理器类型。 取值范围:枚举类型,取值如下:
|
description |
String |
参数解释:规格描述信息。 取值范围:不涉及。 |
feature |
String |
参数解释:实例类别。 取值范围:枚举类型,取值如下:
|
free |
Boolean |
参数解释:是否为免费规格。 取值范围:布尔类型:
|
gpu |
GPUInfo object |
参数解释:GPU信息。 |
id |
String |
参数解释:规格ID。 取值范围:不涉及。 |
memory |
Long |
参数解释:内存大小。 取值范围:不涉及。 |
name |
String |
参数解释:规格名称。 取值范围:不涉及。 |
sold_out |
Boolean |
参数解释:资源是否充足。 取值范围:布尔类型:
|
storages |
Array of strings |
参数解释:规格支持的存储类型。枚举类型,取值如下:
|
vcpus |
Integer |
参数解释:CPU核数。 取值范围:不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/notebooks/{id}/flavors
响应示例
状态码:200
OK。
{ "current" : 1, "data" : [ { "arch" : "aarch64", "ascend" : { "npu_memory" : "32", "npu" : 2, "type" : "ascend-snt9" }, "billing" : { "code" : "modelarts.kat1.xlarge", "unit_num" : 2 }, "category" : "ASCEND", "description" : "The Ascend specification is suitable for deep learning code running and debugging", "feature" : "NOTEBOOK", "free" : false, "id" : "modelarts.bm.snt9.xlarge.2", "memory" : 201326592, "name" : "Ascend: 2*Ascend snt9|CPU: 48vCPUs 192GB", "sold_out" : false, "storages" : [ "EFS" ], "vcpus" : 48 }, { "arch" : "aarch64", "ascend" : { "npu_memory" : "128", "npu" : 8, "type" : "ascend-snt9" }, "billing" : { "code" : "modelarts.kat1.8xlarge", "unit_num" : 1 }, "category" : "ASCEND", "description" : "The Ascend specification is suitable for deep learning code running and debugging", "feature" : "NOTEBOOK", "free" : false, "id" : "modelarts.bm.snt9.xlarge.8", "memory" : 805306368, "name" : "Ascend: 8*Ascend snt9|CPU: 192vCPUs 768GB", "sold_out" : false, "storages" : [ "EFS" ], "vcpus" : 192 } ], "flavors" : [ { "arch" : "aarch64", "ascend" : { "npu_memory" : "32", "npu" : 2, "type" : "ascend-snt9" }, "billing" : { "code" : "modelarts.kat1.xlarge", "unit_num" : 2 }, "category" : "ASCEND", "description" : "The Ascend specification is suitable for deep learning code running and debugging", "feature" : "NOTEBOOK", "free" : false, "id" : "modelarts.bm.snt9.xlarge.2", "memory" : 201326592, "name" : "Ascend: 2*Ascend snt9|CPU: 48vCPUs 192GB", "sold_out" : false, "storages" : [ "EFS" ], "vcpus" : 48 }, { "arch" : "aarch64", "ascend" : { "npu_memory" : "128", "npu" : 8, "type" : "ascend-snt9" }, "billing" : { "code" : "modelarts.kat1.8xlarge", "unit_num" : 1 }, "category" : "ASCEND", "description" : "The Ascend specification is suitable for deep learning code running and debugging", "feature" : "NOTEBOOK", "free" : false, "id" : "modelarts.bm.snt9.xlarge.8", "memory" : 805306368, "name" : "Ascend: 8*Ascend snt9|CPU: 192vCPUs 768GB", "sold_out" : false, "storages" : [ "EFS" ], "vcpus" : 192 } ], "pages" : 1, "size" : 2, "total" : 2 }
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
401 |
Unauthorized。 |
403 |
Forbidden。 |
404 |
Not Found。 |
错误码
请参见错误码。