同租户下MSE、K8S查询管理
1.查询K8s来源中的服务列表
接口功能介绍
无
接口约束
无
URI
GET /cgw/v1/upstreamSource/queryK8sServiceList
Accept: application/json
路径参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
gwInstanceId | 是 | String | 云原生网关实例Id | 7a2828074ef6e32e041a2ef124b19e63 | |
clusterName | 是 | String | k8s集群实例名 | ||
namespaceName | 是 | String | k8s命名空间名称 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Array of Objects | 返回数据 | K8sServiceInfoDTO | |
message | String | 异常描述 | success |
表 K8sServiceInfoDTO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
appName | String | 应用名 | app | |
createdBy | Integer | 创建者 | 1 | |
createdTime | String | 创建时间 | 2023-10-10 12:12:12 | |
externalIps | Array of Objects | 外部ip | 1.1.1.1 | |
isHeadless | Boolean | |||
keyValues | Array of Objects | KeyValue | ||
labels | Array of Objects | KeyValue | ||
namespaceName | String | 命名空间名称 | prod | |
selectors | Array of Objects | KeyValue | ||
serviceIp | String | 服务ip | 1.1.1.2 | |
serviceIpv6 | String | 服务ipv6 | ||
serviceName | String | 服务名 | test | |
servicePortMappingDTOS | Array of Objects | ServicePortMappingDTO | ||
serviceType | String | 服务类型 | ||
sessionAffinity | String | |||
timeoutSeconds | Integer | 超时时间 | ||
used | Boolean | |||
withServiceMesh | Boolean | |||
workloadKind | String | |||
workloadName | String |
表 KeyValue
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
key | String | key | ||
value | String | value |
表 ServicePortMappingDTO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
clusterAccessUrl | String | 集群访问url | ||
containerPort | Integer | 容器内端口 | ||
enableMtls | Boolean | 是否启用了mtls | ||
enableWebsocket | Boolean | 是否启用了websocket协议 | ||
masterExternalVip | String | 外部通信ip | ||
masterInnerVip | String | 内部通信ip | ||
nodePort | Integer | 映射端口 | ||
portName | String | port名称 | ||
protocol | String | 协议类型 | ||
serviceName | String | 服务名 | ||
servicePort | Integer | 服务端口 |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/upstreamSource/queryK8sServiceList?gwInstanceId=String&clusterName=String&namespaceName=String
请求头header
{
"regionId": "1234567890"
}
请求体body
响应示例
{
"message": "String",
"returnObj": [
{
"appName": "String",
"createdBy": 0,
"createdTime": "String",
"externalIps": [
{}
],
"isHeadless": true,
"keyValues": [
{
"key": "String",
"value": "String"
}
],
"labels": [
{
"key": "String",
"value": "String"
}
],
"namespaceName": "String",
"selectors": [
{
"key": "String",
"value": "String"
}
],
"serviceIp": "String",
"serviceIpv6": "String",
"serviceName": "String",
"servicePortMappingDTOS": [
{
"clusterAccessUrl": "String",
"containerPort": 0,
"masterExternalVip": "String",
"masterInnerVip": "String",
"nodePort": 0,
"portName": "String",
"protocol": "String",
"serviceName": "String",
"servicePort": 0
}
],
"serviceType": "String",
"sessionAffinity": "String",
"timeoutSeconds": 0,
"used": true,
"withServiceMesh": true,
"workloadKind": "String",
"workloadName": "String"
}
],
"statusCode": 2000
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。