检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
数据保护技术 安全通道:APIG支持HTTPs协议,保证网络传输安全,同时支持创建安全通道访问后端服务。 防重放、防篡改:APIG通过内部算法,从数据入口屏蔽恶意调用。 父主题: 安全
准备环境 已获取签名密钥的Key和Secret,请参见签名前准备获取。 已在API网关控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 请登录API网关控制台,参考《API网关用户指南》的“SDK”章节,进入SDK页面并下载SDK。或直接下载SDK的最新版本。 已安装Visual
AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 通过AK/SK获取的Token有效期最短为15分钟。 AK/SK既可以使用永久访问密钥中的AK/SK,也可以使用临时访问密钥中的AK/SK,但使用临时访问密钥的AK/SK时需要额外携带“X-Security
certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
global:全局证书 instance:实例证书 instance_id String 实例编码 type为global时,缺省为common type为instance时,为实例编码 project_id String 租户项目编号 common_name String 域名 san Array of
铂金版,并且对现有业务没有影响。 实例版本单价,请参考价格详情中的按需计费价格。 公网带宽 使用的公网入口和公网出口带宽大小。 购买时长 使用实例或公网带宽的时间长度,按小时计费,精确到秒。 购买个数 实例的个数。 假设您计划使用1个专业版实例,开启公网出口,公网带宽大小为5Mb
与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 应用流量限制 单个应用调用API次数上限,仅适用于API的安全认证方式为APP认证。 不超过“用户流量限制”。 与“时长”配合使用,表示单位时间内的单个应用请求次数上限。
类型 说明 api-limit 是 Number API访问次数限制 user-limit 否 Number 用户访问次数限制 app-limit 否 Number 应用访问次数限制 ip-limit 否 Number 源IP访问次数限制 interval 是 Number 流控策略时间周期
以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明
使用APIG的APP认证和自定义认证实现API的双重认证 方案概述 操作流程 实施步骤 父主题: API认证
Object API访问方法,参考表7 表7 method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https
Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上
String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis
使用APIG专享版的流量控制2.0策略实现API的精细流控 方案概述 操作流程 实施步骤 父主题: API策略
String 实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 父主题: 配置API策略
应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击“AppCode”页签,进入AppCode的管理界面。 单击“添加AppCode”,生成AppCode。可自动生成,也可手动输入。 使用AppCode进行API请求的简易认证 在创建API时,选择
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins
查询插件下绑定的API 功能介绍 查询指定插件下绑定的API信息。 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 绑定关系列表中返回的API在对应的环境中可能已经下线 调用方法 请参见如何调用API。 URI GET /v2/{project_