跳转至

调用方式

本文档详细介绍 Aloudata CAN 平台中的 anymetrics 以及 semantic 的 IP 以及端口号获取方式：

提示

在 Aloudata CAN 中调用 API 需要使用不同的地址，有 anymetrics（产品层）和 semantic（语义层）。以下是对不同 API 调用地址的详细说明。

  1. anymetrics 地址：

    • 用于产品层级的 API 调用，包括访问凭证、维度管理、类目管理、指标视图（不包括指标视图结果查询 API）、指标归因分析、指标管理、数据更新等。
    • 示例：
      http://127.0.0.1:8083/anymetrics/api/v1/metrics/create
    • HOST_PORT 获取方式请参考 服务器地址和端口

  2. semantic 地址：

    • 用于语义层级的 API 调用，主要涉及指标查询和指标视图结果查询。
    • 示例：
      http://127.0.0.1:8085/semantic/api/v1.1/metrics/query
    • HOST_PORT 获取方式请参考 服务器地址和端口

服务器地址和端口

{server_host:server_port}：这是 API 服务的服务器 IP 地址和端口号。
具体可以分为 {semantic_host:semantic_port} 和 {anymetrics_host:anymetrics_port}。
根据实际调用的 API 情况替换 {server_ip:server_port}。

重要

调用 指标数据查询 API 和 指标视图结果查询 API 使用地址 {semantic_host:semantic_port}，
其他 API 调用使用地址 {anymetrics_host:anymetrics_port}。

获取方式

  • {semantic_host:semantic_port}
    • 可以在 Aloudata CAN 平台中 API 集成 中拿到
    • 入口：顶部导航栏 指标应用 → 左侧菜单栏选择 API 集成
    • 端口号通常为：8085

image.png

  • {anymetrics_host:anymetrics_port}

    • anymetrics_host：通常为 Aloudata CAN 指标平台的域名或平台访问地址（域名方式等同于 IP+PORT）
    • anymetrics_port：端口号通常为 8083

API 使用方法

示例请求

假设 API 服务的 IP 地址为 127.0.0.1，端口号为 8083，API 请求资源为 创建指标，则示例请求 URL 如下：

请求 URL

http://127.0.0.1:8083/anymetrics/api/v1/metrics/create

请求体示例

{
  "type": "ATOMIC",
  "metricDisplayName": "展示名称",
  "metricName": "metric01",
  "owner": "aloudatacan",
  "businessOwner": "aloudatacan",
  "businessCaliber": "api创建的指标",
  "metricCategoryId": "-1",
  "caliber": {
    "expr": "(['sales_volume'])/8"
  }
}

响应格式

API 通常返回 JSON 格式的响应数据，包含查询结果及其他相关信息。

响应示例

{
  "data": true,
  "success": true,
  "code": "200",
  "errorMsg": null,
  "detailErrorMsg": null,
  "traceId": ""
}