检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
已获取apigateway-backend-signature-demo。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ IDEA官方网站下载。 已安装Java Development Kit 1.8.111或以上版本,如果未安装,请至Oracle官方下载页面下载。 导入工程
E 400 请求参数错误 请求参数校验失败、不支持的HTTP方法 THROTTLED 429 调用次数超出阈值 API调用次数超出所配置的流量策略阈值 UNAUTHORIZED 401 应用未授权 使用的应用未被授权访问该API API运行时可获取变量 表2 网关错误响应消息体支持的变量
须知: 认证方式为华为IAM认证时,任何ROMA API租户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 认证方式为无认证时,任何公网用户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 认证方式为自定义认证时,需要在函数服务中写一段函数,对接用户自己的认
SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。
相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签,查看参数信息。 单击“负载通道”页签,查看通道信息。
在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作,可参见APIs管理。 父主题: API管理
表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称,进入应用详情页面,查看应用ID、实例状态、集成应用、项目ID等。 权限管理
DK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java huaweicloud-sdk-java-v3
访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。 图2 运行环境信息 对于APP认证的API,您必须提供
上架目录 将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
API实现 创建后端 API管理 创建API服务 绑定域名 创建API 授权API 跨域资源共享策略 HTTP响应头管理策略 自定义认证 流量控制 访问控制 签名密钥 API消费 创建API产品 上架目录 订阅API产品 创建凭证 审核管理 调用已发布的API API分析 日志分析
计算签名时,URI必须以“/”结尾。发送请求时,可以不以“/”结尾。 添加规范查询字符串(CanonicalQueryString),以换行符结束。 释义: 查询字符串,即查询参数。如果没有查询参数,则为空字符串,即规范后的请求为空行。 格式: 规范查询字符串需要满足以下要求: 根据以下规则对每个参数名和值进行URI编码:
订阅API产品 API目录相当于一个资产中心,以产品的形式将API资源上架到API目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。
签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批产品信息。 仅支持拥有租户管理员权限者审批。 图2 审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。
单击“确定”,并返回“API产品”页面。 查看申请 在左侧导航栏选择“API消费 > 审核管理”。 单击“我提交的申请”页签。 在已提交的申请所在行,单击“查看详情”,查看申请信息。 审核申请 仅支持拥有租户管理员权限者审批。 单击“我审核的申请”页签。 在待审核申请所在行,单击“查看详情”。 在审核详情页面查看产品基本信息和审核内容。
API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。 查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”,进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”,可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史
盖。 如需查看已启用规则,可单击规则集名称。 (可选)查看规则集详情,包含已启用规则和未启用规则,可单击“管理”或“查看”。 管理:自己创建的规则集支持查看和编辑。 查看:其他用户创建的规则集仅支持查看。 通过“问题级别”和“规则类型”选择性查看。 单击规则名称,可查看规则的“正确示例”和“错误示例”。
单击“Explorer”页签,选择版本号进入。 页面的最左侧展示产品下的API,中间可配置API请求参数,最右侧支持查看调试结果和API文档。 (可选)单击“文档”页签,查看API文档信息。 根据已设置认证方式,编辑请求参数,单击“调试”。 表1 请求参数说明 认证方式 Headers
单击“SSL证书管理”页签。 在“SSL证书管理”页面,可执行下表操作。 表1 管理证书 相关任务 使用场景 操作步骤 查看证书 查看证书详情。 单击证书名称,查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书,单击所在行的“编辑”,即可修改证书信息。