CN - 简体中文
联 系 我 们
售前咨询
产品、解决方案咨询
售后咨询
微信关注：星环科技服务号
更多联系方式 >
多模数据平台监控软件
9.3.4
多模数据平台监控软件
9.3.4
本页导航
9.1 调用方式
更新时间：9/10/2024, 3:10:45 AM

您可以根据实际对接业务场景，选择对接 Aquila 中的不同接口，如下向您介绍不同接口的对接方式

调用 Server 接口

通过调用 Aquila Server 接口，实现 查询告警信息、向 Aquila 推送告警，以及查询指标监控数据。

请求命令

Aquila 9.3.4 及以上版本 
curl -X <request_method> 'http://<insights_server_host>:<port><interface_path>?guardian_access_token=<token_value>'
--header 'Content-Type: <request_data_type>'
--header 'Accept:<accept_data_type>'
--data '{"<para_name>":"<para_value>", "<para_name>":"<para_value>",...}'
复制
Aquila 9.3.3 及以下版本 
curl -X <request_method> 'http://<aquila_server_host>:<port><interface_path>'
--header 'Content-Type: <request_data_type>'
--header 'Accept:<accept_data_type>'
-u '<user_name>:<password>'
--data '{"<para_name>":"<para_value>", "<para_name>":"<para_value>",...}'
复制

参数说明

  • -X <request_method>：指定 API 的请求方法为，如 GET、POST 等，具体请参考后续对应 API 章节，若不指定则默认为 POST。

  • <insights_server_host>：Aquila 服务中 Insights Server 角色所在节点的主机名或 IP 地址

  • <aquila_server_host>：Aquila 服务中 Aquila Server 角色所在节点的主机名或 IP 地址。

  • <port>：Aquila 服务中配置参数 insight.web.port 的值，一般默认为 8666。

  • <request_data_type>：指定请求数据类型，具体请参考后续对应 API 章节。也可以使用 -H 来指定。

  • <accept_data_type>：指定响应数据类型，具体请参考后续对应 API 章节。也可以使用 -H 来指定。

  • <para_name>：参数名称。具体请参考后续对应 API 章节

  • <para_value>：参数取值。具体请参考后续对应 API 章节

  • 使用 --header 'Content-Type: application/json' 指定调用接口时使用 JSON 格式发送数据。

  • <token_value>：Aquila 9.3.4 及以上版本中，开启安全模式下取 Guardian 中的认证 Token Access 值。

    1. 点击 Manager 主页右上角的 全局服务 > Guardian，然后点击 角色 页面，登录 Guardian Server。

    2. 点击右上角用户 ID，下拉框选择 Access Tokens 查看该用户的权限信息。

    3. 单击 点击查看 显示对应的 Access Tocken 值，点击右侧复制即可

      access token guardian

  • <user_name>、 <password>：Aquila 9.3.3 及以下版本中，开启安全模式，需指定登录的用户名和密码。可以通过以下方法确定：

    • 通过查看配置文件 shadow.yml 查看 Aquila 登录用户名

    cat /etc/aquila/conf/server/shadow.yml | grep user
    复制

    • 查看密码的方式，针对 Aquila 9.3.0 及以上版本和以下版本的方式不同：

    ##  Aquila 9.3.0 及以上版本查看密码
kubectl exec $(kubectl get pods | grep aquila-server | awk '{print $1}') -- env | grep AQUILA_SERVER_INTERNAL_ADMIN_PASSWORD

## Aquila 9.3.0 以下版本查看密码
cat /etc/aquila/conf/server/shadow.yml | grep pass
    复制

调用 Prometheus 接口

通过调用 Prometheus 接口，查询指标数据。

命令格式

curl -X <request_method> "http://<ip>:<port><interface_path>?guardian_access_token=<token_value>?<para_name1>=<para_value1>&<para_name2>=<para_value2>...&guardian_access_token=<token_value>"
复制

参数说明

  • -X <request_method>：指定 API 的请求方法为，如 GET、POST 等，具体请参考后续对应 API 章节，若不指定则默认为 GET。

  • <ip>：Aquila 服务中 Prometheus 角色所在节点的主机名称或 IP 地址。

  • <port>：Aquila 服务中配置参数 prometheus.web.port 的值，一般默认为 8690。

  • <interface_path>：接口路径。请根据业务需求选择对应的 API 接口，具体请参考后续章节

  • <para_name>：请求参数名称。

  • <para_value>：请求参数取值。

  • 当调用接口需要添加参数时，使用问号 ? 添加，如果需要添加多个参数，参数与参数之间使用 & 间隔。

  • 当 Aquila 服务开启安全时，调用接口时需要添加参数 guardian_access_token，确定方法请参考Guardian 认证 Access Token。

本页导航