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
- 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. You can call Creating an Address Connectivity Test Request to obtain the value.
Request
None
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. |
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.
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