创建资源池
功能介绍
用户创建资源池。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/pools
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
用户项目ID。获取方法请参见获取项目ID和名称。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-ModelArts-User-ID |
否 |
String |
实际的外部租户ID,如果有的话,工作空间鉴权以该ID为准。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
apiVersion |
是 |
String |
API版本。可选值如下:
|
kind |
是 |
String |
资源类型。可选值如下:
|
metadata |
是 |
PoolMetadataCreation object |
资源池的metadata信息。 |
spec |
否 |
PoolSpecCreation object |
资源池的描述信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
labels |
是 |
PoolLabelsCreation object |
资源池的标签信息。 |
annotations |
否 |
PoolAnnotationsCreation object |
资源池的注释信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
os.modelarts/name |
是 |
String |
用户指定的资源池名称。 |
os.modelarts/workspace.id |
否 |
String |
工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 |
os.modelarts/node.prefix |
否 |
String |
自定义节点名称前缀。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
os.modelarts/description |
否 |
String |
资源池的描述信息。 |
os.modelarts/billing.mode |
否 |
String |
计费模式,可选值如下:
|
os.modelarts/period.num |
否 |
String |
包周期订购周期,比如2。当计费模式为包周期时该参数必传。 |
os.modelarts/period.type |
否 |
String |
包周期订购类型。可选值如下:
当计费模式为包周期时该参数必传。 |
os.modelarts/auto.renew |
否 |
String |
是否自动续费。可选值如下:
|
os.modelarts/auto.pay |
否 |
String |
是否自动付费,仅在用户购买包周期资源时生效。可选值如下:
|
os.modelarts/promotion.info |
否 |
String |
用户在cbc选择的折扣信息。 |
os.modelarts/service.console.url |
否 |
String |
订购订单支付完成后跳转的url地址。 |
os.modelarts/order.id |
否 |
String |
订单id,包周期资源池创建或者计费模式变更的时候该参数必需。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
资源池类型。可选值如下:
|
scope |
是 |
Array of strings |
资源池支持的作业类型。用户创建标准资源池时至少选择一种,物理资源池支持全部选择。可选值如下:
|
resources |
是 |
Array of PoolResourceFlavor objects |
资源池中的资源规格信列表,包括资源规格和相应规格的资源数量。 |
network |
是 |
network object |
资源池网络参数。创建物理资源池时必选。 |
jobFlavors |
否 |
Array of strings |
资源池支持的作业规格信息列表,内容为作业规格名称。 |
driver |
否 |
PoolDriver object |
资源池的驱动信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
flavor |
是 |
String |
资源规格,比如:modelarts.vm.gpu.tnt004。 |
count |
是 |
Integer |
资源规格的保障资源量。 |
maxCount |
否 |
Integer |
资源规格的弹性资源量。物理池中该值和count必须一致。 |
extendParams |
否 |
extendParams object |
自定义配置参数。 |
os |
否 |
Os object |
自定义操作系统镜像信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数解释:操作系统名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
imageId |
否 |
String |
参数解释:操作系统镜像ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
imageType |
否 |
String |
参数解释:操作系统镜像类型。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
网络名称,即网络详情中的metadata.name字段的值。用户接口通过指定网络名称创建网络,系统会自动创建子网,用户无法创建子网。默认将创建在第一个子网下。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
gpuVersion |
否 |
String |
参数解释:资源池默认的GPU驱动版本。 约束限制:物理资源池中包含GPU规格时有效。 取值范围:不涉及。 默认取值:不涉及。 |
npuVersion |
否 |
String |
参数解释:资源池默认的NPU驱动版本。 约束限制:物理资源池中包含NPU规格时有效。 取值范围:不涉及。 默认取值:不涉及。 |
updateStrategy |
否 |
String |
参数解释:资源池驱动升级策略。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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驱动状态。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
version |
String |
参数解释:资源池当前驱动版本。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
state |
String |
参数解释:资源池当前驱动状态。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
状态码:409
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
创建专属资源池。设置资源类型为“Pool”,资源池名称为“pool-001”,资源池类型为“Dedicate”(物理资源池),资源池支持的作业类型为“训练作业”。
POST https://{endpoint}/v2/{project_id}/pools { "kind" : "Pool", "apiVersion" : "v2", "metadata" : { "labels" : { "os.modelarts/name" : "pool-001", "os.modelarts/workspace.id" : "0" }, "annotations" : { "os.modelarts/description" : "", "os.modelarts/billing.mode" : "0" } }, "spec" : { "type" : "Dedicate", "scope" : [ "Train" ], "network" : { "name" : "net-0123-86c13962597848eeb29c5861153a391f" }, "resources" : [ { "flavor" : "modelarts.vm.gpu.tnt004", "count" : 2 } ], "driver" : { "gpuVersion" : "440.31" } } }
响应示例
状态码:400
Bad request
{ "error_code" : "ModelArts.50004000", "error_msg" : "Bad request" }
状态码:409
Already exists
{ "error_code" : "ModelArts.50015000", "error_msg" : "Pool already exists." }
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
400 |
Bad request |
409 |
Already exists |
错误码
请参见错误码。