Querying Connectivity Test Details of a Specified Address

Function

This API is used to query the connectivity test result after the test is submitted.

URI

Request

None

Response

Table 2 Response parameters

Parameter

Mandatory

Type

Description

is_success

Yes

Boolean

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

Yes

String

System prompt. If execution succeeds, the parameter setting may be left blank.

connectivity

Yes

String

Indicates the connectivity test result.

Example Request

None

Example Response

{
    "is_success": true,
    "message": "Get node connectivity status successfully for addressId:9",
    "connectivity": "REACHABLE"
}

Status Codes

Table 3 describes status codes.

Table 3 Status codes

Status Code

Description

200

The query is successful.

400

Request failure.

500

Internal service error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.