创建指定地址连通性测试请求
功能介绍
该API用于往指定队列发送地址连通性测试请求,并将测试地址插入表内。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式:
- 参数说明
表1 URI参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
queue_name
是
String
队列名称。
请求消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
address |
是 |
String |
测试地址。格式为:IP地址或域名:访问端口。 |
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
是 |
Boolean |
请求执行是否成功。“true”表示请求执行成功。 |
message |
是 |
String |
系统提示信息,执行成功时,信息可能为空。 |
task_id |
是 |
Integer |
请求id。 |
请求示例
测试队列与该地址“iam.xxx.com:443”的连通性。
{ "address": "iam.xxx.com:443" }
响应示例
{ "is_success": true, "message": "check connectivity to address:iam.xxx.com with port: 443 successfully", "task_id": 9 }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。