Help Center> Data Lake Insight> API Reference> Queue-related APIs (Recommended)> Creating an Address Connectivity Test Request
View PDF

Creating an Address Connectivity Test Request

Function

This API is used to send an address connectivity test request to a specified queue and insert the test address into the table.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

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

  • 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.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

address

Yes

String

Test address

Response

Table 3 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.

task_id

Yes

String

Request ID

Example

  • Example request 
    {
    "address": "iam.cn-north-1.myhuaweicloud.com:443"
}
  • Example response (successful request) 
    {
    "is_success": true,
    "message": "check connectivity to address:iam.cn-north-1.myhuaweicloud.com with port: 443 successfully",
    "task_id": 9
}

Status Codes

Table 4 describes status codes.

Table 4 Status codes

Status Code

Description

200

The job is created successfully.

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.