检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导出API服务 您可以把ROMA API上的API服务以YAML或JSON格式导出到本地，用于导入API服务或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
"$context.requestId","apiId":"$context.apiId"} JSON体的内容可以按需定制，包括增减字段内容。 API提供的默认网关响应“default”也可以编辑修改。 网关响应所定义的错误类型固定且不可修改，具体见网关错误响应类型说明。 响应内容支持调用A
完成以下流程： 图1 中级使用者流程图 步骤一：购买实例 在创建应用前，需要先购买实例。 步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful API。 步骤四：后端开发（可选） 支持一站式创建代码仓、自动
有可用的VPC，并且已配置好子网与安全组，否则请参考准备资源完成VPC、子网和安全组的创建。 ROMA Connect实例的可用配额不为0。如果可用配额为0，可以删除无用实例或者申请扩大实例配额。 APIG实例： 购买APIG实例的前提条件请参考购买专享版实例中的“购买专享版的约束说明”和“网络环境准备”。
在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。 已发布到环境的API，在修改配置信息后，需要重新发布才能将修改后的信息同步到环境中。
IP地址和账户，您可以创建访问控制策略，允许/禁止某个IP地址或账号访问绑定策略的API。 每个用户最多可以创建100个访问控制策略。 API添加访问控制策略相当于访问控制策略同步绑定了API。同一个环境中一个API只能添加一个访问控制策略，一个访问控制策略可以添加到多个API上。
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
API提供了API设计文件规范性检查，帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段，您按照Swagger规范性设计API的同时，也可额外自定义扩展字段。 您可以进行以下操作： 规则集管理 启用规则集 根据业务需
自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开
创建环境 创建环境后，在创建API服务或发布API时，可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证，填写申请描述。 您可以使用已有的凭证或者新建凭证，新建凭证具体操作请参考创建凭证。 单击“确定”，订阅申请成功。 在左侧导航栏单击“审核管理”，审核申请通过后，订阅产品完成。
本文介绍了ROMA API提供的开放API的SDK语言版本，列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表，您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址
当您使用Token认证方式调用API时，需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证通用请求。 AK/SK认证：通过AK（Access Key ID）/SK（Secret
传输重要或敏感数据时推荐使用HTTPS。 子域名：系统默认分配的一个子域名。 路径：接口请求的路径。请求路径可以包含请求参数，请求参数使用{}标识，例如/a/{b}，也可以通过配置'+'号做前缀匹配，例如：/a/{b+}。 网关响应 网关响应指未能成功处理API请求，从而产生的错误响应。ROMA
HTTP响应头管理策略 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA
se信息。 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参考错误码。 您可以通过调整请求参数与参数值，发送不同的请求，验证API服务。 后续操作 API调试成功后，您可以发布API到环境上。 父主题： APIs管理
单击“编辑器”页签。 单击编辑窗口上方的“规范性检查”。 在可视化窗口单击“Show”查看结果，您可以根据“修改建议”修改规范性问题。 （可选）单击“表单”页签。 单击页面右上角“规范性检查”。 在弹窗中查看结果，您可以根据“修改建议”修改规范性问题。 创建Tag 对API接口进行分类处理，方便筛选或查找API接口。
息以及通过该凭证订阅的产品信息。 单击“创建凭证”，填写凭证基本信息。 图1 填写基本信息 单击“确定”，创建完成。 凭证创建完成后，您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域，凭证“Key”和“Secret”是创建凭证
管理”进行授权配置。 主账号可以对所有IAM用户创建的应用进行授权配置，IAM用户只能对自己创建的应用进行授权配置。 在弹窗中“用户列表”处勾选要授权的IAM用户，在“已选择”处为已选择的IAM用户配置应用的使用权限。 可为每个用户单独配置权限，也可以单击“权限”右侧的为所有已选择IAM用户批量配置权限。
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
