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.

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

Response

Example Request

Test the connectivity between the queue and the address iam.xxx.com:443.

{
    "address": "iam.xxx.com:443"
}

Example Response

{
    "is_success": true,
    "message": "check connectivity to address:iam.xxx.com with port: 443 successfully",
    "task_id": 9
}

Status Codes

Table 4 describes status codes.

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.