检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
根据下表参数信息,配置前端定义。 表1 前端定义参数 信息项 描述 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 URL 前端地址由请求方法、请求协议、子域名和路径组成。
建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。
创建新策略:请参考表1所示输入信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“APP认证”、“Basic Auth”或“Public Key”。
页面左侧展示凭证列表,页面右侧展示对应凭证信息以及通过该凭证订阅的产品信息。 单击“创建凭证”,填写凭证基本信息。 图1 填写基本信息 单击“确定”,创建完成。 凭证创建完成后,您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。
在弹窗中设置授权信息。 选择授权应用。 设置访问参数。 选择是否开启绿色通道。 说明: 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后,需要设置白名单和黑名单。
单击“创建策略”,配置策略信息。 插件策略请参考下表配置: 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。
概述 ROMA API目前提供部分API接口信息。 ROMA实例接口信息请参考:《API参考》。 APIG实例接口信息请参考:《API参考》。
编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到需要删除的自定义认证,单击所在行的“删除”,即可删除自定义认证。 更新自定义认证 刷新自定义认证信息。
编辑 修改产品基本信息。 在API产品所在行,单击“编辑”。 修改产品信息后,单击“完成编辑”。 如果产品已上架,那么需要提交修改申请。 填写申请描述后,单击“确定”。 审核申请通过后,产品信息编辑成功。 删除 API产品不再提供服务,且产品已下架,可以将API产品删除。
在审核详情页面查看产品基本信息和审核内容。 确认产品信息无误后,在“审核结果”处选择“通过”并填写反馈建议。 若产品信息不正确,在“审核结果”处选择“驳回”并填写反馈建议。 单击“确定”,审核完成。 父主题: API消费
API列表 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证信息。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。
根据下表参数说明,配置通道信息。 表1 负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。
单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”,即可删除应用信息。 更新应用 刷新全局应用信息。 在页面右上角单击刷新应用列表。 父主题: 应用管理
凭证认证 在API请求中添加Header参数“X-HW-ID”,获取API的请求信息中获取到凭证信息的Key。 在API请求中添加Header参数“X-HW-AppKey”,获取API的请求信息中获取到凭证信息的Secret。
包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书,单击所在行的“编辑”,即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删除的证书,单击所在行的“删除”,即可删除证书。 父主题: SSL证书管理
已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如果您需要把API发布到其他环境,请提前创建环境。 操作步骤 登录ROMA API控制台。
后端配置 表2 后端参数配置 参数 配置说明 后端名称 填写后端的名称,建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。 归属项目 在创建应用时需要关联项目,默认步骤二中关联项目。 新建代码仓 填写代码仓的名称。
丰富的API运营分析 支持详细的API调用分析和告警设置,识别系统可能存在的潜在风险,并借助离线日志分析,完成精细化的运营报表呈现,让您快速洞察API业务演进。
表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。
根据下表参数说明,配置环境信息。 表1 环境参数说明 参数项 说明 环境名称 API环境名称。 描述 - 单击“确定”,创建完成。 父主题: 实例管理