自定义部署服务相关接口
更新时间：2024-11-04
创建服务
描述
使用自定义镜像创建推理服务，配置启动命令、端口、流量接入、健康检查、滚动更新等策略。
请求结构
POST /api/v1/aihcpom/app/create
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appName | String | 是 | Body参数 | 服务名称,需满足正则表达式^[a-z][a-z0-9-]*[a-z0-9]$，长度不高于50 |
| chipType | String | 是 | Body参数 | 加速芯片类型 |
| insCount | Int32 | 是 | Body参数 | 部署实例数 |
| resPool | ResPoolConf | 是 | Body参数 | 资源池描述 |
| storage | StorageConf | 否 | Body参数 | 存储卷、共享内存配置 |
| containers | Array of ContainerConf | 是 | Body参数 | 服务容器信息，最少需要1个，最多10个，见containers结构 |
| access | AccessConf | 否 | Body参数 | 服务访问配置信息，默认为内网访问 |
| log | LogConf | 否 | Body参数 | 日志配置 |
| deploy | DeployConf | 否 | Body参数 | 部署配置，默认最大超量和最大不可用均为25% |
| misc | Misc | 否 | Body参数 | 实例label、annotations配置 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 说明 |
|---|---|---|
| appId | String | 服务ID |
请求示例
{
"containers": [
{
"name": "container01",
"image": {
"imageType": 1,
"imageAddr": "registry.baidubce.com/inference/inference-sidecar:20240902"
},
"cpus": 1,
"memory": 1,
"cards": 0,
"runCmd": [
"/bin/sh",
"-c",
"sleep inf"
],
"volumeMounts": [
{
"readOnly": false,
"volumnName": "model",
"dstPath": "/mnt/model"
}
]
}
],
"log": {
"persistent": false
},
"insCount": 1,
"misc": {
"podAnnotations": {
"prometheus.io/scrape": "false"
}
},
"resPool": {
"resPool": "cce-z7omyv64",
"queue": "default"
},
"chipType": "baidu.com/a800_80g_cgpu",
"storage": {
"volumns": [
{
"volumeType": "pfs",
"volumnName": "model",
"pfs": {
"srcPath": "/"
}
}
]
},
"appName": "aihc-pom-openapi",
"deploy": {
"canaryStrategy": {
"maxSurge": 25,
"maxUnavailable": 25
}
}
}返回示例
{
"data": {
"appId": "ap-bd89956e"
},
"requestId": "6765379614087209182"
}查询服务列表
描述
查询自定义服务的列表信息。
请求结构
GET /api/v1/aihcpom/app/list
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 参数位置 | 是否必须 | 参数说明 |
|---|---|---|---|---|
| pageNo | Int32 | Query参数 | 否 | 从 1 开始 |
| pageSize | Int32 | Query参数 | 否 | 分页大小，默认为10 |
| orderBy | String | Query参数 | 否 | 暂时只支持创建时间ctime |
| order | String | Query参数 | 否 | asc，desc，默认 desc。需要和orderby同时出现 |
| keyword | String | Query参数 | 否 | 按名称匹配 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 说明 |
|---|---|---|
| list | Array of AppBriefInfo | 服务列表 |
| count | Int32 | 总条目数 |
返回示例
{
"requestId": "1182282645",
"data": {
"count": 17,
"list": [
{
"appId": "ap-xxxxxxxxxxxx",
"appName": "ThisIsName",
"resPool": "xxxx",
"resQueue": "default",
"region": "bj",
"ctime": 13131211,
"utime": 13131211
},
{
"appId": "ap-xxxxxxxxxxxx",
"appName": "ThisIsName",
"resPool": "xxxx",
"resQueue": "default",
"region": "bj",
"ctime": 13131211,
"utime": 13131211
}
]
}
}查询服务状态
描述
获取自定义服务的状态。
请求结构
GET /api/v1/aihcpom/app/stats
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appIds | String | 是 | Query参数 | 批量服务，服务ID之间使用#分割 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| apps | Map<string, AppBriefStat | 每个服务的状态，map的key对应appId，value为服务的状态信息 |
返回示例
{
"requestId": "1182282645",
"data": {
"apps": {
"ap-xxxx1": {
"status": 1:部署中 2:运行中 3:未运行 4:异常 5:更新暂停
"availableIns": 1,
"totalIns": 2
},
"ap-xxxx2": {
"status": 2,
"availableIns": 1,
"totalIns": 2
}
}
}
}查询服务详情
描述
查询自定义服务的详细信息。
请求结构
GET /api/v1/aihcpom/app/details
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 必选 | Query参数 | 服务ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| app | AppConf | 服务的详细配置信息 |
| status | AppStatus | 服务网络状态信息 |
返回示例
{
"data": {
"app": {
"access": {
"eip": "",
"publicAccess": false
},
"appName": "pfsl2-openapi1234",
"chipType": "baidu.com/a800_80g_cgpu",
"containers": [
{
"cards": 0,
"cpus": 1,
"env": {
"AIHC": "true"
},
"image": {
"imageAddr": "registry.baidubce.com/inference/inference-sidecar:20240902",
"imagePullPass": "",
"imagePullUser": "",
"imageType": 1
},
"livenessProbe": {
"failureThreshold": 1,
"handler": {
"exec": {
"command": [
"/bin/sh",
"-c",
"echo 0"
]
}
},
"initialDelaySeconds": 0,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 1
},
"memory": 1,
"name": "container01",
"ports": [
{
"name": "",
"port": 111,
"protocol": ""
}
],
"runArgs": [],
"runCmd": [
"/bin/sh",
"-c",
"sleep inf"
],
"volumeMounts": [
{
"dstPath": "/mnt/model",
"readOnly": false,
"volumnName": "model"
}
]
}
],
"deploy": {
"canaryStrategy": {
"maxSurge": 25,
"maxUnavailable": 25
}
},
"insCount": 1,
"log": {
"persistent": true
},
"misc": {
"podAnnotations": {
"prometheus.io/port": "8088",
"prometheus.io/scrape": "true"
},
"podLabels": {}
},
"resPool": {
"queue": "default",
"resPoolId": "cce-z7omyv64",
"resPoolName": "pfsl2-upgrade-not-del-zhanghuan1",
"subnetID": "",
"vpcID": ""
},
"storage": {
"shmSize": 1,
"volumns": [
{
"pfs": {
"clientID": "pfs-DOcTYj",
"clusterIP": "-",
"clusterPort": "8888",
"hostMountPath": "/pfs/mt-Wc3uig",
"instanceId": "pfs-DOcTYj",
"instanceType": "plusl2",
"mountTargetId": [
"mt-Wc3uig"
],
"srcPath": "/"
},
"volumeType": "pfs",
"volumnName": "model"
}
]
}
},
"creator": "openapi",
"ctime": 1729061996,
"mtime": 1729150810,
"status": {
"accessIPs": {
"external": "",
"internal": "192.168.11.150"
},
"accessPorts": [
{
"containerPort": 111,
"name": "",
"servicePort": 111
}
],
"blbShortId": "lb-c8d6b104"
}
},
"requestId": "4981113014248088918"
}更新服务
描述
升级自定义服务，修改服务的实例数、加速芯片类型等参数。
请求结构
POST /api/v1/aihcpom/app/update
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | query 参数 |
| shortDesc | String | 否 | Query参数 | 对更新的描述 |
| appConf | AppConf | 是 | body参数 | 与创建参数一致，但不允许修改资源池、队列、服务名 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 说明 |
|---|---|---|
| appId | Sring | 服务ID |
请求示例
{
"containers": [
{
"name": "container01",
"image": {
"imageType": 1,
"imageAddr": "registry.baidubce.com/inference/inference-sidecar:20240902"
},
"cpus": 1,
"memory": 1,
"cards": 0,
"runCmd": [
"/bin/sh",
"-c",
"sleep inf"
],
"volumeMounts": [
{
"readOnly": false,
"volumnName": "model",request
"dstPath": "/mnt/model"
}
]
}
],
"log": {
"persistent": false
},
"insCount": 1,
"misc": {
"podAnnotations": {
"prometheus.io/scrape": "false"
}
},
"resPool": {
"resPoolId": "cce-z7omyv64",
"queue": "default"
},
"chipType": "baidu.com/a800_80g_cgpu",
"storage": {
"volumns": [
{
"volumeType": "pfs",
"volumnName": "model",
"pfs": {
"srcPath": "/"
}
}
]
},
"appName": "aihc-pom-openapi",
"deploy": {
"canaryStrategy": {
"maxSurge": 25,
"maxUnavailable": 25
}
}
}返回示例
{
"data": {
"appId": "ap-bd89956e"
},
"requestId": "6765379614087209184"
}扩缩容实例
描述
扩缩容服务的实例数。
请求结构
POST /api/v1/aihcpom/app/scale
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | 操作对象 |
| insCount | Int32 | 是 | Query参数 | 目标实例数量>=0 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无。
返回示例
{
"request":"5980142381875983740"
}配置公网访问
描述
设置服务的访问方式。
请求结构
POST /api/v1/aihcpom/app/pubaccess
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | 服务ID |
| publicAccess | Bool | 是 | Query参数 | 是否开启公网 |
| eip | String | 否 | Query参数 | 开启公网时必填，填入未绑定的EIP IP，如需更换EIP，需要先关闭公网，再选新的EIP |
返回头域
除公共头域，无其它特殊头域。
返回参数
无。
返回示例
{
"requestId":"3017520901476087186"
}查询服务变更记录
描述
获取服务的变更记录，包括变更类型、时间等信息。
请求结构
GET /api/v1/aihcpom/app/listchange
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | 服务ID |
| changeType | Int32 | 否 | Query参数 | 默认全部类型，1:创建 2:更新 3:扩缩容 4:流量接入变更 |
| order | String | 否 | Query参数 | asc，desc，默认 desc。需要和orderby同时出现 |
| orderby | String | 否 | Query参数 | 暂时只支持ctime |
| pageNo | Int32 | 否 | Query参数 | 默认为1 |
| pageSize | Int32 | 否 | Query参数 | 分页大小，默认为10 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| list | Array of AppChangeRecord | 记录列表 |
| count | Int32 | 该服务变更总数 |
返回示例
{
"data": {
"count": 4,
"list": [
{
"changeId": "ch-82c4ef58",
"changeType": 4,
"creator": "liufangyu03",
"ctime": 1729152391,
"prev": "ch-93f811c5",
"shortDesc": ""
},
{
"changeId": "ch-93f811c5",
"changeType": 3,
"creator": "liufangyu03",
"ctime": 1729152006,
"prev": "ch-52ceee24",
"shortDesc": ""
},
{
"changeId": "ch-52ceee24",
"changeType": 2,
"creator": "liufangyu03",
"ctime": 1729150810,
"prev": "ch-0c2b87ed",
"shortDesc": ""
},
{
"changeId": "ch-0c2b87ed",
"changeType": 1,
"creator": "openapi",
"ctime": 1729061996,
"prev": "",
"shortDesc": ""
}
]
},
"requestId": "2837431310594888188"
}查询服务变更记录详情
描述
查询服务变更记录的详细信息。
请求结构
GET /api/v1/aihcpom/app/changedetail
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| changeId | String | 是 | Query参数 | 变更 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| changeId | String | 变更ID |
| prev | String | 前一条变更记录 |
| changeType | Int32 | 变更类型，1:创建 2:更新 3:扩缩容 4:流量接入变更 |
| shortDesc | String | 变更描述 |
| creator | String | 操作人 |
| ctime | Uint32 | 变更创建时间 |
返回示例
{
"data": {
"changeId": "ch-82c4ef58",
"changeType": 4,
"creator": "liufangyu03",
"ctime": 1729152391,
"prev": "ch-93f811c5",
"shortDesc": "",
"snapshot": "{\"appName\":\"pfsl2-openapi1234\",\"chipType\":\"baidu.com/a800_80g_cgpu\",\"insCount\":2,\"resPool\":{\"resPoolId\":\"cce-z7omyv64\",\"resPoolName\":\"pfsl2-upgrade-not-del-zhanghuan1\",\"queue\":\"default\"},\"storage\":{\"shmSize\":1,\"volumns\":[{\"volumeType\":\"pfs\",\"volumnName\":\"model\",\"pfs\":{\"instanceId\":\"pfs-DOcTYj\",\"instanceType\":\"plusl2\",\"hostMountPath\":\"/pfs/mt-Wc3uig\",\"mountTargetId\":[\"mt-Wc3uig\"],\"clusterIP\":\"-\",\"clientID\":\"pfs-DOcTYj\",\"clusterPort\":\"8888\",\"srcPath\":\"/\"}}]},\"containers\":[{\"name\":\"container01\",\"cpus\":1,\"memory\":1,\"runCmd\":[\"/bin/sh\",\"-c\",\"sleep inf\"],\"ports\":[{\"port\":111}],\"env\":{\"AIHC\":\"true\"},\"image\":{\"imageType\":1,\"imageAddr\":\"registry.baidubce.com/inference/inference-sidecar:20240902\"},\"volumeMounts\":[{\"volumnName\":\"model\",\"dstPath\":\"/mnt/model\"}],\"livenessProbe\":{\"timeoutSeconds\":1,\"periodSeconds\":10,\"successThreshold\":1,\"failureThreshold\":1,\"handler\":{\"exec\":{\"command\":[\"/bin/sh\",\"-c\",\"echo 0\"]}}}}],\"access\":{\"publicAccess\":true,\"eip\":\"106.12.155.17\"},\"log\":{\"persistent\":true},\"deploy\":{\"canaryStrategy\":{\"maxSurge\":25,\"maxUnavailable\":25}},\"misc\":{\"podAnnotations\":{\"prometheus.io/port\":\"8088\",\"prometheus.io/scrape\":\"true\"}}}"
},
"requestId": "1269432189319481376"
}删除服务
描述
删除自定义服务。
请求结构
POST /api/v1/aihcpom/app/delete
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | 需要删除的服务ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
无。
返回示例
{
"request":"3866540610773455187"
}查询实例列表
描述
获取服务的实例列表。
请求结构
GET /api/v1/aihcpom/pod/list
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | 需要获取实例列表的服务ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| list | Array of InsInfo | 实例列表 |
返回示例
{
"data": {
"list": [
{
"containers": [
{
"container": {
"cards": 0,
"cpus": 1,
"env": {
"AIHC": "true"
},
"image": {
"imageAddr": "registry.baidubce.com/inference/inference-sidecar:20240902",
"imagePullPass": "",
"imagePullUser": "",
"imageType": 1
},
"livenessProbe": {
"failureThreshold": 1,
"handler": {
"exec": {
"command": [
"/bin/sh",
"-c",
"echo 0"
]
}
},
"initialDelaySeconds": 0,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 1
},
"memory": 1,
"name": "container01",
"ports": [
{
"name": "",
"port": 111,
"protocol": ""
}
],
"runArgs": [],
"runCmd": [
"/bin/sh",
"-c",
"sleep inf"
],
"volumeMounts": [
{
"dstPath": "/mnt/model",
"readOnly": false,
"volumnName": "model"
}
]
},
"containerId": "",
"status": {
"containerStatus": "Pending",
"ctime": 0,
"reason": ""
}
}
],
"insID": "ap-880d26bc-76fd665d87-x9k8j",
"status": {
"availableContainers": 0,
"blocked": false,
"ctime": 1729152007,
"insStatus": "Creating",
"nodeIP": "",
"podIP": "",
"totalContainers": 1
}
},
{
"containers": [
{
"container": {
"cards": 0,
"cpus": 1,
"env": {
"AIHC": "true"
},
"image": {
"imageAddr": "registry.baidubce.com/inference/inference-sidecar:20240902",
"imagePullPass": "",
"imagePullUser": "",
"imageType": 1
},
"livenessProbe": {
"failureThreshold": 1,
"handler": {
"exec": {
"command": [
"/bin/sh",
"-c",
"echo 0"
]
}
},
"initialDelaySeconds": 0,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 1
},
"memory": 1,
"name": "container01",
"ports": [
{
"name": "",
"port": 111,
"protocol": ""
}
],
"runArgs": [],
"runCmd": [
"/bin/sh",
"-c",
"sleep inf"
],
"volumeMounts": [
{
"dstPath": "/mnt/model",
"readOnly": false,
"volumnName": "model"
}
]
},
"containerId": "",
"status": {
"containerStatus": "Pending",
"ctime": 0,
"reason": ""
}
}
],
"insID": "ap-880d26bc-76fd665d87-xzhwv",
"status": {
"availableContainers": 0,
"blocked": false,
"ctime": 1729150826,
"insStatus": "Creating",
"nodeIP": "",
"podIP": "",
"totalContainers": 1
}
},
{
"containers": [
{
"container": {
"cards": 0,
"cpus": 1,
"env": {},
"image": {
"imageAddr": "registry.baidubce.com/inference/inference-sidecar:20240902",
"imagePullPass": "",
"imagePullUser": "",
"imageType": 1
},
"memory": 1,
"name": "container01",
"ports": [],
"runArgs": [],
"runCmd": [
"/bin/sh",
"-c",
"sleep inf"
],
"volumeMounts": [
{
"dstPath": "/mnt/model",
"readOnly": false,
"volumnName": "model"
}
]
},
"containerId": "containerd://07f7b1b60ca66cdcf43c143fecac193e37494c6ad2de74b14c22601317185a95",
"status": {
"containerStatus": "Running",
"ctime": 1729062018,
"reason": ""
}
}
],
"insID": "ap-880d26bc-7d7bc5bd5b-vjskp",
"status": {
"availableContainers": 1,
"blocked": false,
"ctime": 1729062010,
"insStatus": "Running",
"nodeIP": "192.168.11.151",
"podIP": "10.12.13.242",
"totalContainers": 1
}
}
]
},
"requestId": "4205705084851554058"
}实例摘流
描述
关闭指定实例的流量。
请求结构
POST /api/v1/aihcpom/pod/block
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | 服务ID |
| insID | String | 是 | Query参数 | 实例ID |
| block | Bool | 是 | Query参数 | 是否封锁流量 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无。
返回示例
{
"request":"3411958765040011420"
}删除实例重建
描述
删除实例，并触发重建。
请求结构
POST /api/v1/aihcpom/pod/delete
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| appId | String | 是 | Query参数 | 服务ID |
| insID | String | 是 | Query参数 | 实例ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
无。
返回示例
{
"requestId":"2477156867891236783"
}查询资源池列表
描述
获取资源池列表。
请求结构
GET /api/v1/aihcpom/respool/listbrief
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 参数位置 | 是否必须 | 参数说明 |
|---|---|---|---|---|
| pageNo | Int32 | Query参数 | 否 | 默认为1 |
| pageSize | Int32 | Query参数 | 否 | 默认为1000 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| resPools | Array of ResPoolBriefInfo | 资源池信息 |
返回示例
{
"data": {
"resPools": [
{
"ClusterType": "normal",
"Description": "",
"ForbidDelete": true,
"K8sVersion": "1.28.8",
"associatedPfsID": "pfs-7xWeAt",
"createdAt": "2024-10-16T19:15:06+08:00",
"phase": "running",
"resPoolId": "cce-q80z1mig",
"resPoolName": "aihc-1.28-addon-zsp",
"updatedAt": "2024-10-16T20:18:34+08:00"
}
],
"total": 1
},
"requestId": "7473370275413601709"
}查询资源池详情
描述
获取所属资源池的详细信息。
请求结构
GET /api/v1/aihcpom/respool/detail
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 参数位置 | 是否必须 | 参数说明 |
|---|---|---|---|---|
| resPoolId | String | Query参数 | 是 | 需要查询的资源池ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| resPool | ResPoolInfo | 资源池信息 |
| resQueue | Array of ResQueueInfo | 队列信息 |
返回示例
{
"data": {
"resPool": {
"meta": {
"createdAt": "2024-10-09T21:02:16+08:00",
"resPoolId": "cce-wr5hxq74",
"resPoolName": "aihc-a800-route",
"updatedAt": "2024-10-09T21:08:17+08:00"
},
"spec": {
"associatedCpromIDs": [
"cprom-37hxdwr2b88z2"
],
"associatedPfsID": "pfs-7xWeAt",
"createdBy": "",
"description": "",
"forbidDelete": false,
"k8sVersion": "1.24.4",
"region": "bj"
},
"status": {
"GPUCount": {
"total": 0,
"used": 0
},
"NodeCount": {
"total": 2,
"used": 2
},
"phase": "running"
}
},
"resQueue": [
{
"allocated": {},
"capability": {
"baidu.com/a800_80g_cgpu": "8",
"baidu.com/a800_80g_cgpu_decode": "0",
"baidu.com/a800_80g_cgpu_encode": "0",
"cce.baidubce.com/rdmaeni": "0",
"cce.baidubce.com/rdmaip": "12",
"cpu": "132",
"ephemeral-storage": "687510758180",
"hugepages-1Gi": "0",
"hugepages-2Mi": "0",
"memory": "2178027335680",
"nvidia.com/gpu": "8",
"pods": "768",
"rdma/hca": "1k"
},
"createdTime": "2024-10-10T02:24:44Z",
"disableOversell": false,
"name": "63a9f0ea7bb98050796b649e85481845",
"nameSpace": "",
"parentQueue": "63a9f0ea7bb98050796b649e85481845",
"preemptable": true,
"queueType": "Elastic",
"reclaimable": true,
"state": "Open"
}
]
},
"requestId": "4367291807091077655"
}查询PFS信息
描述
获取指定PFS的信息。
请求结构
GET /api/v1/aihcpom/respool/pfs
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 参数位置 | 是否必须 | 参数说明 |
|---|---|---|---|---|
| instanceID | String | Query参数 | 是 | 需要查询的PFS ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| capacity | Int32 | 容量 |
| createTime | string | 创建时间 |
| description | String | 描述 |
| endpoint | String | 终点IP |
| instanceID | String | 实例ID |
| instanceStatus | String | 实例状态 |
| instanceType | String | 实例类型 |
| name | String | 名称 |
| paymentTiming | String | 付费信息 |
| subnetModel | SubnetModel | 子网模式 |
| usage | Int32 | 使用量 |
| VPCID | String | VPCID |
| hasPosixMountTarget | Bool | 是否含有PosixMountTarget |
| posixMountTargets | Array of string | Posix挂载点 |
| mountTargets | MountInfo | 挂载点 |
返回示例
{
"data": {
"VPCID": "vpc-t686xe1isp02",
"capacity": 51200,
"createTime": "2024-02-07T03:22:31Z",
"description": "",
"endpoint": "192.168.12.142",
"hasPosixMountTarget": false,
"instanceID": "pfs-7xWeAt",
"instanceStatus": "RUNNING",
"instanceType": "base",
"mountTargets": null,
"name": "aihc-pfs-l1-1",
"posixMountTargets": null,
"subnetModel": {
"CIDR": "192.168.12.128/25",
"physicalZone": "AZONE-gajl",
"subnetID": "sbn-9g5u0sa9mra9",
"zoneName": "zoneF"
},
"usage": 6768
},
"requestId": "6874040935609479152"
}查询EIP
描述
获取指定PFS的信息。
请求结构
GET /api/v1/aihcpom/app/listeip
Host:aihc.baidubce.com
Authorization:authorization string
ContentType: application/json 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名 | 参数类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| status | String | 否 | 查询指定状态的EIP，可选值包括available、binded、paused，分别表示有效的、已绑定、暂停。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
| list | Array of EIPInfo | 否 |
返回示例
{
"data": {
"list": [
{
"bandwidthInMbps": 1,
"billingMethod": "ByBandwidth",
"clusterId": "c-76a34e7b",
"createTime": "2024-07-12T10:19:56Z",
"eip": "180.76.146.165",
"eipId": "ip-5bA0a6cV",
"eipInstanceType": "normal",
"expireTime": "2024-08-12T10:20:10Z",
"instanceId": "",
"instanceType": "",
"name": "CCE/ClusterEIP/cce-ulmffisu",
"paymentTiming": "Prepaid",
"status": "available"
},
{
"bandwidthInMbps": 10,
"billingMethod": "ByTraffic",
"clusterId": "c-76a34e7b",
"createTime": "2024-10-11T11:23:14Z",
"eip": "120.48.114.181",
"eipId": "ip-7FCtIjMa",
"eipInstanceType": "normal",
"expireTime": "",
"instanceId": "",
"instanceType": "",
"name": "dev-e173f83e-ssh",
"paymentTiming": "Postpaid",
"status": "available"
},
]
},
"requestId": "6265725314704230778"
}