检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在左侧导航栏选择服务版本(例如:专享版),进入总览页。 进入“开发API > API目录”或“开发API > API管理”页面,在待修改的API所在行,选择“更多 > 设置可见”。 在弹出的窗口中单击添加,填写项目ID并确认,即可设置此API在服务目录中额外对以该项目下的用户可见。 项目ID可以参考如下步骤进行获取:
发布完成后,您可以进入到“服务目录”,查看已发布API信息。 相关操作 批量发布API:您可以在专享版的“开发API > API管理”页面,勾选需要发布的API后,依次单击API列表上方的“批量操作 > 批量发布”,实现多个API的统一发布。 图2 批量操作 父主题: 开发数据服务API
apiTypeApi:= model.GetApiApiTypeEnum().API_SPECIFIC_TYPE_SCRIPT logFlagApi:= true descriptionApi:= "dws" nameApi:= "create_script_api" catalogIdApi:=
type String API类型。 枚举值: API_SPECIFIC_TYPE_CONFIGURATION: 配置类API API_SPECIFIC_TYPE_SCRIPT: 脚本类API API_SPECIFIC_TYPE_REGISTER:注册类API debug_status
API_SPECIFIC_TYPE_SCRIPT: 脚本类API API_SPECIFIC_TYPE_MYBATIS: MyBatis类API API_SPECIFIC_TYPE_GROOVY: Groovy类API API_SPECIFIC_TYPE_REGISTER:注册类API API_SPECIFIC_TY
发布API 功能介绍 发布API。API只有发布后,才能够被调用。API发布时,可以将API发送至指定网关。 共享版,必须发送至API网关共享版。 专享版,可以依据自身需要,选择将API发送至API网关专享版、ROMA-APIC、或不发布网关。 发布请求的发起者若非审核人,需要API的审核人完成申请的审核。
工作空间内的API配额已满,无法新建API怎么解决? DataArts Studio实例下数据服务专享版的API总分配配额默认为5000,如果工作空间内的API配额未达此配额,则您可以为当前工作空间分配更多已分配配额。 登录DataArts Studio管理控制台。 在旧版首页的
进入“开发API > API管理”页面,单击“注册现有API”,填写API基本信息。 表1 API基本信息 配置 说明 API名称 支持中文、英文、数字、下划线,且只能以英文或中文开头,3-64个字符。 API目录 一个特定功能或场景的API集合,是数据服务中API的最小组织单元,也是API网关中的最小管理单元。
数据质量API 目录接口 规则模板接口 质量作业接口 对账作业接口 运维管理接口 质量报告接口 导入导出接口
单、快速地通过数据API获取到开放数据。 IAM认证 中 通过IAM应用或白名单将API授权给账号后,借助从IAM服务获取的用户Token进行安全认证。 API工具调用:需要调用IAM服务的获取用户Token接口获取Token,再使用API工具调用。 通过API工具调用IAM认证方式的API
享版支持该参数。 不覆盖:如果已存在同名API,则不导入该API。 当导入API与原有API定义冲突时,覆盖原有API定义:如果存在同名API,则按照导入的API更新API定义。 导入文件 待导入的API文件可以是从其他项目直接导出的API文件,也可以是通过模板填写的Excel文件,需要确保符合模板规范要求。
API操作(下线/停用/恢复) 功能介绍 下线API。将已发布的API下线。下线后,所有授权关系都会被解除,API将无法再被调用。 停用API。将已发布的API临时下线。下线后,授权关系会保留,停用期间API将无法再被调用。 恢复API。将已停用的API恢复使用。恢复后, API重新提供调用。
下线/删除API 操作场景 已发布的API因为其他原因需要停止对外提供服务,可以将API从相关环境中下线,相关操作请参见下线API。 下线后的API如果要继续使用,需要重新进行发布操作,但需注意下线API不会保留原有的授权信息。 下线后的API如果确认不再提供服务,可以将API删除,相关操作请参见删除API。
调试API 功能介绍 调试API。 调用方法 请参见如何调用API。 URI POST /v1/{project_id}/service/apis/{api_id}/instances/{instance_id}/test 表1 路径参数 参数 是否必选 参数类型 描述 project_id
单击“开发API > API管理”页面,进入API管理页面。 勾选待复制的API所在行,在API列表上方,选择“更多 > 复制”,弹出复制窗口。 在弹出的窗口中输入新API的名称和请求path,单击确认即可完成API复制。 图1 复制API 父主题: 管理API
进入总览页。 单击“开发API > API管理”页面,进入API管理页面。 勾选待同步的API所在行,在API列表上方,选择“更多 > 同步至共享版”,进入同步界面。 单击同步进行开始API同步,同步结果中可以展示同步状态。 图1 同步API 同步API到数据地图 在DataArts
如何调用API 构造请求 认证鉴权 返回结果
html手动生成认证信息。 调用API:通过Postman工具调用API。 前提条件 已完成APP认证方式的API或API工作流的发布,在服务目录中可以查看已发布的API。 已完成创建应用并将API授权给应用,即API开发者已完成通过应用授权APP认证方式API,或API调用者已完成申请API授权。 如
批量删除API 功能介绍 批量删除API。 调用方法 请参见如何调用API。 URI POST /v1/{project_id}/service/apis/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参见项目ID和账号ID。
调试API 操作场景 API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 API绑定签名密钥时,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。