检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A
用于前端认证的函数后端或创建用于后端认证的函数后端。 身份来源 设置用于认证的请求参数。 当“类型”为“前端”，且“缓存时间”不为0时，必须设置此参数。使用缓存时，此参数将作为搜索条件来查询认证结果。 缓存时间 设置认证结果缓存的时间。 值为0时代表不缓存，最大支持3600秒。 是否发送body
API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 根据下表相关任务，了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务，开放给其他用户使用。
仅在“限制类型”为“IP地址”时，需要设置。 说明： 允许或禁止访问的IP地址条数，分别可以配置最多100条。 账号名 输入需要允许或者禁止访问API的IAM账号名。IAM账号名的获取方式参考获取账号名。 仅在“限制类型”为“账号名”时，需要设置。支持输入多个账户名，以英文“,”隔开，如aaa
基础版”。 时间窗 选择技术支持对实例进行维护的时间段，建议选择业务量较少的时间段，保持默认设置“22：00：00---02：00：00”。 企业项目 选择实例所属的企业项目，保持默认设置“default”。 公网入口 为简单起见，此处不开启。 公网出口 为简单起见，此处不开启。
负载通道（可选） 仅在使用负载通道时，需要设置。选择已创建的负载通道名称。 说明： VPC通道中，云服务器的安全组必须允许100.125.0.0/16网段访问，否则将导致健康检查失败及业务不通。 后端服务地址（可选） 仅在不使用负载通道时，需要设置。 格式：“主机:端口”，主机为IP地
企业联邦用户不能创建访问密钥，但可以创建临时访问凭证（临时AK/SK和SecuritityToken），具体内容请参见：临时访问密钥。 如果您是IAM用户，请在“安全设置>敏感操作>访问密钥保护”确认所属账号是否开启访问密钥保护。 访问密钥保护关闭时，所有IAM用户可以管理（包含创建、启用/停用或删除）自己的访问密钥。
单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后，单击“确定”。 查看日志分析可单击“日志字段说明”，根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下：
表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称，请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线，当前仅支持在官方提供的流水线中选择。当前提供
凭据策略用于API运行时的策略管理，支持配置APPCode、绑定应用配额策略和绑定访问控制策略，且只有管理员（IAM用户拥有“Tenant Administrator”权限）能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义H
行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端，输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量，保存文件并退出编辑器。
提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法，使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore
的能力。 HTTP响应头管理策略：可以自定义HTTP响应头，在返回的API响应中指定配置的响应头。 可见范围 当实例为ROMA类型时，支持设置当前应用可见或全局应用可见。 描述 填写策略的描述信息。 策略内容 策略的配置内容，支持表单配置和脚本配置两种方式。 根据不同的策略类型，策略内容的配置不同：
API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中，根据实际业务选择实例。 根据下表相关任务，了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略，或单击策略名称，进入策略详情。 单
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务，了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情，包括实例的基本信息、配置参数、负载通道和环境管理。
认证前准备 APP认证方式调用API，需要提前获取如下信息： 访问服务前，首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面，查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面，查看已发布的环境。
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了
什么是ROMA API ROMA API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关（即API管理）后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到H
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
