查询服务列表
此接口用于根据条件查询服务列表。
接口描述
通信协议：HTTP
URL：GET /api/v1/service
传参方式：query
请求参数
| 字段名 | 类型 | 是否必填 | 说明 |
|---|
| pageNum | number | 是 | 页码 |
| pageSize | number | 是 | 每页的服务数量 |
| name | string | 否 | 根据服务名称模糊查询 |
| id | string | 否 | 镜像 ID |
| nodeId | string | 否 | 节点 ID |
| label | string | 否 | 根据服务路径标签模糊查询 |
响应参数
| 字段名 | 类型 | 说明 |
|---|
| total | number | 服务总数 |
| pageNum | number | 页码 |
| pageSize | number | 每页的服务数量 |
| list | ProvisionListRow[ ] | 服务列表 |
ProvisionListRow
| 字段名 | 类型 | 说明 |
|---|
| id | string | 服务 ID |
| name | string | 服务名称 |
| status | string | 服务状态。complete 表示已完成部署；deploying 表示部署中 |
| updatedTime | string | 服务部署时间 |
| createdTime | string | 服务更新时间 |
| imageList | Image[ ] | 服务使用的镜像列表，目前只有一个 |
| nodeList | Node[ ] | 服务部署时选的节点列表 |
| containerStatusGroup | string[ ] | 服务下的容器实例状态集合 |
| factor | number | 服务的容器实例副本数量，静态即与选择的节点数量一致 |
| policy | string | 服务的部署类型。dynamic 表示动态部署；static 表示静态部署 |
| errorInstance | ErrorInstance[ ] | 服务部署失败的实例列表 |
| instanceOnline | number | 当前服务在线且在运行的容器实例数量 |
| defaultLabels | string[ ] | 当前服务的默认标签列表 |
| pathLabel | string | 当前服务的路径，从服务模板继承而来 |
Image
| 字段名 | 类型 | 说明 |
|---|
| name | string | 镜像名称 |
| os | string | 镜像的系统类型 |
| tag | string | 镜像的 Tag |
Node
| 字段名 | 类型 | 说明 |
|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| address | string | 节点 IP 地址 |
ErrorInstance
| 字段名 | 类型 | 说明 |
|---|
| containerId | string | 实例 ID |
| nodeId | string | 实例所在节点的 ID |
| nodeName | string | 实例所在节点的名称 |
| status | string | 实例是否健康。true 表示健康；false 表示不健康 |
| message | string | 错误的原因 |
请求示例
curl --location --request GET 'http://localhost:3001/api/v1/service?pageNum=1&pageSize=10&name=nginx-latest&id=8ac98c24-4de2-4534-903d-7667568c8cda&nodeId=8f5f1959-46dc-4955-84b8-f13a30f299df&lable=/222/333/444/555/777/nginx-latest-ziyuan-30'
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"list": [
{
"id": "1ce58b86-f378-43c5-a599-6c5301200ac0",
"name": "nginx-latest-ziyuan-30",
"status": "complete",
"createdTime": "2022-12-16 15:06:03",
"imageList": [
{
"id": "8ac98c24-4de2-4534-903d-7667568c8cda",
"name": "nginx",
"os": "linux",
"tag": "latest"
}
],
"nodeList": [
{
"nodeId": "8f5f1959-46dc-4955-84b8-f13a30f299df",
"nodeName": "192.168.XX.XX",
"address": "192.168.XX.XX:1112"
},
{
"nodeId": "ba918b9f-197b-44d3-b9f7-effbef62aad7",
"nodeName": "192.168.XX.XX",
"ip": "192.168.XX.XX"
},
{
"nodeId": "0895c702-40bc-4c4a-ac64-a4fb59d06903",
"nodeName": "192.168.XX.XX",
"ip": "192.168.XX.XX"
}
],
"containerStatusGroup": [
"running"
],
"instanceOnline": 3,
"factor": 3,
"policy": "static",
"errorInstance": [],
"defaultLabels": [],
"pathLabel": "/222/333/444/555/777/nginx-latest-ziyuan-30"
}
],
"total": 1,
"pageSize": 10,
"pageNum": 1
}
}
错误码
具体请参见 错误码说明。
京公网安备11010802043204号