更新时间:2026-01-12 GMT+08:00

连通性测试

功能介绍

该接口用于连通性测试。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/checkconnection

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定测试的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

address_and_ports

Array of AddressAndPorts objects

参数解释

地址和端口列表。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表3 AddressAndPorts

参数

是否必选

参数类型

描述

address

String

参数解释

IP地址或域名。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

port

Integer

参数解释

端口号。

约束限制

不涉及

取值范围

0到65535的整数。

默认取值

0

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

Array of result objects

参数解释

连通性测试结果。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表5 result

参数

参数类型

描述

address

String

参数解释

IP地址或域名。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

port

Integer

参数解释

端口号。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

status

Integer

参数解释

连通性测试结果。

约束限制

不涉及

取值范围

  • 1:表示连接成功。

  • 0:表示地址不可达。

  • 2:表示端口不可达。

  • 3:表示域名无法解析。

  • -2:表示位置错误。

默认取值

不涉及

请求示例

配置端口测试连通性。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/checkconnection

{
  "address_and_ports" : [ {
    "address" : "10.0.0.83",
    "port" : "9200"
  } ]
}

响应示例

状态码:200

请求已成功。

{
  "result" : [ {
    "address" : "10.0.0.83",
    "port" : "9200",
    "status" : 1
  } ]
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码