接口功能介绍
查询获取当前DataWings系统中所有数据源列表信息。
接口约束
无
URI
POST /dw/iconnect-datasource/api/v1/open-api/datasource/list
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| X-Open-Api-Region-Id | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 否 | String | 数据源名称 | Doris数据源 | |
| plugin | 否 | String | 数据源插件代码 | a0a218b31c3ca001bae91622cb3e7c5b | |
| source | 否 | String | 数据源创建来源 | ALL |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 结果信息 | ||
| errorCode | String | 错误编码 | ||
| errorMessage | String | 错误信息 | ||
| data | Object | 结果数据 | data |
表 data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| code | String | 数据源代码 | 7decbd0826127a1c3bb8764074aa8db7 | |
| name | String | 数据源名称 | Doris数据源 | |
| pluginCode | String | 数据源插件代码 | a0a218b31c3ca001bae91622cb3e7c5b | |
| pluginName | String | 数据源插件名称 | Doris | |
| isInternal | Boolean | 是否为内置数据源 | false | |
| extraParams | Object | 数据源额外信息 | ||
| params | Object | 数据源配置信息 | ||
| pluginTypeCode | String | 数据源插件类型代码 | DORIS | |
| pluginTypeName | String | 数据源插件类型 | Doris | |
| connectTestStatus | Boolean | 连接测试状态 | true |
枚举参数
参数名 source
| 枚举值 | 类型 | 说明 |
|---|---|---|
| EXTERNAL | String | 外置数据源 |
| INTERNAL | String | 内置数据源 |
| ALL | String | 所有数据源 |
请求示例
请求url
https://datawings-global.ctapi.ctyun.cn/dw/iconnect-datasource/api/v1/open-api/datasource/list
请求头header
X-Open-Api-Region-Id=bb9fdb42056f11eda1610242ac110002
请求体body
{
"name": "Doris数据源",
"plugin": "a0a218b31c3ca001bae91622cb3e7c5b",
"source": "ALL"
}
响应示例
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": [
{
"code": "7decbd0826127a1c3bb8764074aa8db7",
"name": "Doris数据源",
"pluginCode": "a0a218b31c3ca001bae91622cb3e7c5b",
"pluginName": "MySQL",
"isInternal": false,
"extraParams": {
},
"params": {
"businessDescription": "",
"type": "MySQL",
"jdbcParams": "",
"database": "",
"password": "********",
"port": "3306",
"host": "192.168.0.1",
"jdbcUrl": "jdbc:mysql://192.168.0.1:3306/?",
"provideType": "",
"datasourceUnit": "",
"securityRequire": "",
"id": "7decbd0826127a1c3bb8764074aa8db7",
"appSystem": "",
"username": "root"
},
"pluginTypeCode": "DORIS",
"pluginTypeName": "Doris",
"connectTestStatus": true
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
