检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的Kafka日志推送 Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力，方便用户获取API的调用日志信息。 如果此策略在当前实例中不支持，可提交工单升级实例到最新版本。 策略参数会明文展示，为防止信息泄露，请谨慎配置。 约束与限制 同一个环境中，一个
使用场景 API网关主要涉及以下几个开发场景： API调用认证开发：API的认证方式为APP认证或IAM认证，则需要在业务系统侧进行调用认证的开发，为API请求添加认证信息。 使用APP认证（签名认证）调用API：API调用者通过API网关提供Key、Secret和SDK，对API
查询自定义认证列表 功能介绍 查询自定义认证列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查看版本详情 功能介绍 查询某个指定的版本详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_id} 表1 路径参数 参数 是否必选 参数类型
通过APIG创建GRPC API API网关支持创建GRPC API。gRPC是RPC（远程过程调用）的一种，只需定义每个API的Request和Response，剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf（protocol buffers）作为其接口定义语言
创建API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。
查询API详情 功能介绍 查看指定的API的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
新增网关响应 操作场景 网关响应，指API网关未能成功处理API请求，从而产生的错误响应。API网关提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API分组管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为
删除分组指定错误类型的自定义响应配置 功能介绍 删除分组指定错误类型的自定义响应配置，还原为使用默认值的配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups
包年/包月 包年/包月是一种先付费再使用的计费模式，适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式，您可以预先购买专享版API网关并获得一定程度的价格优惠。下面介绍包年/包月API网关的计费规则。 适用场景 包年/包月计费模式需要用户预先支付一定时长的费用，
使用APIG专享版实现WebSocket服务的转发 应用场景 API网关支持WebSocket API，其创建过程和创建HTTP API一致。WebSocket是一种全双工通信协议，建立在单个TCP连接上，允许在客户端和服务器之间进行双向通信。WebSocket的设计旨在解决HTTP
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件，即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件，通常在gRPC中使用。它基于Protobuf语言，用于描述数据的结构和交互方式，充当客户端和服务端之间通信的合同
查看分组下指定错误类型的自定义响应 功能介绍 查看分组下指定错误类型的自定义响应 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses
方案概述 应用场景 API网关支持定义多个策略后端，通过不同的策略条件，将API请求转发到不同的后端服务中，用以满足不同的调用场景。例如为了区分普通调用与特殊调用，可以定义一个“策略后端”，通过调用前端自定义认证参数，为特殊调用方分配专用的后端服务。本方案以“系统参数-前端认证参数
修改分组下指定错误类型的自定义响应 功能介绍 修改分组下指定错误类型的自定义响应。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证
调试APIG创建的API API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 约束与限制 后端路径中含有环境变量的API，不支持调试。 如果API绑定了插件策略或传统策略，在调试API时，策略均不生效。 调试API
部署在VPC下的应用是否可以调用API？ 默认部署在VPC下的应用可以调用API。如果域名解析失败，则参考配置内网DNS，在当前终端节点上配置DNS服务器。配置完成后，部署在VPC下的应用可以调用API。 配置内网DNS 配置DNS需要配置“/etc”目录下的resolv.conf
为简易认证添加AppCode 操作场景 简易认证指调用API时，在HTTP请求头部消息增加一个参数X-Apig-AppCode（参数值填应用详情中“AppCode”的值），而不需要对请求内容签名，API网关也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认证
配置APIG的API简易认证AppCode 简易认证指在调用API时，HTTP请求头部消息增加一个参数X-Apig-AppCode（参数值填凭据详情中“AppCode”的值），而不需要对请求内容签名，API网关也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
