查询用户所有Notebook资源池实例详情 - ListAuthoringClusters

功能介绍

查询用户所有Notebook资源池实例详情接口用于获取用户关联的所有Notebook资源池实例的详细信息。该接口适用于以下场景：当用户创建Notebook示例需要选择资源池时，可通过此接口获取所有资源池实例列表信息。使用该接口的前提条件是用户已注册并登录系统，且具有查看资源池实例的权限。调用成功后，接口将返回包含所有资源池实例的详细信息列表，包括实例名称、状态、节点规格等。若用户未登录、无权限访问或系统内部出现错误，接口将返回相应的错误信息，如未认证、无权限或服务不可用等。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/authoring/clusters

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：1 - 64字符，字母、数字和中划线。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
type	是	String	参数解释：资源池类型。约束限制：不涉及。取值范围：枚举类型，取值如下： MANAGED：公共池。 DEDICATED：专属池。默认取值：不涉及。
workspace_id	否	String	参数解释：工作空间ID。获取方法请参见查询工作空间列表。约束限制：存在并使用的工作空间。取值范围：不涉及。默认取值：“0”。
limit	否	Integer	参数解释：每一页显示实例的数量。约束限制：不涉及。取值范围：大于等于0。默认取值：1000。
offset	否	Integer	参数解释：数据条目偏移量。约束限制：不涉及。取值范围：大于等于0。默认取值：0。
scope	否	String	参数解释：作业类型。约束限制：不涉及。取值范围：枚举类型，取值如下： NOTEBOOK：开发环境 TRAIN：训练作业 INFER：推理作业默认取值：NOTEBOOK。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
current	Integer	参数解释：当前页数。取值范围：正整数。
data	Array of ClusterResponse objects	参数解释：Notebook实例数据。
pages	Integer	参数解释：总的页数。取值范围：正整数。
size	Integer	参数解释：每一页的数量。取值范围：正整数。
total	Long	参数解释：总的记录数量。取值范围：非负整数。

表4 ClusterResponse
参数	参数类型	描述
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	参数解释：资源池规格。
is_allow_root	Boolean	参数解释：资源池是否允许实例以root启动。

表5 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规格信息。

表6 BillingInfo
参数	参数类型	描述
code	String	参数解释：计费码。取值范围：不涉及。
unit_num	Integer	参数解释：计费单元。取值范围：不涉及。

表7 GPUsInfo
参数	参数类型	描述
type	String	参数解释：GPU类型。取值范围：不涉及。
gpu	Double	参数解释：GPU卡数。取值范围：不涉及。
gpu_memory	String	参数解释：GPU内存。取值范围：不涉及。

表8 AscendInfo
参数	参数类型	描述
npu	Integer	参数解释：NPU数量。取值范围：不涉及。
npu_memory	String	参数解释：NPU内存。取值范围：不涉及。
type	String	参数解释：NPU类型。取值范围：不涉及。
chip	Integer	参数解释：NPU设备数。取值范围：不涉及。

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：404

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

请求示例

GET /v1/{project_id}/authoring/clusters

响应示例

状态码：200

OK。

{
  "current" : 0,
  "data" : [ {
    "logic_cluster_id" : "e393b479-bd29-4131-9d89-e8f5d98ea16c",
    "status" : "ACTIVE",
    "pool_id" : "pool-traintest-memarts-06024304be00d5092fbdc0013d201342",
    "type" : "DEDICATED",
    "resource_categories" : [ "CPU" ],
    "flavors" : [ {
      "arch" : "x86_64",
      "billing" : {
        "code" : "modelarts.vm.cpu.2u",
        "unit_num" : 1
      },
      "category" : "CPU",
      "description" : "Intel CPU通用规格，用于快速数据探索和实验",
      "evs_max_size" : "4096",
      "evs_sku_code" : "modelarts.storage.evs.ssd",
      "feature" : "NOTEBOOK",
      "free" : false,
      "grow_support_type" : "INTERNATIONAL",
      "id" : "modelarts.vm.cpu.2u",
      "memory" : 8388608,
      "name" : "CPU: 2核 8GB",
      "sold_out" : false,
      "storages" : [ "EFS_DEDICATED", "OBS", "OBSFS", "EVS" ],
      "vcpus" : 2
    }, {
      "arch" : "x86_64",
      "billing" : {
        "code" : "modelarts.vm.cpu.4u",
        "unit_num" : 1
      },
      "category" : "CPU",
      "description" : "Intel CPU通用规格，用于快速数据探索和实验",
      "evs_max_size" : "4096",
      "evs_sku_code" : "modelarts.storage.evs.ssd",
      "feature" : "NOTEBOOK",
      "free" : false,
      "grow_support_type" : "COMMON",
      "id" : "modelarts.vm.cpu.4u",
      "memory" : 16777216,
      "name" : "CPU: 4核 16GB",
      "sold_out" : false,
      "storages" : [ "EFS_DEDICATED", "OBS", "OBSFS", "EVS" ],
      "vcpus" : 4
    }, {
      "arch" : "x86_64",
      "billing" : {
        "code" : "modelarts.vm.cpu.8u.2xlarge.predefined",
        "unit_num" : 1
      },
      "category" : "CPU",
      "description" : "Intel CPU算力增强型，适用于密集计算场景下运算",
      "evs_max_size" : "4096",
      "evs_sku_code" : "modelarts.storage.evs.ssd",
      "feature" : "NOTEBOOK",
      "free" : false,
      "grow_support_type" : "NONE",
      "id" : "modelarts.vm.cpu.8u.2xlarge.predefined",
      "memory" : 33554432,
      "name" : "CPU: 8核 32GB",
      "sold_out" : false,
      "storages" : [ "EFS_DEDICATED", "OBS", "OBSFS", "EVS" ],
      "vcpus" : 8
    } ],
    "workspace_id" : "0",
    "create_at" : 1737690370131,
    "update_at" : 1752722684027,
    "domain_id" : "06024304b180d5090fbac00141b6cae0",
    "project_id" : "06024304be00d5092fbdc0013d201342"
  } ],
  "pages" : 1,
  "size" : 200,
  "total" : 40
}