Updated on 2026-09-02 GMT+08:00

Logstash Connectivity Test

Function

This API is used to test the connectivity between a Logstash cluster and a data source or destination. Logstash can read data from data sources and send data to destinations only when the network is connected.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
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 Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. Default Value N/A
cluster_id	Yes	String	Definition ID of the cluster to be tested. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range The value is a UUID containing 36 characters. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
address_and_ports	Yes	Array of AddressAndPorts objects	Definition List of addresses and ports. Each element contains an IP address or domain name and a port number. Constraints A maximum of 10 IP addresses and ports are supported at a time.

**Table 3** AddressAndPorts
Parameter	Mandatory	Type	Description
address	Yes	String	Definition IP address or domain name. Constraints N/A Range The IP address ranges from 0.0.0.0 to 255.255.255.255. The domain name must be a valid domain name that complies with Request for Comments (RFC) specifications. Default Value N/A
port	No	Integer	Definition Port number. Constraints N/A Range 1-65535 Default Value 1

Response Parameters

Status code: 200

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

**Table 5** result
Parameter	Type	Description
address	String	Definition: IP address or domain name. Value range: N/A
port	Integer	Definition: Port. Value range: N/A
status	Integer	Definition Connectivity test result. Range 1: Connection succeeded. 0: Address unreachable. 2: Port unreachable. 3: Domain name cannot be resolved. -2: Unknown error.

Example Requests

Configure the port to test connectivity.

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

{
  "address_and_ports" : [ {
    "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.

Error Codes

See Error Codes.

Parent topic: Logstash