JCCE
/
karmada-api
25
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ADD file via upload

This commit is contained in:
qiwang 2022-01-20 14:50:39 +08:00
parent f7f29362ad
commit 05888a3163
1 changed files with 572 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

572
karmada-api.md Normal file
View File

@ -0,0 +1,572 @@
# **作业管理-后端数据查询使用的接口**
### 1、**任务列表**接口
#### 应用场景
​ 场景：返回dashboard任务列表
#### 接口描述
| 描述 | 内容 |
| :--------------------: | :---------------------------: |
| 接口功能 | dashboard任务列表接口 |
| 请求协议 | HTTP |
| 请求方法 | GET |
| 请求格式 | JSON |
| 请求url | /service/list |
| 请求头(和请求格式对应) | Content-Type:application/json |
| 备注 | |
| 请求内容 | |
| 响应码 | 200 |
| 响应格式 | success |
请求参数
| 参数 | 描述 | 必填 | 类型 |
| :--: | :------: | :--: | :--: |
| name | 检索名称 | | |
响应参数
| 参数 | 描述 | 必填 | 类型 |
| :-----------: | :------: | :--: | :--: |
| serviceID | 服务ID | | |
| displayName | | | |
| totalCPU | | | |
| totalMem | | | |
| serviceStatus | 服务状态 | | |
数据字典
| 参数 | 值 | 说明 |
| :-----------: | :-------: | :----: |
| serviceStatus | RUNNING | 进行中 |
| | COMPLETED | 已完成 |
| | ERROR | 异常 |
请求示例
```
http://424d4de7-0737-456f-af1e-fa4ed814d59b.mock.pstmn.io/service/list?name=nginx
```
响应示例：
​ 成功情况
```
{
"code": 0,
"message": "success",
"info": [
{
"serviceID": "nginx",
"displayName": "nginx应用",
"totalMem": 3825298525,
"totalCPU": 0.00442,
"serviceStatus": "RUNNING",
"age": 4852932
},
{
"serviceID": "karmada-agent",
"displayName": "karmada应用",
"totalMem": 3825298525,
"totalCPU": 0.442,
"serviceStatus": "RUNNING",
"age": 4852932
}
]
}
```
​ 失败情况
```
略
```
### 2、**任务详情**接口
#### 应用场景
​ 场景：获取服务的详情
#### 接口描述
| 描述 | 内容 |
| :--------------------: | :---------------------------: |
| 接口功能 | 获取服务的详情 |
| 请求协议 | HTTP |
| 请求方法 | GET |
| 请求格式 | JSON |
| 请求url | /service/detail |
| 请求头(和请求格式对应) | Content-Type:application/json |
| 备注 | |
| 请求内容 | |
| 响应码 | 200 |
| 响应格式 | success |
请求参数
| 参数 | 描述 | 必填 | 类型 |
| :-----------: | :----: | :--: | :--: |
| **serviceID** | 服务ID | | |
响应参数
| 参数 | 描述 | 必填 | 类型 |
| :------------: | :------: | :--: | :--: |
| **clusterNam** | 集群名 | | |
| totalCPU | 总CPU | | |
| totalMem | 总内存 | | |
| status | 状态 | | |
| startTime | 开始时间 | | |
数据字典
| 参数 | 值 | 说明 |
| :-----------: | :-------: | :----: |
| serviceStatus | RUNNING | 进行中 |
| | COMPLETED | 已完成 |
| | ERROR | 异常 |
请求示例
```
http://424d4de7-0737-456f-af1e-fa4ed814d59b.mock.pstmn.io/service/detail?serviceID=nginx
```
响应示例：
​ 成功情况
```
{
"code": 0,
"message": "success",
"info": [
{
"clusterName": "阿里云",
"totalMem": 3825298525,
"totalCPU": 0.00442,
"status": "ACTIVE",
"startTime": 1641263140
},
{
"clusterName": "之江",
"totalMem": 3825298525,
"totalCPU": 0.442,
"status": "INIT",
"startTime": 1641263140
}
]
}
```
​ 失败情况
```
略
```
### 3、网络流量接口
#### 应用场景
​ 场景：**网络流量**查询接口
#### 接口描述
| 描述 | 内容 |
| :--------------------: | :---------------------------: |
| 接口功能 | 查询**网络流量** |
| 请求协议 | HTTP |
| 请求方法 | GET |
| 请求格式 | JSON |
| 请求url | /service/netio |
| 请求头(和请求格式对应) | Content-Type:application/json |
| 备注 | |
| 请求内容 | |
| 响应码 | 200 |
| 响应格式 | success |
请求参数
| 参数 | 描述 | 必填 | 类型 |
| :-----------: | :------: | :--: | :-------: |
| **serviceID** | 服务ID | | |
| **start** | 开始时间 | | unixstamp |
| **end** | 结束时间 | | unixstamp |
| **step** | 步长 | | |
响应参数
| 参数 | 描述 | 必填 | 类型 |
| :-------------: | :--: | :--: | :------: |
| **displayName** | | | |
| values | | | String[] |
请求示例
```
http://424d4de7-0737-456f-af1e-fa4ed814d59b.mock.pstmn.io/service/netio?serviceID=nginx&start=1641206600&end=1641206800&step=120
```
响应示例：
​ 成功情况
```
{
"code": 0,
"message": "success",
"info": [
{
"metric": {
"displayName": "阿里云-接收流量"
},
"values": [
[
1641263140,
20
],
[
1641263260,
40
],
[
1641263380,
60
]
]
},
{
"metric": {
"displayName": "阿里云-发送流量"
},
"values": [
[
1641263140,
100
],
[
1641263260,
120
],
[
1641263380,
140
]
]
},
{
"metric": {
"displayName": "之江-接收流量"
},
"values": [
[
1641263140,
60
],
[
1641263260,
80
],
[
1641263380,
100
]
]
},
{
"metric": {
"displayName": "之江-发送流量"
},
"values": [
[
1641263140,
40
],
[
1641263260,
60
],
[
1641263380,
80
]
]
}
]
}
```
​ 失败情况
```
略
```
### 4、服务部署接口
#### 应用场景
​ 场景：**网络流量**查询接口
#### 接口描述
| 描述 | 内容 |
| :--------------------: | :---------------------------: |
| 接口功能 | 查询**网络流量** |
| 请求协议 | HTTP |
| 请求方法 | GET |
| 请求格式 | JSON |
| 请求url | /service/netio |
| 请求头(和请求格式对应) | Content-Type:application/json |
| 备注 | |
| 请求内容 | |
| 响应码 | 200 |
| 响应格式 | success |
请求参数
| 参数 | 描述 | 必填 | 类型 |
| :-----------: | :------: | :--: | :-------: |
| **serviceID** | 服务ID | | |
| **start** | 开始时间 | | unixstamp |
| **end** | 结束时间 | | unixstamp |
| **step** | 步长 | | |
响应参数
| 参数 | 描述 | 必填 | 类型 |
| :-------------: | :------: | :--: | :------: |
| **displayName** | 服务部署 | | |
| values | | | String[] |
请求示例
```
http://424d4de7-0737-456f-af1e-fa4ed814d59b.mock.pstmn.io/service/cluster_count?serviceID=nginx&start=1641263380&end=1641263490&step=120
```
响应示例：
​ 成功情况
```
{
"code": 0,
"message": "success",
"info": [
{
"metric": {
"displayName": "集群运行数量"
},
"values": [
[
1641263140,
2
],
[
1641263260,
3
],
[
1641263380,
4
]
]
}
]
}
```
​ 失败情况
```
略
```
### 5、**集群状态列表**
#### 应用场景
​ 场景：集群状态列表
#### 接口描述
| 描述 | 内容 |
| :--------------------: | :---------------------------: |
| 接口功能 | 查询**网络流量** |
| 请求协议 | HTTP |
| 请求方法 | GET |
| 请求格式 | JSON |
| 请求url | /cluster/list |
| 请求头(和请求格式对应) | Content-Type:application/json |
| 备注 | |
| 请求内容 | |
| 响应码 | 200 |
| 响应格式 | success |
请求参数
| 参数 | 描述 | 必填 | 类型 |
| :-----------: | :------: | :--: | :-------: |
| **serviceID** | 服务ID | | |
| **start** | 开始时间 | | unixstamp |
| **end** | 结束时间 | | unixstamp |
| **step** | 步长 | | |
响应参数
| 参数 | 描述 | 必填 | 类型 |
| :---------: | :----------: | :--: | :--: |
| clusterType | 集群类型 | | |
| clusterName | 集群名称 | | |
| nodeCnt | 节点数 | | |
| totalCPU | CPU总计 | | |
| CPUUsage | CPU使用情况 | | |
| CPURate | CPU升降情况 | | |
| totalMem | 总内存 | | |
| MemUsage | 使用内存情况 | | |
| MemRate | 内存升降情况 | | |
| volume | 存储容量 | | |
| volumeUsage | 存储使用情况 | | |
| state | 运行状态 | | |
数据字典
| 参数 | 值 | 说明 |
| :---------------------: | :----: | :------: |
| clusterType（集群类型） | HOST | 主控集群 |
| | MEMBER | 成员集群 |
| 参数 | 值 | 说明 |
| :----------------------: | :------: | :--: |
| clusterType(CPU变化情况) | INCR | 增长 |
| | DESC | 下降 |
| | UNCHANGE | 不变 |
| 参数 | 值 | 说明 |
| :-------------------------: | :-----: | :----: |
| clusterType（集群运行状态） | RUNNING | 运行中 |
| | IDLE | 空闲 |
请求示例
```
http://424d4de7-0737-456f-af1e-fa4ed814d59b.mock.pstmn.io/cluster/list
```
响应示例：
​ 成功情况
```
{
"code": 0,
"message": "success",
"info": [
{
"clusterType": "HOST",
"clusterName": "阿里云",
"nodeCnt": 3,
"totalCPU": 24,
"CPUUsage": 0.00424,
"CPURate": "INCR",
"totalMem": 24424292,
"MemUsage": 0.0024,
"MemRate": "DESC",
"volume": 43439639642,
"volumeUsage": 0.0781,
"state": "RUNNING"
},
{
"clusterType": "MEMBER",
"clusterName": "腾讯云",
"nodeCnt": 3,
"totalCPU": 24,
"CPUUsage": 0.00424,
"CPURate": "INCR",
"totalMem": 24424292,
"MemUsage": 0.0024,
"MemRate": "DESC",
"volume": 43439639642,
"volumeUsage": 0.0781,
"state": "IDLE"
}
]
}
```
​ 失败情况
```
略
```
### 6、**集群状态**详情接口
#### 应用场景
​ 场景：获取集群状态详情
#### 接口描述
| 描述 | 内容 |
| :--------------------: | :---------------------------: |
| 接口功能 | 获取集群状态详情 |
| 请求协议 | HTTP |
| 请求方法 | GET |
| 请求格式 | JSON |
| 请求url | /kapis/cluster/status |
| 请求头(和请求格式对应) | Content-Type:application/json |
| 备注 | |
| 请求内容 | |
| 响应码 | 200 |
| 响应格式 | success |
请求参数
| 参数 | 描述 | 必填 | 类型 |
| :-----------: | :----: | :--: | :--: |
| **serviceID** | 服务ID | | |
响应参数
| 参数 | 描述 | 必填 | 类型 |
| :--------: | :------------: | :--: | :--: |
| runningCnt | 正在运行集群数 | | |
| totalCnt | 总集群数 | | |
请求示例
```
http://121.40.154.75:30486/kapis/cluster/status
```
响应示例：
​ 成功情况
```
{
"code":0,
"message":"success",
"info":{
"runningCnt":4,
"totalCnt":7
}
}
```