检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建环境 创建环境后，在创建API服务或发布API时，可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证，填写申请描述。 您可以使用已有的凭证或者新建凭证，新建凭证具体操作请参考创建凭证。 单击“确定”，订阅申请成功。 在左侧导航栏单击“审核管理”，审核申请通过后，订阅产品完成。
（可选）Mock调测。 开启“Mock”会自动生成Mock服务地址，您可以在可视化窗口对接口地址进行调测。 （可选）规范性检查。 在规范性检查之前，您需提前启用规则集或创建规则集。在编辑窗口上方单击“规范性检查”，检查结果在可视化视图窗口查看，您可以根据修改建议修改规范性问题。 图1 规范性检查结果
本文介绍了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
se信息。 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参考错误码。 您可以通过调整请求参数与参数值，发送不同的请求，验证API服务。 后续操作 API调试成功后，您可以发布API到环境上。 父主题： APIs管理
传输重要或敏感数据时推荐使用HTTPS。 子域名：系统默认分配的一个子域名。 路径：接口请求的路径。请求路径可以包含请求参数，请求参数使用{}标识，例如/a/{b}，也可以通过配置'+'号做前缀匹配，例如：/a/{b+}。 网关响应 网关响应指未能成功处理API请求，从而产生的错误响应。ROMA
息以及通过该凭证订阅的产品信息。 单击“创建凭证”，填写凭证基本信息。 图1 填写基本信息 单击“确定”，创建完成。 凭证创建完成后，您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域，凭证“Key”和“Secret”是创建凭证
绑定域名 您需要为API服务绑定一个或多个独立域名，每个API服务最多可以绑定5个独立域名，同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系，将已有的独立域名绑定到API服务上。当客户端发送请求时，根据HTTP请求中的域名定位到所属的API服务，再通过HTTP
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
创建负载通道 创建负载通道后，在创建API服务，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。 前提条件 已创建云服务器。如需创建请参考创建云服务器。 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
审核管理 为产品上架/不推荐/下架/订阅过程提供审核机制，API管理者发起上架/不推荐/下架/订阅请求时，IAM用户（其他管理者）都可以参与到评审中，让更多用户参与到API产品审视中，以确保产品的正确性。 审核流程： 提交申请 查看申请 审核申请 提交申请 登录ROMA API控制台。
自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开
功能。 在线开发 后端创建完成后，您可以使用“在线开发”开发代码，通过CodeArts IDE Online修改代码包中的DemoApplication.java文件。 执行流水线 当前仅支持在官方提供的流水线中选择，待流水线创建成功后，您可以手动触发流水线，完成代码的编译和检查。
应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。 单击“确定”，完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 选择需要下线的API。 单击“下线”，选择需要下线的环境。
情”，审批订阅信息。 仅支持拥有租户管理员权限者审批。 图5 审批申请 订阅成功后，B部门可以调用A部门的API。 订阅成功后，可以在“订阅与凭证”中查看该凭证下已经订阅成功的产品，也可以取消订阅产品。 图6 订阅成功 （可选）返回目录列表，单击产品名称，选择版本号进入，可查看已开放的API以及进行调试。
部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则，检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码，并完成后端的服务能力开发。
ID）/SK（Secret Access Key）认证调用请求。其签名方式和APP认证相似。 使用自定义认证调用API 如果您希望使用自己的认证方式，可以在函数服务中编写一个函数，将其作为您的认证服务。 使用无认证调用API 对API请求不进行认证。 通过多种开发语言对后端服务进行签名 指导
libs\java-sdk-core-x.x.x.jar 签名SDK pom.xml 构建Maven工程所需，定义其他依赖包 changelog 变更日志 src 验证签名SDK的demo代码: WebSocketDemo.java OkHttpDemo.java、 LargeFileUploadDemo
支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”，即可编辑应用信息。 删除应用 已创建的应用不再提供服务，可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”，即可删除应用信息。 更新应用 刷新全局应用信息。 在页面右上角单击刷新应用列表。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
