数据源注册
接口概述
本接口是用于往语义层添加外部数据源，用于后续的指标创建以及数据分析。
接口URL
POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/datasource/create
anymetrics_host:anymetrics_port 获取方式请参考：调用方式
公共参数（HEADERS）
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| tenant-id | String | 是 | 租户ID，用于指标查询内容所在的租户 |
| auth-type | String | 是 | 认证方式，用于设置身份认证方式UID：使用 UID 进行身份认证 TOKEN：使用 TOKEN 进行身份认证 ACCOUNT：使用ACCOUNT 进行身份认证 APIKEY：使用APIKEY 进行身份认证，详情见：API Key 管理 |
| auth-value | String | 是 | UID、TOKEN值、ACCOUNT，与auth-type 类型选择一致 |
请求参数
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| name | String | 是 | 数据源名称 | datasource |
| displayName | String | 否 | 数据源显示名 | 样例数据源 |
| desc | String | 否 | 数据源描述信息 | 这是第一个创建出来的数据源 |
| datasourceType | String | 是 | 数据源类型，如：Aloudata AIR、Starrocks、doris | Starrocks |
| configuration | Array | 是 | 连接属性配置，更多详情请参考：3.1.1 configuration |
configuration
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| host | String | 是 | 连接IP | 10.5.23.25 |
| port | Integer | 是 | 端口号 | 31010 |
| loadbalance | String | 否 | 负载均衡集群 | 10.5.23.25:9030,10.5.23.21:9030 |
| user | String | 是 | 用户名 | root |
| password | String | 是 | 密码 | root |
| engineType | String | 是 | 引擎类型 | 如AIR |
| properties:{ "AIR_ENGINE_TENANT_ID":"", "AIR_ENGINE_CLOUD_ACCOUNT":"" } | JSON | 否 | 连接属性 | { "AIR_ENGINE_TENANT_ID":"tardis_0530", "AIR_ENGINE_CLOUD_ACCOUNT":"2f44uk6iv0u8@aloudata.com" } |
响应参数
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| success | Boolean | 是 | 相应是否成功 | true |
| code | String | 是 | 接口响应码 | 200 |
| errorMsg | String | 是 | 报错信息 | 请求成功 |
| detailErrorMsg | String | 是 | 报错详情 | |
| traceId | String | 是 | traceid，用于跟踪排查问题使用 | fdde6861bd554805998343f9ff2dcd70.292.16857691758642861 |
| data | Array | 是 | 返回结果数据，更多详情请参考：4.1 data |
data
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| datasourceId | String | 是 | 数据源 ID | ds_123149 |
| catalog | String | 是 | catalog名称 | tn_123100_eb5899b802db890f69cea427bca13ae2 |
请求示例
{
"name": "dataSource",
"displayName": "指标平台数据源",
"desc": "这是一个指标平台数据源示例",
"datasourceType": "STARROCKS",
"configuration": {
"host": "0.0.0.0",
"port": "9030",
"user": "root",
"password": "xxxxxxxx",
"engineType": "STARROCKS"
}
}