检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
表1 定义扩展字段 信息项 描述 Key 填写Key值。 显示名 填写扩展字段名称。 显示样式 填写扩展字段的值，支持文本框、单选框、复选框和下拉列表的形式。 配置值 填写扩展字段的值，显示样式非“文本框”时，配置值必填。 必填 若勾选，表示配置扩展字段时，扩展字段内容不能为空。 显示区域
添加API的标签信息，用于快速过滤和查找API。 描述 填写API的描述信息。 根据下表参数定义，配置安全配置。 表2 安全配置参数 信息项 描述 安全认证 API认证方式： APP认证：表示由ROMA API服务负责接口请求的安全认证。 华为IAM认证：表示借助IAM服务进行安全认证。
API列表 API列表支持查看当前实例下所有的API，包含URL、运行环境、安全认证信息。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。 在当前应用关联的实例中，根据实
进入。 页面的最左侧展示产品下的API，中间可配置API请求参数，最右侧支持查看调试结果和API文档。 （可选）单击“文档”页签，查看API文档信息。 根据已设置认证方式，编辑请求参数，单击“调试”。 表1 请求参数说明 认证方式 Headers Parameters Body APP认证
（可选）可视化设计API文件。 单击“表单”页签，您可以创建多个API文件或对API文件进行分类，以及可视化编辑API接口等。 在“API列表”区域，单击，创建API。 在“API列表”区域，单击，对API进行分类管理。 单击“文件基本信息”页签，查看设计文件基本信息。 单击“编辑”，对API进行编辑或修改。
API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。 查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”，进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”，可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史
在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 根据下表相关任务，了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”，修改API信息，具体操作请参考创建API。
的安全保护。 支持区域：华北-北京一、华北-北京四、华东-上海一、华南-广州 如何创建虚拟私有云？ VPC服务介绍【视频】 VPC服务介绍【视频】 OBS 2.0支持API设计 主要介绍API设计者如何设计API文件。在API设计和变更阶段指导设计者遵从API格式规范，提升企业API的交付质量。
单击“确定”，克隆完成。 在已克隆版本中可查看、添加或移除API，以及上架克隆版本。 同步 API服务变更后，需要手动同步信息到产品。 选择变更API服务所属产品，单击产品名称。 在“版本列表”中选择同步版本。 在需要同步的API所在行，单击“同步”。 查看API 查看API产品下的API详情。
单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后，单击“确定”。 查看日志分析可单击“日志字段说明”，根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下：
在“API接口”列表中勾选要开放的API，单击“立即导入”。 （可选）单击“全局配置(可选)”。 安全配置。 表1 安全配置参数说明 参数 参数说明 安全认证 API使用的认证方式，推荐使用APP认证。 APP认证：表示由ROMA API进行API请求的安全认证。 华为IAM认证：表示通过IAM服务进行安全认证。
使用场景 操作步骤 查看实例 查看实例详情，包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例，单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签，查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签，查看参数信息。 单击“负载通道”页签，查看通道信息。
在页面上单击服务名称，进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数，完成后单击“导出”，导出结果可在页面右侧查看，同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。
及响应内容。 响应内容的错误信息以及其他信息，可通过变量的方式获取，支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。 表1 ROMA API的错误响应类型 错误响应类型 默认的响应状态码 错误说明 详细说明
签，可查看申请详情。 在“审核管理”页面，选择“我审核的申请”页签，单击“查看详情”，审批产品信息。 仅支持拥有租户管理员权限者审批。 图2 审批申请 查看上架是否成功。 返回产品详情页面，查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。
path”，“Target”选择工程下的“backend_signature.py”文件，单击“OK”，完成工程配置。 校验后端签名示例 示例演示如何编写一个基于Flask的服务器，作为API的后端，并且实现一个wrapper，对API网关（即API管理）的请求做签名校验。 API绑定签
表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源，包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称，进入应用详情页面，查看应用ID、实例状态、集成应用、项目ID等。 权限管理
根据实际情况修改参数后使用。具体代码说明请参考校验后端签名示例。 sdk-request：签名算法的调用示例。 校验后端签名示例 示例演示如何编写一个基于ASP.Net Core的服务器，作为API的后端，并且实现一个IAuthorizationFilter，对API网关（即API管理）的请求做签名校验。
API提供的开放API的SDK语言版本，列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表，您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java
配置参数说明 表1 配置参数说明 参数 配置说明 allowed origins Access-Control-Allow-Origin响应头，指定允许访问API的外域URI，多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求，可以把参数值设置为“*”，表示允许来自所有域的访问请求。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
