检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。 本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。 操作场景 API使用APP认证时,请根据需要下
非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“Method”为“OPTIONS”的API,作为预检请求。 预检请求API的参数设置,请参考以下说明填写。详细的使用指导可参考非简单请求。 在API的基本信息中,安全认证选“无认证”。 图3 预检请求-使用无认证 定义API请求时,参数填写说明如下:
详情请参考配置API的跨域资源共享。 在“前端定义”中,参数填写说明如下: 请求方法:选择“OPTIONS” 请求协议:选择与已开启CORS的API相同的请求协议 路径:填斜杠/ 图2 预检请求-定义API请求 在“安全配置”中,安全认证选“无认证”,勾选“开启支持跨域CORS”。
调用API示例 在工程中引入apig_sdk。 1 2 3 from apig_sdk import signer import requests import os 生成一个新的Signer,填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本示例
表1 编排规则配置 参数 说明 规则名称 填写编排规则的名称,根据规划自定义。 编排策略 选择编排策略。 list:列表中的值映射成另外的值。 range:范围中的值映射成另外的值。 hash:请求头的值经过哈希计算后直接映射为新的请求头。 hash_range:先用请求参数生成h
s/{instance_id}/throttles/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id
D,将授权账号ID添加至终端节点服务的白名单中。 单击“添加白名单记录”,填写账号ID。 授权账号ID:连接访问终端节点的授权账号ID。 创建时间:白名单的创建时间。 操作:对连接访问终端节点的授权账号进行操作,支持将授权账号从白名单中删除。 父主题: 管理APIG实例
例。 调用API示例 在工程中引入sdk(signer.go)。 import "apig-sdk/go/core" 生成一个新的Signer,输入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICL
API创建完成后,在“API运行”页签中,单击“发布最新版本”,发布API。 使用接口测试工具调用API。 本实践通过IP调用DEFAULT分组下的API,输入“wss://IP地址/hello”发送请求即可。其中,IP地址为APIG控制台“实例信息”中的弹性IP地址。 父主题: API开放
tances/{instance_id}/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id
API网关提供版本有:基础版、专业版、企业版、铂金版等,您可以根据实际业务需要购买。版本的产品规格说明,请参考产品规格。 版本实例包年/包月单价,请参考价格详情中的价格。 购买时长 使用API网关版本实例的时长,支持购买1~9个月,或者1~3年。 购买个数 使用实例的个数。 公网带宽 API请求出公网带宽,按实际使用的带宽大小和时长计费。
示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/throttles/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 流控策略编号 请求消息 表3 参数说明 参数 是否必选
创建自定义的前端函数,使用函数服务开发自定义认证。 创建自定义认证 创建自定义认证,类型选择“前端”,函数地址选择上一步创建的函数。 创建API 安全配置中的安全认证选择APP认证,并勾选“支持双重认证”,选择上一步创建的自定义认证。 创建凭据 使用APP认证的API,需要在API网关中创建一个
Override:覆盖 当API响应中存在指定的响应头时,使用当前响应头的值覆盖已有响应头的值。 当API响应中存在多个与指定响应头相同名称的响应头时,该操作只会按当前响应头的值返回一条响应头记录。 当API响应中不存在指定的响应头时,添加当前响应头。 Append:添加 当API响应中存在指定的响应
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号,可通过查询APP列表获取。 请求消息
API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问? API发布到不同环境后,会调用不同的后端服务吗? API调试的时候,如何指定环境?
js)示例 在工程中引入signer.js。 var signer = require('./signer') var https = require('https') 生成一个新的Signer,填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本示
APIG提供基于云监控服务CES的资源和操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看API网关各项监控指标。 关于APIG支持的监控指标,以及如何创建监控告警规则等内容,请参见API监控。 父主题: 安全
配置API认证凭据的配额控制 凭据配额策略用于限制客户端(API调用者)在某个时间周期内的API调用次数,支持自定义重置时间。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。
在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面,单击“创建策略”。 在“选择策略类型”弹窗中,选择“插件策略 > 流量镜像”。 在“创建策略”弹窗中,配置策略信息。 表1 流量镜像参数说明 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一