检查 OceanBase 数据源的连通性

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

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

功能说明

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

接口说明

接口约束

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

请求路径

POST /api/omsp/v2/endpoints/oceanbase/check

请求参数

Request Body

{
  "name": "string",
  "ip": "string",
  "port": "integer[int32]",
  "user": "string",
  "password": "string",
  "cluster": "string",
  "tenant": "string",
  "oceanbaseMode": "string (enum: MYSQL, ORACLE)",
  "desc": "string",
  "ocpName": "string",
  "region": "string"
}

参数	类型	必选	描述
name	string	Y	OceanBase 数据源的名称。
ip	string	Y	OceanBase 数据源的 IP，可以是 OceanBase Proxy 的 IP。
port	integer[int32]	Y	OceanBase 数据源的端口，可以是 OceanBase Proxy 的端口。
user	string	Y	OceanBase 数据源用户，请注意，此处不携带集群和租户信息。
password	string	Y	OceanBase 数据源密码。
cluster	string	Y	OceanBase 数据源所属集群。
tenant	string	Y	OceanBase 数据源所属租户。
oceanbaseMode	string	Y	OceanBase 数据源的模式，取值可以是 MYSQL 或 ORACLE。
desc	string	N	OceanBase 数据源的描述。
ocpName	string	Y	OceanBase 数据源关联的 OCP 的名称。
region	string	Y	OceanBase 数据源的地域信息。

返回结果

您需要确保返回值中的 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	创建的 OceanBase 数据源的相关信息，具体包含的信息请参见《data 数据结构》。

data 数据结构

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

endpoint 数据结构

参数	类型	描述
cluster	string	OceanBase 数据源所属集群。
tenant	string	OceanBase 数据源所属租户。

示例

请求示例

curl --location --request POST 'http://xxx.xxx.xxx.1:8089/api/omsp/v2/endpoints/oceanbase/check?ctoken=bigfish_ctoken&pageNumber=1&pageSize=10' \
--header 'Authorization: Basic YWRt=' \
--header 'Content-Type: application/json' \
--data '{
    "name": "OB数据源测试",
    "dbType": "OB_MYSQL",
    "ip": "xxx.xxx.xxx.1",
    "port": 2883,
    "user": "username",
    "password": "password",
    "desc": "mysql -hxxx.xxx.xxx.1 -uusername@tenant#cluster -P2883 -ppassword -Dmysql_21",
    "region": "cn-jiangsu",
    "ocpName": "cn-anhui-212-xxx.xxx.xxx.1",
    "oceanbaseMode":"mysql",
    "cluster": "cluster",
    "tenant": "tenant",
    "domainParams": {
      "tenant": "tenant",
      "cluster": "cluster"
    }
}'

返回示例

{
  "success": true,
  "code": null,
  "message": null,
  "advice": null,
  "requestId": null,
  "pageNumber": null,
  "pageSize": null,
  "totalCount": null,
  "cost": null,
  "data": {
    "endpoint": {
      "dbType": "OB_MYSQL",
      "id": null,
      "name": "OB数据源测试",
      "ip": "xxx.xxx.xxx.1",
      "port": 2883,
      "username": "username",
      "password": "",
      "desc": "mysql -hxxx.xxx.xxx.1 -uusername@tenant#cluster -P2883 -ppassword -Dmysql_21",
      "gmtCreate": null,
      "domainParams": {
        "cluster": "cluster",
        "tenant": "tenant"
      },
      "version": "2.2.77",
      "timezone": "+08:00",
      "charset": "utf8mb4",
      "nlsLengthSemantics": null,
      "operatingSystem": null,
      "region": "cn-jiangsu",
      "ocpName": "cn-anhui-212-xxx.xxx.xxx.1",
      "role": null,
      "partnerId": null,
      "tryKeepHb": null
    },
    "connected": true,
    "diagnoseMessage": ""
  }
}