查询资源池列表
功能介绍
查询资源池列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/pools
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID，获取方法请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workspaceId |
否 |
String |
参数解释：工作空间ID。[获取方法请参见查询工作空间列表。](tag:hc,hk )未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 约束限制：不涉及。 取值范围：不涉及。 默认取值：0。 |
|
labelSelector |
否 |
String |
参数解释：资源池标签筛选。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
status |
否 |
String |
参数解释：资源池状态。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释：资源的API版本。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
kind |
String |
参数解释：资源的类型。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
items |
Array of PoolModel objects |
参数解释：资源池列表。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释：资源的API版本。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
kind |
String |
参数解释：资源的类型。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
metadata |
PoolMetadata object |
参数解释：资源池的元信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
spec |
PoolSpecModel object |
参数解释：资源池的规格信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
status |
PoolStatus object |
参数解释：资源池的状态信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释：资源池的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
creationTimestamp |
String |
参数解释：资源池的创建时间。例如"2025-11-01T03:49:41Z"。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
labels |
PoolMetaLabels object |
参数解释：资源池的标签信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
annotations |
PoolMetaAnnotations object |
参数解释：资源池的注释信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
os.modelarts/workspace.id |
String |
参数解释：工作空间ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：0。 |
|
os.modelarts/name |
String |
参数解释：资源池的显示名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/resource.id |
String |
参数解释：资源池计费使用的资源ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/tenant.domain.id |
String |
参数解释：资源池所属的租户ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
os.modelarts/description |
String |
参数解释：资源池的描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/billing.mode |
String |
参数解释：计费模式。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
os.modelarts/period.num |
String |
参数解释：包周期资源池的订购周期。 约束限制：和os.modelarts/period.type字段配合使用。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/period.type |
String |
参数解释：包周期资源池的订购类型。 约束限制：和os.modelarts/period.num字段配合使用。 取值范围：可选值如下：
默认取值：不涉及。 |
|
os.modelarts/auto.renew |
String |
参数解释：包周期资源池的自动续费类型。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：0。 |
|
os.modelarts/promotion.info |
String |
参数解释：包周期资源池购买时选择的折扣信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/service.console.url |
String |
参数解释：购买包周期资源在订单支付完成后跳转地址。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/order.id |
String |
参数解释：包周期资源池购买时传递的订单ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/flavor.resource.ids |
String |
参数解释：包周期资源池中资源规格对应的资源ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os.modelarts/tms.tags |
String |
参数解释：资源池上的资源标签。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释：资源池类型。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
scope |
Array of strings |
参数解释：资源池支持的作业类型。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
resources |
Array of resources objects |
参数解释：资源池中的资源规格信列表，包括资源规格和相应规格的资源数量。 约束限制：至少包含一个资源信息。 取值范围：不涉及。 默认取值：不涉及。 |
|
network |
network object |
参数解释：资源池网络参数。 约束限制：物理资源池该参数必选。 取值范围：不涉及。 默认取值：不涉及。 |
|
jobFlavors |
Array of strings |
参数解释：资源池支持的作业规格列表。参数为作业规格名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
driver |
PoolDriver object |
参数解释：资源池驱动信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
controlMode |
Integer |
参数解释：资源池的受限状态。状态可以叠加，比如9代表转包周期受限和冻结状态。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flavor |
String |
参数解释：资源规格ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
count |
Integer |
参数解释：资源池中资源规格实例数量。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
azs |
Array of PoolNodeAz objects |
参数解释：资源池中期望创建的资源规格实例的az分布。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
extendParams |
extendParams object |
参数解释：资源池自定义配置参数。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
os |
Os object |
参数解释：资源池中节点操作系统镜像信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
dockerBaseSize |
String |
参数解释：资源池创建的节点的容器引擎空间大小。值为0时表示不限制大小。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释：操作系统名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
imageId |
String |
参数解释：操作系统镜像ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
imageType |
String |
参数解释：操作系统镜像类型。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
gpuVersion |
String |
参数解释：资源池默认的GPU驱动版本。 约束限制：物理资源池中包含GPU规格时有效。 取值范围：不涉及。 默认取值：不涉及。 |
|
npuVersion |
String |
参数解释：资源池默认的NPU驱动版本。 约束限制：物理资源池中包含NPU规格时有效。 取值范围：不涉及。 默认取值：不涉及。 |
|
updateStrategy |
String |
参数解释：资源池驱动升级策略。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
phase |
String |
参数解释：资源池的状态。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
message |
String |
参数解释：资源池当前状态的提示信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
resources |
resources object |
参数解释：资源池中不同状态的资源信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
scope |
Array of scope objects |
参数解释：资源池当前支持的业务类型的状态信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
driver |
driver object |
参数解释：资源池驱动状态信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
parent |
String |
参数解释：资源池所属父资源池的ID。物理池为空。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
root |
String |
参数解释：资源池根资源池的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
creating |
PoolResourceFlavorCount object |
参数解释：资源池中创建状态的资源信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
available |
PoolResourceFlavorCount object |
参数解释：资源池中可用状态的资源信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
abnormal |
PoolResourceFlavorCount object |
参数解释：资源池中异常状态的资源信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
deleting |
PoolResourceFlavorCount object |
参数解释：资源池中删除中状态的资源信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flavor |
String |
参数解释：资源规格ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
count |
Integer |
参数解释：资源池中资源规格实例数量。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
maxCount |
Integer |
参数解释：资源池中资源规格实例弹性数量。物理池中该值和count相同。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
azs |
Array of PoolNodeAz objects |
参数解释：资源池中期望创建的资源规格实例的az分布。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
nodePool |
String |
参数解释：节点池ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
az |
String |
参数解释：可用区名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
count |
Integer |
参数解释：可用区资源实例的数量。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
scopeType |
String |
参数解释：资源池的业务类型。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
state |
String |
参数解释：资源池业务类型状态。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
gpu |
PoolDriverStatus object |
参数解释：资源池GPU驱动状态。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
npu |
PoolDriverStatus object |
参数解释：资源池NPU驱动状态。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求示例
查询资源池列表。
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。 |
错误码
请参见错误码。
