查询集群模式端口列表 - ListClusterPort
功能介绍
列出当前集群下的所有集群模式端口
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cpcs:cluster:listElbPort
List
cluster *
-
-
-
URI
GET /v1/{project_id}/dew/cpcs/cluster/{cluster_id}/port
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
cluster_id |
是 |
String |
集群ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户token,参见:IAM token获取方法 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
端口总数 |
|
result |
Array of ElbClusterPortReponseBody objects |
端口列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
uuid |
|
cluster_id |
String |
该端口归属的集群id |
|
elb_id |
String |
租户的elbId |
|
elb_ip |
String |
租户的elb的ip |
|
mode |
String |
PROXY:代理模式端口 TUNNEL:隧道模式自定端口 TUNNEL_FIXED:隧道模式的固定隧道端口 |
|
listener_port |
Integer |
elb监听端口 |
|
listener_id |
String |
elb监听器id |
|
server_group_port |
Integer |
后端服务组绑定的后端服务器的业务端口 |
|
server_group_id |
String |
后端服务组id |
|
project_id |
String |
项目id |
|
validate_time |
String |
最后验证时间 |
|
wrong |
Boolean |
资源是否异常。 由于该接口功能是cpcs操作租户的elb。而租户是可以二次操作cpcs创建的端口映射的。cpcs提供了一个检测接口,用以检测cpcs创建的这一套监听端口是否有误。 |
|
wrong_msg |
String |
若端口有误。即wrong=true时。该字段描述错误的地方 |
请求示例
无
响应示例
状态码:200
请求已成功
{
"total_num" : 2,
"result" : [ {
"id" : "string",
"cluster_id" : "string",
"elb_id" : "string",
"elb_ip" : "string",
"mode" : "PROXY",
"listener_port" : 0,
"listener_id" : "string",
"server_group_port" : 0,
"server_group_id" : "string",
"project_id" : "string",
"validate_time" : "2025-07-15 17:29:59",
"wrong" : true,
"wrong_msg" : "后端服务组中后端服务器的数量不对"
}, {
"id" : "string",
"cluster_id" : "string",
"elb_id" : "string",
"elb_ip" : "string",
"mode" : "PROXY",
"listener_port" : 0,
"listener_id" : "string",
"server_group_port" : 0,
"server_group_id" : "string",
"project_id" : "string",
"validate_time" : "2025-07-15 17:29:59",
"wrong" : true,
"wrong_msg" : "后端服务组中后端服务器的数量不对"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。