数据服务API是一种API类型,由云计算资源中的数据通过参数配置生成,生成的API便于后续调用,可减少资源操作成本。本文介绍如何通过向导模式新建API。
对原始数据层表“ys_xyk_bkxx”封装API
前提条件
工作组管理员账号登录。
已创建“信息中心(xxzx)”工作组,具体操作,请参见新建工作组并添加成员。
已在系统设置添加“RDS MySQL”云计算资源,具体操作,请参见新建云计算资源。
已创建API归属应用,具体操作,请参见新建API归属应用。
操作步骤
登录数据资源平台控制台。
在页面左上角,单击图标,选择协同。
在顶部菜单栏,单击图标,选择目标工作组,单击资产加工。
在左侧导航栏,单击图标,选择API开发 > 数据服务API。
在数据服务API页面右上角,单击创建API。
根据配置向导创建API。
设置API基础信息:输入API的名称为“根据银行客户办卡额度查询”、选择所属应用为“全域数据平台”、调用认证方式为“简单身份认证”,输入描述为“根据银行客户办卡额度查询”。
配置API参数。
选择云计算资源为“dataq_dws_rds”,服务资源组选择为“数据服务系统资源组”,新建模式选择“向导模式”,选择源数据表为“ys_xyk_bkxx”,在返回参数下勾选所有字段。
在请求参数区域,单击+请求参数,选择参数名称“climit”,条件选择“>”,默认值为“10”,描述为“卡额度大于10万”。
打开配置参数开关,勾选返回结果分页,使用默认值。单击+排序字段,选择字段名称“actdate”,排序方式为“顺序”。
在测试区域,单击开始测试,查看测试结果,核对返回信息。
在流量控制区域,填写API最大调用QPS为“1”,选择超时配置为“3秒”,单击保存。
预期结果
在数据服务API列表可查看到新建的API。
对数据建模DWS层表“dws_ren_kh_demo_di”封装API
用于在数据资产case中演示API资产类型,以及在解决方案case中演示导入导出。
前提条件
工作组管理员账号登录。
已在系统设置添加“RDS MySQL”云计算资源。
已创建API归属应用。
通过数据开发把Maxcompute(“dws_ren_kh_demo_di”)表同步到RDS MySQL(“dws_ren_kh_demo_di”)表中。
操作步骤
登录数据资源平台控制台。
在页面左上角,单击图标,选择协同。
在顶部菜单栏,单击图标,选择目标工作组,单击资产加工。
在左侧导航栏,单击图标,选择API开发 > 数据服务API。
在数据服务API页面右上角,单击创建API。
根据配置向导创建API。
API基础信息配置:输入API的名称为“银行客户根据证件号码查询”、选择所属应用为“全域数据平台”、调用认证方式选择为“简单身份认证”,输入描述为“银行客户根据证件号码查询”。
配置API参数。
选择云计算资源为“ dataq_dws_rds ”,源数据表选择为“dws_ren_kh_demo_di”,服务资源组选择为“数据服务系统资源组”,新建模式选择“向导模式”。在返回参数下勾选字段zzhm、khmc、nl、xb、jysp、hyzk、gz和jtnsr等字段。
在请求参数区域,单击+请求参数,选择参数名称“zzhm”,条件选择“=”,默认值为“CKR-1000”。
打开配置参数开关,勾选返回结果分页,使用默认值。单击+排序字段,选择字段名称“nl”,排序方式为“顺序”。
在测试区域,单击开始测试,查看测试结果,核对返回信息。
在流量控制区域,填写API最大调用QPS为“1”,选择超时配置为“3秒”,单击保存。
预期结果
在数据服务API列表可查看到新建的API。