查询容器实例列表
此接口用于通过微服务主键查询微服务的容器实例列表。
接口描述
通信协议:HTTP
URL:GET /api/v1/micro-service/instance
传参方式:query
请求参数
字段名 | 类型 | 是否必填 | 说明 |
---|---|---|---|
id | string | 是 | 微服务主键 |
pageNum | number | 是 | 页码,如果传 -1,则展示全部数据 |
pageSize | number | 是 | 每页的实例数量 |
keyWord | string | 否 | 根据容器名称模糊查询 |
响应参数
字段名 | 类型 | 说明 |
---|---|---|
total | number | 实例总数 |
list | object[ ] | 容器实例列表,列表中各容器实例参数详情请参见 Container |
pageNum | number | 当前页码 |
pageSize | number | 每页的容器实例数量 |
请求示例
curl --location --request GET 'https://localhost:3001/api/v1/micro-service/instance?id=vsoa&pageNum=1&pageSize=10&keyWord='
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"total": 1,
"list": [
{
"id": "instance_fKsyj6x97Lkoh8v2",
"taskId": "64f1f6a410671736497300971081a33a4",
"name": "instance_fKsyj6x97Lkoh8v2",
"status": "running",
"uptime": 13219,
"startedTime": "2025-01-14T04:37:27.424Z",
"createdTime": "2025-01-14T04:37:20.863Z",
"taskCreatedTime": "2025-01-10 16:21:40",
"deployStatus": "success",
"failedMessage": null,
"restartCnt": 0,
"deployNum": 0,
"vsoaPort": 44004,
"cpuUsage": {
"total": 0,
"cores": [
0
]
},
"memoryLimit": 536870912,
"memoryUsage": 24829952,
"memoryMaxUsage": 24829952,
"sizeUsage": 107769,
"sizeLimit": 2147483648,
"serviceId": "0dfd93401065173649730097103259b1a",
"serviceName": "testvsoa",
"nodeId": "667517ef1013173649689952308a31c72",
"address": "10.12.XX.XX",
"nodeName": "10.12.XX.XX",
"nodeArch": "x86-64",
"imageId": "31218cfd1126173631921590177fee933",
"imageName": "x64_vsoa_server",
"imageVersion": "latest",
"imageOS": "sylixos",
"imageArch": "x86-64",
"ip": "10.12.XX.XX",
"loadStrategy": null,
"vsoaStatus": true
}
],
"pageNum": 1,
"pageSize": 10
}
}
错误码
具体请参见 错误码说明。