查询微服务列表
此接口用于分页查询微服务列表。
接口描述
通信协议：HTTP
URL：GET /api/v1/micro-service/
传参方式：query
请求参数
| 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| pageNum | number | 是 | 页码 |
| pageSize | number | 是 | 每页的微服务数量 |
| keyWord | string | 否 | 根据微服务名称模糊查询 |
| projectId | number | 否 | 镜像 ID |
| nodeId | string | 否 | 节点 ID |
| label | long | 否 | 根据服务路径标签模糊查询 |
响应参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| total | number | 微服务总数 |
| pageNum | number | 当前页码 |
| pageSize | number | 每页的微服务数量 |
| list | List[ ] | 微服务列表 |
List
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | string | 微服务主键 |
| imageName | string | 镜像名称 |
| instance | number | 微服务的容器实例数 |
| healthInstance | number | 微服务健康数 |
| loadBalance | string | 负载均衡策略。各类型负载均衡策略说明如下：
|
| name | string | 微服务名称 |
请求示例
curl --location --request GET 'http://localhost:3001/api/v1/micro-service?keyWord=&pageNum=1&pageSize=10'
响应示例
{
"status":200,
"message":"success",
"fieldErrors":null,
"data":{
"size":10,
"list":[
{
"id":66,
"name":"8825-zp-4",
"imageName":"ecmpjavademo@latest",
"instance":1,
"healthInstance":0,
"loadBalance":"roundRobin"
},
],
"total":2,
"pageSize":10,
"pageNum":1,
"pages":1,
"hasPreviousPage":false,
"hasNextPage":false
}
}
错误码
具体请参见 错误码说明。
京公网安备11010802043204号