跳转至

修改数据源

接口概述

本接口是用于修改已添加成功的数据源的信息。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/datasource/update

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

公共参数(HEADERS)

参数 类型 是否必选 最大长度 描述 示例值
tenant-id String 32 租户ID,用于指标查询内容所在的租户 tn_125288
auth-type String 32 认证方式支持:UID(基于用户ID认证)TOKEN(基于令牌认证)。 UID
user-id String 32 UID 或者TOKEN 值 341523017135816704

请求参数

参数 类型 是否必选 最大长度 描述 示例值
datasourceId String 128 数据源 ID ds_123149
displayName String 32 数据源显示名 样例数据源
desc String 512 数据源描述信息 这是第一个创建出来的数据源
datasourceType String 32 数据源类型,如:doris、starrocks doris
configuration Array 数据源链接信息

configuration

参数 类型 是否必选 描述 示例值
host String 连接IP 10.5.23.25
port Integer 端口号 31010
user String 用户名 root
password String 密码 root
engineType String 引擎类型 如AIR
properties 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

请求示例

curl --location --request GET 'https://127.0.0.1:8083/anymetrics/api/v1/datasource/update' \
--header 'auth-type: UID' \
--header 'tenant-id: tn_19487697' \
--header 'auth-value: 463663891121963008' \
--header 'Accept-Language: zh-CN' \
--data-raw '{
    "datasourceId": "ds_24903626",
    "name": "fl_doris1",
    "configuration": {
        "host": "127.0.0.1",
        "port": "9030",
        "user": "root",
        "password": "xxxxxx",
        "engineType": "DORIS",
        "properties": {
            "port": "9030",
            "host": "127.0.0.1"
        }
    }
}'

响应示例

{
    "data": {
        "datasourceId": "ds_24903626",
        "catalog": "fl_doris1"
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "6387c419bf5d48d9a00613bd98057244.148.17289018554670115"
}