查看API资产详情

仅已上架的资产可查看资产详情。本文为您介绍如何查看API资产详情。

前提条件

已购买资产运营增值服务,并购买数据服务功能

API资产详情

  1. Dataphin首页的顶部菜单栏,选择资产 > 资产目录

  2. 选择API资产页签,单击目标资产的名称,进入资产详情页面。

    image

    区域

    描述

    概要信息

    为您展示API的名称、API_ID、类型、描述、标签信息。同时您可以对资产执行以下操作:

    • 查看元数据:单击跳转至资产清单该API的详情页。

    • 搜索资产:支持快捷搜索其他对象,选择需要查看的资产,跳转至该API详情页。

    • 收藏:单击即可收藏或取消收藏。收藏后,您也可以在个人数据中心查看全量收藏的资产,详情请参见查看及管理我收藏的资产

    • 下载API文档:单击下载API文档,格式为Word,便于业务人员修改。

    • 申请权限:单击快捷跳转到当前API的权限申请页面,详情请参见管理API权限

    • 编辑:单击编辑跳转至目录管理下当前API资产编辑页面,可修改资产的属性信息、使用说明等,详情请参见编辑资产信息

    • 查看调用说明:单击查看API的调用示例模板,包括Java SDK调用方式(含Python SDK调用流程)、Token调用方式、白名单调用方式

      说明

      若在数据服务 > 调用 > 调用说明中修改SDK与调用说明,此处的调用说明将同步修改,因此帮助文档与实际会有差异。

    • 默认调用示例下载:单击下载API调用示例。

    • python调用示例下载:单击下载Python示例文件压缩包。

    • Java SDK下载:单击下载Java SDK代码包。

    基本信息

    • 属性信息:为您展示API的属性信息,包括技术属性。

      • 技术属性:为您展示API的资产来源、API分组、数据更新频率、缓存设置、缓存时长信息。

        数据更新频率:当前API的数据源更新频率,便于调用方了解数据的时效性。

      • 自定义属性:为您展示在数仓规划 > 属性管理所创建的可见于资产目录的属性。其中,自定义属性归属于业务属性、管理属性、技术属性。

    • API文档:您可查看API的基本信息、业务请求参数列表、公共请求参数列表、返回参数列表、JSON返回示例以及客户端错误码、服务端错误码(调用API)、服务端错误码(执行SQL语句)。

    • 使用说明:需要在手动上架的API资产编辑页面开启使用说明。为您展示当前资产的使用说明,为数据浏览者和使用者提供信息参考。

    资产信息

    为您展示API用数统计基本信息等详细信息。

    • 用数统计:包括API的浏览量、收藏数和最近7天调用数。

      • 浏览量:为您展示当前API的访问页次(PV),每刷新1次增加1次,实时更新。仅包含访问资产目录详情页的页次。

      • 收藏数:为您展示当前API被用户收藏的次数,包含在资产清单和资产目录中收藏的次数,实时更新。

      • 最近7天调用数:当前API最近7天被调用的次数,实时更新。

    • 基本信息:包括初次上架时间、最近上架时间、发布人、归属目录。