检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
无问题修复,请单击“继续导入”。 选择步骤一中实例,填写服务名称,并选择API接口。 单击“全局配置(可选)”,定义API服务。 图5 全局配置 安全配置:选择认证方式,此处选择“APP认证”。 后端请求配置。 表4 后端请求参数配置 参数 配置说明 后端服务类型 选择后端服务类型,此处选择“HTTP&HTTPS”。
在“系统参数”下,单击“添加系统参数”,添加后端服务请求的系统参数。 表8 系统参数配置 数 配置说明 系统参数类型 选择系统参数的类型。 网关内置参数:ROMA API支持配置的参数。 前端认证参数:前端自定义认证返回结果中的参数。在设置前端定义和安全配置中,“安全认证”选择“自定义认证”时,才可以选择此参数。
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 根据下表相关任务,了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。
单击“创建API产品”。 根据参数提示,填写产品基本信息。 在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。 单击“立即创建”,创建API产品。
需要拥有更高的性能跟全栈的应用集成能力 APIG实例: 需要实现API的开放托管,安全等配置 使用一些基础的API编排集成能力 前提条件 ROMA Connect实例: 有可用的VPC,并且已配置好子网与安全组,否则请参考准备资源完成VPC、子网和安全组的创建。 ROMA Conn
(可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。 勾选需要配置SLA的API,单击“批量配置SLA”。 (可选)Mock调测。 开启“Mock”会自动生成Mock服务地址,您可以在可视化窗口对接口地址进行调测。 (可选)规范性检查。 在规范性检查之前,您需提前启用规则集或创建
单击“配置参数”页签。 在“配置参数”页面,找到需要配置的参数,单击“编辑”。 根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值
查看API产品下的API详情。 选择API所属产品,单击产品名称。 在“版本列表”中选择版本。 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。 移除 API产品不需要某个API时,可将API从未上架产品中移除,即解除API与产品的绑定关系。 选择API所属产品,单击产品名称。
在页面右上角单击“API设计配置”。 在“API设计配置”页面,单击“扩展字段配置”。 单击“添加扩展字段”,定义扩展字段。 表1 定义扩展字段 信息项 描述 Key 填写Key值。 显示名 填写扩展字段名称。 显示样式 填写扩展字段的值,支持文本框、单选框、复选框和下拉列表的形式。 配置值 填写扩
如果您无法管理您的访问密钥,请联系管理员: 由管理员管理您的访问密钥,方法请参见:管理IAM用户访问密钥。 请管理员为您配置权限或修改访问密钥保护状态。如需配置权限请参见:给IAM用户授权,如需修改访问密钥状态请参见:访问密钥保护。 管理员可以在“用户详情”页面查看IAM用户的访
发送API请求时,需要将当前时间置于请求消息头的X-Sdk-Date,将签名信息置于请求消息头的Authorization。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 ROMA API除了校验时间格式外,还会校验该时间值与ROMA API收到请
oken接口: {iam_endpoint}请参见地区和终端节点获取。 {user_name}和{password}分别替换为连接IAM服务器的用户名和密码。 {project_id}为项目ID。在管理控制台,将鼠标移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。 请
API设计 创建API设计 API设计配置 管理API设计
在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 根据下表相关任务,了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”,修改API信息,具体操作请参考创建API。
在控制台单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务,了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题: 管理中心
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务,了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境