资源池相关接口
更新时间：2024-07-25
资源池详情
描述
获取百舸资源池列表的接口
请求结构
GET /api/v1/resourcepools/{resourcePoolId}
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Path参数 | 标识资源池的唯一标识符 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 请求 ID, 用于标识请求的唯一ID |
| result | ResourcePoolInfoResult | 是 | 请求返回的结果对象 |
返回示例
{
"requestId": "b2d6ed8e-25b2-40fd-81a1-27239c7dbdfb",
"result": {
"resourcePool": {
"metadata": {
"createdAt": "2024-06-07T12:07:10Z",
"name": "baige-pfsl1",
"id": "cce-9c2b8j9n",
"updatedAt": "2024-06-19T07:44:07Z"
},
"spec": {
"k8sVersion": "1.20.8",
"associatedCpromIds": null,
"associatedPfsId": "pfs-7xWeAt",
"createdBy": "zhanghuan12",
"description": "",
"forbidDelete": true,
"region": "bj"
},
"status": {
"gpuCount": {
"total": 16,
"used": 16
},
"nodeCount": {
"total": 2,
"used": 2
},
"phase": "running"
}
}
}
}资源池列表
描述
获取指定资源池的详细信息，包括资源池元数据、状态、节点总数、空闲节点数、GPU总数、空闲卡数等
请求结构
GET /api/v1/resourcepools
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| orderBy | String | 否 | Query 参数 | 集群查询排序字段，可选 [clusterName, clusterID, createdAt]，默认值为 clusterAt |
| order | String | 否 | Query 参数 | 排序方式，可选 [asc, desc]，asc 为升序，desc 为降序，默认值为 desc |
| pageNo | Integer | 否 | Query 参数 | 页码，默认值为1 |
| pageSize | Integer | 否 | Query 参数 | 单页结果数，默认值为10 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 请求ID |
| result | ResourcePoolListResult | 是 | 请求成功时的响应结果 |
返回示例
{
"requestId": "120007d6-d64a-4056-be3b-e675527ea1f2",
"result": {
"resourcePools": [
{
"metadata": {
"createdAt": "2024-01-24T10:51:44+08:00",
"name": "demo",
"id": "cce-xxxxx",
"updatedAt": "2024-04-18T15:41:21+08:00"
},
"spec": {
"k8sVersion": "1.20.8",
"associatedCpromIDs": [
"cprom-u02v1w7bj3j0b"
],
"associatedPfsID": "pfs-pxE6jz",
"createdBy": "weibingcheng",
"description": "",
"forbidDelete": true,
"region": "bj"
},
"status": {
"gpuCount": {
"total": 1,
"used": 0
},
"nodeCount": {
"total": 6,
"used": 5
},
"phase": "running"
}
},
{
"metadata": {
"createdAt": "2023-05-27T17:06:38+08:00",
"name": "aihc-test",
"uid": "cce-6zwnp4zf",
"updatedAt": "2024-05-15T19:59:18+08:00"
},
"spec": {
"k8sVersion": "1.22.5",
"associatedCpromIDs": null,
"associatedPfsID": "pfs-pxE6jz",
"createdBy": "",
"description": "百舸灰度测试集群-don't delete",
"forbidDelete": true,
"region": "bj"
},
"status": {
"gpuCount": {
"total": 4,
"used": 0
},
"nodeCount": {
"total": 6,
"used": 5
},
"phase": "running"
}
}
],
"totalCount": 9
}
}资源池节点列表
描述
获取指定资源池列表，及对应节点基本信息、GPU使用量等
请求结构
GET /api/v1/resourcepools/{resourcePoolId}/nodes
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Path参数 | 标识资源池的唯一标识符 |
| result | ResourcePoolNodeResult | 是 | 请求成功时的响应结果 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 请求ID |
| result | Object | 是 | 请求成功时的响应结果 |
| nodes | Object | 是 | 节点模型 |
| pageNo | Integer | 是 | 页面序号，默认为1 |
| pageSize | Integer | 是 | 单页返回的数量，默认为10 |
| orderBy | String | 是 | 排序字段，默认为createdAt |
| order | String | 是 | 排序方式，desc为逆序，asc为顺序，默认为逆序 |
| total | Number | 是 | 总记录数 |
返回示例
{
"requestId": "822092d2-e4ec-4b29-8015-ad809d660a39",
"result": {
"total": 3,
"nodes": [
{
"chargingType": "Postpaid",
"gpuAllocated": 0,
"gpuTotal": 0,
"gpuType": "",
"instanceID": "cce-gm1vwbke-oi6ymus3",
"instanceName ": "cce-9iv03gmg-8jmisp2d",
"intervention": "unintervened",
"nodeName": "192.168.12.38",
"statusPhase": "running",
"zone": "zoneF",
"region": "bj"
},
{
"chargingType": "Postpaid",
"gpuAllocated": 0,
"gpuTotal": 0,
"gpuType": "",
"instanceID": "cce-gm1vwbke-nq73ktdc",
"instanceName ": "cce-gm1vwbke-nq73ktdc",
"intervention": "tainted",
"nodeName": "192.168.12.147",
"statusPhase": "ready_scheduling_disabled",
"zone": "zoneF",
"region": "bj"
},
{
"chargingType": "Postpaid",
"gpuAllocated": 8,
"gpuTotal": 8,
"gpuType": "nTeslaA800-80G",
"instanceID": "cce-gm1vwbke-zb9askrv",
"instanceName ": "cce-gm1vwbke-zb9askrv",
"intervention": "unintervened",
"nodeName": "",
"statusPhase": "create_failed",
"zone": "",
"region": ""
}
]
}
}队列创建
描述
创建资源池队列
请求结构
POST /api/v1/resourcepools/{resourcePoolId}/queue
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Path参数 | 标识资源池的唯一标识符 |
| description | String | 否 | RequestBody参数 | 队列描述 |
| name | String | 是 | RequestBody参数 | 队列名称 |
| queueType | String | 否 | RequestBody参数 | 队列类型，当前支持regular |
| parentQueue | String | 否 | RequestBody参数 | 父队列，默认root |
| deserved | Object | 否 | RequestBody参数 | 队列申请配额 |
| disableOversell | Boolean | 否 | RequestBody参数 | 超发开关，队列是否允许超发，默认为false |
| reclaimable | Boolean | 否 | RequestBody参数 | 被抢占开关，队列资源是否可被抢占，默认为false |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 请求ID |
| result | QueueResult | 是 | 请求成功时的响应结果 |
请求示例
{
"description": "This is a test queue",
"deserved": {
"cpu": 10,
"memory": 20
},
"name": "demo",
"parentQueue": "root",
"queueType": "Regular",
"disableOversell": false
}返回示例
{
"result": {
"queueName": "def1"
},
"requestID": "524eef70-c7fc-4b78-84a4-bd949a757be2"
}队列列表
描述
获取队列列表，包含队列详情
请求结构
GET /api/v1/resourcepools/{resourcePoolId}/queue
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Path参数 | 标识资源池的唯一标识符 |
| orderBy | String | 否 | Query 参数 | 集群查询排序字段，目前仅支持通过创建时间(createdTime)排序 |
| order | String | 否 | Query 参数 | 排序方式，可选 [asc, desc]，asc 为升序，desc 为降序，默认值为 desc |
| pageNo | Integer | 否 | Query 参数 | 页码，默认值为1 |
| pageSize | Integer | 否 | Query 参数 | 单页结果数，默认值为10 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 请求ID |
| result | QueueListResult | 是 | 请求成功时的响应结果 |
返回示例
{
"result": {
"total": 3,
"queues": [
{
"createdTime": "2024-06-05T09:09:32Z",
"name": "63a9f0ea7bb98050796b649e85481845",
"nameSpace": "",
"parentQueue": "63a9f0ea7bb98050796b649e85481845",
"queueType": "Regular",
"state": "Open",
"reclaimable": true,
"capability": {
"cce.baidubce.com/eni": "2",
"cce.baidubce.com/ip": "512",
"cpu": "136",
"ephemeral-storage": "392812923001",
"hugepages-1Gi": "0",
"hugepages-2Mi": "0",
"memory": "573173870592",
"pods": "512"
},
"allocated": {
"cpu": "0",
"memory": "0"
},
"disableOversell": false
},
{
"createdTime": "2024-06-05T09:09:28Z",
"name": "default",
"nameSpace": "",
"parentQueue": "63a9f0ea7bb98050796b649e85481845",
"queueType": "Elastic",
"state": "Open",
"reclaimable": true,
"allocated": {
"cpu": "0",
"memory": "0"
},
"disableOversell": false
}
]
},
"requestID": "65b3909e-0711-42f4-b120-e1436e3a1c57"
}队列删除
描述
删除指定队列
请求结构
DELETE /api/v1/resourcepools/{resourcePoolId}/queue/{queueName}
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Path 参数 | 标识资源池的唯一标识符 |
| queueName | String | 是 | Path 参数 | 特定队列设置的名称 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestID | String | 是 | 请求ID |
| result | QueueResult | 是 | 请求成功时的响应结果 |
返回示例
{
"result": {
"queueName": "demo"
},
"requestID": "504d5733-c6b1-44fe-8d0a-15eb97388ae4"
}队列更新
描述
更新队列资源配额、超发、抢占配置
请求结构
PUT /api/v1/resourcepools/{resourcePoolId}/queue/{queueName}
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Path 参数 | 标识资源池的唯一标识符 |
| queueName | String | 是 | Path 参数 | 特定队列设置的名称 |
返回头域
除公共头域外，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 请求ID |
| result | QueueResult | 是 | 请求成功时的响应结果 |
请求示例
{
"description": "This is a test",
"disableOversell": true,
"deserved": {
"cpu": 5,
"memory": 10
}
}返回示例
{
"result": {
"queueName": "demo"
},
"requestID": "cf293451-89e0-43e2-a673-dd2d2aa8433a"
}队列详情
描述
获取指定队列详情，包括队列基本信息以及资源使用量等
请求结构
GET /api/v1/resourcepools/{resourcePoolId}/queue/{queueName}
Host:aihc.bj.baidubce.com
Authorization:authorization string
ContentType: application/json 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Path 参数 | 标识资源池的唯一标识符 |
| queueName | String | 是 | Path 参数 | 特定队列设置的名称 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 请求 ID, 用于标识请求的唯一ID |
| result | QueueInfoResult | 是 | 请求返回的结果对象 |
返回示例
{
"result": {
"queue": {
"createdTime": "2024-07-16T12:27:57Z",
"description": "This is a test",
"name": "dddddddd",
"parentQueue": "63a9f0ea7bb98050796b649e85481845",
"queueType": "Regular",
"state": "Open",
"reclaimable": false,
"deserved": {
"cpu": "5",
"memory": "10"
},
"disableOversell": false
}
},
"requestID": "ab78f741-a05a-4346-a8f7-13302b6e6604"
}