检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
审批申请 查看上架是否成功。 返回产品详情页面，查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。 订阅API B部门在“目录列表”中订阅API产品。 单击“订阅”，填写订阅申请信息。 图4 订阅申请 在“审核管理”页面，选择“我提交的申请”页签，可查看申请详情。
如忽略问题，可单击“继续导入”。 （可选）可视化设计API文件。 单击“表单”页签，您可以创建多个API文件或对API文件进行分类，以及可视化编辑API接口等。 在“API列表”区域，单击，创建API。 在“API列表”区域，单击，对API进行分类管理。 单击“文件基本信息”页签，查看设计文件基本信息。
创建凭证 凭证代表用户认证标识，用户通过凭证来订阅上架的产品，订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
API策略”。 在当前应用关联的实例中，根据实际业务选择实例。 单击“自定义认证”页签。 在“自定义认证”页面，可执行下表操作。 表1 管理自定义认证 相关任务 使用场景 操作步骤 查看自定义认证 查看自定义认证详情。 单击认证名称，查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。
创建应用成功后，在“应用管理”的列表中显示新创建应用的基本信息，同时也支持权限管理、编辑、删除等操作管理应用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务，了解如何管理应用。
API产品创建完成后，在产品列表中显示新创建API产品信息，同时也支持下架、下线等操作管理API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务，了解如何管理API产品。
使用自定义认证调用API Function API通过编写函数脚本实现将多个服务封装成一个服务。 有关API调用的认证帮助，请参考编写函数API脚本（Java Script）。
PI设计文件，单击“确定”。 导入Swagger文件：从用户本地导入API，生成测试用例。选择API文件，单击“打开”。 配置用例参数。 表1 用例参数 参数 配置说明 用例名称 用例的名称，根据规划自定义。 生成用例 生成用例方式分两种： 所有接口生成一个用例：将选择的API接口生成一个用例。
已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务，了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情，包括实例的基本信息、配置参数、负载通道和环境管理。
单击实例名称或实例卡片右上角的“查看控制台”。 单击“配置参数”页签。 在“配置参数”页面，找到需要配置的参数，单击“编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。
在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 单击产品名称。 在“版本列表”中选择版本。 单击“添加API”。 在弹窗中选择API，单击“确定”。 后续操作 如需对外提供API服务，可将API产品上架目录。 父主题：
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
在当前应用关联的实例中，根据实际业务选择实例。 单击“自定义认证”页签。 在自定义认证页面，单击“创建自定义认证”。 在创建自定义认证弹框中，根据下表填写参数信息。 表1 自定义认证参数 信息项 描述 认证名称 您自定义的认证名称，用于区分不同的自定义认证。 类型 前端：对API的访问进行认证鉴权。
API设计 创建API设计 API设计配置 管理API设计
APIs管理 创建API 调试API 发布API 管理API 流量控制 访问控制 签名密钥 跨域资源共享 父主题： API管理
自定义认证 创建自定义认证 管理自定义认证 父主题： API管理
API产品 创建API产品 上架目录 管理API产品 父主题： API消费
API分析 API指标分析
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题： 管理中心
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
