检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
您可以进行以下操作： 规则集管理 启用规则集 根据业务需求选择适用于API设计文件规范性检查的规则集。 创建规则集 根据业务需求创建规则集。 设置无需检查的接口 设置无需规范性检查的接口。 配置扩展字段 支持统一自定义扩展字段，指定显示区域，字段名必须以“x-”开头。 启用规则集 登录ROMA
页面的最左侧展示产品下的API，中间可配置API请求参数，最右侧支持查看调试结果和API文档。 （可选）单击“文档”页签，查看API文档信息。 根据已设置认证方式，编辑请求参数，单击“调试”。 表1 请求参数说明 认证方式 Headers Parameters Body APP认证 说明：
> 授权”。 在弹窗中设置授权信息。 选择授权应用。 设置访问参数。 选择是否开启绿色通道。 说明： 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单
API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务，了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源，包含应用信息、实例信息、调用密钥、APPCode等。
curl 操作场景 使用curl命令调用APP认证的API时，您需要先下载JavaScript SDK生成curl命令，然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。 调用API示例
最大长度/最大值：“类型”为“STRING”时，设置参数值的最大字符串长度，“类型”为“NUMBER”时，设置参数值的最大值。 最小长度/最小值：“类型”为“STRING”时，设置参数值的最小字符串长度，“类型”为“NUMBER”时，设置参数值的最小值。 示例 参数值的填写示例。 描述
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A
用于前端认证的函数后端或创建用于后端认证的函数后端。 身份来源 设置用于认证的请求参数。 当“类型”为“前端”，且“缓存时间”不为0时，必须设置此参数。使用缓存时，此参数将作为搜索条件来查询认证结果。 缓存时间 设置认证结果缓存的时间。 值为0时代表不缓存，最大支持3600秒。 是否发送body
全自动化设计规范检测 从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约，自动生成API
API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 根据下表相关任务，了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务，开放给其他用户使用。
ey”已设置为“on”，开启app_api_key认证。 在API请求中添加Header或Query参数“apikey”，参数值为获取API的请求信息中获取到的Key或AppKey。 app_secret认证 ROMA API的实例配置参数“app_secret”已设置为“on”
已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务，了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情，包括实例的基本信息、配置参数、负载通道和环境管理。
Token认证 操作场景 当您使用Token认证方式调用API时，需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证调用请求。 AK/SK认证：通过AK（Access
凭据策略用于API运行时的策略管理，支持配置APPCode、绑定凭据配额策略和绑定访问控制策略，且只有管理员（IAM用户拥有“Tenant Administrator”权限）能设置。 凭据策略分三种类型：集成凭据、订阅凭据和客户凭据（集成凭据由ROMA实例下的集成应用同步创建；订阅凭据通过订阅产品后，在产品所属实例下
在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务，了解如何管理API产品。 表1 管理产品 相关任务 使用场景 操作步骤 创建新版本 创建产品新版本，同步产品基本信息，可自行添加API。 单击需要创建新版本的产品名称。
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。 表2 实例配置参数说明 参数名 参数说明 ratelimit_api_limits
新建一个HttpRequest对象，将请求method、url、query、signedHeaders对应的请求头放入其中。判断是否需要设置body并设置。 需要读取body的条件为：不存在值为UNSIGNED-PAYLOAD的x-sdk-content-sha256头。 1 2
新建一个HttpRequest对象，将请求method、url、query、signedHeaders对应的请求头放入其中。判断是否需要设置body并设置。 需要读取body的条件为：不存在值为UNSIGNED-PAYLOAD的x-sdk-content-sha256头。 1 2
的安全保护。 支持区域：华北-北京一、华北-北京四、华东-上海一、华南-广州 如何创建虚拟私有云？ VPC服务介绍【视频】 VPC服务介绍【视频】 OBS 2.0支持API设计 主要介绍API设计者如何设计API文件。在API设计和变更阶段指导设计者遵从API格式规范，提升企业API的交付质量。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
