检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
Connect开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API服务 API服务是同一种业务API的集合，API开发者以API服务为单位，管理服务内的所有API。 API产品 API产品是从服务中挑选想要共享的API组合而成，即为将要上架的API的集合。 API目录 API目
ROMA API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。 表1 产品功能 功能 说明
API产品是从服务中挑选想要共享的API组合而成，即为将要上架的API的集合。 新建API产品 创建新的API产品。 添加API到产品 为已创建的API产品添加API。 新建API产品 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本，列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表，您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
访问服务前，首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面，查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面，查看已发布的环境。 图2 运行环境信息 对于APP认证的API，您
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
不论“default（默认）”或是您自定义的网关响应，响应类型范围固定不可修改。您可以修改每种响应的状态码，以及响应内容。 响应内容的错误信息以及其他信息，可通过变量的方式获取，支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。
API网关收到请求后，执行1~3，计算签名。 将3中的生成的签名与5中生成的签名进行比较，如果签名匹配，则处理请求，否则将拒绝请求。 APP签名仅支持Body体12M及以下的请求签名。 步骤1：构造规范请求 使用APP方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与API网关使用相同的请求规范，可以
API中管理员以及IAM用户创建的应用是隔离的，无法互相访问。如果用户想分配权限给不同的IAM用户，需要手动在应用管理内的权限管理进行分配，或在IAM中给用户添加Tenant Administrator权限。 除应用外，IAM用户也需拥有应用关联资源的权限才可进行对应操作，具体可参考：
APP认证：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 Public Key：填写public_key认证所使用的公钥。 Secret 根据选择的密钥类型，填写不同的密钥信息。 APP认证：填写APP认证所使用密钥对的Secret。 Basic
ROMA API是API全生命周期治理经验的产品，如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题，提供了规范化的产品跟工具支撑，帮助企业快速实现API经济，并持续构建高质量的API服务能力。 图1 API全生命周期
统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统，API的管理者可将API包装成产品上架到API目录中
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
单击“日志分析”页签，查看调用日志信息。 编辑实例 支持编辑实例的基本信息、参数、通道和环境。 找到需要编辑的实例，单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签，然后单击可编辑对应参数信息。 单击“配置参数”页签，然后单击对应参数所在行的“编辑”，即可编辑参数信息。 单击“负载通
支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”，即可编辑应用信息。 删除应用 已创建的应用不再提供服务，可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”，即可删除应用信息。 更新应用 刷新全局应用信息。
创建凭证 凭证代表用户认证标识，用户通过凭证来订阅上架的产品，订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
域名，ROMA API对调试域名的访问次数做了限制，每天最多可以访问1000次。 独立域名：您自定义的域名，API调用者通过访问独立域名来调用您开放的API。 前提条件 已备案独立域名，未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上，具体方法请参考增加A类型记录集。
访问控制策略信息 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址：允许/禁止访问API的IP地址。 账号名：允许/禁止访问API的账号名。 动作 包括允许和禁止。 和“限制类型”配合使用，允许/禁止访问API的IP地址/账号名。 IP地址 单击“增加IP
curl 操作场景 使用curl命令调用APP认证的API时，您需要先下载JavaScript SDK生成curl命令，然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。 调用API示例
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
