更新时间:2026-09-30 GMT+08:00

获取集群访问的地址

功能介绍

该API用于通过集群ID获取集群访问的地址,包括PrivateIP(HA集群返回VIP)与PublicIP

集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径。

调用方法

请参见如何调用API。

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/openapi

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

是

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。

约束限制:

GET方法不做校验

取值范围:

不涉及

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

metadata

Metadata object

参数解释:

基本信息,为集合类的元素类型,包含一组由不同名称定义的属性

spec

OpenAPISpec object

参数解释:

集群访问地址的配置参数信息

status

status object

参数解释:

状态信息

表4 Metadata

参数

参数类型

描述

uid

String

参数解释:

唯一id标识

取值范围:

不涉及

name

String

参数解释:

资源名称

取值范围:

不涉及

labels

Map<String,String>

参数解释:

资源标签,key/value对格式,接口保留字段,填写不会生效

取值范围:

不涉及

annotations

Map<String,String>

参数解释:

资源注解,由key/value组成

取值范围:

不涉及

updateTimestamp

String

参数解释:

更新时间

取值范围:

不涉及

creationTimestamp

String

参数解释:

创建时间

取值范围:

不涉及

表5 OpenAPISpec

参数

参数类型

描述

spec

spec object

参数解释:

集群访问的地址

表6 spec

参数

参数类型

描述

eip

EipSpec object

参数解释:

EIP的详细信息

IsDynamic

Boolean

参数解释:

是否动态创建

取值范围:

不涉及

表7 EipSpec

参数

参数类型

描述

bandwidth

bandwidth object

参数解释:

带宽信息

表8 bandwidth

参数

参数类型

描述

size

Integer

参数解释:

带宽大小

取值范围:

不涉及

sharetype

String

参数解释:

带宽类型

取值范围:

  • PER:独享带宽,支持对单个EIP进行限速,且该EIP仅能被一个云资源(弹性云服务器、NAT网关、弹性负载均衡等)使用

  • WHOLE:共享带宽,支持对多个EIP集中限速,支持添加多个按需计费的EIP

表9 status

参数

参数类型

描述

privateEndpoint

String

参数解释:

集群访问的PrivateIP(HA集群返回VIP)

取值范围:

不涉及

publicEndpoint

String

参数解释:

集群访问的PublicIP

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

表示获取集群访问的地址成功。

{
  "metadata" : { },
  "spec" : {
    "spec" : {
      "eip" : {
        "bandwidth" : { }
      },
      "IsDynamic" : false
    }
  },
  "status" : {
    "privateEndpoint" : "https://192.168.3.238:5443",
    "publicEndpoint" : ""
  }
}

状态码

状态码

描述

200

表示获取集群访问的地址成功。

错误码

请参见错误码。