检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Description 项目描述。 单击“创建”,页面自动跳转到“后端总览”,支持查看后端“基本信息”、“代码仓库”和“流水线”信息。 后端创建完成后,您可以在“代码仓库”中: 单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发
authroization failed."); } 运行服务器,验证代码正确性。下面示例使用JavaScript SDK中的html签名工具生成签名。 填入如图所示字段后,单击“Send request”,复制生成的curl命令,并在命令行中执行,服务器返回“Hello World!”。 如果使
(可选)Mock调测。 开启“Mock”会自动生成Mock服务地址,您可以在可视化窗口对接口地址进行调测。 (可选)规范性检查。 在规范性检查之前,您需提前启用规则集或创建规则集。在编辑窗口上方单击“规范性检查”,检查结果在可视化视图窗口查看,您可以根据修改建议修改规范性问题。 图1 规范性检查结果
访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。
在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后,单击“确定”。 查看日志分析可单击“日志字段说明”,根据日志字段说明分析日志。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
> 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“配置参数”页签。 在“配置参数”页面,找到需要配置的参数,单击“编辑”。 根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值
配置说明 动作 选择访问控制的动作。 允许:表示仅允许指定IP地址的客户端调用API。 禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后,单击“确定”。 绑定API 登录ROMA
签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批产品信息。 仅支持拥有租户管理员权限者审批。 图2 审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。
表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称,进入应用详情页面,查看应用ID、实例状态、集成应用、项目ID等。 权限管理
描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。 函数地址 选择用于前端自定义认证或后端自定义认证的函数后端,且创建的函数请求方法为“POST”。如需创建自定义后端,请参考创建用于前端认证的函数后端或创建用于后端认证的函数后端。
计算签名时,URI必须以“/”结尾。发送请求时,可以不以“/”结尾。 添加规范查询字符串(CanonicalQueryString),以换行符结束。 释义: 查询字符串,即查询参数。如果没有查询参数,则为空字符串,即规范后的请求为空行。 格式: 规范查询字符串需要满足以下要求: 根据以下规则对每个参数名和值进行URI编码:
相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签,查看参数信息。 单击“负载通道”页签,查看通道信息。
API概念,提供的能力,以及操作指引。 您可以根据不同角色查看行为路径,或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者,敬请期待。 API治理专家,敬请期待。 目前仅初级使用者和中级使用者支持“查看指引”。
单击“确定”,克隆完成。 在已克隆版本中可查看、添加或移除API,以及上架克隆版本。 同步 API服务变更后,需要手动同步信息到产品。 选择变更API服务所属产品,单击产品名称。 在“版本列表”中选择同步版本。 在需要同步的API所在行,单击“同步”。 查看API 查看API产品下的API详情。
在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作,可参见APIs管理。 父主题: API管理
实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
取用于调用API的SDK。 自定义认证:向API管理者获取请求参数中要携带的自定义认证信息。 无认证:无需认证信息。 调用API 配置请求地址相关参数。 API调用场景 API请求参数配置 使用域名调用API ROMA API允许使用服务分配的子域名或服务绑定的域名调用API,无需另外配置。
如需批量发布,单击“批量操作”,选择要发布的API,单击。 填写发布信息,单击“确定”,完成发布。 图1 填写发布信息 如需查看发布历史,单击“更多”,选择“发布历史”。 图2 查看发布历史 后续操作 API发布完成后,您可直接将API服务生成产品,或从API服务中挑选部分API组合生成产品。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“环境管理”页签。 单击“创建环境”。 根据下表参数说明,配置环境信息。 表1 环境参数说明 参数项 说明 环境名称 API环境名称。