检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法，使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore
无认证：无需认证信息。 调用API 配置请求地址相关参数。 API调用场景 API请求参数配置 使用域名调用API ROMA API允许使用服务分配的子域名或服务绑定的域名调用API，无需另外配置。 使用IP调用API ROMA API的实例配置参数“app_route”已设置为“on”，允许通过IP访问API。
您可以进行以下操作： 规则集管理 启用规则集 根据业务需求选择适用于API设计文件规范性检查的规则集。 创建规则集 根据业务需求创建规则集。 设置无需检查的接口 设置无需规范性检查的接口。 配置扩展字段 支持统一自定义扩展字段，指定显示区域，字段名必须以“x-”开头。 启用规则集 登录ROMA
页面的最左侧展示产品下的API，中间可配置API请求参数，最右侧支持查看调试结果和API文档。 （可选）单击“文档”页签，查看API文档信息。 根据已设置认证方式，编辑请求参数，单击“调试”。 表1 请求参数说明 认证方式 Headers Parameters Body APP认证 说明：
参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。 表2 实例配置参数说明 参数名 参数说明 ratelimit_api_limits
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A
后端：对后端服务的访问授权。 函数地址 选择用于前端自定义认证或后端自定义认证的函数后端，且创建的函数请求方法为“POST”。如需创建自定义后端，请参考创建用于前端认证的函数后端或创建用于后端认证的函数后端。 身份来源 设置用于认证的请求参数。 当“类型”为“前端”，且“缓存时间”不为0时，必须设置此参数。
API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务，了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源，包含应用信息、实例信息、调用密钥、APPCode等。
企业联邦用户不能创建访问密钥，但可以创建临时访问凭证（临时AK/SK和SecuritityToken），具体内容请参见：临时访问密钥。 如果您是IAM用户，请在“安全设置>敏感操作>访问密钥保护”确认所属账号是否开启访问密钥保护。 访问密钥保护关闭时，所有IAM用户可以管理（包含创建、启用/停用或删除）自己的访问密钥。
“日志组”和“日志流”设置完成后，单击“确定”。 查看日志分析可单击“日志字段说明”，根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下： 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id
发送API请求时，需要将当前时间置于请求消息头的X-Sdk-Date，将签名信息置于请求消息头的Authorization。 客户端须注意本地时间与时钟服务器的同步，避免请求消息头X-Sdk-Date的值出现较大误差。 ROMA API除了校验时间格式外，还会校验该时间值与ROMA API收到请
表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称，请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线，当前仅支持在官方提供的流水线中选择。当前提供
在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务，了解如何管理API产品。 表1 管理产品 相关任务 使用场景 操作步骤 创建新版本 创建产品新版本，同步产品基本信息，可自行添加API。 单击需要创建新版本的产品名称。
已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务，了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情，包括实例的基本信息、配置参数、负载通道和环境管理。
层保障您的后端安全。 接入层 基于HTTPS访问，保证网络传输安全；从数据入口屏蔽恶意调用，防重放、防篡改；从APP、API、IP等多维度设置的流控策略进行保护。 认证层 提供AK/SK、Token方式进行应用的认证，授权后才可访问；支持系统级和API级的IP黑白名单，拒绝恶意访问。
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中，根据实际业务选择实例。 根据下表相关任务，了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略，或单击策略名称，进入策略详情。 单
requestId 当次API调用生成请求ID $context.stage API调用的部署环境 $context.sourceIp API消费者的源地址 $context.authorizer.frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值
凭据策略用于API运行时的策略管理，支持配置APPCode、绑定应用配额策略和绑定访问控制策略，且只有管理员（IAM用户拥有“Tenant Administrator”权限）能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义H
行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端，输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量，保存文件并退出编辑器。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
