Help Center> Data Lake Insight> API Reference> Queue-related APIs (Recommended)> Querying Connectivity Test Details of a Specified Address
View PDF

Querying Connectivity Test Details of a Specified Address

Function

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

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    GET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

    queue_name

    Yes

    String

    Name of a queue.

    task_id

    Yes

    String

    Job ID

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

  • Example request 
    None
  • Example response (successful request) 
    {
    "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 Code.