检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API服务 创建API 创建API策略 OBS 2.0支持API消费 主要介绍API管理者如何将API服务转换为产品,上架到API目录供API消费者查看和使用。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API产品 上架API目录 订阅API产品
在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后,单击“确定”。 查看日志分析可单击“日志字段说明”,根据日志字段说明分析日志。
API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 单击页面右上角的“创建API服务 > 创建API服务”。 在弹框中填写服务信息。 图1 填写服务信息 单击“确定”创建完成。 创建服务成功后,用户可新建API,具体操作请参考创建API。 导入API设计文件 登录ROMA API控制台。
使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签,查看参数信息。 单击“负载通道”页签,查看通道信息。
表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称,进入应用详情页面,查看应用ID、实例状态、集成应用、项目ID等。 权限管理
boot的服务器,作为API的后端,并且实现一个Filter,对API网关(即API管理)的请求做签名校验。 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 编写一个Controller,匹配所有路径和方法,返回体为“Hello World!”。 1 2 3 4 5 6 7 8
在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作,可参见APIs管理。 父主题: API管理
计算签名时,URI必须以“/”结尾。发送请求时,可以不以“/”结尾。 添加规范查询字符串(CanonicalQueryString),以换行符结束。 释义: 查询字符串,即查询参数。如果没有查询参数,则为空字符串,即规范后的请求为空行。 格式: 规范查询字符串需要满足以下要求: 根据以下规则对每个参数名和值进行URI编码:
APP认证方式调用API,需要提前获取如下信息: 访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。 图2
请。 已上架的产品修改产品信息后需要提交申请,审核通过后才能修改成功。 单击“确定”,并返回“API产品”页面。 查看申请 在左侧导航栏选择“API消费 > 审核管理”。 单击“我提交的申请”页签。 在已提交的申请所在行,单击“查看详情”,查看申请信息。 审核申请 仅支持拥有租户管理员权限者审批。
表1 管理自定义认证 相关任务 使用场景 操作步骤 查看自定义认证 查看自定义认证详情。 单击认证名称,查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到
API指标”。 在当前应用关联的实例中,根据实际业务选择实例。 单击服务名称,进入到API服务信息页面。 单击“API运行”页签。 在页面左侧选择API。 在“监控视图”区域,查看API的各项监控指标。 查看API服务的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
在“版本列表”中选择同步版本。 在需要同步的API所在行,单击“同步”。 查看API 查看API产品下的API详情。 选择API所属产品,单击产品名称。 在“版本列表”中选择版本。 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。 移除 API产品不需要某个API时,可将API从
选择需要发布的API,在页面右上角单击“发布”。 如需批量发布,单击“批量操作”,选择要发布的API,单击。 填写发布信息,单击“确定”,完成发布。 图1 填写发布信息 如需查看发布历史,单击“更多”,选择“发布历史”。 图2 查看发布历史 后续操作 API发布完成后,您可直接将API服务生成产品,或从API服务中挑选部分API组合生成产品。
根据下表相关任务,了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”,修改API信息,具体操作请参考创建API。 授权API 仅使用APP认证方式的API,才需要授权,发布API后,通过指定授权给某些应用,让指定应用能够调用API。
签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批产品信息。 仅支持拥有租户管理员权限者审批。 图2 审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。
在当前应用关联的实例中,根据实际业务选择实例。 单击“自定义认证”页签。 在自定义认证页面,单击“创建自定义认证”。 在创建自定义认证弹框中,根据下表填写参数信息。 表1 自定义认证参数 信息项 描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。
API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。 查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”,进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”,可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史
盖。 如需查看已启用规则,可单击规则集名称。 (可选)查看规则集详情,包含已启用规则和未启用规则,可单击“管理”或“查看”。 管理:自己创建的规则集支持查看和编辑。 查看:其他用户创建的规则集仅支持查看。 通过“问题级别”和“规则类型”选择性查看。 单击规则名称,可查看规则的“正确示例”和“错误示例”。
API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“环境管理”页签。 单击“创建环境”。 根据下表参数说明,配置环境信息。 表1 环境参数说明 参数项 说明 环境名称 API环境名称。 描述 - 单击“确定”,创建完成。