计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询资源池列表

更新时间:2025-02-12 GMT+08:00

功能介绍

查询资源池列表,可通过标签、资源池状态筛选查询资源池列表。

调试

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

URI

GET /v2/{project_id}/pools

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

workspaceId

String

工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。

labelSelector

String

标签筛选。

status

String

资源池状态。状态为空时,返回当前有效的资源池,包括创建中和创建成功的资源池。可选值如下:

  • created: 创建成功的资源池。

  • failed:创建失败的资源池,创建失败的资源池记录保留3天。

  • creating:创建中的资源池。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本。可选值如下:

  • v2

kind

String

资源类型。可选值如下:

  • PoolList:资源池列表

items

Array of PoolModel objects

资源池列表。

表4 PoolModel

参数

参数类型

描述

apiVersion

String

API版本。可选值如下:

  • v2

kind

String

资源类型。可选值如下:

  • Pool:资源池

metadata

PoolMetadata object

资源池的metadata信息。

spec

PoolSpecModel object

资源池的期望信息。

status

PoolStatus object

资源池的状态信息。

表5 PoolMetadata

参数

参数类型

描述

name

String

系统自动生成的pool名称,相当于pool ID。

creationTimestamp

String

时间戳,例如"2021-11-01T03:49:41Z"。

labels

PoolMetaLabels object

资源池的标签信息。

annotations

PoolMetaAnnotations object

资源池的注释信息。

表6 PoolMetaLabels

参数

参数类型

描述

os.modelarts/workspace.id

String

工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。

os.modelarts/name

String

用户指定的pool名称。

os.modelarts/resource.id

String

资源池的主资源id,通常提供给cbc使用。

os.modelarts/tenant.domain.id

String

资源池的租户id,记录资源池创建在哪个租户账号下。

表7 PoolMetaAnnotations

参数

参数类型

描述

os.modelarts/description

String

资源池的描述信息。

os.modelarts/billing.mode

String

计费模式。可选值如下:

  • 0:按需计费

  • 1:包周期计费

os.modelarts/period.num

String

包周期订购周期,比如2。

os.modelarts/period.type

String

包周期订购类型。可选值如下:

  • 2:月

  • 3:年

  • 4:小时

os.modelarts/auto.renew

String

是否自动续费.可选值如下:

  • 0:不自动续费,默认值

  • 1:自动续费

os.modelarts/promotion.info

String

用户在cbc选择的折扣信息。

os.modelarts/service.console.url

String

订购订单支付完成后跳转的url地址。

os.modelarts/order.id

String

订单id,包周期资源池创建或者计费模式变更的时候该参数必需。

os.modelarts/flavor.resource.ids

String

每种规格对应的resourceId,主要和cbc交互使用。

os.modelarts/tms.tags

String

创建的时候由用户指定的TMS标签。

表8 PoolSpecModel

参数

参数类型

描述

type

String

资源池类型。可选值如下:

  • Dedicate:物理资源池,独立的网络,支持网络打通,定制驱动,定制作业类型。

scope

Array of strings

资源池支持的作业类型。至少选择一种,物理资源池支持全部选择。可选值如下:

  • Train:训练作业

  • Infer:推理作业

  • Notebook:Notebook作业

resources

Array of resources objects

资源池中的资源规格信列表,包括资源规格和相应规格的资源数量。

network

network object

资源池网络参数。物理资源池时必选。

jobFlavors

Array of strings

资源池支持的作业规格信息列表,内容为作业规格名称。

driver

PoolDriver object

资源池的驱动信息。

controlMode

Integer

资源池的受限状态。可选值如下:

  • 0:代表不受限

  • 1:转包周期受限

  • 2:规格变更受限

  • 4:服务受限

  • 8:冻结

  • 16:公安冻结(不可退订)

    另外状态是可以叠加的,比如9代表转包周期受限+冻结状态。

表9 resources

参数

参数类型

描述

flavor

String

资源规格,比如:modelarts.vm.gpu.tnt004。

count

Integer

相应规格资源数量。

azs

Array of PoolNodeAz objects

az列表信息。

表10 PoolNodeAz

参数

参数类型

描述

az

String

可用区名称。

count

Integer

指定可用区扩容时,指定可用区的节点数。

表11 network

参数

参数类型

描述

name

String

网络名称;用户接口通过指定网络名称创建网络,系统会自动创建子网,用户无法创建子网。默认将创建在第一个子网下。

表12 PoolDriver

参数

参数类型

描述

gpuVersion

String

GPU驱动版本,物理资源池中含有GPU规格时可填,例如:"440.33"。

npuVersion

String

NPU驱动版本,物理资源池中含有ascend规格时可填,例如:"C78"。

updateStrategy

String

驱动升级策略。可选值如下:

  • force:强制升级,立即升级节点驱动,可能影响节点上正在运行的作业

  • idle:安全升级,待节点上没有作业运行时进行驱动升级

表13 PoolStatus

参数

参数类型

描述

phase

String

资源池集群状态。可选值如下:

  • Creating:创建中

  • Running:运行中

  • Abnormal:资源池不正常

  • Deleting:删除中

  • Error:资源池错误

message

String

资源池处于当前状态的提示信息。

resources

resources object

资源池中不同状态的资源量。

scope

Array of scope objects

资源池业务状态信息。

driver

driver object

资源池驱动信息。

parent

String

资源池父节点名称,物理池为空。

root

String

资源池根节点名称,物理池为自己的名称。

表14 resources

参数

参数类型

描述

creating

PoolResourceFlavorCount object

状态为创建中状态的资源量。

available

PoolResourceFlavorCount object

状态为可用状态的资源量。

abnormal

PoolResourceFlavorCount object

状态为非正常状态的资源量。

deleting

PoolResourceFlavorCount object

状态为删除中状态的资源量。

表15 PoolResourceFlavorCount

参数

参数类型

描述

flavor

String

资源规格名称,比如:modelarts.vm.gpu.tnt004。

count

Integer

规格保障使用量。

maxCount

Integer

资源规格的弹性使用量,物理池该值和count相同。

azs

Array of azs objects

资源所在的AZ的数量。

nodePool

String

节点池名称。比如:nodePool-1。

表16 azs

参数

参数类型

描述

az

String

AZ的名称。

count

Integer

AZ的资源数量。

表17 scope

参数

参数类型

描述

scopeType

String

业务类型。可选值如下:

  • Train:训练任务

  • Infer:推理任务

  • Notebook:Notebook作业

state

String

业务状态。可选值如下:

  • Enabling:启动中

  • Enabled:已启动

  • Disabling:关闭中

  • Disabled:已关闭

表18 driver

参数

参数类型

描述

gpu

PoolDriverStatus object

GPU驱动信息。

npu

PoolDriverStatus object

NPU驱动信息。

表19 PoolDriverStatus

参数

参数类型

描述

version

String

当前驱动版本。

state

String

当前驱动状态。可选值如下:

  • Creating:创建中

  • Upgrading:升级中

  • Running:运行中

  • Abnormal:不正常

请求示例

查询资源池列表。

GET https://{endpoint}/v2/{project_id}/pools

{ }

响应示例

状态码:200

OK。

{
  "kind" : "PoolList",
  "apiVersion" : "v2",
  "items" : [ {
    "kind" : "Pool",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "auto-pool-os-86c13962597848eeb29c5861153a391f",
      "creationTimestamp" : "2022-09-16T03:10:40Z",
      "labels" : {
        "os.modelarts/name" : "auto-pool-os",
        "os.modelarts/workspace.id" : "0",
        "os.modelarts/resource.id" : "maos-auto-pool-os-72w8d"
      },
      "annotations" : {
        "os.modelarts/description" : "",
        "os.modelarts/billing.mode" : "0"
      }
    },
    "spec" : {
      "type" : "Dedicate",
      "scope" : [ "Train", "Infer" ],
      "resources" : [ {
        "flavor" : "modelarts.vm.cpu.4ud",
        "count" : 2
      } ],
      "network" : {
        "name" : "network-maos-86c13962597848eeb29c5861153a391f"
      }
    },
    "status" : {
      "phase" : "Running",
      "root" : "auto-pool-os-86c13962597848eeb29c5861153a391f",
      "scope" : [ {
        "scopeType" : "Train",
        "state" : "Enabled"
      }, {
        "scopeType" : "Infer",
        "state" : "Enabled"
      } ],
      "resources" : {
        "available" : [ {
          "flavor" : "modelarts.vm.cpu.4ud",
          "count" : 2,
          "azs" : [ {
            "az" : "cn-north-7c",
            "count" : 2
          } ]
        } ]
      }
    }
  } ]
}

状态码

状态码

描述

200

OK。

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容