文档首页/ 密码安全中心 DEW/ API参考/ API/ 云平台密码系统服务/ 集群端口管理/ 查询集群模式端口列表 - ListClusterPort
更新时间:2026-06-09 GMT+08:00
分享

查询集群模式端口列表 - ListClusterPort

功能介绍

列出当前集群下的所有集群模式端口

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    cpcs:cluster:listELBPort

    List

    cluster *

    -

    -

    -

URI

GET /v1/{project_id}/dew/cpcs/cluster/{cluster_id}/port

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

端口总数

取值范围:

不涉及

result

Array of ElbClusterPortReponseBody objects

参数解释:

端口列表

取值范围:

不涉及

表4 ElbClusterPortReponseBody

参数

参数类型

描述

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时。该字段描述错误的地方

取值范围:

不涉及

请求示例

查询端口列表

GET https://cpcs.com/v1/d4e559b49b3b403da5279723299ed4a6/dew/cpcs/cluster/ca433336f99446229fc86eca74f7572a/port

响应示例

状态码: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

请求已成功

错误码

请参见错误码

相关文档