Help Center/ Cloud Search Service/ API Reference/ APIs/ Logstash/ Obtaining a Cluster Route

Updated on 2024-10-17 GMT+08:00

View PDF

Obtaining a Cluster Route

Function

This API is used to obtain a cluster route.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the target cluster

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
routeResps	Array of RouteRespsResource objects	Route IP address

**Table 3** RouteRespsResource
Parameter	Type	Description
ipAddress	String	IP address
ipNetMask	String	Subnet mask
updateAt	String	Update time

Example Requests

Obtain the cluster route.

GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/route

Example Responses

Status code: 200

Request succeeded.

{
  "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"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request instead of retrying.
409	The request cannot be processed due to a conflict. This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
412	The server does not meet one of the requirements that the requester puts on the request.