检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
在当前应用关联的实例中，根据实际业务选择实例，查看当前实例下包含的API，以及API基本信息。 单击API名称，查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作，可参见APIs管理。 父主题： API管理
为了保证历史兼容性，系统会使用访问密钥创建时间作为最近使用时间的初始值。在您使用该访问密钥时，系统将自动刷新最近使用时间。 输入描述信息，单击“确定”。 创建成功后，在“创建成功”弹窗中，单击“立即下载”下载密钥，并妥善保管。 您可以在访问密钥列表中查看访问密钥ID（AK），在下载的
API对调试域名的访问次数做了限制，每天最多可以访问1000次。 独立域名：您自定义的域名，API调用者通过访问独立域名来调用您开放的API。 前提条件 已备案独立域名，未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上，具体方法请参考增加A类型记录集。 如果API服务中的API支持H
企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
API概念，提供的能力，以及操作指引。 您可以根据不同角色查看行为路径，或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者，敬请期待。 API治理专家，敬请期待。 目前仅初级使用者和中级使用者支持“查看指引”。
DK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表，您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java huaweicloud-sdk-java-v3
基本概念 应用 API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
单击已订阅版本号。 单击API名称，查看API接口认证方式、请求方法、URL和请求参数。 图11 获取API的请求信息 获取“凭证信息”的Key和Secret。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。 选择步骤十一中已创建凭证，查看“凭证信息”的“Key”和“Secret”。
导入API设计文件”。 在弹窗中选择要开放API所在的设计文件，单击“确定”。 系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 如忽略问题，单击“继续导入”。 填写服务名称，或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API，单击“立即导入”。
环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。
如需批量发布，单击“批量操作”，选择要发布的API，单击。 填写发布信息，单击“确定”，完成发布。 图1 填写发布信息 如需查看发布历史，单击“更多”，选择“发布历史”。 图2 查看发布历史 后续操作 API发布完成后，您可直接将API服务生成产品，或从API服务中挑选部分API组合生成产品。
在规范性检查之前，您需提前启用规则集或创建规则集。在编辑窗口上方单击“规范性检查”，检查结果在可视化视图窗口查看，您可以根据修改建议修改规范性问题。 图1 规范性检查结果 （可选）导入到API服务。 单击“导入到API服务”，系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源，包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称，进入应用详情页面，查看应用ID、实例状态、集成应用、项目ID等。 权限管理
（可选）配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息，如网关内置参数、前端认证参数和后端认证参数等，可以通过设置系统参数来实现。ROMA API向后端服务发送请求时，将系统参数添加到请求的指定位置，然后将请求发送给后端服务。 在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。
相关任务 使用场景 操作步骤 查看实例 查看实例详情，包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例，单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签，查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签，查看参数信息。 单击“负载通道”页签，查看通道信息。
上架目录 将API产品上架到API目录，供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品，单击产品名称。 在“版本列表”中，选择上架版本，单击“上架”。
单击实例名称或实例卡片右上角的“查看控制台”。 单击“配置参数”页签。 在“配置参数”页面，找到需要配置的参数，单击“编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围
前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
