- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 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(仅存量用户使用)
- 权限策略和授权项
- 附录
- 修订记录
- 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分组
- 绑定域名
- 创建环境变量
- 新增网关响应
- 创建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-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策略
- 凭据管理
- 监控分析
- 实例管理
- SDK
- 调用已发布的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?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南(吉隆坡区域)
-
API参考(吉隆坡区域)
- 使用前必读
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 权限策略和授权项
- 附录
- 修订记录
-
用户指南(阿布扎比区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建API分组
- 导入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策略
- 凭据管理
- 监控分析
- 实例管理
- SDK
- 调用已发布的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?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南(阿布扎比区域)
-
API参考(阿布扎比区域)
- 使用前必读
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 权限策略和授权项
- 附录
- 修订记录
- 最佳实践(阿布扎比区域)
- 用户指南(巴黎区域)
- 开发指南(巴黎区域)
- API参考(巴黎区域)
-
用户指南专享版(巴黎区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建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-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列表
- API策略
- 凭据管理
- 监控分析
- 实例管理
- 调用已发布的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?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南专享版(巴黎区域)
-
API参考专享版 (巴黎区域)
- 使用前必读
- 如何调用API
- 专享版API(V2)
- 权限策略和授权项
- 附录
- 修订记录
-
用户指南(吉隆坡区域)
- 通用参考
链接复制成功!
云审计服务支持的APIG操作列表
开通云审计服务
如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务,具体请参见《云审计服务用户指南》的“开通云审计服务”章节。
云审计服务包含以下功能:
- 记录审计日志
- 审计日志查询
- 审计日志转储
- 事件文件加密
- 关键操作通知
查看关键操作列表
通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。
操作名称 |
资源类型 |
事件名称 |
---|---|---|
创建API分组 |
ApiGroup |
createApiGroup |
修改API分组 |
ApiGroup |
updateApiGroup |
删除API分组 |
ApiGroup |
deleteApiGroup |
校验API分组名称是否存在 |
Swagger |
CheckApiGroups |
创建环境 |
Environment |
createEnvironment |
修改环境 |
Environment |
updateEnvironment |
删除环境 |
Environment |
deleteEnvironment |
新建变量 |
EnvVariable |
CreateEnvironmentVariable |
删除变量 |
EnvVariable |
DeleteEnvironmentVariable |
修改变量 |
EnvVariable |
UpdateEnvironmentVariable |
创建流控策略 |
Throttle |
CreateRequestThrottlingPolicy |
修改流控策略 |
Throttle |
UpdateRequestThrottlingPolicy |
删除流控策略 |
Throttle |
DeleteRequestThrottlingPolicy |
创建API |
Api |
CreateApi |
修改API |
Api |
UpdateApi |
删除API |
Api |
DeleteApi |
发布或下线API |
Api |
CreateOrDeletePublishRecordForApi |
校验API定义 |
Api |
CheckApis |
调试API |
Api |
DebugApi |
批量发布/下线API |
Api |
BatchPublishOrOfflineApi |
切换API版本 |
Api |
ChangeApiVersion |
根据版本号下线API |
Api |
DeleteApiByVersionId |
创建签名密钥 |
Signature |
CreateSignatureKey |
修改签名密钥 |
Signature |
UpdateSignatureKey |
删除签名密钥 |
Signature |
DeleteSignatureKey |
绑定签名密钥 |
SignatureBinding |
AssociateSignatureKey |
解除API与签名密钥的绑定关系 |
SignatureBinding |
DisassociateSignatureKey |
绑定流控策略 |
ThrottleBinding |
AssociateRequestThrottlingPolicy |
解除API与流控策略的绑定关系 |
ThrottleBinding |
DisassociateRequestThrottlingPolicy |
批量解绑流控策略 |
ThrottleBinding |
BatchDisassociateThrottlingPolicy |
创建特殊设置 |
ThrottleSpecial |
CreateSpecialThrottlingConfiguration |
修改特殊流控 |
ThrottleSpecial |
UpdateSpecialThrottlingConfiguration |
删除特殊流控 |
ThrottleSpecial |
DeleteSpecialThrottlingConfiguration |
APP授权 |
AppAuth |
CreateAuthorizingApps |
解除授权 |
AppAuth |
CancelingAuthorization |
绑定域名 |
ApiGroup |
AssociateDomain |
绑定域名证书 |
ApiGroup |
AssociateCertificate |
修改域名 |
ApiGroup |
UpdateDomain |
解绑域名 |
ApiGroup |
DisassociateDomain |
删除域名证书 |
ApiGroup |
DisassociateCertificate |
创建ACL策略 |
Acl |
CreateAclStrategy |
修改ACL策略 |
Acl |
UpdateAclStrategy |
删除ACL策略 |
Acl |
DeleteAcl |
批量删除ACL策略 |
Acl |
BatchDeleteAclV2 |
将API与ACL策略进行绑定 |
AclBinding |
CreateApiAclBinding |
解除API与ACL策略的绑定 |
AclBinding |
DeleteApiAclBinding |
批量解除API与ACL策略的绑定 |
AclBinding |
BatchDeleteApiAclBinding |
创建自定义认证 |
Authorizer |
CreateCustomAuthorizer |
修改自定义认证 |
Authorizer |
UpdateCustomAuthorizer |
删除自定义认证 |
Authorizer |
DeleteCustomAuthorizer |
导出API |
Swagger |
ExportApiDefinitions |
导入API |
Swagger |
ImportApiDefinitions |
创建VPC通道 |
Vpc |
CreateVpcChannel |
更新VPC通道 |
Vpc |
UpdateVpcChannel |
删除VPC通道 |
Vpc |
DeleteVpcChannel |
添加或更新后端实例 |
Vpc |
AddingBackendInstances |
更新后端实例 |
Vpc |
UpdateBackendInstances |
删除后端实例 |
Vpc |
DeleteBackendInstance |
批量修改后端服务器状态可用 |
Vpc |
BatchEnableMembers |
批量修改后端服务器状态不可用 |
Vpc |
BatchDisableMembers |
修改VPC通道健康检查 |
Vpc |
UpdateHealthCheck |
添加或更新VPC通道后端服务器组 |
Vpc |
CreateMemberGroup |
删除VPC通道后端服务器组 |
Vpc |
DeleteMemberGroup |
更新VPC通道后端服务器组 |
Vpc |
UpdateMemberGroup |
创建分组自定义响应 |
ApiGroup |
CreateGatewayResponse |
修改分组自定义响应 |
ApiGroup |
UpdateGatewayResponse |
删除分组自定义响应 |
ApiGroup |
DeleteGatewayResponse |
修改分组下指定错误类型的自定义响应 |
ApiGroup |
UpdateGatewayResponseType |
删除分组指定错误类型的自定义响应配置 |
ApiGroup |
DeleteGatewayResponseType |
实例配置特性 |
Feature |
CreateFeatureV2 |
创建专享版实例(按需) |
Instance |
CreateInstance |
更新专享版实例 |
Instance |
UpdateInstance |
实例更新或绑定EIP |
Instance |
AddEip |
实例解绑EIP |
Instance |
RemoveEip |
开启实例公网出口 |
Instance |
AddEngressEip |
更新实例出公网带宽 |
Instance |
UpdateEngressEip |
关闭实例公网出口 |
Instance |
RemoveEngressEip |
开启实例公网入口 |
Instance |
AddIngressEip |
更新实例入公网带宽 |
Instance |
UpdateIngressEip |
关闭实例公网入口 |
Instance |
RemoveIngressEip |
删除专享版实例 |
Instance |
DeleteInstances |
按需规格变更 |
Instance |
CreatePostPayResizeOrder |
接受或拒绝终端节点连接 |
vpc-endpoint |
AcceptOrRejectEndpointConnections |
批量添加实例终端节点连接白名单 |
vpc-endpoint |
AddEndpointPermissions |
批量删除实例终端节点连接白名单 |
vpc-endpoint |
DeleteEndpointPermissions |
批量添加或删除单个实例的标签 |
Instance |
BatchCreateOrDeleteInstanceTags |
导入微服务 |
Microservice |
ImportMicroservice |
创建SSL证书 |
SslCertificate |
CreateCertificate |
域名绑定SSL证书 |
ApiGroup |
BatchAssociateCerts |
域名解绑SSL证书 |
ApiGroup |
BatchDisassociateCerts |
删除SSL证书 |
SslCertificate |
DeleteCertificate |
修改SSL证书 |
SslCertificate |
UpdateCertificate |
SSL证书绑定域名 |
Certificate |
BatchAssociateDomains |
SSL证书解绑域名 |
Certificate |
BatchDisassociateDomains |
创建插件 |
Plugin |
CreatePlugin |
修改插件 |
Plugin |
UpdatePlugin |
删除插件 |
Plugin |
DeletePlugin |
插件绑定API |
Plugin |
AttachApiToPlugin |
API绑定插件 |
Plugin |
AttachPluginToApi |
解除绑定插件的API |
Plugin |
DetachApiFromPlugin |
解除绑定API的插件 |
Plugin |
DetachPluginFromApi |
创建APP |
App |
CreateAnApp |
修改APP |
App |
UpdateApp |
删除APP |
App |
DeleteAppV2 |
重置密钥 |
App |
ResettingAppSecret |
校验APP |
App |
CheckApp |
创建APP Code |
AppCode |
CreateAppCode |
自动生成APP Code |
AppCode |
CreateAppCodeAuto |
删除APP Code |
AppCode |
DeleteAppCode |
设置APP的访问控制 |
AppAcl |
UpdateAppAcl |
删除APP的访问控制 |
AppAcl |
DeleteAppAcl |
创建凭据配额 |
AppQuota |
CreateAppQuota |
修改凭据配额 |
AppQuota |
UpdateAppQuota |
删除凭据配额 |
AppQuota |
DeleteAppQuota |
凭据配额绑定凭据列表 |
AppQuotaBinding |
AssociateAppsForAppQuota |
解除凭据配额和凭据的绑定 |
AppQuotaBinding |
DisassociateAppQuotaWithApp |
关闭云审计服务
如果需要关闭云审计服务,具体步骤请参见《云审计服务用户指南》的“删除追踪器”章节。