更新BEC容器服务
更新时间：2022-05-17
接口描述
该接口用于更新BEC容器服务。
请求结构
PUT /v2/service/{serviceId}?clientToken={clientToken} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
{
"bandwidth": 0,
"containers": [
{
"args": [],
"commands": [],
"cpu": 0,
"envs": [
{
"name": "",
"value": "",
"valueFrom": {
"configMapKeyRef": {
"key": "",
"name": "",
"optional": true
},
"fieldRef": {
"apiVersion": "",
"fieldPath": ""
},
"resourceFieldRef": {
"containerName": "",
"divisor": "",
"resource": ""
},
"secretKeyRef": {
"key": "",
"name": "",
"optional": true
}
}
}
],
"imageAddress": "",
"imageVersion": "",
"memory": 0,
"name": "",
"ports": [
{
"containerPort": 0,
"hostIP": "",
"hostPort": 0,
"name": "",
"protocol": ""
}
],
"volumeMounts": [
{
"mountPath": "",
"mountPropagation": "",
"name": "",
"readOnly": true,
"subPath": ""
}
],
"workingDir": ""
}
],
"deployInstances": [
{
"city": "",
"region": "",
"regionId": "",
"replicas": 0,
"serviceProvider": ""
}
],
"imageRegistrySecrets": [
{
"name": ""
}
],
"kernelParam": "",
"needIpv6PublicIp": true,
"serviceName": "",
"type": ""
}请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| request | 更新服务请求体 | body | 是 | UpdateBecServiceForm |
| bandwidth | 带宽 | 否 | number(float) | |
| containers | 容器组信息 | 否 | array | |
| args | 容器启动参数 | 否 | array | |
| commands | 容器启动命令 | 否 | array | |
| cpu | 容器申请的CPU核数 | 否 | integer | |
| envs | 容器环境变量 | 否 | array | |
| name | 容器环境变量key。 | 是 | string | |
| value | 容器环境变量value. | 否 | string | |
| imageAddress | 镜像地址 | 否 | string | |
| imageVersion | 镜像版本 | 否 | string | |
| memory | 容器申请的内存大小 | 否 | integer | |
| name | 容器的名称 | 否 | string | |
| ports | 容器端口协议 | 否 | array | |
| protocol | 容器暴露端口协议，必须是UDP、TCP、SCTP其中一种。默认是TCP。 | 否 | string | |
| volumeMounts | 容器数据卷信息 | 否 | array | |
| mountPath | 容器数据卷挂载路径 | 是 | string | |
| name | 容器数据卷名称。 | 是 | string | |
| readOnly | 容器数据卷是否只读，默认否 | 否 | boolean | |
| workingDir | 容器工作目录 | 否 | string | |
| deployInstances | 部署地域信息 | 否 | array | |
| city | 服务部署的城市 | 否 | string | |
| region | 服务部署的地域 | 否 | string | |
| regionId | 服务部署的节点ID | 否 | string | |
| replicas | 服务部署的副本数 | 否 | integer | |
| serviceProvider | 服务部署的运营商,可用值:BGP,CHINA_MOBILE, CHINA_UNICOM,CHINA_TELECOM,TRIPLE_LINE,INTRA |
否 | string | |
| imageRegistrySecrets | 镜像仓库凭据 | 否 | array | |
| name | 镜像仓库凭据名称 | 否 | string | |
| needIpv6PublicIp | 是否开通IPv6公网，true为开通，false为不开通。type需指定为resource。 只允许从IPv4变为IPv4/IPv6双栈。 |
否 | boolean | |
| serviceName | 服务名称 | 否 | string | |
| type | 修改类型，取值为name、replicas、resource，分别表示要修改 容器名字、实例数量、资源版本 |
是 | string | |
| serviceId | 服务ID | path | 是 | string |
| clientToken | 幂等性Token，是一个长度不超过64位的ASCII字符串 | query | 否 | string |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| deployInstances | 服务部署实例信息 | array |
| city | 城市 | string |
| cityName | 城市中文名 | string |
| country | 国家 | string |
| countryName | 国家中文名 | string |
| networkType | 网络类型 | string |
| region | 区域 | string |
| regionName | 区域中文名 | string |
| replicas | 副本数量 | integer |
| serviceProvider | 运营商,可用值:BGP,CHINA_MOBILE,CHINA_UNICOM, CHINA_TELECOM,TRIPLE_LINE,INTRA |
string |
| spName | 运营商中文名 | string |
| regions | 服务部署区域个数 | integer |
| runningPods | 服务RUNNING POD数 | integer |
| serviceId | 服务Id | string |
| serviceName | 服务名称 | string |
| status | 资源状态,可用值:STARTING,RUNNING,PENDING,EXCEPTION, FAILED,UNKNOWN,TERMINATED,WAITING,STOP,BINDING,STOPPING, TERMINATING,DELETING,NORMAL |
string |
| totalCpu | 服务CPU总数 | integer |
| totalDisk | 服务磁盘总数 | integer |
| totalGpu | 服务GPU总数 | integer |
| totalMem | 服务内存总数 | integer |
| totalPods | 服务POD总数 | integer |
错误码
请参照错误返回章节的内容。
请求示例
PUT /v2/service/{serviceId} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
{
"deployInstances": [{
"regionId": "cn-yangzhou-cm",
"region": "EAST_CHINA",
"replicas": 1,
"city": "YANGZHOU",
"serviceProvider": "CHINA_MOBILE",
}],
"type": "replicas"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"result": true,
"action": "update",
"details": [
{
"serviceId": "s-d6le3kd6",
"serviceName": "test-**",
"level": null,
"status": "STARTING",
"totalCpu": 2,
"totalMem": 4,
"totalGpu": 0,
"totalDisk": 0,
"regions": 2,
"totalPods": 2,
"runningPods": 1,
"tagsMap": null,
"deployInstances": [
{
"regionId": "cn-*-cm",
"replicas": 1,
"region": "*",
"serviceProvider": "CHINA_MOBILE",
"city": "TAIYUAN",
"regionName": "华北",
"spName": "移动",
"cityName": "太原",
"country": "CHINA",
"countryName": "中国"
},
{
"regionId": "cn-*-cm",
"replicas": 1,
"region": "EAST_CHINA",
"serviceProvider": "CHINA_MOBILE",
"city": "HANGZHOU",
"regionName": "华东",
"spName": "移动",
"cityName": "杭州",
"country": "CHINA",
"countryName": "中国"
}
],
"createTime": "2022-04-13T03:25:26Z",
"lastUpdateTime": null
}
]
}