获取终端节点连接

功能介绍

终端节点服务（VPC Endpoint Service）通过专属网关，实现跨 VPC 内网访问，可将 VPC 中的服务安全、可靠地提供给其他 VPC 资源使用，无需暴露服务端网络信息。其访问地址包含三种类型：IPv4 地址（启用终端节点服务即自动分配）；IPv6 地址（需创建专业型终端节点并启用双栈网络时分配）；内网域名（需主动启用域名功能后系统分配）。该接口用于获取集群的终端节点连接。

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方法请参见获取项目ID和名称。约束限制：不涉及取值范围：账户的项目ID。默认取值：不涉及
cluster_id	是	String	参数解释：指定查询的集群ID。获取方法请参见获取集群ID。约束限制：不涉及取值范围：集群ID。默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	参数解释：指定终端节点连接的查询起始值。约束限制：不涉及取值范围：大于或等于0 默认取值： 0
limit	否	Integer	参数解释：指定终端节点连接的查询个数。约束限制：不涉及取值范围： 1-1000 默认取值：默认值为10，即一次查询10个任务信息。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
connections	Array of connections objects	参数解释：集群终端节点的连接信息。取值范围：不涉及
vpcServiceName	String	参数解释：集群终端节点服务名称。取值范围：不涉及
permissions	Array of permissions objects	参数解释：集群终端节点连接白名单列表权限列表。取值范围：不涉及
vpcepUpdateSwitch	Boolean	参数解释：集群终端节点更新开关。取值范围： true：开启终端节点。 false：关闭终端节点。
total_count	Integer	参数解释：集群终端节点数量。取值范围：不涉及

表4 connections
参数	参数类型	描述
id	String	参数解释：集群终端节点ID。取值范围：不涉及
status	String	参数解释：集群终端节点状态。取值范围： accepted：允许该终端节点连接。 rejected：拒绝该终端节点连接。
maxSession	String	参数解释：集群终端节点的最大连接数。取值范围：不涉及
specificationName	String	参数解释：集群终端节点名称。取值范围：不涉及
created_at	String	参数解释：集群终端节点创建时间。取值范围格式为ISO8601：CCYY-MM-DDThh:mm:ss。
update_at	String	参数解释：集群终端节点更新时间。默认为null。取值范围格式为ISO8601：CCYY-MM-DDThh:mm:ss。
domain_id	String	参数解释：拥有者的账号ID。取值范围：不涉及
vpcepIp	String	参数解释：集群终端节点IPv4。取值范围：不涉及
vpcepIpv6Address	String	参数解释：集群终端节点IPv6。取值范围：不涉及
vpcepDnsName	String	参数解释：集群终端节点内网域名。取值范围：不涉及

表5 permissions
参数	参数类型	描述
id	String	参数解释： Permission的ID，唯一标识。取值范围：不涉及
permission	String	参数解释：终端节点连接白名单权限详情。取值范围：不涉及
permission_type	String	参数解释：终端节点权限类型。取值范围： domainId：用户账号ID。
created_at	String	参数解释：终端节点的创建时间。取值范围：格式为ISO8601：CCYY-MM-DDThh:mm:ss。

请求示例

获取集群的终端节点连接。

GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/vpcepservice/connections

响应示例

状态码：200

请求成功。

{
  "connections" : [ {
    "id" : "54b7f739-31a1-40d0-862b-ac85b83ab2da",
    "status" : "accepted",
    "maxSession" : "3000",
    "specificationName" : "default",
    "vpcepIp" : "192.168.0.122",
    "created_at" : "2024-06-11T09:36:24Z",
    "update_at" : null,
    "domain_id" : "db9b76a0d9ae431f8e85e89da2ca867c"
  } ],
  "vpcepUpdateSwitch" : false,
  "total_count" : 1,
  "vpcServiceName" : "cn-north-4.css-op-no-delete.cf072729-b076-49db-83d3-020dc9f589bd",
  "permissions" : [ {
    "id" : "432a6429-f377-4168-8b24-feb5885af08c",
    "permission" : "iam:domain::db9b76a0d9ae431f8e85e89da2ca867c",
    "permission_type" : "domainId",
    "created_at" : "2023-10-12T07:33:11Z"
  } ]
}

状态码

状态码	描述
200	请求成功。
400	非法请求。建议直接修改该请求，不要重试该请求。
409	服务器在完成请求时发生冲突。返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。
412	未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码。

父主题： 终端节点

上一篇：关闭终端节点服务

下一篇：更新终端节点连接