获取应用实例列表
更新时间 2026-08-19 15:09:37
最近更新时间: 2026-08-19 15:09:37
接口功能介绍
分页获取应用实例列表。
接口约束
无
URI
GET /v1/cae/application/list-instances
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appID | 否 | String | 应用ID | 09db72fa-xxxx-xxxx-a1d8-24a420181216 | |
| group | 否 | String | 分组 | default | |
| namespaceID | 否 | String | 命名空间ID | 0b7b7988-xxxx-xxxx-af7d-244e82424221 | |
| order | 否 | String | ASC升序，DESC降序，默认降序 | DESC | |
| orderBy | 否 | String | 排序字段名，默认按创建时间排序 | createTime | |
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 分页大小 | 10 | |
| pipelineID | 否 | String | 流水线ID | pipeline-xxxx | |
| search | 否 | String | 模糊查询的关键字，默认为空 | test |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池 ID | bb9fdb42056xxxeda1610242ac1xxxxx | |
| locale | 否 | String | 指定客户端期望的响应语言偏好，默认语言为中文 | en英文，zh-CH中文 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 业务状态码（800为成功，900为失败） | 800 | |
| message | String | 业务状态码为900时的错误信息 | success | |
| description | String | 业务状态码为900时的错误描述 | 成功 | |
| returnObj | Object | 业务数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页数量 | 10 | |
| instances | Array of Objects | 实例列表 | InstanceData | |
| pageNo | Integer | 当前页 | 1 | |
| pageSize | Integer | 页面大小 | 10 | |
| totalCount | Integer | 总数 | 100 | |
| requestID | String | 请求ID | 5fd3e6f7-9229-4fb4-a352-0f91bfd638b1 |
表 InstanceData
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| appID | String | 应用id | 09db72fa-xxxx-xxxx-a1d8-24a420181216 | |
| containerInfoList | Array of Objects | 容器信息列表 | ContainerInfo | |
| createTimeStamp | Integer | 创建时间戳 | 1634544000000 | |
| finishTimeStamp | Integer | 完成时间戳 | 1634544300000 | |
| group | String | 分组 | default | |
| imageUrl | String | 镜像地址 | nginx:latest | |
| instanceContainerIPv4 | String | InstanceContainerIP string json:"instanceContainerIp" example:"10.0.0.10" //实例容器ip | 10.0.0.10 | |
| instanceContainerIPv6 | String | 实例容器ip(ipv6) | 240e:982:daf5:3701:8f7a:da6:141c:b67f | |
| instanceContainerRestarts | Integer | 实例容器重启次数 | 0 | |
| instanceContainerStatus | String | 实例容器状态 | Running | |
| instanceId | String | 实例id | instance-123456 | |
| instanceName | String | 实例名称 | my-app-pod-1 | |
| namespaceID | String | 命名空间id | ns-123456 | |
| subnetID | String | 子网id | subnet-123456 | |
| unhealthyMessage | String | 不健康消息 |
表 ContainerInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| containerID | String | 容器id | docker://abc123 | |
| name | String | 容器名称 | nginx | |
| nodeIp | String | 节点ip | 192.168.1.10 |
枚举参数
无
请求示例
请求url
GET /v1/cae/application/list-instances
请求头header
regionId:20000000***1852
请求体body
无
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"returnObj": {
"currentCount": 10,
"instances": [
{
"appID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
"containerInfoList": [
{
"containerID": "docker://abc123",
"name": "nginx",
"nodeIp": "192.168.1.10"
}
],
"createTimeStamp": 1634544000000,
"finishTimeStamp": 1634544300000,
"group": "default",
"imageUrl": "nginx:latest",
"instanceContainerIPv4": "10.0.0.10",
"instanceContainerIPv6": "240e:982:daf5:3701:8f7a:da6:141c:b67f",
"instanceContainerRestarts": 0,
"instanceContainerStatus": "Running",
"instanceId": "instance-123456",
"instanceName": "my-app-pod-1",
"namespaceID": "ns-123456",
"subnetID": "subnet-123456",
"unhealthyMessage": ""
}
],
"pageNo": 1,
"pageSize": 10,
"totalCount": 100,
"requestID": "5fd3e6f7-9229-4fb4-a352-0f91bfd638b1"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
