检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
总览 ROMA API是API全生命周期治理经验的产品，如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题，提供了规范化的产品跟工具支撑，帮助企业快速实现API经济，并持续构建高质量的API服务能力。 图1 API全生命周期
后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。
选择是否开启绿色通道。 说明： 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。 单击“确定”，完成授权。
G”时，设置参数值的最大字符串长度，“类型”为“NUMBER”时，设置参数值的最大值。 最小长度/最小值：“类型”为“STRING”时，设置参数值的最小字符串长度，“类型”为“NUMBER”时，设置参数值的最小值。 示例 参数值的填写示例。 描述 对于此参数的描述。 单击“下一步”，进入后端配置。
在“审核管理”页面，选择“我提交的申请”页签，可查看申请详情。 在“审核管理”页面，选择“我审核的申请”页签，单击“查看详情”，审批订阅信息。 仅支持拥有租户管理员权限者审批。 图5 审批申请 订阅成功后，B部门可以调用A部门的API。 订阅成功后，可以在“订阅与凭证”中查看该凭证下已经订阅成功的产品，也可以取消订阅产品。
共享流控：针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。 与“API流量限制”配合使用，表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用，表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用，表示单位时间内的单个APP请求次数上限。
服务端在空闲的情况下会逐个处理排队的请求。 后端超时 请求超时时间，1 ~ 60000ms。 后端认证 当您的后端服务需要对API调用增加自己的认证，则需要开启后端认证。 后端认证需要先添加一个自定义认证，自定义认证通过函数服务实现，在函数服务中编写一个函数，实现您的认证鉴权流程，或者使用函数调用您的统一鉴权服务。
单击证书名称，查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书，单击所在行的“编辑”，即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删除的证书，单击所在行的“删除”，即可删除证书。 父主题： SSL证书管理
提供如何在API的描述信息中使用markdown语法，使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore 提供多种复杂API的定义样例。 单击
API中管理员以及IAM用户创建的应用是隔离的，无法互相访问。如果用户想分配权限给不同的IAM用户，需要手动在应用管理内的权限管理进行分配，或在IAM中给用户添加Tenant Administrator权限。 除应用外，IAM用户也需拥有应用关联资源的权限才可进行对应操作，具体可参考：
认证名称 您自定义的认证名称，用于区分不同的自定义认证。 类型 前端：对API的访问进行认证鉴权。 后端：对后端服务的访问授权。 函数地址 选择用于前端自定义认证或后端自定义认证的函数后端，且创建的函数请求方法为“POST”。如需创建自定义后端，请参考创建用于前端认证的函数后端或创建用于后端认证的函数后端。
单击规则名称，可查看规则的“正确示例”和“错误示例”。 （可选）编辑规则集，可单击“管理”或“编辑”。 管理：配置规则。 取消已启用规则 在“已启用”的规则中，勾选需要取消启用的规则，单击“取消启用”。 启用规则 在“未启用”的规则中，勾选需要启用的规则，单击“启用”。 编辑：修改规则集名称和描述。
API网关收到请求后，执行1~3，计算签名。 将3中的生成的签名与5中生成的签名进行比较，如果签名匹配，则处理请求，否则将拒绝请求。 APP签名仅支持Body体12M及以下的请求签名。 步骤1：构造规范请求 使用APP方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与API网关使用相同的请求规范，可以
移至用户名，在下拉列表中单击“我的凭证”，查看“项目ID”。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值，如下图所示： 图1 从返回消息的Header中获取X-Subject-Token 使用如下命令将token设置为环境变量，方便后续事项。
API前，您需要先创建应用，然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源，IAM用户只能管理自己创建的应用和资源，默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式，把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件
APP认证凭证：选择已创建凭证，可选择的凭证是已使用凭证订阅了API所在产品的凭证。 填写API的Headers参数。 填写API的Params参数。 已定义Body 通过切换输入方式可以选择表单填写或文本输入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。
查看单个API设计文件的变更历史 单击对应API设计文件所在行的“变更历史”，即可查看相关操作记录。 单击对应操作所在行的“查看对比”，查看变更前和变更后的对比信息。 （可选）差异对比，可任意选择两个操作，单击“差异对比”，查看变更前后的信息。 如需还原操作，单击对应操作所在行的“还原”，还原到当前版本。
分析日志 快速获取并分析API的调用日志。 前提条件 已调用API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。
单击“日志分析”页签，查看调用日志信息。 编辑实例 支持编辑实例的基本信息、参数、通道和环境。 找到需要编辑的实例，单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签，然后单击可编辑对应参数信息。 单击“配置参数”页签，然后单击对应参数所在行的“编辑”，即可编辑参数信息。 单击“负载通
支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”，即可编辑应用信息。 删除应用 已创建的应用不再提供服务，可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”，即可删除应用信息。 更新应用 刷新全局应用信息。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
