更新时间:2025-01-21 gmt 08:00

自助取数-九游平台

效能洞察平台提供自助取数功能,支持指标统计数据、明细数据生成api,提供给第三方调用。

新建api和管理api所需角色权限请参考权限设置

新增api

  1. 访问效能洞察服务。
  2. 在左侧菜单栏中选择“自助取数”,单击“新建api”。
  3. 参考表1填写相关信息,单击“确定”。
    表1 参数说明

    参数项

    是否必填

    说明

    api接口

    需要新增的api接口。

    请以小写字母开头,可包含小写字母、数字以及下划线,长度限制128。

    api名称

    需要新增api的名称。

    支持中英文、数字、中划线和下划线,长度限制128。

    请求方式

    系统默认选择“post”。

    认证方式

    系统默认选择“iam认证”。

    描述

    新增api的描述信息。

  4. 单击页面左上角选择数据源图标,选择一个数据集(可选择数据集和自定义数据集)。
  5. 配置展示方式。
    1. 在页面中间选择指标的展示方式,可选项包括:曲线图、柱状图、双轴图、条形图、饼图、面积图、指标卡、表格、燃尽图。
    2. 根据需要选择图表中的展示内容,将被选中的字段从页面左侧拖拽到文本框中。
    1. (可选)其他设置。不同的指标展示方式需要设置的字段不同,请根据界面实际显示设置。
      • 字段设置:若文本框中字段右侧显示图标,表示此字段可重新设置。
        方法:单击,根据实际需要设置字段的显示名、汇总方式、数据格式、排序方式。

        不同字段可设置的参数不同,请根据界面实际显示的参数设置。

      • 删除字段:若不需要被选中的字段,单击文本框中字段右侧的,删除字段。
      • 自定义字段:若文本框中显示,表示可自定义字段。

        方法:单击文本框中的“自定义指标”,“方法”至少选择聚合函数中的一个方法,根据实际情况选择“数据”,(可选)设置筛选条件,单击“确定”。

    完成配置后,页面中将显示图表结果。

  6. (可选)在页面右侧“数据筛选”页签中,单击“新增筛选条件”,根据需要选择筛选条件。
  7. (可选)修改基本信息。
    1. 单击“基本信息”,可修改api的中英文名以及描述。
    2. 单击“确定”,完成修改。
  8. (可选)参数配置。
    1. 单击页面右上角的“参数配置”,设置参数。
    2. 单击“调试”验证设置。
    3. 单击右上角的关闭图标
  9. 单击页面右上角的“保存”。

管理api

相关任务和对应的操作如表2所示。

表2 管理api

操作任务

操作步骤

搜索api

在搜索框中输入api关键字,页面中显示搜索结果。

查看api详情

在自助取数页面,单击api名称。

编辑api

  1. 在自助取数页面,单击api右侧的图标。
  2. 进入api编辑页面,可参考新增api编辑api信息。
    说明:

    “已上线”状态的api不支持编辑。

调试api

方法一:

  1. 在自助取数页面,单击api右侧的图标。
  2. 单击页面右上角的“参数配置”。
  3. 设置偏移量的参数值。
  4. 单击“调试”。

方法二:

  1. 在自助取数页面,单击新建api右侧的图标,单击“调试”。
  2. 设置偏移量的参数值。
  3. 单击“调试”。

上线api

  1. 在自助取数页面,单击api右侧的图标。
  2. 单击“确定”。
    说明:

    api状态为“已上线”后,用户若需要使用该api,可单击该api名称,在api详情中单击获取接口调用的url。如果存在url域名无法解析的情况,请联系九游平台的技术支持工程师获取该域名的ip进行本地hosts配置。

下线api

在自助取数页面,单击api右侧的图标,即可对已上线的api进行下线。

说明:

下线之后的api不能继续被调用,可以重新编辑、在线调试、重新上线后调用。

删除api

  1. 在自助取数页面,单击api右侧的图标,单击“删除”。
  2. 输入“yes”(大小写均可),单击“确定”。
    说明:

    “已上线”状态的api不支持删除。

相关文档

网站地图