检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 使用APP认证调用API APP认证需要通过SDK访问。 使用IAM认证调用API 支持Token认证和AK/SK认证两种。 Token认证：通过Token认证调用请求。Token认证无需使用SDK签名，优先使用Token认证。
自定义认证 在API请求参数中携带认证信息进行认证。 无认证 无需认证，可直接调用API。 父主题： 调用API
步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful API。 步骤四：后端开发（可选） 支持一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力。
参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。 表2 实例配置参数说明 参数名 参数说明 ratelimit_api_limits API全局默认流控值。
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。
API列表 API列表支持查看当前实例下所有的API，包含URL、运行环境、安全认证信息。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。
在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。 表8 系统参数配置 数 配置说明 系统参数类型 选择系统参数的类型。 网关内置参数：ROMA API支持配置的参数。 前端认证参数：前端自定义认证返回结果中的参数。
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 如忽略问题，单击“继续导入”。 填写服务名称，或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API，单击“立即导入”。 （可选）单击“全局配置(可选)”。
认证层 提供AK/SK、Token方式进行应用的认证，授权后才可访问；支持系统级和API级的IP黑白名单，拒绝恶意访问。 审计层 支持LTS日志分析，可为追查异常调用和恢复业务操作提供客观依据。
IAM认证 支持Token认证或AK/SK认证。Explorer自动获取或临时生成Token或AK/SK。 无认证 填写API的Headers参数。 自定义认证 单击“调试结果”页签，查看调试结果。 父主题： API目录
访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。 单击“确定”，完成授权。
创建凭证 凭证代表用户认证标识，用户通过凭证来订阅上架的产品，订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。
通信失败、返回异常响应等错误 AUTHORIZER_FAILURE 500 自定义认证失败 自定义认证方返回认证失败 AUTHORIZER_IDENTITIES_FAILURE 401 自定义认证身份来源错误 前端自定义认证的身份来源信息缺失或不合法错误 AUTH_FAILURE
APP认证：填写APP认证所使用密钥对的Secret。 Basic Auth：填写basic认证所使用的密码。 Public Key：填写Public Key认证所使用的私钥。
26 auth_type API认证类型。 27 access_model1 认证模式1。 28 access_model2 认证模式2，开启双重认证时，为自定义认证编号。 29 inner_time apig的内部处理时长，单位秒。
添加AppCode 使用APP认证方式的API，支持通过AppCode进行API调用的简易安全认证。 绑定凭据配额策略 凭据配额用于限制凭据在某个时间周期内的API调用次数，支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户端IP地址，保护后端服务。
应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 步骤2：准备应用运行环境 更多 Ping不通 应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 更多 访问外网 应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 步骤2：准备应用运行环境 更多 操作系统相关
使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
