配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上
APIG的API响应消息头说明 调用API时,API网关增加下表中的响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 X-Request-Id 请求ID。所有合法请求,都会返回此参数。 X-Apig-Latency 从AP
配置APIG的API认证凭据 使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。
API签名认证的内容是否包括Body体? 包括。除了几个必选的请求头部参数,Body体也是签名要素之一。例如有一个使用POST方法上传文件的API,那么在签名过程中,会取这个文件的hash值,参与生成签名信息。 关于签名的详细指导,可参考:签名认证算法详解。 父主题: API认证
X-Apig-Latency 从API网关接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时,返回此参数 X-Apig-Upstream-Latency 从API网关请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debu
配置APIG的监控告警 通过创建告警规则,您可自定义监控目标与通知策略,及时了解API网关服务运行状况,从而起到预警作用。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
API调用对请求的响应消息体限制 API调用对请求的响应体大小没有限制。 API调用对请求的请求体大小有限制。详细指导请参考request_body_size。 父主题: 调用API
是否支持对API的请求并发次数做控制? 不支持。 流控策略只控制单位时间内调用次数,无请求并发次数控制。 每个API的访问频率不超过6000次/秒,详情请参考约束与限制章节。 对API调用限制次数可通过流量控制策略控制,配置流量控制策略请参考配置API的流量控制策略章节。 父主题:
是否启用日志记录,默认关闭,仅启用后才能查看API的调用日志。 日志组 选择日志流所在的日志组。 如果没有可选的日志组,单击“查看日志组”,跳转到云日志服务管理控制台,并创建一个日志组,具体操作请参考创建日志组。 日志流 选择API调用日志要存储的日志流。 如果没有可选的日志流,单击“查看日志流”,跳
点服务名称。 连接管理 展示连接到网关实例的终端节点信息。如果需要新建终端节点,请单击“创建终端节点”创建。 终端节点ID:终端节点的ID。 报文标识:终端节点ID的标识,用来识别是哪个终端节点。 状态:终端节点的状态。 关于终端节点的各个状态,请查看终端节点服务和终端节点有哪些状态?。
API的流量控制策略不生效怎么处理? 如果流控策略的API流量限制或源IP流量限制不生效,检查API是否绑定流控策略。 如果流控策略的用户流量限制不生效,检查API的安全认证方式是否为APP认证或IAM认证。 如果流控策略的应用(凭据)流量限制不生效,检查API的安全认证方式是否为APP认证。
APIG对API请求体的大小是否有限制? 共享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,API网关会拒绝该请求。这种场景,推荐考虑使用对象存储服务。 专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,
使用APIG专享版实现gRPC服务的路由转发 使用APIG专享版实现gRPC服务的路由转发方案概述 使用APIG专享版实现gRPC服务的路由转发操作流程 使用APIG专享版实现gRPC服务的路由转发实施步骤 父主题: 开放API
广泛应用于实时聊天、在线游戏、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket API受API超时时间的限制,如果当前WebSocket连接空闲时间超过了配置的超时时间,并且没有ping/pong保活,则连接会被自动断开。
编写自定义认证函数 创建一个函数作为用户自己的认证服务。 创建自定义认证 在APIG中创建一个自定义认证,将函数服务接入APIG。 创建自定义认证的API 创建一个自定义认证方式的API。 设置错误响应 为了让API响应结果为函数中返回的context中的字段,需要修改网关响应。 映射后端参数
0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String
conf文件,指定DNS服务器的IP地址。 内网DNS服务器的IP地址与您所位于的区域相关,您可通过内网DNS地址表获取内网DNS服务器的IP地址。 新增内网DNS服务器有两种方法。 方法一:修改虚拟私有云的子网信息 方法二:编辑“/etc/resolv.conf”文件 方法二新增的内网DNS在弹
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能,支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时,一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容,请参考约束与限制。 自定义客户端访问端口
配置APIG的API简易认证AppCode 简易认证指在调用API时,HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用AP
使用APIG专享版实现不同后端服务的调用 使用APIG专享版实现不同后端服务的调用方案概述 使用APIG专享版实现不同后端服务的调用操作流程 使用APIG专享版实现不同后端服务的调用实施步骤 父主题: 开放API
您即将访问非华为云网站,请注意账号财产安全