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

URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/openapi
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
cluster_id | 是 | String | 参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 参数解释: 消息体的类型(格式) 约束限制: GET方法不做校验 取值范围:
默认取值: 不涉及 |
X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
metadata | Metadata object | 参数解释: 基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 约束限制: 不涉及 |
spec | OpenAPISpec object | 参数解释: 集群访问地址的配置参数信息 约束限制: 不涉及 |
status | status object | 参数解释: 状态信息 约束限制: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
uid | String | 参数解释: 唯一id标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name | String | 参数解释: 资源名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
labels | Map<String,String> | 参数解释: 资源标签,key/value对格式,接口保留字段,填写不会生效 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
annotations | Map<String,String> | 参数解释: 资源注解,由key/value组成 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
updateTimestamp | String | 参数解释: 更新时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
creationTimestamp | String | 参数解释: 创建时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
eip | EipSpec object | 参数解释: EIP的详细信息 约束限制: 不涉及 |
IsDynamic | Boolean | 参数解释: 是否动态创建 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
无
响应示例
状态码:200
表示获取集群访问的地址成功。
{
"metadata" : { },
"spec" : {
"spec" : {
"eip" : {
"bandwidth" : { }
},
"IsDynamic" : false
}
},
"status" : {
"privateEndpoint" : "https://192.168.3.238:5443",
"publicEndpoint" : ""
}
} 状态码
状态码 | 描述 |
|---|---|
200 | 表示获取集群访问的地址成功。 |
错误码
请参见错误码。

