RegisterCustomConnector - 注册自定义连接器_实时计算 Flink版(Flink)-阿里云帮助中心

在项目空间下注册自定义连接器，注册的自定义连接器可以在SQL中使用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v2/namespaces/{namespace}/connectors:register

请求参数

名称	类型	必填	描述	示例值
workspace	string	是	工作空间 ID。	a14bd5d90a****
namespace	string	是	项目空间名称。	default-namespace
jarUrl	string	是	自定义连接器 Jar 包存放的地址，需要平台可访问该地址。	oss://flink/connector/mysql123

返回参数

名称	类型	描述	示例值
	object	响应数据。
requestId	string	请求 ID。	CBC799F0-AS7S-1D30-8A4F-882ED4DD****
success	boolean	表示业务请求是否成功。	true
httpCode	integer	业务状态码，统一为 200；使用 success 表示业务请求是否成功。	200
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	""
errorMessage	string	当 success 为 false，返回业务错误信息；当 success 为 true，返回空值。	""
data	array	当 success 为 true，返回满足条件的作业列表；当 success 为 false，该值为空。
	Connector	自定义连接器信息。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "name": "mysql-test",
      "type": "mysql-test",
      "source": false,
      "sink": true,
      "lookup": true,
      "properties": [
        {
          "key": "username",
          "defaultValue": "userA",
          "description": "用户名",
          "required": true,
          "definesFormat": true,
          "sensitive": false
        }
      ],
      "supportedFormats": [
        "Json"
      ],
      "dependencies": [
        "oss://bucket/add.jar"
      ],
      "creator": "183899668*******",
      "creatorName": "userA",
      "modifier": "183899668*******",
      "modifierName": "userA"
    }
  ]
}

错误码

访问错误中心查看更多错误码。