ListCustomConnectors - 获取自定义连接器列表

获取已注册的自定义连接器的列表信息。

调试

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

授权信息

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

请求语法

GET /api/v2/namespaces/{namespace}/connectors

请求参数

名称类型必填描述示例值
workspacestring

工作空间 ID。

a14bd5d90a****
namespacestring

项目空间名称。

default-namespace

返回参数

名称类型描述示例值
object

响应数据。

requestIdstring

请求 ID。

CBC799F0-AS7S-1D30-8A4F-882ED4DD****
successboolean

表示业务请求是否成功。

true
httpCodeinteger

业务状态码,统一为 200;使用 success 表示业务请求是否成功。

200
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

""
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

""
dataarray

当 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"
    }
  ]
}

错误码

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