检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
只有管理员（IAM用户拥有“Tenant Administrator”权限）能设置。 凭据策略分三种类型：集成凭据、订阅凭据和客户凭据（集成凭据由ROMA实例下的集成应用同步创建；订阅凭据通过订阅产品后，在产品所属实例下同步创建；客户凭据由租户管理员在APIG实例下创建）。 添加AppCode
当实例为APIG类型时，支持是否启用Prometheus指标接口。启用Prometheus后，您可通过 https://<网关组件IP>:1026/metrics采集到Prometheus格式的API调用统计数据。 app_jwt_enable app_jwt认证方式开关。启用后，可在API请求
后端认证”开启时，才可以选择此参数。 系统参数名 填写系统参数的名称。 系统参数类型为“网关内置参数”时，选择系统支持获取的参数。 系统参数类型为“前端认证参数”或“后端认证参数”时，支持自定义参数，但是此参数必须为自定义认证返回结果中的参数。 后端参数名称 填写系统参数需要映射的后端参数名称。
“Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP，可参考实例配置参数。 操作步骤。 登录ROMA
函数名称。选择函数后，自动生成。 函数URN 函数请求唯一标识。 单击“添加”，添加所需的functionURN。 版本 函数的版本。 调用类型 Synchronous：同步调用。指后端函数服务收到调用请求后立即执行并返回调用结果，客户端发送请求后同步等待，收到后端响应后关闭连接。 A
允许外部访问8080端口。 8080端口允许访问后，单击右上角“访问”即可访问运行中的应用。 应用访问成功后，将打开一个新的Web网站，页面中显示如下信息。 单击“后端总览”页签。 在“流水线”区域，单击“执行”。 流水线执行成功后，单击“克隆/下载”下载流水线的jar包，将包部署到自己的服务器上。
法创建访问密钥。 如需修改访问密钥，请删除访问密钥后重新创建。 为了保证历史兼容性，系统会使用访问密钥创建时间作为最近使用时间的初始值。在您使用该访问密钥时，系统将自动刷新最近使用时间。 输入描述信息，单击“确定”。 创建成功后，在“创建成功”弹窗中，单击“立即下载”下载密钥，并妥善保管。
企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转，并不断演进。 应用是一个系统资源的集合，API的全生命周期是在应用中实现，因此在开启API的全生命周期管理之前，您需要在“管理中心”先创建应用。 API设计 API设计者主要负责API整体的规划和设计，提前Mock调测和规范检查。
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
凭据策略用于API运行时的策略管理，支持配置APPCode、绑定应用配额策略和绑定访问控制策略，且只有管理员（IAM用户拥有“Tenant Administrator”权限）能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义
明请参考开启跨域共享。 跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力，可快速、灵活的实现API的跨域访问。 使用限制 已了解前提条件。 同一API服务下，相同请求路径的所有API，只能绑定同一个跨域资源共享策略。 若API开启了“支持
勾选需要配置SLA的API，单击“批量配置SLA”。 （可选）Mock调测。 开启“Mock”会自动生成Mock服务地址，您可以在可视化窗口对接口地址进行调测。 （可选）规范性检查。 在规范性检查之前，您需提前启用规则集或创建规则集。在编辑窗口上方单击“规范性检查”，检查结果在可视化视
前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
仅使用APP认证方式的API，才需要授权，发布API后，通过指定授权给某些应用，让指定应用能够调用API。 选择需要授权的API。 选择“更多 > 授权”。 在弹窗中设置授权信息。 选择授权应用。 设置访问参数。 选择是否开启绿色通道。 说明： 仅能授权自己有权限的应用。 访问参
选择已有策略：单击“选择已有策略”后，选择策略名称。 创建新策略：请参考表1所示输入信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“APP认证”、“Basic Auth”或“Public Key”。 在应用关联实例的配置参数中开启pub
发布API 在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。
on”，开启app_api_key认证。 在API请求中添加Header或Query参数“apikey”，参数值为获取API的请求信息中获取到的Key或AppKey。 app_secret认证 ROMA API的实例配置参数“app_secret”已设置为“on”，开启app_s
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
