查询云容器引擎来源中的服务列表
更新时间 2025-11-19 09:11:45
最近更新时间: 2025-11-19 09:11:45
接口功能介绍
无
接口约束
无
URI
GET /cgw/v1/upstreamSource/queryK8sServiceList
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| gwInstanceId | 是 | String | 云原生网关实例Id | 7a2828074ef6e32e041a2ef124b19e63 | |
| clusterName | 是 | String | 云容器引擎集群实例名 | ||
| namespaceName | 是 | String | 云容器引擎命名空间名称 |
请求参数
请求头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 | ||
| isHeadless | Boolean | 是否是无头函数 | ||
| 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 | 集群访问地址 | 3.3.3.3 | |
| containerPort | Integer | 容器端口 | 6443 | |
| enableMtls | Boolean | 是否开启mTLS,默认为false,只有当schema为https时才可选 | false | |
| enableWebsocket | Boolean | 是否开启webSocket, 默认关闭 | false | |
| fileCacheKeyVO | Object | 证书文件的缓存key | FileCacheKeyVO | |
| keyFileCacheKeyVO | Object | 密钥证书文件的缓存key | FileCacheKeyVO | |
| masterExternalVip | String | 外网访问地址 | 2.2.2.2 | |
| masterInnerVip | String | 内网访问地址 | 1.1.1.1 | |
| nodePort | Integer | 节点端口 | 80 | |
| portName | String | 端口名称 | http | |
| protocol | String | 服务协议 | http | |
| serviceName | String | 服务名称 | test | |
| servicePort | Integer | 服务端口 | 80 | |
| used | Boolean | 服务是否已添加的标志，传入的话可以避免重复检测 | false | |
| 表 FileCacheKeyVO |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| certFileKey | String | 证书文件的缓存key | cert file key | |
| certFileName | String | 证书文件名 | cert file name |
枚举参数
无
请求示例
请求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,
"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
}
状态码
请参考 状态码
错误码
请参考 错误码
