Page tree
Skip to end of metadata
Go to start of metadata

接口

1、创建资源连接器

  • 两种用途
    • 云智易发布平台级别连接器
    • 云智易发布企业客户开源的连接器
  • 资源连接器中名称不能重复
  • 名称32个字符,前后不允许空格,中间允许存在空格

Request

URL

POST /v2/connectors/resource

Header

Content-Type:application/json
Access-Token:"Xlink级别token"

Content

{
    "name": "连接器名称,必须",
    "desc": "连接器描述,非必须",
    "source_type": "来源类型,1:平台,2:企业",
    "source_name": "连接器来源",
    "source_id": "连接器来源标识, source_type为时为企业id"
}
字段说明是否必须
name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
desc连接器描述,长度100个字符
source_type来源类型,1:平台,2:企业
source_name连接器来源名称
source_id连接器来源标识,source_type为2时为企业id


Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "连接器标识",
    "name": "连接器名称",
    "desc": "连接器描述",
    "source_type": "来源类型",
    "source_name": "连接器来源",
    "source_id": "连接器来源标识",
    "create_time": "创建时间"
}
字段说明是否必须
id连接器资源标识
name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
desc连接器描述,长度100个字符
source_type来源类型,1:平台,2:企业
source_name连接器来源名称
source_id连接器来源标识,source_type为2时为企业id
create_time连接器资源创建时间

2、修改资源连接器

  • 修改资源连接器信息,目前支持
    • 名称
    • 描述
  • 修改名称需要校验是否重复以及名称32个字符,前后不允许空格,中间允许存在空格

Request

URL

PUT /v2/connectors/resource/{id}

Header

Content-Type:application/json
Access-Token:"Xlink级别token"

Content

{
    "name": "连接器名称, 非必须",
    "desc": "连接器描述, 非必须"
}


字段说明是否必须
name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
desc连接器描述,长度100个字符


Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "连接器标识",
    "name": "连接器名称",
    "desc": "连接器描述",
    "source_type": "来源类型",
    "source_name": "连接器来源",
    "source_id": "连接器来源标识",
    "create_time": "创建时间"
}
字段说明是否必须
id连接器资源标识
name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
desc连接器描述,长度100个字符
source_type来源类型,1:平台,2:企业
source_name连接器来源名称
source_id连接器来源标识,source_type为2时为企业id
create_time连接器资源创建时间

3、删除资源连接器

  • 删除资源连接器
  • 同时删除该资源连接器下的所有版本

Request

URL

DELETE /v2/connectors/resource/{id}

Header

Content-Type:application/json
Access-Token:"Xlink级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

4、查询资源连接器

  • 查询资源连接器
  • Xlink权限可查询,企业成员权限亦可查询

Request

URL

GET /v2/connectors/resource/{id}

Header

Content-Type:application/json
Access-Token:"Xlink/Corp级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "连接器标识",
    "name": "连接器名称",
    "desc": "连接器描述",
    "source_type": "来源类型",
    "source_name": "连接器来源",
    "source_id": "连接器来源标识",
    "create_time": "创建时间"
}
字段说明是否必须
id连接器资源标识
name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
desc连接器描述,长度100个字符
source_type来源类型,1:平台,2:企业
source_name连接器来源名称
source_id连接器来源标识,source_type为2时为企业id
create_time连接器资源创建时间

5、资源连接器列表

  • 查询资源连接器列表
  • Xlink权限可查询,企业成员权限亦可查询
  • 默认条件:连接器有版本,且有版本处于发布状态
  • 添加查询条件,排序条件,起始位置,偏移量

Request

URL

POST /v2/connectors/resources

Header

Content-Type:application/json
Access-Token:"Xlink/Corp级别token"

Content

{
    "offset": "0",
    "limit": "10",
    "filter": [
        "id"
    ],
    "query": {
        "name": {
            "$eq": "云智联易"
        }
    },
    "order": {
        "create_time": "desc/asc"
    },
    "status": "2:已发布, 改字段不是必须,不传则查询全部,传则目前只支持2"
}

Response

Header

HTTP/1.1 200 OK

Content

{
    "count": "总数",
    "list": [{
            "id": "连接器标识",
            "name": "连接器名称",
            "desc": "连接器描述",
            "source_type": "来源类型",
            "source_name": "连接器来源",
            "source_id": "连接器来源标识",
            "create_time": "创建时间",
            "new_version_release_time": "最新版本发布时间"
        },
        {
            "id": "连接器标识",
            "name": "连接器名称",
            "desc": "连接器描述",
            "source_type": "来源类型",
            "source_name": "连接器来源",
            "source_id": "连接器来源标识",
            "create_time": "创建时间",
            "new_version_release_time": "最新版本发布时间"
        }
    ]
}
字段说明是否必须
count连接器数量
list连接器列表
list.id连接器资源标识
list.name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
list.desc连接器描述,长度100个字符
list.source_type来源类型,1:平台,2:企业
list.source_name连接器来源名称
list.source_id连接器来源标识,source_type为2时为企业id
list.create_time连接器资源创建时间

6、创建连接器

  • 主要用于企业创建自己连接器
  • 名字不能重复以及相关正则表达式
  • 需要注重创建者、创建者类型以及安全审计日志
  • 保存信息与资源连接器有所区别,企业创建连接器之后需要提交发布申请才能进入到资源连接器

Request

URL

POST /v2/connector

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

{
    "name": "连接器名称,必须",
    "desc": "连接器描述,非必须"
}
字段说明是否必须
name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
desc连接器描述,连接器描述,长度100个字符

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "连接器标识",
    "name": "连接器名称",
    "desc": "连接器描述",
    "creator": "创建者",
    "creator_type": "创建者类型",
    "source_name": "连接器来源",
    "create_time": "创建时间"
}
字段说明是否必须
id连接器标识
name连接器名称
desc连接器描述
creator_type连接器创建者类型, 1:成员,2:accesskey
creator连接器创建者,creator_type为2是为accessKeyId
source_name连接器来源名称,企业名称
create_time连接器创建时间

7、修改连接器

  • 主要用于企业修改自己连接器
  • 名字不能重复以及相关正则表达式
  • 需要安全审计日志

Request

URL

PUT /v2/connector/{id}

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

{
    "name": "连接器名称,非必须",
    "desc": "连接器描述,非必须"
}
字段说明是否必须
name连接器名称,不能重复,名称32个字符,前后不允许空格,中间允许存在空格
desc连接器描述,连接器描述,长度100个字符

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "连接器标识",
    "name": "连接器名称",
    "desc": "连接器描述",
    "creator": "创建者",
    "creator_type": "创建者类型",
    "source_name": "连接器来源",
    "create_time": "创建时间"
}
字段说明是否必须
id连接器标识
name连接器名称
desc连接器描述
creator_type连接器创建者类型, 1:成员,2:accesskey
creator连接器创建者,creator_type为2是为accessKeyId
source_name连接器来源名称,企业名称
create_time连接器创建时间

8、删除连接器

  • 主要用于企业删除自己连接器
  • 删除连接器同时删除连接器下所有版本
  • 需要安全审计日志

Request

URL

DELETE /v2/connector/{id}

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

9、查询连接器

  • 主要用于企业删除自己连接器
  • 只有企业成员才能查询

Request

URL

GET /v2/connector/{id}

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
    "id": "连接器标识",
    "name": "连接器名称",
    "desc": "连接器描述",
    "creator": "创建者",
    "creator_type": "创建者类型",
    "source_name": "连接器来源",
    "create_time": "创建时间"
}
字段说明是否必须
id连接器标识
name连接器名称
desc连接器描述
creator_type连接器创建者类型, 1:成员,2:accesskey
creator连接器创建者,creator_type为2是为accessKeyId
source_name连接器来源名称,企业名称
create_time连接器创建时间

10、连接器列表

  • 查询企业下连接器列表
  • 企业成员权限亦可查询
  • 添加查询条件,排序条件,起始位置,偏移量

Request

URL

POST /v2/connectors

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

{
    "offset": "0",
    "limit": "10",
    "filter": ["id"],
    "query": {
        "name": {
            "$eq": "云智联易"
        }
    },
    "order": {
        "create_time": "desc/asc"
    },
    "status": "2:已发布, 改字段不是必须,不传则查询全部,传则目前只支持2"
}

Response

Header

HTTP/1.1 200 OK

Content

{
    "count": "总数",
    "list": [{
        "id": "连接器标识",
        "name": "连接器名称",
        "desc": "连接器描述",
        "creator": "创建者",
        "creator_type": "创建者类型",
        "create_time": "创建时间",
        "source_name": "连接器来源名称",
        "new_version_release_time": "最新版本发布时间"
    }, {
        "id": "连接器标识",
        "name": "连接器名称",
        "desc": "连接器描述",
        "creator": "创建者",
        "creator_type": "创建者类型",
        "create_time": "创建时间",
        "source_name": "连接器来源名称",
        "new_version_release_time": "最新版本发布时间"
    }]
}
字段说明是否必须
count连接器总数
list连接器列表
list.id连接器标识
list.name连接器名称
list.desc连接器描述
list.creator_type连接器创建者类型, 1:成员,2:accesskey
list.creator连接器创建者,creator_type为2是为accessKeyId
list.source_name连接器来源名称, 企业名称
list.create_time连接器创建时间

11、资源连接器版本上传

  • 连接器版本的zip包或者jar包上传到云端
  • 需要兼容阿里云存储、亚马逊存储、微软存储、腾讯云存储、本地存储方案

Request

URL

POST /v2/connectors/resources/upload

Header

Content-Type:application/octet-stream
Access-Token:"Xlink级别token"

Content

文件流下载bytearray

Response

Header

HTTP/1.1 200 OK

Content

{
    "url": "云智易链接地址"
}
字段说明是否必须
url云智易链接地址

12、创建资源连接器版本

  • 创建资源连接器版本
  • 版本version校验,不能小于当前版本
  • 下载连接url不能为空
  • 状态为未发布

Request

URL

POST /v2/connectors/resource/{connector_id}/version

Header

Content-Type:application/json
Access-Token:"Xlink级别token"

Content

{
    "version": "版本,格式1.1.1",
    "details": "详情",
    "url": "下载链接"
}
字段说明是否必须
version连接器资源版本号,不能小于当前版本,格式为1.1.1,类似ip地址格式
url连接器资源下载连接,必须存在与平台中,即是从上传版本得到的url
details连接器资源详情,长度4096


Response

Header

HTTP/1.1 200 OK

Content

{
	"id": "版本标识",
	"connector_id": "连接器标识",
	"version": "版本,格式1.1.1",
	"details": "版本,格式1.1.1",
	"status": "状态,1:未发布,2:已发布,3:已下线",
	"releasor": "发布者",
	"release_time": "发布时间",
	"release_desc": "发布备注",
	"url": "下载链接",
	"create_time": "创建时间"
}
字段说明是否必须
id连接器资源版本标识
connector_id连接器资源版本所属连接器标识
version连接器资源版本号
details连接器版本详情
status连接器资源版本状态
releasor连接器资源版本发布者
release_time连接器资源版本发布时间
release_desc连接器资源版本发布备注
url连接器资源版本下载链接
create_time连接器资源版本创建时间

13、修改资源连接器版本

  • 创建资源连接器版本
  • 版本version不可修改
  • 下载连接和描述可选修改

Request

URL

PUT /v2/connectors/resource/{connector_id}/version/{id}

Header

Content-Type:application/json
Access-Token:"Xlink级别token"

Content

{
    "details": "详情",
    "url": "下载链接"
}
字段说明是否必须
url连接器资源下载连接,必须存在与平台中,即是从上传版本得到的url
details连接器资源详情,长度4096


Response

Header

HTTP/1.1 200 OK

Content

{
	"id": "版本标识",
	"connector_id": "连接器标识",
	"version": "版本,格式1.1.1",
	"details": "版本,格式1.1.1",
	"status": "状态,1:未发布,2:已发布,3:已下线",
	"releasor": "发布者",
	"release_time": "发布时间",
	"release_desc": "发布备注",
	"url": "下载链接",
	"create_time": "创建时间"
}
字段说明是否必须
id连接器资源版本标识
connector_id连接器资源版本所属连接器标识
version连接器资源版本号
details连接器资源版本详情
status连接器资源版本状态
releasor连接器资源版本发布者
release_time连接器资源版本发布时间
release_desc连接器资源版本发布备注
url连接器资源版本下载链接
create_time连接器资源版本创建时间

14、删除资源连接器版本

  • 删除资源连接器版本
  • 已发布的连接器版本不允许进行删除

Request

URL

DELETE /v2/connectors/resource/{connector_id}/version/{id}

Header

Content-Type:application/json
Access-Token:"Xlink级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

15、查询资源连接器版本

  • 查询资源连接器版本
  • Xlink权限以及Corp权限可以访问

Request

URL

GET /v2/connectors/resource/{connector_id}/version/{id}

Header

Content-Type:application/json
Access-Token:"Xlink/Corp级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
	"id": "版本标识",
	"connector_id": "连接器标识",
	"version": "版本,格式1.1.1",
	"details": "版本,格式1.1.1",
	"status": "状态,1:未发布,2:已发布,3:已下线",
	"releasor": "发布者",
	"release_time": "发布时间",
	"release_desc": "发布备注",
	"url": "下载链接",
	"create_time": "创建时间"
}
字段说明是否必须
id连接器资源版本标识
connector_id连接器资源版本所属连接器标识
version连接器资源版本号
status连接器资源版本状态
releasor连接器资源版本发布者
release_time连接器资源版本发布时间
desc连接器资源版本发布备注
url连接器资源版本下载链接
create_time连接器资源版本创建时间

16、资源连接器版本列表

  • 根据连接器标识查询连接器版本列表
  • Xlink权限以及Corp权限可以访问

Request

URL

POST /v2/connectors/resource/{connector_id}/versions

Header

Content-Type:application/json
Access-Token:"Xlink/Corp级别token"

Content

{
    "offset": "0",
    "limit": "10",
    "filter": ["id"],
    "query": {
        "version": {
            "$eq": "1.1.1"
        }
    },
    "order": {
        "create_time": "desc/asc"
    }
}

Response

Header

HTTP/1.1 200 OK

Content

{
	"count": "总数",
	"list": [{
		"id": "版本标识",
		"connector_id": "连接器标识",
		"version": "版本,格式1.1.1",
		"details": "详情",
		"status": "状态,1:未发布,2:已发布,3:已下线",
		"releasor": "发布者",
		"release_time": "发布时间",
		"release_desc": "发布备注",
		"url": "下载链接",
		"create_time": "创建时间"
	}]
}
字段说明是否必须
count符合条件的连接器资源版本总数
list符合条件的连接器资源版本列表
list.id连接器资源版本标识
list.connector_id连接器资源版本所属连接器标识
list.version连接器资源版本号
list.details连接器资源版本详情
list.status连接器资源版本状态
list.releasor连接器资源版本发布者
list.release_time连接器资源版本发布时间
list.desc连接器资源版本发布备注
list.url连接器资源版本下载链接
list.create_time连接器资源版本创建时间

17、资源连接器版本操作

  • 针对已创建的连接器版本进行 发布、下线、重新发布 等操作
  • 未发布状态 的 可以进行发布
  • 已发布的 可以进行下线
  • 已下线的 可以进行重新发布

Request

URL

PUT /v2/connectors/resource/{connector_id}/version/{id}/operation

Header

Content-Type:application/json
Access-Token:"Xlink/Corp级别token"

Content

{
	"operation": "操作,1:发布,2:下线",
	"release_desc": "发布备注"
}
字段说明是否必须
operation操作类型,1:发布,2:下线
release_desc发布备注,0-32个长度,发布时需要


Response

Header

HTTP/1.1 200 OK

Content

18、资源连接器版本下载

  • 资源连接器下载zip包或者jar包
  • 仅供Xlink权限使用

Request

URL

GET /v2/connectors/resource/{connector_id}/version/{id}/download

Header

Content-Type:application/json
Access-Token:"Corp级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
    "auth_url": "授权下载地址"
}
字段说明是否必须
auth_url授权下载地址

19、连接器版本上传

  • 连接器版本的zip包或者jar包上传到云端
  • 需要兼容阿里云存储、亚马逊存储、微软存储、腾讯云存储、本地存储方案

Request

URL

POST /v2/connectors/upload

Header

Content-Type:application/octet-stream
Access-Token:"Corp/Empower级别token"

Content

文件流下载bytearray

Response

Header

HTTP/1.1 200 OK

Content

{
    "url": "云智易链接地址"
}
字段说明是否必须
url云智易链接地址

20、创建连接器版本

  • 创建资源连接器版本
  • 版本version校验,不能小于当前版本
  • 下载连接url不能为空
  • 状态为未发布
  • 添加安全审计日志

Request

URL

POST /v2/connector/{connector_id}/version

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

{
    "version": "版本,格式1.1.1",
    "details": "详情",
    "url": "下载链接"
}


字段说明是否必须
version连接器版本号,不能小于当前版本,格式为1.1.1,类似ip地址格式
url连接器下载连接,必须存在与平台中,即是从上传版本得到的url
details连接器版本详情,长度4096


Response

Header

HTTP/1.1 200 OK

Content

{
	"id": "版本标识",
	"connector_id": "连接器标识",
	"version": "版本,格式1.1.1",
	"details": "详情",
	"status": "状态,1:未发布,2:已发布,3:已下线",
	"releasor": "发布者",
	"release_time": "发布时间",
	"release_desc": "发布备注",
	"url": "下载链接",
	"create_time": "创建时间"
}
字段说明是否必须
id连接器版本标识
connector_id连接器版本所属连接器标识
version连接器版本号
details连接器版本详情
status连接器版本状态
releasor连接器版本发布者
release_time连接器版本发布时间
desc连接器版本发布备注
url连接器版本下载链接
create_time连接器版本创建时间

21、修改连接器版本

  • 创建连接器版本
  • 版本version不可修改
  • 下载连接和描述可选修改
  • 添加安全审计日志

Request

URL

PUT /v2/connector/{connector_id}/version/{id}

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

{
    "details": "详情",
    "url": "下载链接"
}


字段说明是否必须
url连接器下载连接,必须存在与平台中,即是从上传版本得到的url
details连接器详情,长度4096


Response

Header

HTTP/1.1 200 OK

Content

{
	"id": "版本标识",
	"connector_id": "连接器标识",
	"version": "版本,格式1.1.1",
	"details": "详情",
	"status": "状态,1:未发布,2:已发布,3:已下线",
	"releasor": "发布者",
	"release_time": "发布时间",
	"release_desc": "发布备注",
	"url": "下载链接",
	"create_time": "创建时间"
}
字段说明是否必须
id连接器版本标识
connector_id连接器版本所属连接器标识
version连接器版本号
details连接器版本详情
status连接器版本状态
releasor连接器版本发布者
release_time连接器版本发布时间
release_desc连接器版本发布备注
url连接器版本下载链接
create_time连接器版本创建时间

22、删除连接器版本

  • 删除企业连接器版本
  • 已发布的连接器版本不允许进行删除
  • 添加安全审计日志

Request

URL

DELETE /v2/connector/{connector_id}/version/{id}

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

23、查询连接器版本

  • 查询企业连接器版本
  • 仅企业权限、Empower权限可查

Request

URL

GET /v2/connector/{connector_id}/version/{id}

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
	"id": "版本标识",
	"connector_id": "连接器标识",
	"version": "版本,格式1.1.1",
	"details": "详情",
	"status": "状态,1:未发布,2:已发布,3:已下线",
	"releasor": "发布者",
	"release_time": "发布时间",
	"release_desc": "发布备注",
	"url": "下载链接",
	"create_time": "创建时间"
}
字段说明是否必须
id连接器版本标识
connector_id连接器版本所属连接器标识
version连接器版本号
details连接器版本详情
status连接器版本状态
releasor连接器版本发布者
release_time连接器版本发布时间
release_desc连接器版本发布备注
url连接器版本下载链接
create_time连接器版本创建时间

24、连接器版本列表

  • 根据连接器标识查询连接器版本列表
  • Corp权限、Empower权限可以访问

Request

URL

POST /v2/connector/{connector_id}/versions

Header

Content-Type:application/json
Access-Token:"Corp/Empower级别token"

Content

{
    "offset": "0",
    "limit": "10",
    "filter": ["id"],
    "query": {
        "version": {
            "$eq": "1.1.1"
        }
    },
    "order": {
        "create_time": "desc/asc"
    }
}

Response

Header

HTTP/1.1 200 OK

Content

{
	"count": "总数",
	"list": [{
		"id": "版本标识",
		"connector_id": "连接器标识",
		"version": "版本,格式1.1.1",
		"details": "详情",
		"status": "状态,1:未发布,2:已发布,3:已下线",
		"releasor": "发布者",
		"release_time": "发布时间",
		"release_desc": "发布备注",
		"url": "下载链接",
		"create_time": "创建时间"
	}]
}
字段说明是否必须
count符合条件的连接器版本总数
list符合条件的连接器版本列表
list.id连接器版本标识
list.connector_id连接器版本所属连接器标识
list.details连接器版本详情
list.version连接器版本号
list.status连接器版本状态
list.releasor连接器版本发布者
list.release_time连接器版本发布时间
list.release_desc连接器版本发布备注
list.url连接器版本下载链接
list.create_time连接器版本创建时间

25、连接器版本操作

  • 针对已创建的连接器版本进行 发布、下线、重新发布 等操作
  • 未发布状态 的 可以进行发布
  • 已发布的 可以进行下线
  • 已下线的 可以进行重新发布

Request

URL

PUT /v2/connector/{connector_id}/version/{id}/operation

Header

Content-Type:application/json
Access-Token:"Corp级别 Empower级别token"

Content

{
	"operation": "操作,1:发布,2:下线",
	"release_desc": "发布描述"
}
字段说明是否必须
operation操作类型,1:发布,2:下线
release_desc发布描述,0-32个字符,发布时需要


Response

Header

HTTP/1.1 200 OK

Content

26、连接器下载

  • 连接器下载zip包或者jar包
  • 企业权限以及Corp权限可调用

Request

URL

GET /v2/connector/{connector_id}/version/{id}/download

Header

Content-Type:application/json
Access-Token:"Corp级别 Empower级别token"

Content

Response

Header

HTTP/1.1 200 OK

Content

{
    "auth_url": "授权下载地址"
}
字段说明是否必须
auth_url授权下载地址

  • No labels