服务来源管理
1.服务来源列表
接口描述
查询网关实例已添加的服务来源列表。
接口约束
无
URI
GET v1/upstreamSource/list
Accept: application/json
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instId | 是 | String | 实例Id | 7a2828074ef6e32e041a2ef124b19e63 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 123456074ef6e32e041a2ef124b19e63 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Array of Objects | 返回数据 | UpstreamSourceVO | |
message | String | 异常描述 | success |
表 UpstreamSourceVO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
id | String | 服务来源内部资源id | 7a2828074ef6e32e041a2ef124123456 | |
idId | String | 从注册中心获取的实例ID | 123456074ef6e32e041a2ef124123456 | |
idName | String | 从注册中心获取的实例名称 | rcc-ters | |
ingressControllerInstallFailMessage | String | ingressController安装失败信息 | ||
ingressControllerInstallStatus | String | ingressController安装状态 | ||
ingressControllerInstallStatusDesc | String | ingressController安装状态中文展示 | ||
kubernetesInfo | Object | k8s来源的详情 | KubernetesSourceInfo | |
nacosInfo | Object | nacos来源的详情 | NacosSourceInfo | |
namespaceLabelSelector | String | ingressController监听的命名空间标签选择器 | ||
relatedInfo | String | 从注册中心获取的实例关联信息 | 1.1.1.1:47588 | |
type | String | 服务来源类型 | nacos | |
updateTime | Long | 变更时间 | 2023-10-10 12:12:12 |
表 KubernetesSourceInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
host | 是 | String | 从ccse获取的k8s实例ip | 987456074ef6e32e041a2ef124123456 | |
port | 是 | String | 从ccse获取的k8s实例端口 | 6443 | |
schema | 是 | String | 从ccse获取的k8s实例schema | http | |
token | 是 | String | 从ccse心获取的k8s实例token | token |
表 NacosSourceInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
fetchInterval | 否 | Integer | 定时fetch间隔,默认30秒 | 30 | |
nacosNodes | 是 | Array of Objects | nacos实例(集群)节点信息 | NacosNode | |
prefix | 否 | String | 前缀配置,默认为"/nacos/v1" | /nacos/v1 | |
timeout | 否 | Object | 访问nacos时的超时配置 | Timeout | |
weight | 否 | Integer | 权重,默认100 | 100 |
表 NacosNode
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
host | 是 | String | 从注册中心获取的nacos实例ip | 1.1.1.1 | |
password | 是 | String | 从注册中心获取的nacos实例密码 | passwd | |
port | 是 | String | 从注册中心获取的nacos实例端口 | 47588 | |
username | 是 | String | 从注册中心获取的nacos实例用户名 | rcc-etrs |
表 Timeout
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
connect | 否 | Float | 连接超时,默认2000毫秒 | 2000 | |
read | 否 | Float | 接收超时,默认5000毫秒 | 2000 | |
send | 否 | Float | 发送超时,默认2000毫秒 | 2000 |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/upstreamSource/list?instId=String
请求头header
{
"regionId": "1234567890"
}
请求体body
响应示例
{
"statusCode": 2000,
"message": "success",
"returnObj": [
{
"id": "00000000000000000020",
"type": "nacos",
"idName": "mse-test-chenjh123",
"idId": "76fb7717e5bd9a15a9f926d26e640537",
"relatedInfo": "192.168.128.119:47588",
"nacosInfo": {
"prefix": "/nacos/cgw/v1/",
"weight": 100,
"timeout": {
"connect": 2000,
"read": 5000,
"send": 2000
},
"fetchInterval": 30
},
"updateTime": "2023-03-10 10:31:17"
},
{
"id": "00000000000000000027",
"type": "kubernetes",
"idName": "ccse-cjh",
"idId": "48fd3ead79a3df829c7b7c7777cdd3bc",
"relatedInfo": "ccse-cjh",
"kubernetesInfo": {
"schema": "https",
"host": "192.168.128.60",
"port": "6443"
},
"updateTime": "2023-03-13 10:57:51"
}
]
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。