- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 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
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
通过CCE工作负载导入API
API网关支持导入云容器引擎(Cloud Container Engine,简称CCE)的工作负载,将工作负载作为后端服务,在API网关中开放API,提供给API调用者使用。
如果当前实例不支持“导入CCE工作负载”,请联系客服。
注意事项
- 仅支持华为云CCE Turbo集群、VPC网络模型的CCE集群。
- 您需要确保当前实例与CCE集群所属同一个VPC中,或通过其他方式保证两者网络可达,否则导入后调用API会出现失败场景。
- 选择VPC网络模型的CCE集群时,您需要在实例详情界面的路由配置中添加CCE集群的容器网段,否则导入后调用API会出现失败场景。
- 导入后会生成相应的API以及微服务类型的负载通道,负载通道会监测工作负载下所有实例的地址变化,并更新到负载通道中。
前提条件
已创建CCE工作负载。
导入CCE工作负载
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > API分组”。
- 单击“创建API分组 > 导入CCE工作负载”。根据下表参数说明,配置信息。
表1 配置信息 参数
说明
所属分组
CCE工作负载所属分组。支持同步创建新的分组或选择已有分组。
集群
选择集群,可单击“查看云容器引擎CCE”查看。
命名空间
选择工作负载的命名空间。命名空间是对一组资源和对象的抽象整合。
工作负载类型
选择工作负载类型。
- 无状态负载 Deployment:在运行中始终不保存任何数据或状态的工作负载称为无状态负载 。
- 有状态工作负载 Statefulset:在运行过程中会保存数据或状态的工作负载称为有状态工作负载。
- 守护进程集 DaemonSet:守护进程集可以确保全部(或者某些)节点上仅运行一个Pod实例,当有节点加入集群时,也会为其新增一个Pod 。 当有节点从集群移除时,这些Pod会被回收。删除DaemonSet将会删除它创建的所有Pod。
工作负载类型的介绍请参考工作负载概述。
服务标识名
选择工作负载的Pod标签,通过Pod标签指定某个工作负载。服务标识名为Pod标签的键,服务标识值为Pod标签的值。
Pod标签相关内容指导,请参考设置标签与注解。
服务标识值
标签
选择工作负载的Pod标签。如果服务标识名和服务标识值不唯一,且不能指定某个工作负载时,还可以通过选择其他Pod标签指定某个工作负载。
请求协议
支持HTTP、HTTPS,传输重要或敏感数据时推荐使用HTTPS。
请求路径前缀
请求路径通过配置“+”做前缀匹配。例如,请求路径为/a/{b+}。
端口
填写CCE工作负载的监测端口号。
安全认证
支持APP认证、华为IAM认证和无认证。
- APP认证:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。
- 华为IAM认证:表示借助IAM服务进行安全认证。
- 无认证:表示不需要认证。
支持跨域CORS
是否开启跨域访问CORS(cross-origin resource sharing)。
CORS允许浏览器向跨域服务器,发出XMLHttpRequest请求,从而克服了AJAX只能同源使用的限制。
CORS请求分为两类:
- 简单请求:头信息之中,增加一个Origin字段。
- 非简单请求:在正式通信之前,增加一次HTTP查询请求。
开启CORS(非简单请求)时,您需要单独创建一个“请求方法”为“OPTIONS”的API,具体操作请参考开启跨域访问。
后端超时(ms)
后端服务请求的超时时间,可填写范围1ms~60000ms。
如果在API调试过程中,遇到后端响应超时之类的错误,请适当调大后端超时时间,以便排查原因。
- 单击“完成”。