检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
HTTP响应头管理 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统
、管理和部署不同规模的API。简单、快速、低成本、低风险的实现内部系统集成、成熟业务能力开放及业务能力变现。 使用场景 ROMA Connect实例: 需要解决跨网及多云API业务集成 需要使用丰富的API编排跟数据API服务能力 需要拥有更高的性能跟全栈的应用集成能力 APIG实例:
统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例
访问密钥保护关闭时,所有IAM用户可以管理(包含创建、启用/停用或删除)自己的访问密钥。 访问密钥保护开启时,仅管理员可以管理用户的访问密钥。 如果您无法管理您的访问密钥,请联系管理员: 由管理员管理您的访问密钥,方法请参见:管理IAM用户访问密钥。 请管理员为您配置权限或修改访
创建凭证 凭证代表用户认证标识,用户通过凭证来订阅上架的产品,订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
APP认证凭证:选择已创建凭证,可选择的凭证是已使用凭证订阅了API所在产品的凭证。 填写API的Headers参数。 填写API的Params参数。 已定义Body 通过切换输入方式可以选择表单填写或文本输入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号,然后单击“跨域资源共享”。 图1
使用自定义认证调用API Function API通过编写函数脚本实现将多个服务封装成一个服务。 有关API调用的认证帮助,请参考编写函数API脚本(Java Script)。
以确保产品的正确性。 审核流程: 提交申请 查看申请 审核申请 提交申请 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择待申请的产品,单击产品名称。 选择待申请的版本,单击“上架/不推荐/下架”,填写申请。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 选择需要发布的API,在页面右上角单击“发布”。 如需批
API目录相当于一个资产中心,以产品的形式将API资源上架到API目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证,填写申请描述。
移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值,如下图所示: 图1 从返回消息的Header中获取X-Subject-Token 使用如下命令将token设置为环境变量,方便后续事项。
在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批订阅信息。 仅支持拥有租户管理员权限者审批。 图5 审批申请 订阅成功后,B部门可以调用A部门的API。 订阅成功后,可以在“订阅与凭证”中查看该凭证下已经订阅成功的产品,也可以取消订阅产品。
查看单个API设计文件的变更历史 单击对应API设计文件所在行的“变更历史”,即可查看相关操作记录。 单击对应操作所在行的“查看对比”,查看变更前和变更后的对比信息。 (可选)差异对比,可任意选择两个操作,单击“差异对比”,查看变更前后的信息。 如需还原操作,单击对应操作所在行的“还原”,还原到当前版本。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。 根据下表相关任务,了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略,或单击策略名称,进入策略详情。
单击认证名称,查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到需要删除的自定义认证,单击所在行的“删除”,即可删除自定义认证。 更新自定义认证 刷新自定义认证信息。
登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。 在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。
使用自定义认证调用API 如果您希望使用自己的认证方式,可以在函数服务中编写一个函数,将其作为您的认证服务。 使用无认证调用API 对API请求不进行认证。 通过多种开发语言对后端服务进行签名 指导API开放者通过创建后端签名,确保后端服务的安全。