检查 Kafka 数据源的连通性

更新时间：2023-06-08 10:49:34

本文为您介绍 OMS 提供的 OpenAPI：检查 Kafka 数据源的连通性。

功能说明

本接口用于检查 Kafka 数据源的连通性。

接口说明

接口约束

本接口适用于 OMS V2.1.2 及以上版本。

请求路径

POST /api/omsp/v2/endpoints/kafka/check

请求参数

Request Body

{
  "name": "string",
  "endpoint": "string",
  "user": "string",
  "password": "string",
  "desc": "string",
  "region": "string"
}

参数	类型	必选	描述
name	string	Y	Kafka 数据源的名称。
endpoint	string	Y	Kafka 数据源连接。
user	string	N	Kafka 数据源的用户。
password	string	N	Kafka 数据源的密码，允许为空。
desc	string	N	Kafka 数据源的描述。
region	string	Y	Kafka 数据源的地域信息。

返回结果

您需要确保返回值中的 success 字段为 true，且 connected 字段为 true，预检查才算成功。否则您需要检查返回的 diagnoseMessage 字段内容。

参数	类型	描述
success	boolean	是否调用成功。
code	string	状态码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer[int32]	当前页数。
pageSize	integer[int32]	每页条数。
totalCount	integer[int64]	总记录数。
cost	string	请求耗时。
data	Object	Kafka 数据源的信息。具体包含的信息请参见下面的《data 数据结构》。

data 数据结构

参数	类型	描述
endpoint	Object	Kafka 数据源的相关信息。具体包含的信息请参见下面的《endpoint 数据结构》。
connected	boolean	连通性测试结果。
diagnoseMessage	string	诊断信息。如果连通性测试通过，则不返回诊断信息。

endpoint 数据结构

参数	类型	描述
dbType	string	数据源类型，取值为 KAFKA。
id	string	数据源终端标识。
name	string	数据源终端名称。
ip	string	数据源终端 IP 地址。
port	integer[int32]	数据源终端开放端口。
username	string	数据源终端连接账号。
password	string	数据源终端连接密码。
desc	string	数据源终端描述。
gmtCreate	string[date]	数据源终端创建时间。
domainParams	Object	Kafka 扩展信息: endpoint, user, password, 其中后两者为可选。
version	string	数据源终端版本。
timezone	string	数据源终端时区。
charset	string	数据源终端字符编码。
nlsLengthSemantics	string	`nls_length_semantics` 属性。本接口不会返回该信息。
operatingSystem	string	操作系统。
region	string	地域信息。
ocpName	string	OCP 的名称。本接口不会返回该信息。
role	string	数据源的角色。取值包括 MASTER 和 SLAVE。
partnerId	string	对应主备库 ID。
tryKeepHb	boolean	是否允许尝试维持心跳，只有数据源角色是 MASTER 时会返回本字段。

示例

请求示例

curl --location --request POST 'http://xxx.xxx.xxx.1:8089/api/omsp/v2/endpoints/kafka/check?ctoken=bigfish_ctoken' \
--header 'Authorization: Basic YWRt=' \
--header 'Content-Type: application/json' \
--data '{
    "name": "name",
    "region": "cn-fujian",
      "enableSSL": false,
      "enableSASL": false,
    "desc": "接口自动化自动添加",
    "endpoint": "xxx.xxx.xxx.1:9092",
    "dbType": "KAFKA"
}'

返回示例

{
  "success": true,
  "code": null,
  "message": null,
  "advice": null,
  "requestId": null,
  "pageNumber": null,
  "pageSize": null,
  "totalCount": null,
  "cost": null,
  "data": {
    "endpoint": {
      "dbType": "KAFKA",
      "id": null,
      "name": "name",
      "ip": null,
      "port": null,
      "username": null,
      "password": null,
      "desc": null,
      "gmtCreate": null,
      "domainParams": null,
      "version": null,
      "timezone": null,
      "charset": null,
      "nlsLengthSemantics": null,
      "operatingSystem": null,
      "region": null,
      "ocpName": null,
      "role": null,
      "partnerId": null,
      "tryKeepHb": null
    },
    "connected": true,
    "diagnoseMessage": "connected"
  }
}