- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 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时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
错误码 |
错误信息 |
HTTP状态码 |
语义 |
解决方案 |
---|---|---|---|---|
APIG.0101 |
The API does not exist or has not been published in the environment. |
404 |
API不存在或未发布到环境 |
检查调用API所使用的域名、请求方法、路径和创建的API是否一致;检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名;检查调用API使用的域名是否已经绑定到API所在的分组。 |
APIG.0101 |
The API does not exist. |
404 |
API请求方法不存在 |
检查API请求方法是否与API定义的方法相同 |
APIG.0103 |
The backend does not exist. |
500 |
无法找到后端 |
联系技术支持 |
APIG.0104 |
The plug-ins do not exist. |
500 |
无法找到插件配置 |
联系技术支持 |
APIG.0105 |
The backend configurations do not exist. |
500 |
无法找到后端配置 |
联系技术支持 |
APIG.0106 |
Orchestration error. |
400 |
编排错误 |
检查API配置的前后端参数是否合理 |
APIG.0201 |
API request error. |
400 |
请求格式不合法 |
使用合法的请求 |
APIG.0201 |
Request entity too large. |
413 |
请求body过大(大于12M) |
减小请求body大小 |
APIG.0201 |
Request URI too large. |
414 |
请求URI过大(大于32K) |
减小请求URI大小 |
APIG.0201 |
Request headers too large. |
494 |
请求头过大(单个请求头大于32K或所有请求头总长度大于128K) |
减小请求头大小 |
APIG.0201 |
Backend unavailable. |
502 |
后端不可用 |
检查API配置的后端地址是否可用 |
APIG.0201 |
Backend timeout. |
504 |
后端超时 |
增大超时时间或缩小后端的处理时间 |
APIG.0201 |
An unexpected error occurred |
500 |
内部错误 |
联系技术支持 |
APIG.0202 |
Backend unavailable |
502 |
后端不可用 |
检查API配置的后端请求协议是否与后端服务请求协议一致 |
APIG.0203 |
Backend timeout. |
504 |
后端超时 |
增大超时时间或缩小后端的处理时间 |
APIG.0204 |
SSL protocol is not supported: TLSv1.1 |
400 |
SSL协议版本不支持 |
使用支持的SSL协议版本 |
APIG.0301 |
Incorrect IAM authentication information. |
401 |
IAM认证信息错误 |
检查token是否正确,具体请参见IAM信息认证错误 |
APIG.0302 |
The IAM user is not authorized to access the API. |
403 |
IAM用户不允许访问API |
检查用户是否被黑白名单限制 |
APIG.0303 |
Incorrect app authentication information. |
401 |
APP认证信息错误 |
APP签名认证时,做如下检查:
请参考使用APP认证调用API检查签名代码的问题。 APPCODE简易认证时,做如下检查:检查请求是否携带了X-Apig-AppCode头域 |
APIG.0304 |
The app is not authorized to access the API. |
403 |
APP不允许访问API |
检查APP是否授权访问API |
APIG.0305 |
Incorrect authentication information. |
401 |
认证信息错误 |
检查认证信息是否正确 |
APIG.0306 |
API access denied. |
403 |
不允许访问API |
检查是否授权访问API |
APIG.0307 |
The token must be updated. |
401 |
token需要更新 |
重新从IAM获取token |
APIG.0308 |
The throttling threshold has been reached. |
429 |
超出流控值限制 |
等待流控刷新后访问。如果触发子域名的单日请求数上限,请绑定独立域名。 |
APIG.0310 |
The project is unavailable. |
403 |
project不可使用 |
使用其他project访问 |
APIG.0311 |
Incorrect debugging authentication information. |
401 |
调试认证信息错误 |
联系技术支持 |
APIG.0401 |
Unknown client IP address. |
403 |
无法识别客户端IP地址 |
联系技术支持 |
APIG.0402 |
The IP address is not authorized to access the API. |
403 |
IP地址不允许访问 |
检查IP地址是否被黑白名单限制 |
APIG.0404 |
Access to the backend IP address has been denied. |
403 |
后端IP不允许访问 |
后端IP地址或后端域名对应的IP地址不允许访问 |
APIG.0501 |
The app quota has been used up. |
405 |
APP已经超出配额 或云商店调用次数用完 |
扩大APP配额 或重新购买云商店调用次数 |
APIG.0502 |
The app has been frozen. |
405 |
APP被冻结 |
余额不足 |
APIG.0601 |
Internal server error. |
500 |
内部错误 |
联系技术支持 |
APIG.0602 |
Bad request. |
400 |
非法请求 |
检查请求是否合法 |
APIG.0605 |
Domain name resolution failed. |
500 |
域名解析失败 |
检查域名拼写,以及域名是否绑定了正确的后端地址 |
APIG.0606 |
Failed to load the API configurations. |
500 |
未加载API配置 |
联系技术支持 |
APIG.0607 |
The following protocol is supported: {xxx} |
400 |
协议不被允许,允许的协议是xxx。 注意:xxx以实际响应中的内容为准。 |
改用支持的协议(HTTP/HTTPS)访问 |
APIG.0608 |
Failed to obtain the admin token. |
500 |
无法获取管理租户 |
联系技术支持 |
APIG.0609 |
The VPC backend does not exist. |
500 |
找不到vpc后端 |
联系技术支持 |
APIG.0610 |
No backend available. |
502 |
没有可连接的后端 |
检查所有后端是否可用,如调用信息与实际配置是否一致。 |
APIG.0611 |
The backend port does not exist. |
500 |
后端端口未找到 |
联系技术支持 |
APIG.0612 |
An API cannot call itself. |
500 |
API调用自身 |
修改API后端配置,递归调用层数不能超过10层。 |
APIG.0613 |
The IAM service is currently unavailable. |
503 |
IAM服务暂时不可用 |
联系技术支持 |
APIG.0705 |
Backend signature calculation failed. |
500 |
计算后端签名失败 |
联系技术支持 |
APIG.0802 |
The IAM user is forbidden in the currently selected region |
403 |
该IAM用户在当前region中被禁用 |
联系技术支持 |
APIG.1009 |
AppKey or AppSecret is invalid |
400 |
AppKey或AppSecret不合法 |
检查请求的AppKey或AppSecret是否正确 |