检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
ROMA API为企业构建规范化的API全流程体系，将企业服务能力包装成标准API服务，上架市场进行售卖。变现自身服务能力的同时，降低企业研发投入，专注于企业核心业务，提升运营效率。提供全栈的API数据化运营能力，用运行数据驱动规范跟设计的落地，提供更高维度的顶层API架构设计能力。
上架目录 将API产品上架到API目录，供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品，单击产品名称。 在“版本列表”中，选择上架版本，单击“上架”。
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
ROMA API支持把API服务中的API资源作为一个产品，共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。
计费说明 ROMA API本身不收费，但需先关联资源才可使用对应功能。请参考： 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
仅当“协议”选择“HTTP”或“HTTPS”时需要配置。 选择健康检查所使用的HTTP请求方法，可选择“GET”和“HEAD”。 高级设置 检查端口 健康检查的目标端口，默认使用负载通道配置的端口号，但您可以指定其他的端口。 正常阈值 执行健康检查时，判定服务器状态正常的连续检查成功次数。例如“正常阈值”设置为
共享流控：针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。 与“API流量限制”配合使用，表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用，表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用，表示单位时间内的单个APP请求次数上限。
APP认证凭证：选择已创建凭证，可选择的凭证是已使用凭证订阅了API所在产品的凭证。 填写API的Headers参数。 填写API的Params参数。 已定义Body 通过切换输入方式可以选择表单填写或文本输入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。
APP认证：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 Public Key：填写public_key认证所使用的公钥。 Secret 根据选择的密钥类型，填写不同的密钥信息。 APP认证：填写APP认证所使用密钥对的Secret。 Basic
在“配置参数”页面，找到需要配置的参数，单击“编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次
“总览”页面展示分别展示ROMA API概念，提供的能力，以及操作指引。 您可以根据不同角色查看行为路径，或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者，敬请期待。 API治理专家，敬请期待。 目前仅初级使用者和中级使用者支持“查看指引”。
参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称，请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线，当前仅支持在官方提供的流水线中选择。当前提供的流水线为手动触发流水线，在
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本，列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表，您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
、灵活的实现API的跨域访问。 使用限制 已了解前提条件。 同一API服务下，相同请求路径的所有API，只能绑定同一个跨域资源共享策略。 若API开启了“支持CORS”功能的同时，也绑定了跨域资源共享策略，则以绑定的策略为准。 若某个请求路径下有OPTIONS方法的API，则该请
单击规则名称，可查看规则的“正确示例”和“错误示例”。 （可选）编辑规则集，可单击“管理”或“编辑”。 管理：配置规则。 取消已启用规则 在“已启用”的规则中，勾选需要取消启用的规则，单击“取消启用”。 启用规则 在“未启用”的规则中，勾选需要启用的规则，单击“启用”。 编辑：修改规则集名称和描述。
）。 添加AppCode 使用APP认证方式的API，支持通过AppCode进行API调用的简易安全认证。 绑定凭据配额策略 凭据配额用于限制凭据在某个时间周期内的API调用次数，支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户端IP地址，保护后端服务
api_name API名称。 35 app_name 当使用APP认证访问时，请求方使用的APP名称。 36 provider_app_id API所属的APP ID。 37 provider_app_name API所属的APP名称。 38 custom_data_log1 用户自定义日志字段值1。
ROMA API对调试域名的访问次数做了限制，每天最多可以访问1000次。 独立域名：您自定义的域名，API调用者通过访问独立域名来调用您开放的API。 前提条件 已备案独立域名，未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上，具体方法请参考增加A类型记录集。
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
