Obtaining a Cluster Route
Function
By default, a CSS Elasticsearch cluster cannot access a target service—such as a client program or a Lightweight Directory Access Protocol (LDAP) service—that is located in a different VPC. To enable this access, you need to configure cluster routes. This API is used to obtain cluster route information, including the route IP address and the total number of routes.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/route
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A |
cluster_id |
Yes |
String |
Definition: ID of the target cluster. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Definition: The start value of the query. The default value is 1, indicating that the query starts from the first route. Constraints: N/A Value range: 1-1000 Default value: 1 |
limit |
No |
Integer |
Parameter description: Number of routes to be queried. The default value is 10, indicating that 10 routes are queried at a time. Constraints: N/A Options: 1-1000 Default value: 10 |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
routeResps |
Array of RouteRespsResource objects |
Definition: Route IP address. Value range: N/A |
totalSize |
Integer |
Definition: Total number of routes. Value range: N/A |
Example Requests
Obtain cluster routes.
GET https://{Endpoint}/v1.0/{project_id}/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" } ], "totalSize" : 2 }
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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot