Help Center/ Cloud Search Service/ API Reference/ APIs/ Logstash/ Performing a Connectivity Test

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

View PDF

Performing a Connectivity Test

Function

This API is used to test connectivity.

Debugging

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

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/checkconnection

**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	Cluster ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
addressAndPorts	Yes	Array of AddressAndPorts objects	Address and port list.

**Table 3** AddressAndPorts
Parameter	Mandatory	Type	Description
address	Yes	String	IP address or domain name.
port	No	Integer	Port number.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	Array of result objects	Connectivity test result.

**Table 5** result
Parameter	Type	Description
address	String	IP address or domain name.
port	Integer	Port number.
status	Integer	Test result. 1: The connection is successful. 0: The address is unreachable. 2: The port is unreachable. 3: The domain name cannot be resolved. 2: The location is incorrect.

Example Requests

Configure the port to test connectivity.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/checkconnection

{
  "addressAndPorts" : [ {
    "address" : "10.0.0.83",
    "port" : "9200"
  } ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "result" : [ {
    "address" : "10.0.0.83",
    "port" : "9200",
    "status" : 1
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. The client should modify the request instead of re-initiating it.
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 did not meet one of the preconditions contained in the request.