文档首页> 云容器引擎 CCE> API参考 (巴黎区域) > API> 集群管理> 获取集群访问的地址
更新时间：2023-07-03 GMT+08:00
查看PDF

获取集群访问的地址

功能介绍

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式）

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

带宽类型
表9 status

参数

参数类型

描述

privateEndpoint

String

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

publicEndpoint

String

集群访问的PublicIP

请求示例

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

响应示例

状态码： 200

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

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

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题： 集群管理