HTTPDNS:Java SDK API

操作の定義

static void init(String accountId, InitConfig config)

クラス

HttpDnsClient

パラメーター

コード例

InitConfig config = new InitConfig.Builder()
    .setSecretKey("your-secret-key")
    .setEnableHttps(true)
    .setTimeoutMillis(2000)
    .setEnableExpiredIp(true)
    .build();

HttpDnsClient.init("your-account-id", config);

インターフェイスの定義

static HttpDnsClient getClient(String accountId)
static HttpDnsClient getClient(String accountId, String secretKey)

クラス

HttpDnsClient

パラメーター

戻り値の説明

コード例

HttpDnsClient client = HttpDnsClient.getClient("your-account-id");

setSecretKey

HTTPDNS 解決時にリクエストの署名に使用するキーを設定します。

キーを設定すると、SDK はサーバーに送信するリクエストに署名します。これにより、HTTPDNS サーバーは解決リクエストを認証し、改ざん防止機能を提供します。このプロセスにより、SDK とサーバー間の対話のセキュリティが向上します。

インターフェイスの定義

InitConfig.Builder setSecretKey(String secretKey)

クラス

InitConfig.Builder

パラメーター

setAesSecretKey

HTTPDNS 解決時の暗号化に使用するキーを設定します。

暗号鍵を設定すると、SDK はサーバーサイドにリクエストを送信する際に、AES アルゴリズムを使用してリクエストパラメーターと応答を暗号化します。この暗号化機能はセキュリティを強化しますが、課金ロジックにも影響します。詳細については、「製品課金」をご参照ください。

インターフェイスの定義

InitConfig.Builder setAesSecretKey(String aesSecretKey)

クラス

InitConfig.Builder

パラメーター

setEnableHttps

デフォルトでは、HTTPDNS SDK は HTTP プロトコルを使用して解決リクエストを送信します。HTTPS プロトコルを使用するには、SDK が HTTPS を使用して名前解決を行うように設定できます。

HTTPS リクエストはより高いセキュリティを提供します。ただし、HTTP リクエストと HTTPS リクエストでは課金方法が異なります。詳細については、「製品課金」をご参照ください。

インターフェイスの定義

InitConfig.Builder setEnableHttps(boolean enableHttps)

クラス

InitConfig.Builder

パラメーター

setTimeoutMillis

名前解決のタイムアウト期間を設定します。デフォルト値は 2000 ミリ秒です。

インターフェイスの定義

InitConfig.Builder setTimeoutMillis(int timeoutMillis)

クラス

InitConfig.Builder

パラメーター

setEnableExpiredIp

SDK は DNS プロトコルに従い、TTL (Time to Live) に基づいて名前解決の結果をキャッシュします。これにより、アプリケーションがネットワークリクエストを開始する際の IP アドレス取得の効率が向上します。キャッシュの有効期限が切れた場合、アプリケーションが解決操作を呼び出して IP アドレスを取得すると、状況に応じて異なる動作をします：

1. アプリケーションが同期非ブロッキング操作を呼び出し、キャッシュが期限切れの場合、SDK はサーバーから新しい解決結果をすぐに取得できません。スレッドのブロッキングを避けるため、操作は空の結果を返します。呼び出し元は LocalDNS 解決へのフォールバックを処理する必要があります。

2. アプリケーションが同期または非同期操作を呼び出すと、SDK は解決リクエストを送信してサーバーから新しい結果を取得します。このプロセスには時間がかかります。同期操作は新しい結果が得られるまでスレッドをブロックします。非同期操作は新しい結果が得られた後にのみコールバックを提供します。

SDK は、期限切れの IP アドレスを再利用するオプションを提供します。このオプションを true に設定すると、キャッシュされた IP が期限切れであっても、操作はすぐに期限切れの IP アドレスを返すことができます。これにより、DNS ステップの処理時間が短縮され、ネットワークリクエストのパフォーマンスが向上します。同時に、SDK が IP の期限切れを検出すると、非同期スレッドを開始してドメイン名を解決し、新しい解決結果を取得します。

したがって、このオプションを有効にすることによる副作用は最小限です。特に、プライマリサイトのドメイン名や静的ゲートウェイのドメイン名など、ドメイン名自体の解決設定が頻繁に変更されない場合に有効です。ドメイン名の解決が変更された場合でも、このオプションを有効にすることによる影響は、ドメインのキャッシュが期限切れになった後の最初のリクエストに限定されます。これは、SDK が呼び出されて期限切れの IP を検出すると、常に即座にドメイン名の解決の更新を開始するためです。

デフォルトで有効になっています。

インターフェイスの定義

InitConfig.Builder setEnableExpiredIp(boolean enableExpiredIp)

クラス

InitConfig.Builder

パラメーター

enableMemoryCache

メモリキャッシュを有効にするかどうかを設定します。

インターフェイスの定義

InitConfig.Builder enableMemoryCache(boolean enable)

クラス

InitConfig.Builder

パラメーター

setRegion

アプリケーションが中国以外の環境で HTTPDNS を使用する必要がある場合、この SDK の起動サービスノードを設定して解決効率を向上させることができます。ノードを設定すると、SDK はそのノードを名前解決および後続のスケジューリングノードリストの更新に使用します。

インターフェイスの定義

InitConfig.Builder setRegion(Region region)

クラス

InitConfig.Builder

パラメーター

setIPRankingList

IP プリファレンスリストを設定します。この操作を設定すると、対応するドメイン名が解決された場合、SDK は返された IP アドレスに対して IP 速度テストを実行します。返されたリストを動的にソートして、最初の IP アドレスがより良い可用性を持つようにします。

インターフェイスの定義

InitConfig.Builder setIPRankingList(List<? extends IPRankingBean> ipRankingList)

クラス

InitConfig.Builder

パラメーター

configCacheTtlChanger

デフォルトでは、各解決結果はサーバーから提供された TTL を使用して期限切れかどうかを判断します。解決結果の TTL を変更するには、この操作を使用して設定できます。

インターフェイスの定義

InitConfig.Builder configCacheTtlChanger(CacheTtlChanger changer)

クラス

InitConfig.Builder

パラメーター

setNotUseHttpDnsFilter

特定のドメイン名が HTTPDNS を使用して解決されるのを防ぐために、この操作でそれらのドメイン名をフィルタリングできます。フィルタリングされたドメイン名は空の解決結果を返します。名前解決には LocalDNS へのフォールバックが必要です。

インターフェイスの定義

InitConfig.Builder setNotUseHttpDnsFilter(NotUseHttpDnsFilter filter)

クラス

InitConfig.Builder

パラメーター

setSdnsGlobalParams

カスタム解決 (SDNS) のグローバルパラメーターを設定します。これらのグローバルパラメーターは、カスタム解決操作の追加パラメーター設定には影響しません。これらはカスタム解決操作の追加パラメーターとマージされます。各カスタム解決リクエストはこれらのグローバルパラメーターを伴います。

インターフェイスの定義

InitConfig.Builder setSdnsGlobalParams(Map<String, String> params)

クラス

InitConfig.Builder

パラメーター

setPreResolveHosts

インターフェイスの定義

void setPreResolveHosts(List<String> hostList)
void setPreResolveHosts(List<String> hostList, RequestIpType requestIpType)

クラス

HttpDnsClient

パラメーター

コード例

List<String> hosts = Arrays.asList("www.example.com", "api.example.com");
client.setPreResolveHosts(hosts, RequestIpType.both);

getHttpDnsResultForHostSyncNonBlocking

インターフェイスの定義

HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType type)
HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType type, String clientIp)
HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType type, Map<String, String> params, String cacheKey)
HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType type, Map<String, String> params, String cacheKey, String clientIp)

クラス

HttpDnsClient

パラメーター

戻り値

コード例

HTTPDNSResult result = client.getHttpDnsResultForHostSyncNonBlocking(
    "www.example.com", 
    RequestIpType.both
);

if (result != null && result.getIps() != null && result.getIps().length > 0) {
    String ip = result.getIps()[0];
}

getHttpDnsResultForHostSync

インターフェイスの定義

HTTPDNSResult getHttpDnsResultForHostSync(String host, RequestIpType type)
HTTPDNSResult getHttpDnsResultForHostSync(String host, RequestIpType type, String clientIp)
HTTPDNSResult getHttpDnsResultForHostSync(String host, RequestIpType type, Map<String, String> params, String cacheKey)
HTTPDNSResult getHttpDnsResultForHostSync(String host, RequestIpType type, Map<String, String> params, String cacheKey, String clientIp)

クラス

HttpDnsClient

パラメーター

戻り値

コード例

HTTPDNSResult result = client.getHttpDnsResultForHostSync(
    "www.aliyun.com", 
    RequestIpType.both
);

getHttpDnsResultForHostAsync

インターフェイスの定義

void getHttpDnsResultForHostAsync(String host, RequestIpType type, HttpDnsCallback callback)
void getHttpDnsResultForHostAsync(String host, RequestIpType type, String clientIp, HttpDnsCallback callback)
void getHttpDnsResultForHostAsync(String host, RequestIpType type, Map<String, String> params, String cacheKey, HttpDnsCallback callback)
void getHttpDnsResultForHostAsync(String host, RequestIpType type, Map<String, String> params, String cacheKey, String clientIp, HttpDnsCallback callback)

クラス

HttpDnsClient

パラメーター

コード例

client.getHttpDnsResultForHostAsync("www.example.com", RequestIpType.both, 
    new HttpDnsCallback() {
        @Override
        public void onHttpDnsCompleted(HTTPDNSResult result) {
            if (result != null && result.getIps() != null) {
                String[] ips = result.getIps();
                // 解決結果を使用します。
            }
        }
    });

cleanHostCache

インターフェイスの定義

void cleanHostCache(ArrayList<String> hosts)

クラス

HttpDnsClient

パラメーター

コード例

// 特定のドメイン名のキャッシュをクリアします。
ArrayList<String> hosts = new ArrayList<>();
hosts.add("www.example.com");
client.cleanHostCache(hosts);

// すべてのキャッシュをクリアします。
client.cleanHostCache(null);

getSessionId

インターフェイスの定義

String getSessionId()

クラス

HttpDnsClient

戻り値

コード例

String sessionId = client.getSessionId();
System.out.println("SessionId: " + sessionId);

getSdkVersion

インターフェイスの定義

String getSdkVersion()

クラス

HttpDnsClient

戻り値

コード例

String version = client.getSdkVersion();
System.out.println("SDK Version: " + version);

HttpDnsLog.enable

HTTPDNS のロギングを有効にするかどうかを設定します。デフォルトでは無効になっています。

インターフェイスの定義

static void enable(boolean enable)

クラス

HttpDnsLog

パラメーター

コード例

HttpDnsLog.enable(true);

HttpDnsLog.setLogger

ログコールバッククラスを設定することで、SDK が出力するログを取得できます。

インターフェイスの定義

static void setLogger(ILogger logger)

クラス

HttpDnsLog

パラメーター

コード例

HttpDnsLog.setLogger(new ILogger() {
    @Override
    public void log(String msg) {
        System.out.println("[HTTPDNS] " + msg);
    }
});

HttpDnsLog.removeLogger

ログコールバッククラスを削除します。

インターフェイスの定義

static void removeLogger(ILogger logger)

クラス

HttpDnsLog

パラメーター

コード例

HttpDnsLog.removeLogger(myLogger);

setRegion

インターフェイスの定義

void setRegion(Region region)

クラス

HttpDnsClient

パラメーター

コード例

client.setRegion(Region.HK);  // 中国 (香港) ノードに切り替えます。

setAuthCurrentTime

インターフェイスの定義

void setAuthCurrentTime(long time)

クラス

HttpDnsClient

パラメーター

コード例

HttpDnsClient client = HttpDnsClient.getClient(accountId);
client.setAuthCurrentTime(System.currentTimeMillis());

getHost

対応するドメイン名を取得します。

インターフェイスの定義

String getHost()

戻り値

getIps

解決された IPv4 アドレスを取得します。

インターフェイスの定義

String[] getIps()

戻り値

getIpv6s

解決された IPv6 アドレスを取得します。

インターフェイスの定義

String[] getIpv6s()

戻り値

getExtras

解決から追加パラメーターを取得します。カスタム解決のみがこのデータを持ちます。

インターフェイスの定義

String getExtras()

戻り値

isExpired

解決結果が期限切れかどうかを示します。有効期限は、結果が取得された時刻とドメイン名に設定された TTL に基づいて計算されます。

インターフェイスの定義

boolean isExpired()

戻り値

getTtl

解決結果の TTL (Time to Live) を取得します。

インターフェイスの定義

int getTtl()

戻り値

onHttpDnsCompleted

解決完了後のコールバック関数。この関数は成功と失敗の両方で呼び出されます。

インターフェイスの定義

void onHttpDnsCompleted(HTTPDNSResult result)

パラメーター

コード例

client.getHttpDnsResultForHostAsync("www.example.com", RequestIpType.both, 
    new HttpDnsCallback() {
        @Override
        public void onHttpDnsCompleted(HTTPDNSResult result) {
            if (result != null && result.getIps() != null) {
                // 解決に成功しました。
            } else {
                // 解決に失敗したか、結果がありません。
            }
        }
    });

log

ログメソッド。

インターフェイスの定義

void log(String msg)

パラメーター

コード例

HttpDnsLog.setLogger(new ILogger() {
    @Override
    public void log(String msg) {
        // カスタムログ処理。
        System.out.println("[HTTPDNS] " + msg);
    }
});

changeCacheTtl

TTL をカスタマイズします。

インターフェイスの定義

int changeCacheTtl(String host, RequestIpType type, int ttl)

パラメーター

応答の説明

コード例

new InitConfig.Builder()
    .configCacheTtlChanger(new CacheTtlChanger() {
        @Override
        public int changeCacheTtl(String host, RequestIpType type, int ttl) {
            if ("www.aliyun.com".equals(host)) {
                return ttl * 10;
            }
            return ttl;
        }
    });

notUseHttpDns

HTTPDNS で解決すべきでないドメイン名を設定します。

インターフェイスの定義

boolean notUseHttpDns(String hostName)

パラメーター

戻り値

コード例

new InitConfig.Builder()
    .setNotUseHttpDnsFilter(new NotUseHttpDnsFilter() {
        @Override
        public boolean notUseHttpDns(String hostName) {
            return "www.aliyun.com".equals(hostName);
        }
    });

コンストラクター

IPRankingBean(String hostName, int port)

パラメーター

getHostName

ドメイン名を取得します。

インターフェイスの定義

String getHostName()

getPort

ポートを取得します。

インターフェイスの定義

int getPort()

コード例

List<IPRankingBean> list = new ArrayList<>();
list.add(new IPRankingBean("www.example.com", 443));
list.add(new IPRankingBean("api.example.com", 8080));

new InitConfig.Builder()
    .setIPRankingList(list);