跳转至

新增关系

接口说明

本接口用于在指标平台中创建一个数据集关联关系。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/relation/create

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

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 描述
tenant-id String 租户ID,用于指标查询内容所在的租户
auth-type String 认证方式。支持 UIDTOKENACCOUNTAPIKEY
auth-value String auth-type 对应的认证值

公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成,在 API 集成界面获取;auth-value 请按 auth-type 填写对应认证值。

image.png

Body 请求参数

参数 类型 是否必选 最大长度 描述 示例值
relationName String 128 关系英文名/标识,租户下建议唯一 rel_product_shop
relationDisplayName String 128 关系展示名 商品门店关系
type String 32 关系类型。枚举值:ONE_TO_ONEMANY_TO_ONE MANY_TO_ONE
srcDatasetName String 128 来源数据集名称。填写 AnyMetrics 数据集名称,不是物理表名 oracle_product_1
dstDatasetName String 128 目标数据集名称。填写 AnyMetrics 数据集名称,不是物理表名 oracle_shop
relationConditions List - 关系条件列表,详见 relationConditions 参数说明 -
filterExprList List - 关系约束表达式列表 ["[oracle_product_1/STATUS] = \"VALID\""]

relationConditions 参数说明

参数 类型 是否必选 描述 示例值
srcExpr String 来源数据集字段表达式 [oracle_product_1/SHOP_ID]
dstExpr String 目标数据集字段表达式 [oracle_shop/SHOP_ID]

响应参数

参数 类型 是否必选 描述
code String 接口响应码
success Boolean 请求是否成功
errorMsg String 报错信息
detailErrorMsg String 报错详情
traceId String 跟踪 ID,用于问题排查
data String 创建成功后的关系 ID

请求示例

{
  "relationName": "rel_product_shop",
  "relationDisplayName": "商品门店关系",
  "srcDatasetName": "oracle_product_1",
  "type": "MANY_TO_ONE",
  "relationConditions": [
    {
      "srcExpr": "[oracle_product_1/SHOP_ID]",
      "dstExpr": "[oracle_shop/SHOP_ID]"
    }
  ],
  "dstDatasetName": "oracle_shop"
}

响应示例

{
  "data": "relation_12",
  "success": true,
  "code": "200",
  "errorMsg": null,
  "detailErrorMsg": null,
  "traceId": "f6e656798ed241c789f7132823c46c6b.141.17194028392300357"
}