获取最佳的 HTTPDNS 服务端 IP 地址--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

获取最佳的 HTTPDNS 服务端 IP 地址

最近更新时间：2023.09.22 15:26:42首次发布时间：2023.07.21 15:05:35

API 说明

获取最佳的 HTTPDNS 服务端 IP 地址。您可以使用 HTTP 请求或 HTTPS 请求。该 API 的请求不计费。

说明

该 API 处于公测阶段，目前默认关闭。如果您希望体验该功能，可以提交工单联系我们开启该 API。

说明

客户端 SDK 可以自动获取最佳的 HTTPDNS 服务端 IP 地址。如果您无法使用客户端 SDK，您可以使用该 API 获取最佳的 HTTPDNS 服务端地址。

您可以使用 httpdns.volcengineapi.com 作为请求域名，也可以向 HTTPDNS 服务端的固定 IP 地址发送直连请求。

使用 httpdns.volcengineapi.com 作为请求域名

GET https://httpdns.volcengineapi.com/svc_meta?account_id={account_id}&sign={sign}&svc_meta_ts={svc_meta_ts}&timestamp={timestamp}

GET http://httpdns.volcengineapi.com/svc_meta?account_id={account_id}&sign={sign}&svc_meta_ts={svc_meta_ts}&timestamp={timestamp}

向 HTTPDNS 服务端的固定 IP 地址发送直连请求

GET https://{ip_address}/svc_meta?account_id={account_id}&sign={sign}&svc_meta_ts={svc_meta_ts}&timestamp={timestamp}

GET http://{ip_address}/svc_meta?account_id={account_id}&sign={sign}&svc_meta_ts={svc_meta_ts}&timestamp={timestamp}

说明

固定 IP 地址接入功能处于公测阶段，暂不对外公开。您可以提交工单联系我们获取固定 IP 地址。

查询参数

参数名称	数据类型	是否必选	参数说明
account_id	String	是	您的 Service ID。可以从控制台的鉴权配置页面获取。
svc_meta_ts	String	是	上一次请求返回的 `ts` 参数的值。HTTPDNS 服务端可以根据该参数监控客户端更新 HTTPDNS 服务端 IP 地址的比例。您也可以把该参数设为 0。
sign	String	是	指定请求的签名，用来对请求进行鉴权。签名计算方法见计算签名。
timestamp	String	是	指定签名的过期时间。时间的格式为 Unix 时间戳，单位是毫秒。例如，`1653021179804` 表示签名在 2022 年 5 月 20 日 04:32:59（UTC 时间）过期。如果 HTTPDNS 服务端收到了过期的签名，该请求会被丢弃。这样可以防止重放攻击。警告该参数不能是当前时间。否则，请求到达 HTTPDNS 服务端时，签名已过期。该参数的单位必须是毫秒。

响应正文

参数名称	数据类型	参数说明
svc_meta	Object	可用的 HTTPDNS 服务端 IP 地址信息。参见 svc_meta 对象。
ts	Integer	本次获得 HTTPDNS 服务端地址的 Unix 时间戳，单位是毫秒。例如，`1653021179804` 表示本次获得 HTTPDNS 服务端地址的时间是 2022 年 5 月 20 日 04:32:59（UTC 时间）。您可以自行保存该参数的值，用于定时向 HTTPDNS 服务端发送请求，获取最新的 IP 地址。
update_interval_min	Integer	获取最新的 HTTPDNS 服务端 IP 地址的建议时间间隔（分钟）。

svc_meta 对象

参数名称	数据类型	参数说明
main_domains	String Array	推荐您优先使用的 HTTPDNS 服务端 IP 地址。您可以按照列表中 IP 地址的顺序，按照轮询逻辑依次尝试访问。
backup_domains	String Array	HTTPDNS 服务端备用 IP 地址。如果 `main_domains` 中的 IP 地址都不可用，那么您可以尝试访问该地址。

请求示例

https://httpdns.volcengineapi.com/svc_meta?account_id=2100212964&svc_meta_ts=1677139810853&timestamp=1677139810853&sign=bf0525e89431b5820af17555ba4c13a1

响应示例

{
  "svc_meta": {
    "main_domains": [
      "1.1.1.1",
      "2.2.2.2",
      "3.3.3.3"
    ],
    "backup_domains": [
      "4.4.4.4"
    ]
  },
  "ts": 1676777261000,
  "update_interval_min": 30
}