接口功能介绍
调用createK8sService接口为K8s集群中的应用创建K8s服务Service
接口约束
无
URI
POST /v1/app/inst/createK8sService
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
appDeployId | 是 | String | 应用部署ID,数据来源于获取已部署应用列表 | ||
name | 是 | String | K8s service名称,开头为小写字母,后可为大小写字母以及数字 | ||
servicesPorts | 是 | Array of Objects | K8sService端口映射表 | servicesPorts | |
trafficPolicy | 否 | String | K8s service路由策略,填写内容可为Local/Cluster,默认为Local | ||
type | 是 | String | K8s service类型,填写内容可为ClusterIP/NodePort |
表 servicesPorts
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodePort | 否 | Integer | 节点端口 | 0 | |
port | 是 | Integer | 服务端口 | 0 | |
protocol | 是 | String | 服务协议 | ||
targetPort | 是 | Integer | 容器端口 | 0 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | ||
error | String | 调用错误时返回的错误编码 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"appDeployId":"29b25b16-0b71-48ae-8e82-3746a052b98d ",
"name":"test",
"servicesPorts":[
{
"nodePort":"80",
"port":"80",
"protocol":"",
"targetPort":"80"
}
],
"trafficPolicy":"Local",
"type":"ClusterIP"
}
响应示例
{
"statusCode":2000,
"returnObj":{
"changeOrderId":"29b25b16-0b71-48ae-8e82-3746a052b98d "
},
"message":"成功"
}
状态码
请参考 状态码
错误码
请参考 错误码