当用户调用 API 网关服务时，如果日志中出现“504 Gateway Time-out”，可以从以下几个角度排查问题： 检查直接访问 API 网关后端服务是否正常 当后端服务是 HTTP 类型，且不在任何 VPC 内，直接通过外网访问查看是否超时。 当用户后端服务是 VPC 内的负载均衡资源时，使用相同 VPC 内的另一台 CVM 访问负载均衡的内网 IP，检查是否超时。 当用户后端服务是 TSF 时，通过 TSF 下同一个命名空间的服务实例对超时实例进行访问，检查是否超时。 在以上情况中，如果测试依然超时，考虑是后端服务存在问题，建议检查后端服务是否正常。 检查 API 网关以及后端服务设置的超时时间 用户在配置 API 网关的 API 时，需要在后端配置中添加超时时间，如果后端服务没有在超时时间内返回结果，网关会返回504错误。 检查安全组是否设置正确 当用户后端地址是 VPC 内的 CLB 时，查看关联的 CLB 绑定的 CVM 安全组是否放通了 API 网关的 IP。如果没有设置安全组，请查看后端地址是否还存在其他的端口网络限制。 放通安全组方法：CLB 绑定的后端 CVM 安全组，需要放通 API 网关的内网 IP 网段，不同地域内网 IP 网段列表请参考 API 网关各地域内网网段以及外网 VIP。端口需要放通部署在 CVM 上的服务的端口。安全组的设置方式请参考 安全组操作。 当用户的 API 是微服务 API，且服务部署在 CVM 上时，需要在 CVM 上的安全组上放通客户端 IP，端口放通服务端口。 当用户的 API 是微服务 API，且服务部署在容器中时，由于容器的 pod 不一定固定在某个 CVM 上，建议将集群中的机器都放通相同的安全组，放通客户端 IP，端口放通容器的端口。 当用户的后端地址是一般的外网可访问 HTTP 地址时，也需要检查是否有设置防火墙、安全组等，需要放通网关的外网 VIP 。 ?由于 API 网关不能保证外网 VIP 以及内网网段不变，建议用户使用密钥对鉴权以保证请求的安全。... 展开详请

用户调用 API 网关时，常见的 HTTP 错误码及说明如下： 前台错误： 错误码 日志中错误提示 说明 401 HMAC apikey is invalid for API. APIKey 没有绑定到该 API。 401 HMAC signature cannot be verified, a valid x-date header is required for HMAC Authentication. HMAC 认证时没有在 header 中带上 x-date，或者 HMAC 值非法。 401 HMAC signature cannot be verified, the x-date header is out of date for HMAC Authentication. x-date 时间戳超时，默认为900s。 401 HMAC signature cannot be verified, a valid date or x-date header is required. 如果没有 x-date，则 header 中包含 date。 401 HMAC id or signature missing. Authorization 中 ID 或者 signatrue 字段缺失。 401 HMAC do not support multiple HTTP header. 不支持一个 header 包含多个值的形式。 401 HMAC signature cannot be verified, a valid xxx header is required. 请求中缺少 xxx header。 401 HMAC algorithm xxx not supported. HMAC 算法不支持 xxx，目前支持 hmac-sha1、hmac-sha256、hmac-sha384、hmac-sha512。 401 HMAC authorization format error. Authorization 格式错误。 401 HMAC authorization headers is invalidate. Authorization 缺少足够的参数，请参考 密钥对认证-最终发送内容。 401 HMAC signature cannot be verified. 无法检验签名，可能原因为 APIKey 无法识别，通常是 APIKey 没有绑定到这个服务或者没有绑定到这个 API。 401 HMAC signature does not match. 签名不一致。 401 Oauth call authentication server fail. 调用认证服务器失败。 401 Oauth found no related Oauth api. 没有查到关联的 Oauth 认证 API，无法认证 id_token。 401 Oauth miss Oauth id_token. 请求缺少 id_token。 401 Oauth signature cannot be verified, a validate authorization header is required. 没有认证头部。 401 Oauth authorization header format error. Oauth 头部格式错误。 401 Oauth found no authorization header. 没有找到认证头部。 401 Oauth found no id_token. 没有找到 id_token。 401 Oauth id_token verify error. JWT 格式的 id_token 验证失败。 403 Found no validate usage plan. 没有找到对应的使用计划，禁止访问（开启使用计划时可能出现的错误）。 403 Cannot identify the client IP address, unix domain sockets are not supported. 无法识别源 IP。 403 Endpoint IP address is not allowed. 禁止访问的后端 IP。 403 Get xxx params fail. 从请求中获取参数出错。 403 need header Sec-WebSocket-Key. 实际请求缺少 header Sec-WebSocket-Key，配置了 websoket 的 API 会检验。 403 need header Sec-WebSocket-Version. 实际请求缺少 header Sec-WebSocket-Version，配置了 websoket 的 API 会检验。 403 header xxx is required. 实际请求缺少 header xxx。 403 path variable xxx is required. 配置了路径变量{xxx}，但是与实际请求的路径不能匹配。 403 querystring xxx is required. 实际请求缺少 querystring xxx。 403 req content type need application/x-www-form-urlencoded. 配置了 body 参数的请求必须是表单格式。 403 body param xxx is required. 实际请求缺少 body 参数 xxx。 404 Not found micro service with key. 没有找到对应的微服务。 404 Not Found Host. 请求携带 host 字段，该字段值需要填服务器的域名，且为 String 类型。 404 Get Host Fail. 请求中携带的 host 字段值不是 String 类型。 404 Could not support method. 并不支持该请求方法类型。 404 There is no api match host$host. 找不到请求服务器域名/地址。 404 There is no api match env_mapping$env_mapping. 自定义域名后的 env_mapping 字段错误。 404 There is no api match default env_mapping$env_mapping. 默认域名后的 env_mapping 字段需要是 test/prepub/release。 404 There is no api match uri$uri. 在该请求地址对应的服务下找不到对应 URI 匹配的 API。 404 Not allow use HTTPS protocol或者Not allow use HTTP protocol. 该请求地址对应的服务并不支持对应 HTTP 协议类型。 404 Found no api. 请求没有匹配到 API。 405 Method Not Allowed. 不允许的 HTTP 请求方法。 426 Not allow use HTTPS protocol. 不允许用 HTTPS 协议。 426 Not allow use HTTP protocol. 不允许用 HTTP 协议。 426 Not allow use xxx protocol. 不允许用 xxx 协议。 429 API rate limit exceeded. 请求速率超过限速值，当前速率值可以查看请求的 header。 429 API quota exceeded. 配置超限，剩余的配额可以通过请求的 header 查看。 429 req is cross origin, api $uri need open cors flag on qcloud apigateway. 该请求是跨域请求，但对应的 API 并未打开跨域开关。 481 API config error. API 配置错误。 481 TSF config error. TSF 相关配置错误。 481 Get location of micro service info fail. 没有配置微服务名、微服务命名空间获取位置。 481 Only support the map_from like method.req.{path}.{}. 配置了微服务名、微服务空间的拉取位置，但是位置格式非法。 481 Found no valid cors config. CORS 配置出错。 481 Oauth public key error. 配置的公钥证书错误。 481 Oauth id_token location forbidden. 不允许的 id_token 存放位置。 481 Oauth found no oauth config. 没有找到 Oauth 配置。 481 Oauth found no public key. 没有找到公钥。 481 Mock config error. mock 的配置出错。 499 Client closed connetion. 客户端主动中断连接。 后台错误： 错误码 日志中错误提示 说明 500 Error occurred during query params. query 参数处理出错。 500 Internal Server Error. 其他 APIGW 内部逻辑错误。 2. 若 API 为 proxy 类型，访问了没有权限访问的后端地址也会报该错误。 502 Bad Gateway. 连接后端服务出错，可能情况： 1. 后端拒绝服务，全部请求都为502。 2. 后端高负载，导致部分请求响应为502。 504 Gateway Time-out. 后端服务器连接超时。 ... 展开详请

如果客户进来的请求是 /product/apigw/document，命中 前端 path 为 /product/ 的 API： 如果后端 path 为空串，那么转给后端的 URL 就是 /apigw/document； 如果后端 path 的内容不为空为 /tencent/，那么就切掉 /product/ 部分，剩下的黏在后端的 path 后面成为 /tencent/apigw/document。... 展开详请

如果 API path 以 = 开始，代表精确匹配，优先级最高。 如果 API path 以 ^~ 开始，代表优先前缀匹配，后面不能跟正则表达式，优先级第二。 如果 API path 为正则表达式（包括有路径变量），优先级第三。 如果 API path 为普通串，字符串最长的优先级高，满足最长匹配。... 展开详请

在创建 API 时，若勾选了支持 CORS，则 API 网关支持跨域请求，默认配置如下： <dx-codeblock> ::: plaintext #define CORS_DEFAULT_AC_ALLOW_ORIGIN ("*") #define CORS_DEFAULT_AC_ALLOW_METHODS ("GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH") #define CORS_DEFAULT_AC_ALLOW_CREDENTIALS ("true") #define CORS_DEFAULT_AC_ALLOW_HEADERS ("X-Api-ID,X-Service-RateLimit,X-UsagePlan-RateLimit,X-UsagePlan-Quota,Cache- Control,Connection,Content-Disposition,Date,Keep-Alive,Pragma,Via,Accept,Accept-Charset,Accept-Encoding,Accept-Language,Authorization,Cookie,Expect,From,Host,If-Match,If-Modified-Since,If-None-Match,If-Range,If-Unmodified-Since,Range,Origin,Referer,User-Agent,X-Forwarded-For,X-Forwarded-Host,X-Forwarded-Proto,Accept-Range,Age,Content-Range,Content-Security-Policy,ETag,Expires,Last-Modified,Location,Server,Set-Cookie,Trailer,Transfer-Encoding,Vary,Allow,Content-Encoding,Content-Language,Content-Length,Content-Location,Content-Type") #define CORS_DEFAULT_AC_EXPOSE_HEADERS (CORS_DEFAULT_AC_ALLOW_HEADERS) #define CORS_DEFAULT_AC_MAX_AGE ("86400") ::: </dx-codeblock>... 展开详请

用户在创建 API 服务后，经常发现调用失败，返回类似提示： {"message":"There is no api match uri[\/api\/v1\/tool\/123\/ico] host [service-asoj98o0-1251762227.ap-guangzhou.apigateway.myqcloud.com]"} 此时请先检查这个 API 服务是否已经发布在某个环境中。 创建 API 后，必须发布服务到环境中方可进行调用。API 在被编辑后也需要重新发布才能生效。 另外，当服务发布在不同环境中，默认调用地址中需要带环境名称，如： service-asoj98o0-1251762227.ap-guangzhou.apigateway.myqcloud.com/release/用户路径... 展开详请

如果前端配置包含固定串和Path参数，如前端路径为 /{PathA}/{PathB}/detail，如果客户进来的请求是 /middleware/apigw/detail，那么传给后端的PathA参数值为middleware，PathB参数值为apigw； 如果前端配置包含固定串和Path参数，如前端路径为 /{PathA}/product/{PathB}，如果客户进来的请求是 /middleware/product/apigw/detail，那么传给后端的PathA参数值为middleware，PathB参数值为apigw/detail； 如果前端配置仅使用Path参数，如前端路径为 /{PathA}/{PathB}，如果客户进来的请求是 /middleware/apigw/detail，那么传给后端的PathA参数值为middleware/apigw，PathB参数值为detail。 ?对于微服务 API，不建议同时将 X-NameSpace-Code和X-MicroService-Name 定义为 Path 参数。如需同时定义为 Path 参数，请使用固定串分割，如/{X-NameSpace-Code}/{X-MicroService-Name}/service。... 展开详请

您好，我的世界服务器程序不应该直接绑定公网IP地址，您应该将server.properties文件里面的ip绑定选项设定为在0.0.0.0上运行，如下图所示： image.png 由于我的世界服务器默认不能沟通外网，所以绑定外网iP没啥意义~... 展开详请