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
- 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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
address |
Yes |
String |
Test address. The format is IP address or domain name:port. |
Response
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 |
Integer |
Request ID |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot