全部文档
API网关 APIG
API网关 APIG
本产品内“
”的所有结果
本产品内“
”的所有结果
最新动态
功能总览
服务公告
漏洞公告
漏洞修复策略
产品介绍
图解API网关
什么是API网关
产品优势
应用场景
产品规格差异
安全
责任共担
资产识别与管理
身份认证与访问控制
APIG的身份认证与访问控制
数据保护技术
审计与日志
监控安全风险
认证证书
约束与限制
权限管理
基本概念
计费说明
计费概述
计费模式
计费模式概述
包年/包月
按需计费
计费项
变更计费模式
变更计费模式概述
按需转包年/包月
包年/包月转按需
续费
续费概述
手动续费
自动续费
费用账单
欠费说明
停止计费
成本管理
快速入门
概述
开放API
开放API流程
创建API分组
绑定域名
创建API
调试API
创建环境(可选)
发布API
调用API
调用API流程
创建凭据并获取授权
为简易认证添加AppCode
调用API
入门实践
用户指南
总览
API管理
创建API分组
导入CSE微服务
导入CCE工作负载
绑定域名
创建环境变量
新增网关响应
创建API
创建GRPC API
克隆API
开启跨域访问
调试API
授权API
发布API
下线API
导入导出API
限制与兼容性说明
导入API
导出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
查看API列表
支持HTTP2.0
API策略
创建策略并绑定API
跨域资源共享策略说明
响应缓存策略说明
HTTP响应头管理策略说明
流量控制2.0策略说明
Kafka日志推送策略说明
断路器策略说明
第三方认证策略说明
流量控制策略说明
访问控制策略说明
签名密钥策略说明
自定义认证
SSL证书管理
负载通道
环境管理
编排规则管理
凭据管理
创建凭据并绑定API
重置Secret
为简易认证绑定AppCode
绑定凭据配额策略
绑定访问控制策略
监控分析
API监控
支持的监控指标
创建告警规则
查看监控指标
带宽监控
日志分析
实例管理
购买实例
查看或编辑实例信息
配置参数
标签管理
终端节点管理
自定义入端口
实例规格变更
SDK
调用已发布的API
调用API
响应消息头
错误码
权限管理
创建用户并授权使用API网关
API网关自定义策略
云审计服务支持的关键操作
云审计服务支持的APIG操作列表
查询审计事件
共享版操作指导(仅存量用户使用)
APIG使用流程
进入共享版控制台
API分组管理
创建API分组
绑定域名
删除分组
新增网关响应
API管理
创建API
开启跨域访问
调试API
授权API
发布API
下线API
删除API
导入API
导出API
流量控制
创建流控策略
删除流控策略
添加特殊应用或租户
删除特殊应用或租户
访问控制
创建访问控制策略
删除访问控制策略
环境管理
创建环境和环境变量
删除环境
签名密钥
创建并使用签名密钥
删除签名密钥
VPC通道
创建VPC通道
删除VPC通道
编辑健康检查配置
在VPC通道中编辑云服务器配置
自定义认证
创建自定义认证
删除自定义认证
监控
支持的监控指标
创建告警规则
查看监控指标
应用管理
创建应用并获取授权
删除应用
重置AppSecret
为简易认证添加AppCode
查看应用绑定的API详情
SDK
已购买API
调用已发布的API
调用API
响应消息头
错误码
云审计服务支持的关键操作
云审计服务支持的APIG操作列表
查看云审计日志
最佳实践
使用API网关专享版开放云容器引擎CCE工作负载
方案概述
资源规划
操作流程
实施步骤
使用API网关专享版开放本地数据中心的服务能力
使用函数服务开发自定义认证
API网关专享版跨VPC开放后端服务
方案概述
资源规划
操作流程
实施步骤
API网关专享版对接Web应用防火墙 WAF
API网关专享版流量控制2.0策略
方案概述
操作流程
实施步骤
API网关专享版双重认证
方案概述
操作流程
实施步骤
API网关共享版对接DDOS高防
方案概述
资源规划
操作流程
实施步骤
API网关专享版支持http到https自动重定向
方案概述
操作流程
实施步骤
基于API网关专享版实现gRPC服务的路由转发
方案概述
操作流程
实施步骤
使用API网关专享版与客户端进行认证
方案描述
操作流程
实施步骤
通过匹配系统参数-前端认证参数调用API的策略后端
方案概述
操作流程
实施步骤
开发指南
使用场景
使用APP认证调用API
认证前准备
APP认证工作原理
Java
Go
Python
C#
JavaScript
PHP
C++
C
Android
curl
使用IAM认证调用API
Token认证
AK/SK认证
创建用于前端自定义认证的函数
创建用于后端自定义认证的函数
对后端服务进行签名
签名前准备
Java
Python
C#
API参考
使用前必读
概述
调用说明
终端节点
约束限制
基本概念
API概览
专享版API概览
共享版API概览
如何调用API
构造请求
认证鉴权
返回结果
快速入门
专享版API(V2)
专享版-API分组管理
创建API分组
修改API分组
删除API分组
查询分组详情
查询分组列表
校验API分组名称是否存在
专享版-环境管理
创建环境
修改环境
删除环境
查询环境列表
专享版-环境变量管理
新建变量
删除变量
查看变量详情
查询变量列表
修改变量
专享版-流控策略管理
创建流控策略
修改流控策略
删除流控策略
查询流控策略列表
查看流控策略详情
专享版-API管理
创建API
修改API
删除API
发布或下线API
查询API详情
查询API列表
校验API定义
调试API
批量发布或下线API
查询API历史版本列表
切换API版本
查询API运行时定义
查看版本详情
根据版本编号下线API
专享版-签名密钥管理
创建签名密钥
修改签名密钥
删除签名密钥
查询签名密钥列表
专享版-签名密钥绑定关系管理
绑定签名密钥
解除API与签名密钥的绑定关系
查看API绑定的签名密钥列表
查看签名密钥未绑定的API列表
查看签名密钥绑定的API列表
专享版-API绑定流控策略
绑定流控策略
解除API与流控策略的绑定关系
查看流控策略绑定的API列表
查看流控策略未绑定的API列表
查看API绑定的流控策略列表
批量解绑流控策略
专享版-设置特殊流控
创建特殊设置
修改特殊设置
删除特殊设置
查看特殊设置列表
专享版-APP授权管理
APP授权
解除授权
查看APP已绑定的API列表
查看APP未绑定的API列表
查看API已绑定的APP列表
专享版-概要查询
查询API概况
查询API分组概况
查询APP概况
专享版-域名管理
绑定域名
绑定域名证书
修改域名
解绑域名
设置调试域名是否可以访问
删除域名证书
查看域名证书
专享版-ACL策略管理
创建ACL策略
修改ACL策略
删除ACL策略
批量删除ACL策略
查看ACL策略详情
查看ACL策略列表
专享版-API绑定ACL策略
将API与ACL策略进行绑定
解除API与ACL策略的绑定
批量解除API与ACL策略的绑定
查看ACL策略绑定的API列表
查看ACL策略未绑定的API列表
查看API绑定的ACL策略列表
专享版-自定义认证管理
创建自定义认证
修改自定义认证
删除自定义认证
查看自定义认证详情
查询自定义认证列表
专享版-OpenAPI接口
导出API
导入API
专享版-VPC通道管理
创建VPC通道
更新VPC通道
删除VPC通道
查看VPC通道详情
查询VPC通道列表
添加或更新后端实例
查看后端实例列表
更新后端实例
删除后端实例
批量修改后端服务器状态可用
批量修改后端服务器状态不可用
修改VPC通道健康检查
添加或更新VPC通道后端服务器组
查询VPC通道后端云服务组列表
查看VPC通道后端服务器组详情
删除VPC通道后端服务器组
更新VPC通道后端服务器组
专享版-监控信息查询
API统计信息查询-最近一段时间
查询监控数据
分组统计信息查询-最近一小时内
专享版-分组自定义响应管理
创建分组自定义响应
查询分组自定义响应详情
修改分组自定义响应
删除分组自定义响应
查看分组下指定错误类型的自定义响应
修改分组下指定错误类型的自定义响应
删除分组指定错误类型的自定义响应配置
查询分组自定义响应列表
专享版-标签管理
查询标签列表
专享版-实例特性管理
实例配置特性
查看实例特性列表
查询实例支持的特性列表
专享版-配置管理
查询某个实例的租户配置列表
查询租户实例配置列表
专享版-实例管理
创建专享版实例(按需)
查看专享版实例详情
更新专享版实例
查看专享版实例创建进度
实例更新或绑定EIP
实例解绑EIP
开启实例公网出口
更新实例出公网带宽
关闭实例公网出口
开启实例公网入口
更新实例入公网带宽
关闭实例公网入口
查看可用区信息
查询专享版实例列表
删除专享版实例
创建专享版实例(包周期)
创建包周期规格变更订单
按需规格变更
查看实例约束信息
专享版-实例终端节点管理
查询实例终端节点连接列表
接受或拒绝终端节点连接
查询实例的终端节点服务的白名单列表
批量添加实例终端节点连接白名单
批量删除实例终端节点连接白名单
专享版-实例标签管理
查询项目下所有实例标签
查询单个实例标签
批量添加或删除单个实例的标签
查询包含指定标签的实例数量
通过标签查询实例列表
专享版-微服务中心管理
导入微服务
专享版-SSL证书管理
获取SSL证书列表
创建SSL证书
域名绑定SSL证书
域名解绑SSL证书
查看证书详情
删除SSL证书
修改SSL证书
SSL证书绑定域名
SSL证书解绑域名
获取SSL证书已绑定域名列表
专享版-插件管理
创建插件
修改插件
删除插件
查询插件列表
查询插件详情
插件绑定API
API绑定插件
解除绑定插件的API
解除绑定API的插件
查询插件下绑定的API
查询API下绑定的插件
查询可绑定当前插件的API
查询可绑定当前API的插件
专享版-凭据管理
创建APP
修改APP
删除APP
重置密钥
校验APP
查看APP详情
查询APP列表
创建APP Code
自动生成APP Code
删除APP Code
查看APP Code详情
查询APP Code列表
查询凭据关联的凭据配额
设置APP的访问控制
查看APP的访问控制详情
删除APP的访问控制
专享版-凭据配额管理
创建凭据配额
获取凭据配额详情
获取凭据配额列表
修改凭据配额
删除凭据配额
查询凭据配额已绑定的凭据列表
凭据配额绑定凭据列表
解除凭据配额和凭据的绑定
查询凭据配额可绑定的凭据列表
专享版-异步任务管理
异步导出API
异步导入API
获取异步任务结果
专享版-编排规则管理
创建编排规则
查看编排规则列表
查询编排规则详情
更新编排规则
删除编排规则
查询编排规则绑定的API
专享版-实例自定义入方向端口管理
查询实例指定的自定义入方向端口绑定的域名信息
查询实例的自定义入方向端口列表
新增实例的自定义入方向端口
删除实例指定的自定义入方向端口
共享版API(仅存量用户使用)
API分组管理
对象模型
创建API分组
修改API分组
删除API分组
查看分组详情
查询分组列表
API管理
对象模型
创建API
修改API
删除API
发布API
下线API
批量发布或下线API
查看API详情
查询API列表
查询API历史版本列表
根据版本编号下线API
查看版本详情
查询API运行时定义
调试API
APP管理
对象模型
创建APP
修改APP
重置密钥
删除APP
校验APP
查看APP详情
查询APP列表
创建App Code
自动生成App Code
查看App Code详情
查询App Code列表
删除App Code
APP授权管理
对象模型
查看APP未绑定的API列表
授权
查看APP已绑定的API列表
查看API已绑定的APP列表
解除授权
环境管理
对象模型
创建环境
修改环境
删除环境
查询环境列表
环境变量管理
对象模型
新建变量
删除变量
查看变量详情
查询变量列表
流控策略管理
对象模型
创建流控策略
修改流控策略
删除流控策略
查看流控策略详情
查询流控策略列表
API绑定流控策略
对象模型
查看流控策略未绑定的API列表
绑定流控策略
查看流控策略绑定的API列表
查看API绑定的流控策略列表
解除绑定
设置特殊流控
对象模型
创建特殊设置
修改特殊设置
删除特殊设置
查看特殊设置列表
ACL策略管理
对象模型
创建ACL策略
修改ACL策略
删除ACL策略
批量删除ACL策略
查看ACL策略详情
查看ACL策略列表
API绑定ACL策略
对象模型
将API与ACL策略进行绑定
查看API绑定的ACL策略列表
查看ACL策略绑定的API列表
查看ACL策略未绑定的API列表
解除API与ACL策略的绑定
批量解除API与ACL策略的绑定
云商店订购信息查询
查询已购买的API分组列表
查询分组详情
查询已购买的API列表
配置管理
对象模型
查询租户配置详情
概要查询
查询API分组概况
查询API概况
查询APP概况
签名密钥管理
对象模型
创建签名密钥
修改签名密钥
删除签名密钥
查询签名密钥列表
签名密钥绑定关系管理
对象模型
查看签名密钥未绑定的API列表
绑定签名密钥
查看签名密钥绑定的API列表
查看API绑定的签名密钥列表
解除绑定
域名管理
对象模型
绑定域名
解绑域名
绑定域名证书
删除域名证书
查看域名证书
VPC通道管理
对象模型
创建VPC通道
更新VPC通道
删除VPC通道
查看VPC通道详情
查看VPC通道列表
添加后端实例(云服务器)
删除后端实例(云服务器)
查看后端实例列表(云服务器列表)
监控信息查询
API统计信息查询-最近一段时间
分组统计信息查询-最近一小时
OpenAPI接口
导出分组下所有API
批量导出API
导入API到新分组
导入API到已有分组
自定义认证管理
创建自定义认证
修改自定义认证
删除自定义认证
查看自定义认证详情
查询自定义认证列表
专享版API(V1)(待下线)
使用限制
API分组管理(待下线)
对象模型
创建API分组
修改API分组
删除API分组
查看分组详情
查询分组列表
API管理(待下线)
对象模型
创建API
修改API
删除API
发布API
下线API
批量发布或下线API
查看API详情
查询API列表
查询API历史版本列表
根据版本编号下线API
查看版本详情
查询API运行时定义
调试API
APP管理(待下线)
对象模型
创建APP
修改APP
重置密钥
删除APP
校验APP
查看APP详情
查询APP列表
APP授权管理(待下线)
对象模型
查看APP未绑定的API列表
授权
查看APP已绑定的API列表
查看API已绑定的APP列表
解除授权
环境管理(待下线)
对象模型
创建环境
修改环境
删除环境
查询环境列表
环境变量管理(待下线)
对象模型
新建变量
删除变量
查看变量详情
查询变量列表
流控策略管理(待下线)
对象模型
创建流控策略
修改流控策略
删除流控策略
查看流控策略详情
查询流控策略列表
API绑定流控策略(待下线)
对象模型
查看流控策略未绑定的API列表
绑定流控策略
查看流控策略绑定的API列表
查看API绑定的流控策略列表
解除绑定
设置特殊流控(待下线)
对象模型
创建特殊设置
修改特殊设置
删除特殊设置
查看特殊设置列表
ACL策略管理(待下线)
对象模型
创建ACL策略
修改ACL策略
删除ACL策略
批量删除ACL策略
查看ACL策略详情
查看ACL策略列表
API绑定ACL策略(待下线)
对象模型
将API与ACL策略进行绑定
查看API绑定的ACL策略列表
查看ACL策略绑定的API列表
查看ACL策略未绑定的API列表
解除API与ACL策略的绑定
批量解除API与ACL策略的绑定
概要查询(待下线)
查询API分组概况
查询API概况
查询APP概况
签名密钥管理(待下线)
对象模型
创建签名密钥
修改签名密钥
删除签名密钥
查询签名密钥列表
签名密钥绑定关系管理(待下线)
对象模型
查看签名密钥未绑定的API列表
绑定签名密钥
查看签名密钥绑定的API列表
查看API绑定的签名密钥列表
解除绑定
域名管理(待下线)
对象模型
绑定域名
解绑域名
绑定域名证书
删除域名证书
查看域名证书
VPC通道管理(待下线)
对象模型
创建VPC通道
更新VPC通道
删除VPC通道
查看VPC通道详情
查看VPC通道列表
添加后端实例(云服务器)
删除后端实例(云服务器)
查看后端实例列表(云服务器列表)
API导入导出(待下线)
导出分组下所有API
批量导出API
导入API到新分组
导入API到已有分组
自定义认证管理(待下线)
创建自定义认证
修改自定义认证
删除自定义认证
查看自定义认证详情
查询自定义认证列表
权限策略和授权项
附录
分页显示查询结果
过滤查询结果
HTTP状态码
错误码
实例支持的APIG特性
获取项目ID
获取账号名和账号名ID
修订记录
SDK参考
SDK概述
场景代码示例
常见问题
热门咨询
API创建
无法创建API是什么原因?
API的响应码如何定义?
使用VPC通道(负载通道),后端服务的主机端口怎么填写?
不使用VPC通道(负载通道)时,后端服务地址可以是什么?
后端服务地址是否一定要配置为ECS的地址?
后端服务是否支持绑定私网ELB地址?
后端服务地址支持填写私有地址(子网IP)吗?
API网关是否支持多后端节点方案?
独立域名申请后还需要做什么?
API网关可以绑定内网域名吗?
为什么分组跨域配置失败?
API调用
API调用失败的可能原因有哪些?
API调用返回错误码如何处理?
API调用报错“414 Request URI too large”
"The API does not exist or has not been published in the environment."如何解决?
No backend available,怎么解决?
后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析
后端服务调用报错域名无法解析“Backend domain name resolution failed”
修改后端服务的超时时间上限“backend_timeout”后未生效
如何切换调用环境?
调用请求包最大支持多少?
使用iOS系统时,如何进行APP认证?
新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
应用(凭据)问题汇总
是否支持移动应用调用API?
部署在VPC下的应用是否可以调用API?
SDK有没有发布到maven仓库中?
API网关是否支持WebSocket数据传输?
API调用是否支持长连接
策略后端有多个时,怎么匹配和执行
API调用对请求的响应消息体限制
如何通过APIG访问公网后端服务
API认证鉴权
是否支持HTTPS的双向认证?
“无认证”方式的API该怎么鉴权与调用?
TLS加密协议支持什么版本?
API签名认证是否支持自定义认证方式?
安全认证签名的内容是否包括Body体
调用服务提示AK/SK过期如何处理
IAM认证信息错误
APP认证信息错误
API控制策略
API流量控制
是否支持对请求并发次数做自定义控制?
每个子域名(调试域名)每天最多可以访问1000次,如果账号为企业账号,是否还有这个限制?
API调用是否存在带宽限制
流量控制策略不生效怎么办?
API访问控制
怎样给指定的用户开放API
配置了身份认证的API,如何在特殊场景下(如指定IP地址)允许不校验身份?
访问控制策略的IP地址是否取的客户端的IP地址?
API发布
对API的修改是否需要重新发布?
API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问?
API发布到不同环境后,会调用不同的后端服务吗?
API调试的时候,如何指定环境?
API导入导出
API导入失败是什么原因?
swagger导入API的扩展字段有没有模板?
API安全
怎样保护API?
怎样保证API网关调用后端服务器的安全?
能否针对VPC通道(负载通道)内的ECS私有IP进行访问控制
其他
如何将API服务上架到华为云商店上售卖?
API分组为什么无法上架到云商店?
API、环境、应用(凭据)之间的关系?
怎样使用API网关?
API网关支持哪些SDK语言?
API网关是否支持通过POST方法上传文件?
如何获取API网关错误返回信息?
API网关如何开放部署在华为云上的服务?
API网关共享版是否可以升级到专享版?
API网关控制台所有按钮均无法单击
视频帮助
文档下载
通用参考
产品术语
云服务等级协议(SLA)
白皮书资源
支持区域
系统权限