文档首页> 数据湖探索 DLI> API参考> 队列相关API(推荐)> 创建指定地址连通性测试请求
更新时间:2023-11-27 GMT+08:00
分享

创建指定地址连通性测试请求

功能介绍

该API用于往指定队列发送地址连通性测试请求,并将测试地址插入表内。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

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

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    queue_name

    String

    队列名称。

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

address

String

测试地址。格式为:IP地址或域名:访问端口。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

请求执行是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

task_id

String

请求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
}

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

创建成功。

400

请求失败。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品