检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可用区3”。 实例名称 填写实例的名称,此处填写“apig-test”。 实例规格 选择实例的规格,此处选择“基础版”。 可维护时间窗 指定可对实例进行维护的时间段,此处默认。 企业项目 选择实例所属的企业项目,此处选择“default”。 网络 选择已准备的VPC和子网。 公网入口
集。 如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前准备SSL证书。此证书不支持导入,您需要填写证书的名称、内容和密钥。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“域名管理”页签。
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全; // 本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK
添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“SSL证书管理”页面,单击“创建SSL证书”。 表1 SSL证书配置 参数 配置说明 证书名称 填写
说明: 目前仅上海一、乌兰察布一、贵阳一、北京四、华东二、利雅得、香港区域支持选择更多铂金版规格。 可维护时间窗 指允许云服务技术支持对实例进行维护的时间段。如果有维护需要,技术支持会提前与您沟通确认。 建议选择业务量较少的时间段。 企业项目 使用企业用户登录时,可选择实例所属企业项目。
Identity and Access Management,简称IAM),通过IAM,您可以: 根据企业的业务组织,在您的华为云账号中,给企业中不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证,并使用API网关服务资源。 根据企业用户的职能,设置不同的访问权限,以达到用户之间的权限隔离。
自定义认证 向API提供者获取请求参数中要携带的自定义认证信息。 无认证 无需认证信息。 获取应用的AppKey和AppSecret: 在API网关共享版控制台选择“调用API > 应用管理”,在应用列表中单击API所授权应用的名称,进入应用详情页面,获取应用的AppKey和AppSecret。
String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 response_id 是 String 响应编号 请求参数 表2 请求Header参数
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问示意图 浏览器将CORS请求分为两类: 简单请求
跨域调用APIG开放的API 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类:
创建跨域资源共享策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面,单击“创建策略”。 在“选择策略类型”弹窗中,选择“插件策略 > 跨域资源共享”。 在“创建策略”弹窗中,配置策略信息。 表1 跨域资源共享策略配置
操作流程 配置API前端 在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证(APP认证或IAM认证),并选择指定的自定义认证对象,如果没有,则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参
String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 response_id 是 String 响应编号 response_type 是 String
只需要将API发布到对应的环境中即可。 调试API。 在“API运行”页签中,单击“调试”,进入调试页面。再次单击“调试”,响应结果中返回状态码“200”,表示调试成功,执行下一步。否则,请参考错误码章节处理。 发布API。 在“API运行”页签中,单击“发布最新版本”,默认选择
签名前准备 获取签名密钥信息: 在APIG实例控制台选择“API管理 > API策略 > 策略管理”,单击签名密钥名称进入详情页面,在“策略内容”区域查看Key和Secret。 父主题: 对后端服务进行签名
API网关共享版是否可以升级到专享版? 暂不支持一键升级,但可以平滑迁移,您可以参考以下方案: 新购买专享版实例。 导出共享版中的API。 将API导入到专享版。 重新绑定域名,并修改DNS解析记录至专享版实例的公网访问入口。 父主题: 产品咨询
路径:后端服务的路径。此处填写“/”。 单击“完成”。 在“API运行”页面中,API的URL不显示调用方法以及协议,仅显示域名跟路径部分。当发送gRPC请求时,填入域名部分即可。 发布API 在“API运行”页面,选择已创建的API,单击“发布最新版本”。 选择API的发布环境,并填写发布说明。
流量控制”,进入到流量控制信息页面。 通过以下任意一种方式,弹出“删除流控策略”对话框。 在待删除的流控策略所在行,单击“删除”。 单击待删除的策略名称,进入流量控制详情页面,在右上角单击“删除”。 仅在流控策略未绑定任何API时,支持删除,否则请先解绑API。在流量控制详情页面,单击待解绑API所在行的“解除”。
导入方式包含以下2种: 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。 选择已有分组:将API定义导入到一个已有的分组,导入过程中不会删除分组中已有的API,只是将新增的API导入分组。 API分组 仅在选择“选择已有分组”时,需要选择API分组。