文档首页/ AI开发平台ModelArts/ API参考/ 开发环境管理/ 查询Notebook资源池详情
更新时间：2025-11-19 GMT+08:00
查看PDF
分享

查询Notebook资源池详情

功能介绍

查询Notebook资源池详情接口用于获取资源池的详细信息。该接口适用于以下场景：当用户需要创建Notebook实例作业时，可通过此接口查询指定集群的详细信息。使用该接口的前提条件是集群已成功纳管且用户具有相应的访问权限。调用该接口后，系统将返回集群的实例ID、名称、Flavor规格、实例状态以及实例可打开的URL等详细信息。若集群不存在、未被纳管或用户无权限访问，接口将返回相应的错误信息。

调试

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

URI

GET /v1/{project_id}/authoring/clusters/{cluster_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制：1 - 64字符，字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。

cluster_id

是

String

参数解释：纳管集群ID。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

logic_cluster_id

String

参数解释： 逻辑资源池ID。

取值范围： 不涉及。

status

String

参数解释：资源池状态。

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

  • PENDING：等待中。

  • INITIALIZING：初始化中。

  • INITIALIZE_FAILED：初始化失败。

  • ACTIVE：可用。

  • DELETING：删除中。

  • DELETED：已删除。

  • DELETE_FAILED：删除失败。

  • MIGRATING：迁移中。

pool_id

String

参数解释：资源池ID。

取值范围：不涉及。

type

String

参数解释：资源池类型。

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

  • MANAGED：公共池。

  • DEDICATED：专属池。

resource_categories

String

参数解释：资源类别。

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

  • GPU

  • CPU

  • ASCEND

workspace_id

String

参数解释：工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

取值范围：不涉及。

create_at

String

参数解释：实例创建的时间，UTC毫秒。

取值范围：不涉及。

update_at

String

参数解释：实例最后更新的时间，UTC毫秒。

取值范围：不涉及。

project_id

String

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

取值范围：不涉及。

domain_id

String

参数解释：账号ID。

取值范围：不涉及。

flavors

Array of Flavor objects

参数解释：资源池规格。
表3 Flavor

参数

参数类型

描述

arch

String

参数解释：硬件架构类型。

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

  • x86_64：X86架构。

  • aarch64：ARM架构。

billing

BillingInfo object

参数解释：话单信息。

category

String

参数解释：处理器类型。

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

  • CPU

  • GPU

  • ASCEND

description

String

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

取值范围：不涉及。

evs_max_size

String

参数解释：规格包含EVS时，EVS存储创建的最大上限(单位：GB)。

取值范围：不涉及。

evs_sku_code

String

参数解释：规格包含EVS时，EVS存储的sku编码。

取值范围：不涉及。

feature

String

参数解释：规格类别。

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

  • DEFAULT：CodeLab规格。

  • NOTEBOOK：Notebook规格。

free

Boolean

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

取值范围：布尔类型：

  • true：免费规格。

  • false：非免费规格。

grow_support_type

String

参数解释：支持站点类型。

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

  • COMMON：国内与国际站都支持。

  • NATIONAL：仅在国内站支持。

  • INTERNATIONAL：仅在国际站支持。

  • NONE：国内与国际站都不支持。

id

String

参数解释：规格ID。

取值范围：不涉及。

memory

String

参数解释：内存大小。

取值范围：不涉及。

name

String

参数解释：规格名称。

取值范围：不涉及。

sold_out

Boolean

参数解释：是否告罄。

取值范围：布尔类型：

  • true：告罄。

  • false：未告罄。

storages

Array of strings

参数解释：规格支持的存储类型。

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

  • EVS：云硬盘。

  • OBS：对象存储服务。

  • OBSFS：并行文件系统。

  • EFS：弹性文件服务（SFS Turbo）

vcpus

Integer

参数解释：CPU核数。

取值范围：不涉及。

gpu

GPUsInfo object

参数解释：当处理器类型为GPU时，GPU规格信息。

ascend

AscendInfo object

参数解释：当处理器类型为ASCEND时，ASCEND规格信息。
表4 BillingInfo

参数

参数类型

描述

code

String

参数解释：计费码。

取值范围：不涉及。

unit_num

Integer

参数解释：计费单元。

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

参数

参数类型

描述

type

String

参数解释：GPU类型。

取值范围：不涉及。

gpu

Double

参数解释：GPU卡数。

取值范围：不涉及。

gpu_memory

String

参数解释：GPU内存。

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

参数

参数类型

描述

npu

Integer

参数解释：NPU数量。

取值范围：不涉及。

npu_memory

String

参数解释：NPU内存。

取值范围：不涉及。

type

String

参数解释：NPU类型。

取值范围：不涉及。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

请求示例

无

响应示例

无

状态码

状态码

描述

200

OK。

401

Unauthorized。

403

Forbidden。

404

Not Found。

错误码

请参见错误码。

父主题： 开发环境管理