CorsPluginContent 表1 CorsPluginContent 参数 是否必选 参数类型 描述 allow_origin 是 String Access-Control-Allow-Origin头,该字段必填,允许访问该资源的外域URI。对于不需要携带身份凭证的请求,
ProxyCacheContent 表1 ProxyCacheContent 参数 是否必选 参数类型 描述 cache_key 否 PluginProxyCacheKey object 根据配置参数作为响应缓存键值,cache_key为必填项,因此三个参数system_params
ProxyMirrorContent 表1 ProxyMirrorContent 参数 是否必选 参数类型 描述 protocol 是 String 镜像请求协议。 host 是 String 镜像服务的地址,由IP或域名和端口号组成,总长度不超过255。格式为主机:端口(如:xxx.xxx.xxx
跨域调用APIG开放的API 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件
查看或编辑APIG的API信息 API列表支持查看或编辑当前实例下所有的API,查看或编辑API的运行环境、请求方法、请求路径等信息。 查看或编辑API信息 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”,您可以查看或编辑当前实例下的所有
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。 操作步骤 进入API网关控制台页面。
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
AK/SK认证 使用AK(Access Key ID)、SK(Secret Access Key)对请求进行签名。 AK:访问密钥ID。与私有访问密钥关联的唯一标识符,访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK:与访问密钥ID结合使用的密钥,对请求进行加密签名,
如何通过APIG访问公网后端服务? 通过开启公网入口访问,允许外部服务调用API。 如果您在调用API遇到网络问题,请参考调用API失败的可能原因。 父主题: 调用API
对API的修改是否需要重新发布? 需要。 API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。 关于API重新发布的详细指导,请参考发布API。 父主题: 发布API
API签名认证的内容是否包括Body体? 包括。除了几个必选的请求头部参数,Body体也是签名要素之一。例如有一个使用POST方法上传文件的API,那么在签名过程中,会取这个文件的hash值,参与生成签名信息。 关于签名的详细指导,可参考:签名认证算法详解。 父主题: API认证
API管理 对象模型 创建API 修改API 删除API 发布API 下线API 批量发布或下线API 查看API详情 查询API列表 查询API历史版本列表 根据版本编号下线API 查看版本详情 查询API运行时定义 调试API 父主题: 共享版API(仅存量用户使用)
环境管理 对象模型 创建环境 修改环境 删除环境 查询环境列表 父主题: 共享版API(仅存量用户使用)
配置管理 对象模型 查询租户配置详情 父主题: 共享版API(仅存量用户使用)
域名管理 对象模型 绑定域名 解绑域名 绑定域名证书 删除域名证书 查看域名证书 父主题: 共享版API(仅存量用户使用)
BreakerContent 表1 BreakerContent 参数 是否必选 参数类型 描述 scope 否 String 断路器策略的类型。支持的取值: basic:基础,表示绑定到断路器插件的每个API各自计算断路器策略 share:共享,表示绑定到断路器插件的所有API共享断路器策略
SetRespHeadersContent 表1 SetRespHeadersContent 参数 是否必选 参数类型 描述 response_headers 否 Array of HeaderPolicy objects 响应标头信息。 表2 HeaderPolicy 参数 是否必选
监控 支持的监控指标 创建告警规则 查看监控指标 父主题: 共享版操作指导(仅存量用户使用)