更新时间:2025-08-15 GMT+08:00

获取集群路由

功能介绍

当CSS服务的Elasticsearch集群需要访问客户端或其他服务(如LDAP)时,如果集群与目标服务位于不同VPC,默认无法直接通信,此时,需要配置Elasticsearch集群路由打通网络。该接口用于获取集群路由,得到集群路由IP、路由总数等信息。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/route

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定待操作的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

指定查询起始值,默认值为1,即从第1个路由开始查询。

约束限制

不涉及

取值范围

1-1000

默认取值

1

limit

Integer

参数解释

指定查询个数,默认值为10,即一次查询10个路由信息。

约束限制

不涉及

取值范围

1-1000

默认取值

10

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

routeResps

Array of RouteRespsResource objects

参数解释

路由IP。

取值范围

不涉及

totalSize

Integer

参数解释

路由总数。

取值范围

不涉及

表4 RouteRespsResource

参数

参数类型

描述

ipAddress

String

参数解释

IP地址。

取值范围

不涉及

ipNetMask

String

参数解释

子网掩码。

取值范围

不涉及

updateAt

String

参数解释

路由IP更新时间。

取值范围

不涉及

请求示例

获取集群路由。

GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/route

响应示例

状态码:200

请求已成功。

{
  "routeResps" : [ {
    "ipAddress" : "1.2.3.65",
    "ipNetMask" : "255.255.255.255",
    "updateAt" : "2023-07-17T08:09:20"
  }, {
    "ipAddress" : "1.1.1.1",
    "ipNetMask" : "255.255.255.255",
    "updateAt" : "2023-07-17T08:08:50"
  } ],
  "totalSize" : 2
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码