配置管理 对象模型 查询租户配置详情 父主题: 共享版API(仅存量用户使用)
域名管理 对象模型 绑定域名 解绑域名 绑定域名证书 删除域名证书 查看域名证书 父主题: 共享版API(仅存量用户使用)
BreakerContent 表1 BreakerContent 参数 是否必选 参数类型 描述 scope 否 String 断路器策略的类型。支持的取值: basic:基础,表示绑定到断路器插件的每个API各自计算断路器策略 share:共享,表示绑定到断路器插件的所有API共享断路器策略
SetRespHeadersContent 表1 SetRespHeadersContent 参数 是否必选 参数类型 描述 response_headers 否 Array of HeaderPolicy objects 响应标头信息。 表2 HeaderPolicy 参数 是否必选
APIG是否支持多后端节点方案? 支持。 通过VPC通道(负载通道)支持多后端节点,一个VPC通道中可以添加多个云服务器。 关于VPC通道(负载通道)的详细操作,请参考负载通道。 父主题: 开放API
使用iOS系统时,如何使用APP认证调用API? 目前API网关为APP认证提供了Java、Python、C、PHP、Go等多种语言的SDK与demo。 当您使用iOS系统(Objective-C语言)或者其他未包含在内的语言时,请参考APP认证工作原理的指导进行APP认证。 父主题
APIG是否支持WebSocket数据传输? API网关支持WebSocket数据传输。 在创建API时,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 父主题: 调用API
调用API报“The API does not exist or has not been published in the environment” 调用API网关中开放的API报错,请按以下顺序排查可能原因: 调用API所使用的域名、请求方法、路径不正确。 比如创建的API为POST
是否支持对API的请求并发次数做控制? 不支持。 流控策略只控制单位时间内调用次数,无请求并发次数控制。 每个API的访问频率不超过6000次/秒,详情请参考约束与限制章节。 对API调用限制次数可通过流量控制策略控制,配置流量控制策略请参考配置API的流量控制策略章节。 父主题:
专享版-实例管理 创建专享版实例 查看专享版实例详情 更新专享版实例 查看专享版实例创建进度 实例更新或绑定EIP 实例解绑EIP 开启实例公网出口 更新实例出公网带宽 关闭实例公网出口 查看可用区信息 查询专享版实例列表 删除专享版实例 父主题: 专享版API(V2)
专享版-凭据管理 创建APP 修改APP 删除APP 重置密钥 校验APP 查看APP详情 查询APP列表 创建APP Code 自动生成APP Code 删除APP Code 查看APP Code详情 查询APP Code列表 查询凭据关联的凭据配额 设置APP的访问控制 查看APP
专享版-概要查询 查询API概况 查询API分组概况 查询APP概况 父主题: 专享版API(V2)
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上。
APIG的API响应消息头说明 调用API时,API网关增加下表中的响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 X-Request-Id 请求ID。所有合法请求,都会返回此参数。 X-Apig-Latency 从API
配置APIG的API认证凭据 使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对
变更APIG的实例规格 当实例规格无法满足您的业务需求时,您可以进行规格变更操作升配到更高规格版本。 约束与限制 规格变更过程中,长连接会发生闪断,需要重新建链,建议业务低峰期进行规格变更。 只能升配到更高规格,无法降配规格。 规格变更时,出私网IP会发生变化,如有相关防火墙配置或者白名单配置需要完全放通
通过APIG创建GRPC API API网关支持创建GRPC API。gRPC是RPC(远程过程调用)的一种,只需定义每个API的Request和Response,剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf(protocol buffers)作为其接口定义语言
查看或编辑APIG实例信息 实例创建完成后,可在控制台查看和编辑实例的配置信息。 查看或编辑实例信息 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上,单击“查看控制台”或实例名称。 在“实例信息”页签,根据下表参数说明,查看或编辑实例的配置信息。
API分组管理 对象模型 创建API分组 修改API分组 删除API分组 查看分组详情 查询分组列表 父主题: 共享版API(仅存量用户使用)
对象模型 本节介绍APP的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP对象模型 参数 类型 说明 操作类型 是否必选