检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简
实例创建完成后，可在控制台编辑实例的配置信息。 前提条件 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“配置参数”页签。
选择步骤十一中已创建凭证，查看“凭证信息”的“Key”和“Secret”。 使用接口测试工具配置调用信息。 配置获取的API请求信息。 添加Header参数“X-HW-ID”，参数值为“凭证信息”的“Key”。 添加Header参数“X-HW-AppKey”，参数值为“凭证信息”的“Secret”。
概述 ROMA API目前提供部分API接口信息。 ROMA实例接口信息请参考：《API参考》。 APIG实例接口信息请参考：《API参考》。
表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源，包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称，进入应用详情页面，查看应用ID、实例状态、集成应用、项目ID等。 权限管理
（可选）配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息，如网关内置参数、前端认证参数和后端认证参数等，可以通过设置系统参数来实现。ROMA API向后端服务发送请求时，将系统参数添加到请求的指定位置，然后将请求发送给后端服务。 在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。
选择需要发布的API，在页面右上角单击“发布”。 如需批量发布，单击“批量操作”，选择要发布的API，单击。 填写发布信息，单击“确定”，完成发布。 图1 填写发布信息 如需查看发布历史，单击“更多”，选择“发布历史”。 图2 查看发布历史 后续操作 API发布完成后，您可直接将API服务生成产品，或从API服务中挑选部分API组合生成产品。
使用场景 操作步骤 查看实例 查看实例详情，包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例，单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签，查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签，查看参数信息。 单击“负载通道”页签，查看通道信息。
表1 管理证书 相关任务 使用场景 操作步骤 查看证书 查看证书详情。 单击证书名称，查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书，单击所在行的“编辑”，即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删除的证
页面左侧展示凭证列表，页面右侧展示对应凭证信息以及通过该凭证订阅的产品信息。 单击“创建凭证”，填写凭证基本信息。 图1 填写基本信息 单击“确定”，创建完成。 凭证创建完成后，您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域，凭证“Key”和
在当前应用关联的实例中，根据实际业务选择实例，查看当前实例下包含的API，以及API基本信息。 单击API名称，查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作，可参见APIs管理。 父主题： API管理
根据下表相关任务，了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”，修改API信息，具体操作请参考创建API。 授权API 仅使用APP认证方式的API，才需要授权，发布API后，通过指定授权给某些应用，让指定应用能够调用API。
请。 已上架的产品修改产品信息后需要提交申请，审核通过后才能修改成功。 单击“确定”，并返回“API产品”页面。 查看申请 在左侧导航栏选择“API消费 > 审核管理”。 单击“我提交的申请”页签。 在已提交的申请所在行，单击“查看详情”，查看申请信息。 审核申请 仅支持拥有租户管理员权限者审批。
表1 管理自定义认证 相关任务 使用场景 操作步骤 查看自定义认证 查看自定义认证详情。 单击认证名称，查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证，单击所在行的“编辑”，即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到
在“版本列表”中选择同步版本。 在需要同步的API所在行，单击“同步”。 查看API 查看API产品下的API详情。 选择API所属产品，单击产品名称。 在“版本列表”中选择版本。 选择API，单击“查看API”，查看监控视图、前端配置和后端配置等信息。 移除 API产品不需要某个API时，可将API从
单击实例名称或实例卡片右上角的“查看控制台”。 单击“负载通道”页签。 单击“创建负载通道”。 根据下表参数说明，配置通道信息。 表1 负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称，根据规划自定义。建议您按照一定的命名规则填写负载通道名称，方便您快速识别和查找。 端口
-AppCode”，参数值为获取API的请求信息中获取到的AppCode。 双重认证 在API请求参数中增加自定义认证信息进行认证。 凭证认证 在API请求中添加Header参数“X-HW-ID”，获取API的请求信息中获取到凭证信息的Key。 在API请求中添加Header参数
API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“环境管理”页签。 单击“创建环境”。 根据下表参数说明，配置环境信息。 表1 环境参数说明 参数项 说明 环境名称 API环境名称。 描述 - 单击“确定”，创建完成。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
