Skip to main content

域名及出口 IP

查询 Qoder 在当前环境的访问域名和公网出口 IP,用于配置防火墙或 IP/域名白名单。

本接口为公开信息,无需认证,不需要 API Key 或组织 ID。
调用前请阅读 OpenAPI 约定与规范。

概述

通过服务网络元信息接口,可查询当前环境生效的访问域名和公网出口 IP,供配置网络白名单时使用。
  • 出口 IP:同一环境可能使用多个出口 IP,请放行 egressIps 中返回的全部地址。
  • 访问域名:按 domains[].pattern 配置域名白名单,支持精确域名和 *. 通配域名。details 仅补充具体域名及用途,可能省略,不应视为完整域名列表。
  • 信息更新:网络元信息变更生效后,接口会返回新结果,无需重新接入。响应带 Cache-Control: no-store,请勿长期缓存结果,应以最新响应更新白名单。

API 列表

查询域名及出口 IP

GET /v1/public/meta 本接口替代已弃用的 GET /v1/public/egress-ips。 不接受路径参数、查询参数(包括分页参数)或请求体。传入查询参数或请求体时返回 400 BadRequest。

请求示例

curl --silent --show-error "https://api.qoder.com/v1/public/meta"

成功响应(200 OK)

以下 IP 和域名仅为格式示例,请以接口实际返回值配置白名单。
{
  "egressIps": [
    {
      "ip": "203.0.113.10",
      "ipVersion": "IPv4"
    },
    {
      "ip": "2001:db8::1",
      "ipVersion": "IPv6"
    }
  ],
  "domains": [
    {
      "pattern": "*.example.com",
      "details": [
        {
          "domain": "api.example.com",
          "purpose": "服务 API 域名"
        }
      ]
    },
    {
      "pattern": "example.com"
    }
  ]
}
字段类型必填说明
egressIpsarray是当前生效的全部服务出口 IP,按地址排序并去重
egressIps[].ipstring是规范化后的 IP 地址
egressIps[].ipVersionstring是地址版本:IPv4 或 IPv6,由地址本身推导
domainsarray是当前生效的粗粒度域名列表;没有域名时返回空数组 []
domains[].patternstring是建议放行的精确域名或 *. 通配域名
domains[].detailsarray否pattern 下的细粒度域名说明;未配置或为空时省略
domains[].details[].domainstring是细粒度精确域名或 *. 通配域名
domains[].details[].purposestring否该细粒度域名的用途;未配置或为空时省略
精确域名和通配域名会去除首尾空白并转换为小写,purpose 会去除首尾空白。domains 及 details 按平台配置顺序返回。

错误

错误响应使用 OpenAPI 约定与规范中定义的通用结构。requestId 与响应头 X-Request-ID 一致。
HTTP 状态码错误码常见原因
400BadRequest传入查询参数或请求体
503InternalError网络元信息配置尚未加载或暂不可用
503 InternalError 响应示例:
{
  "requestId": "req_example",
  "code": "InternalError",
  "message": "service meta is not available"
}
配置不可用时不会返回空出口 IP 列表。此时应视为查询失败,而不是无需放行任何地址。