更新时间:2023-07-03 GMT+08:00
获取集群访问的地址
功能介绍
该API用于通过集群ID获取集群访问的地址,包括PrivateIP(HA集群返回VIP)与PublicIP
集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径。
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/openapi
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见如何获取接口URI中参数。 |
cluster_id |
是 |
String |
集群ID,获取方式请参见如何获取接口URI中参数。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式) |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
metadata |
Metadata object |
基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 |
spec |
OpenAPISpec object |
集群访问地址的配置参数信息 |
status |
status object |
状态信息 |
请求示例
{ "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 |
表示获取集群访问的地址成功。 |
错误码
请参见错误码。
父主题: 集群管理