接口功能介绍
调用getK8sServices接口获取K8s集群中应用的服务Service列表
接口约束
无
URI
GET /v1/app/inst/getK8sServices
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
appDeployId | 是 | String | 应用部署ID,数据来源于获取已部署应用列表 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
clusterIp | String | K8s集群IP | ||
extraVip | String | 外网IP | ||
intraVip | String | 内网IP | ||
name | String | K8s service名称 | ||
servicesPorts | Array of Strings | Pod信息列表 | servicesPorts | |
trafficPolicy | String | K8s service路由策略 | ||
type | String | K8s service类型 | ||
msg | String | 消息内容 |
表 servicesPorts
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
nodePort | Integer | 节点端口 | 0 | |
port | Integer | 服务端口 | 0 | |
protocol | String | 服务协议 | ||
targetPort | Integer | 容器端口 | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 2000,
"returnObj": {
"clusterIp": "192.168.1.1",
"extraVip": "200.168.21.3",
"intraVip": "192.168.1.1",
"name": "test1",
"servicesPorts": {
"nodePort": "80",
"port": "80",
"protocol": "TCP",
"targetPort": "80"
},
"trafficPolicy": "Local",
"type": ""
},
"message": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码