查询资源池规格最大可用资源 - GetFlavorMaxAvailableResourceForTraining
功能介绍
查询资源池规格最大可用资源接口用于获取指定资源池中指定资源规格可分配的最大CPU和内存资源。
该接口适用于以下场景：当用户需要在创建训练作业前了解资源池中某规格的可用资源上限，以便合理选择规格和节点数时，可以通过此接口进行查询。使用该接口的前提条件是用户已知资源池ID和资源规格ID，并具有查看训练资源的权限。查询操作完成后，平台将返回该规格在资源池中的最大可用CPU核数和内存大小。若资源池或规格不存在、或用户无权限操作，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/training-pool-flavors
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：1 - 64字符，字母、数字和中划线。 默认取值：不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| flavor_id | 是 | String | 参数解释：资源规格ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
| pool_id | 是 | String | 参数解释：资源池ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cpu_core_num | Integer | 参数解释：最大可用CPU核数。 取值范围：不涉及。 |
| mem_size | Integer | 参数解释：最大可用内存大小，单位为GB。 取值范围：不涉及。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_solution | String | 错误解决建议。 |
请求示例
如下以查询资源池ID为pool-xxxx中规格为modelarts.bm.gpu.v100的最大可用资源为例。
GET https://{endpoint}/v2/{project_id}/training-pool-flavors?flavor_id=modelarts.bm.gpu.v100&pool_id=pool-xxxx 响应示例
状态码：200
查询资源池规格最大可用资源响应体
{
"cpu_core_num" : 8,
"mem_size" : 32
} 状态码：500
服务内部错误。
{
"error" : "get max available resource failed",
"message" : "get pool from os error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询资源池规格最大可用资源响应体 |
| 500 | 服务内部错误。 |
错误码
请参见错误码。
