Performing a Connectivity Test

Function

This API is used to test connectivity.

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 Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: Cluster ID. 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

Request Parameters

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

**Table 3** AddressAndPorts
Parameter	Mandatory	Type	Description
address	Yes	String	Definition: IP address or domain name. Constraints: N/A Value range: N/A Default value: N/A
port	No	Integer	Definition: Port. Constraints: N/A Value range: An integer ranging from 0 to 65535. Default value: 0

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	Array of result objects	Definition: Connectivity test result. Constraints: N/A Value range: N/A Default value: N/A

**Table 5** result
Parameter	Type	Description
address	String	Definition: IP address or domain name. Constraints: N/A Value range: N/A Default value: N/A
port	Integer	Definition: Port. Constraints: N/A Value range: N/A Default value: N/A
status	Integer	Definition: Connectivity test result. Constraints: N/A Value range: 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. Default value: N/A

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.