1039      英雄联盟

API接口__SDK手册_HTTPDNS-阿里云

API接口

0. 重要提示

用户通过编码使用HTTPDNS提供的服务时， 务必添加针对无法获取解析结果时的降级处理代码（参见第3节错误处理降级部分），否则极端异常情况下存在业务无法访问的风险。

1. API访问说明

HTTPDNS通过HTTP接口对外提供域名解析服务，对外服务的IP地址固定为203.107.1.1，服务的访问方式如下。

请求方式：HTTP GET或HTTPS GET（两种请求方式的收费价格不同，请参考计费说明）

HTTP服务URL：https://203.107.1.1/{account_id}/d

HTTPS服务URL：https://203.107.1.1/{account_id}/d

其中的{account_id}需要替换为用户的HTTPDNS Account ID，在HTTPDNS控制台上可以获得这个ID。

URL参数说明：

访问HTTPDNS服务时，一次请求只能解析一个域名。

请求示例：

• 示例1（默认来源IP）：https://203.107.1.1/100000/d?host=www.aliyun.com
• 示例2（指定来源IP）：https://203.107.1.1/100000/d?host=www.aliyun.com&ip=42.120.74.196

2. API响应说明

请求成功

请求成功时，HTTP响应的状态码为200，响应结果用JSON格式表示，示例如下：

{
  "host": "www.aliyun.com",
  "ips": [
    "140.205.140.234"
  ],
  "ttl": 57
}

返回字段说明：

注意，请求成功时，返回结果中的ips字段可能是空列表，即没有获得该域名的IP地址，这里主要有两个原因：

1. 该域名没有在HTTPDNS控制台中添加，请前往控制台添加。
2. 该域名不存在对应IP，域名未注册，或者没有配置IP地址。

ips字段为空的返回结果示例：

{
  "host": "www.aliyun.com",
  "ips": [],
  "ttl": 300
}

返回结果中包含TTL缓存时间，为避免频繁进行域名解析，用户应该按这个TTL时间，对域名解析结果进行缓存。在TTL过期之前，直接使用缓存的IP；TTL过期后，再去请求HTTPDNS服务，获得最新的解析结果。

请求失败

请求失败时，HTTP响应的状态码为4xx/5xx，同时也返回具体的错误码，响应结果用JSON格式表示。

请求失败的响应示例：

{
  "code": "MissingArgument"
}

错误码列表如下：

3. 错误处理说明

用户业务使用HTTPDNS时，应做好异常情况下的出错兼容逻辑，主要包括重试和降级。

重试

访问HTTPDNS服务解析域名时，如果请求HTTPDNS服务端失败，即HTTP请求没有返回，可以进行重试。

大部分情况下，这种访问失败是由于网络原因引起的，重试可以解决。

降级

不管是因为什么原因，当通过HTTPDNS服务无法获得域名对应的IP时，都必须降级：使用标准的DNS解析，通过Local DNS去解析域名。

如上所述，请求HTTPDNS但没有返回IP时，主要是因为“域名没有在控制台添加”或“域名本身不存在”，无论如何，如果通过HTTPDNS没有解析出IP，为保证业务请求正常，必须“降级”使用标准的DNS，作为一种兜底的方案。

4. 快速接入

为了方便移动端用户的接入，我们提供了基于HTTPDNS接口的接入Demo和SDK，包括Android和iOS平台。

接入Demo

该Demo基于HTTPDNS服务的API接口，是接入HTTPDNS的一个参考实现，用户可以根据自身业务的需要做相关修改。

Demo的源码托管在GitHub，包含在阿里云移动服务Demo的项目中，通过以下链接可获取：

• HTTPDNS Android Demo
• HTTPDNS iOS Demo

SDK

SDK封装了HTTPDNS服务的底层API接口，提供给用户一个可用的库，方便用户快速接入HTTPDNS服务。

SDK的获取和使用，可参考：

• Android SDK开发指南
• iOS SDK开发指南

5. 注意事项

HTTP请求头HOST字段设置

标准的HTTP协议中服务端会将HTTP请求头HOST字段的值作为请求的域名信息进行解析。使用HTTPDNS后，您可能需要将HTTP请求URL中的HOST字段替换为HTTPDNS解析获得的IP，这时标准的网络库会将您的IP赋值给HTTP请求头的HOST字段，进而导致服务端的解析异常（服务端认可的是您的域名信息，而非IP信息）。为了解决这个问题，您可以主动设置HTTP请求HOST字段的值，以HttpUrlConnection为例：

// 比如您要访问https://www.aliyun.com/，假设www.aliyun.com域名的解析结果是140.205.62.8。
// 一般情况下，使用IP的方式进行访问时，需要设置HTTP请求头的HOST字段为原来的域名。
String fullPath = "https://140.205.62.8/";
String host = "www.aliyun.com";
URL url = new URL(fullPath);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
// 设置HTTP请求头HOST字段为www.aliyun.com
conn.setRequestProperty("Host", host);

COOKIE字段

部分网络库支持COOKIE的自动存储管理，当您使用HTTPDNS进行IP URL请求时，部分网络库会将您URL中的IP信息作为COOKIE对应的域名信息进行存储管理（而非HTTP请求头HOST字段信息），进而造成COOKIE管理与使用上的困扰，因此您需要关闭COOKIE的自动管理功能（默认关闭）。

HTTPS域名下的使用

在使用HTTPS服务时本地认证证书环节需要确认您的访问域名是否和证书一致，采用IP URL发起请求时系统网络库会使用IP信息进行验证进而发生异常。针对该问题，有以下2种解决方案:

1. 建议您在进行HTTPS服务时关闭HTTPDNS功能。
2. 更改客户端验证证书的逻辑，可参考HTTPS业务场景的解决方案。

代理情况下的使用

当存在中间HTTP代理时，客户端发起的请求中请求行会使用绝对路径的URL，在您开启HTTPDNS并采用IP URL进行访问时，中间代理将识别您的IP信息并将其作为真实访问的HOST信息传递给目标服务器，这时目标服务器将无法处理这类无真实HOST信息的HTTP请求。针对该问题，有以下2种解决方案：

1.使用原生的DNS解析规避该问题。2.修改服务端配置，使用类似于WAP网关(见下面介绍)在header字段中增加其它字段的方式，服务端根据该私有字段进行验证。

移动WAP网关使用了X-Online-Host的私有协议字段来解决这个问题，比如：

目标URL：https://www.aliyun.com/product/oss/
代理：10.0.0.172:80
您的HTTP请求头应设置为：
GET https://10.0.0.172:80/product/oss/ HTTP/1.1
Host: 10.0.0.172
X-Online-Host: www.aliyun.com

同样您可以通过setRequestProperty方法进行X-Online-Host请求头域的设置。