检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题： 管理中心
API目录 订阅API产品 创建凭证 通过Explorer调试API 父主题： API消费
应用管理 创建应用 管理应用 父主题： 管理中心
调用API 调用已发布的API 配置跨域访问API 错误码 父主题： API消费
API实现 创建后端
策略管理 创建API策略 跨域资源共享策略 HTTP响应头管理策略 管理API策略 父主题： API管理
对后端服务进行签名 Java Python C#
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
信息项 描述 安全认证 API认证方式： APP认证：表示由ROMA API服务负责接口请求的安全认证。 华为IAM认证：表示借助IAM服务进行安全认证。 自定义认证：用户有自己的认证系统或服务（如使用OAuth认证），可选择“自定义认证”。 无认证：表示不需要认证。 推荐使用APP认证方式。
API列表 API列表支持查看当前实例下所有的API，包含URL、运行环境、安全认证信息。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。 在当前应用关联的实例中，根据实
“后端开发”为您提供业界主流框架代码初始化能力，提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力，使后端开发无需从零开始。后端开发流程如下图所示： 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念，每一个后端都具有自主运行的业务功能。同时，后端支持框架代码的查看、删除，以及源码包的下载功能。
起上架/不推荐/下架/订阅请求时，IAM用户（其他管理者）都可以参与到评审中，让更多用户参与到API产品审视中，以确保产品的正确性。 审核流程： 提交申请 查看申请 审核申请 提交申请 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
//签名校验代码 ... } } } OnAuthorization函数为签名校验代码。校验流程如下：使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7
则返回认证失败。 1 2 3 if signingKey not in secrets: return 'Signing key not found.', 401 signingSecret = secrets[signingKey] 新建一个HttpRequest对象，将请
expired."); return; } 将Authorization头也放入Request对象中，调用verify方法校验请求签名。如果校验通过，则执行下一个filter，否则返回认证失败。 1 2 3 4 5 6 7 DefaultSigner signer = (DefaultSigner)
如果API已定义formData类型参数，将不展示Body参数，且暂不支持调试。 IAM认证 支持Token认证或AK/SK认证。Explorer自动获取或临时生成Token或AK/SK。 无认证 填写API的Headers参数。 自定义认证 单击“调试结果”页签，查看调试结果。 父主题： API目录
选择是否开启绿色通道。 说明： 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。 单击“确定”，完成授权。
500 自定义认证配置错误 自定义认证方异常，通信失败、返回异常响应等错误 AUTHORIZER_FAILURE 500 自定义认证失败 自定义认证方返回认证失败 AUTHORIZER_IDENTITIES_FAILURE 401 自定义认证身份来源错误 前端自定义认证的身份来源信息缺失或不合法错误
创建凭证 凭证代表用户认证标识，用户通过凭证来订阅上架的产品，订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
的调用认证。 app_secret app_secret认证方式开关。启用后，可在API请求中添加“X-HW-ID”和“X-HW-AppKey”参数，携带的Key和Secret（或客户端的AppKey和AppSecret）进行API的调用认证。 使用app_secret认证时，需
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
