- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- APIG业务使用流程
- 创建用户并授权使用APIG
- 创建APIG实例
- 开放API
- 配置API调用授权(可选)
- 调用API
-
管理API
- 管理API概述
- 查看或编辑APIG的API信息
- 配置API的自定义认证
- 配置API的参数编排规则
- 自定义API的错误响应信息
- 克隆APIG的API
- 下线APIG的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
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- x-apigateway-auth-opt
- x-apigateway-result-normal-sample
- x-apigateway-result-failure-sample
- x-apigateway-authorizer
- x-apigateway-response
- x-apigateway-responses
- x-apigateway-pass-through
- x-apigateway-sample
- x-apigateway-content-type
- x-apigateway-orchestrations
- 配置API策略
- 配置凭据策略
- 管理APIG实例
- 查看监控指标与配置告警
- 查看APIG审计日志
- 共享版操作指导(仅存量用户使用)
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 专享版-编排规则管理
- 专享版-实例自定义入方向端口管理
- 共享版API(仅存量用户使用)
- 专享版API(V1)(待下线)
- 权限策略和授权项
- 附录
- 修订记录
- SDK参考
- 场景代码示例
-
常见问题
- 热门咨询
- 产品咨询
- 开放API
- 发布API
-
调用API
- 调用API失败的可能原因
- 调用API报“414 Request URI too large”
- 调用API报“The API does not exist or has not been published in the environment”
- 调用API报“No backend available”
- API的后端服务报“Backend unavailable”或“Backend timeout”
- API的后端服务报“Backend domain name resolution failed”
- 调用API报“Incorrect IAM authentication information”
- 调用API报“Incorrect app authentication information”
- 修改API后端服务的超时时间上限“backend_timeout”后未生效
- APIG对API请求体的大小是否有限制?
- API调用对请求的响应消息体限制
- 使用iOS系统时,如何使用APP认证调用API?
- 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- APIG是否支持WebSocket数据传输?
- API的策略后端有多个时,怎么匹配和执行API请求?
- 如何通过APIG访问公网后端服务?
- API认证
- API策略
- 导入导出API
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
创建API的负载通道(可选)
负载通道主要用于将服务通过API网关专享版开放给外部访问。它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能(服务器通道类型),以及自动同步服务节点变更的能力(微服务通道类型)和使用已有的负载通道能力(引用负载通道类型),从而实现后端服务的负载均衡或自动同步服务节点的变更或重复使用负载通道。
创建负载通道后,在创建API,且后端服务类型为HTTP&HTTPS时,后端服务地址可以直接使用已创建的负载通道。
例如,负载中包含6台ECS,已创建一条负载通道,其中ECS 01和ECS 04已添加到负载通道中,此时API网关通过负载通道可以直接访问负载中的ECS 01和ECS 04。

注意事项
- 创建服务器通道类型须注意以下事项:
API网关与负载通道中的服务器之间网络互通。
- 创建云容器引擎微服务通道类型需注意以下事项:
- 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。
- 您需要确保当前实例与CCE集群所属同一个VPC中,或通过其他方式保证两者网络可达,否则创建后调用API会出现失败场景。
- 选择VPC网络模型的CCE集群时,您需要在实例详情界面的路由配置中添加CCE集群的容器网段,否则创建后调用API会出现失败场景。
- 创建微服务类型的负载通道后,负载通道会监测工作负载下所有实例的地址变化,并更新到负载通道中。
前提条件
创建负载通道
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API策略”。
- 单击“负载通道”页签,进入到负载通道列表页面。
- 单击“创建负载通道”,根据下表参数说明,配置基本信息。
表1 基本信息配置 参数
说明
通道名称
自定义负载通道名称,用于识别不同的负载通道。支持中文、英文、数字、下划线、中划线、点,且只能以英文和中文开头,长度为3~64个字符。
端口
负载通道中主机的端口号,即用户的后端业务端口号。
取值范围为1~65535。
分发算法
通过分发算法确定请求被发送到哪台主机。
分发算法包含如下几种:- 加权轮询:结合弹性服务器权重值,将请求轮流转发到每一台服务器。
- 加权最少:结合弹性服务器权重值,将请求转发到具有最少活跃连接数的那台服务器。
- 源地址哈希:由请求的来源IP地址决定请求被转发到哪一台云服务器,相同源地址的请求始终会转发到同一台服务器,除非该云服务器不可用。
- URI哈希:由请求的路径决定请求被转发到哪一台云服务器,相同路径的请求始终会转发到同一台服务器,除非该云服务器不可用。
通道类型
- 选择通道类型为服务器时,配置通道内服务器。
说明:
负载通道支持私网ELB,可通过指定服务器地址配置。
- 选择云服务器。
- 单击“创建服务器分组”。
- 单击“添加云服务器”。
- 配置完成后,进行健康检查配置。
- 指定服务器地址。
- 选择云服务器。
- 选择通道类型为微服务时,配置微服务和服务器分组。
- 根据下表参数说明,配置微服务信息。
表4 云容器引擎微服务配置 参数
说明
微服务类型
默认云容器引擎CCE类型。
集群
选择集群,可单击“查看云容器引擎CCE”查看。
已创建的CCE集群与API网关实例属于同一个VPC,或者二者之间通过对等连接等方式保证网络可达。通过同一个VPC(有扩展网段等)、对等连接等方式连接网络时,需要在控制台将CCE集群详情中的“容器网段”添加到API网关实例详情中的“路由”上,否则会导致API网关到容器网络不通。
命名空间
选择CCE集群的命名空间。命名空间是对一组资源和对象的抽象整合。
工作负载类型
- 无状态负载 Deployment:在运行中始终不保存任何数据或状态的工作负载称为无状态负载 。
- 有状态工作负载 Statefulset:在运行过程中会保存数据或状态的工作负载称为有状态工作负载。
- 守护进程集 DaemonSet:守护进程集可以确保全部(或者某些)节点上仅运行一个Pod实例,当有节点加入集群时,也会为其新增一个Pod 。 当有节点从集群移除时,这些Pod会被回收。
说明:
删除DaemonSet将会删除它创建的所有Pod。
工作负载类型的介绍请参考工作负载概述。
服务标识名
选择工作负载的Pod标签,通过Pod标签指定某个工作负载。服务标识名为Pod标签的键,服务标识值为Pod标签的值。
Pod标签相关内容指导,请参考标签与注解。
服务标识值
- 配置服务器分组。
单击“添加服务器分组”,根据下表参数说明,配置信息。
表5 云容器引擎微服务的服务器分组配置 参数
说明
服务器分组名称
默认为服务标识值,用户也可根据业务需求修改。支持中文、英文、数字、下划线、中划线、点,且只能以英文和中文开头,长度为3~64个字符。
权重分配
填写服务器分组的权重值,权重值越大,转发到该分组下服务器的请求数量越多。默认为1,取值范围为0~100。
分发算法选择哈希算法时,权重默认为1,且不支持修改。
后端服务端口
后端服务器的访问端口号。不指定端口号或端口号为0时,默认使用负载通道的端口号。
取值范围为0~65535。
工作负载名称
选择CCE工作负载。
标签
选择工作负载的Pod标签。如果服务标识名和服务标识值不唯一,且不能指定某个工作负载时,还可以通过选择其他Pod标签指定某个工作负载。
例如,工作负载01和工作负载02的app相同,可通过选择version或test_name区分工作负载01或工作负载02。
工作负载01:
spec: replicas: 2 selector: matchLabels: app: 'app01' version: 'v1'
工作负载02:
spec: replicas: 2 selector: matchLabels: app: 'app01' test_name: 'test_value'
- 配置完成后,进行健康检查配置。
- 根据下表参数说明,配置微服务信息。
- 选择通道类型为引用负载通道时,根据下表参数说明,配置服务器分组。
表6 服务器分组配置 参数
说明
服务器分组名称
根据规划自定义。建议您按照一定的命名规则填写分组名称,方便您快速识别和查找。
支持中文、英文、数据、下划线、中划线、点,且只能以英文和中文开头,取值范围为3~64字符。
权重分配
填写服务器分组的权重值,权重值越大,转发到该分组下服务器的请求数量越多。默认:1,取值范围为0~100。
分发算法选择哈希算法时,权重默认为1,且不支持修改。
被引用的负载通道
选择需要引用的负载通道。
描述
填写分组的描述信息。
配置完成后,进行健康检查配置。
- 配置健康检查。
表7 基本信息配置 参数
说明
协议
使用以下协议,对负载中主机执行健康检查。
- TCP
- HTTP
- HTTPS
默认为TCP协议。
双向认证
仅在协议为“HTTPS”时,需要设置。
开启后,API网关将认证API后端服务。双向认证所需的证书配置说明,请参考配置参数。
路径
仅在协议不为“TCP”时,需要设置。
健康检查时的目标路径。
请求类型
- GET
- HEAD
检查端口
健康检查的目标端口。
缺省时,检查端口为负载通道的端口号。
正常阈值
判定负载通道中主机正常的依据为:连续检查x成功,x为您设置的正常阈值。
取值范围为2 ~ 10。缺省值为2。
异常阈值
判定负载通道中主机异常的依据为:连续检查x失败,x为您设置的异常阈值。
取值范围为2 ~ 10。缺省值为5。
超时时间
检查期间,无响应的时间,单位为秒。
取值范围为2 ~ 30。缺省值为5。
间隔时间
连续两次检查的间隔时间,单位为秒。
取值范围为5 ~ 300。缺省值为10。
HTTP响应码
仅在协议不为“TCP”时,需要设置。
检查目标HTTP响应时,判断成功使用的HTTP响应码。
- 单击“完成”,完成负载通道的创建。
如果通道类型为微服务,CCE工作负载的“实例IP”变更(增删改),“后端服务器地址”会同步变更。
图2 微服务类型负载通道详情
后续操作
- 确认APIG实例已添加路由。通过同一个VPC(有扩展网段等)、对等连接等方式连接CCE负载与APIG实例的网络时,需要添加路由。
- 进入云容器引擎控制台,在“集群管理”页面单击已创建的CCE集群名称。
- 在“总览”页面的“网络信息”区域查看“容器网段”,并记录。
- 进入API网关控制台,在“实例管理”页面单击对应的实例名称。
- 在“实例信息”页面的“路由”区域查看已添加的路由与容器网段是否一致。如果不一致,请添加。
- 创建API,将部署在负载中的后端服务开放API。