HTTPDNS:Java SDK API

Definisi operasi

static void init(String accountId, InitConfig config)

Kelas

HttpDnsClient

Parameter

Contoh kode

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

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

Definisi antarmuka

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

Kelas

HttpDnsClient

Parameter

Deskripsi Kembalian

Contoh kode

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

setSecretKey

Menetapkan kunci yang digunakan untuk menandatangani permintaan selama resolusi HTTPDNS.

Setelah kunci ditetapkan, SDK akan menandatangani permintaan yang dikirim ke server. Hal ini membantu server HTTPDNS mengotentikasi permintaan resolusi dan menyediakan Proteksi anti-pemalsuan, sehingga meningkatkan keamanan interaksi antara SDK dan server.

Definisi Antarmuka

InitConfig.Builder setSecretKey(String secretKey)

Kelas

InitConfig.Builder

Parameter

setAesSecretKey

Menetapkan kunci yang digunakan untuk enkripsi selama resolusi HTTPDNS.

Setelah kunci enkripsi ditetapkan, SDK menggunakan algoritma AES untuk mengenkripsi parameter permintaan dan respons saat mengirim permintaan ke sisi server. Fitur enkripsi ini memberikan keamanan yang lebih baik, tetapi juga memengaruhi logika penagihan. Untuk informasi selengkapnya, lihat Penagihan Produk.

Definisi Antarmuka

InitConfig.Builder setAesSecretKey(String aesSecretKey)

Kelas

InitConfig.Builder

Parameter

setEnableHttps

Secara default, SDK HTTPDNS menggunakan protokol HTTP untuk mengirim permintaan resolusi. Untuk menggunakan protokol HTTPS, Anda dapat mengonfigurasi SDK agar menggunakan HTTPS dalam resolusi nama domain.

Permintaan HTTPS memberikan keamanan yang lebih tinggi. Namun, permintaan HTTP dan HTTPS memiliki skema penagihan yang berbeda. Untuk informasi selengkapnya, lihat Penagihan Produk.

Definisi Antarmuka

InitConfig.Builder setEnableHttps(boolean enableHttps)

Kelas

InitConfig.Builder

Parameter

setTimeoutMillis

Menetapkan periode timeout untuk resolusi nama domain. Nilai default adalah 2.000 ms.

Definisi Antarmuka

InitConfig.Builder setTimeoutMillis(int timeoutMillis)

Kelas

InitConfig.Builder

Parameter

setEnableExpiredIp

SDK mengikuti protokol DNS dan menyimpan cache hasil resolusi nama domain sesuai dengan Time to Live (TTL)-nya. Hal ini meningkatkan efisiensi pengambilan alamat IP ketika aplikasi memulai permintaan jaringan. Ketika cache kedaluwarsa, jika aplikasi memanggil operasi resolusi untuk mengambil alamat IP, situasi berikut dapat terjadi:

1. Jika aplikasi memanggil operasi sinkron non-blocking dan cache telah kedaluwarsa, SDK tidak dapat langsung mengambil hasil resolusi baru dari server. Untuk menghindari pemblokiran thread, operasi tersebut mengembalikan hasil kosong. Pemanggil harus menangani fallback ke resolusi LocalDNS.

2. Jika aplikasi memanggil operasi sinkron atau asinkron, SDK mengirim permintaan resolusi untuk mengambil hasil baru dari server. Proses ini memerlukan waktu tertentu. Operasi sinkron memblokir thread hingga hasil baru diperoleh. Operasi asinkron hanya memberikan callback setelah hasil baru diperoleh.

SDK menyediakan opsi untuk menggunakan kembali alamat IP yang telah kedaluwarsa. Jika Anda menetapkan opsi ini ke true, operasi tersebut dapat langsung mengembalikan alamat IP yang kedaluwarsa meskipun cache IP telah kedaluwarsa. Hal ini mengurangi waktu pemrosesan untuk langkah DNS dan meningkatkan performa permintaan jaringan. Secara bersamaan, ketika SDK mendeteksi bahwa IP telah kedaluwarsa, SDK juga memulai thread asinkron untuk meresolusi nama domain dan mengambil hasil resolusi baru.

Oleh karena itu, efek samping dari mengaktifkan opsi ini minimal, terutama ketika konfigurasi resolusi nama domain tersebut tidak sering berubah, seperti untuk nama domain situs utama atau nama domain gateway statis. Jika resolusi nama domain memang berubah, pengaktifan opsi ini hanya memengaruhi permintaan pertama setelah cache domain kedaluwarsa. Hal ini karena ketika SDK dipanggil dan menemukan IP yang kedaluwarsa, SDK selalu langsung memulai pembaruan resolusi nama domain.

Diaktifkan secara default.

Definisi Antarmuka

InitConfig.Builder setEnableExpiredIp(boolean enableExpiredIp)

Kelas

InitConfig.Builder

Parameter

enableMemoryCache

Menetapkan apakah akan mengaktifkan cache memori.

Definisi Antarmuka

InitConfig.Builder enableMemoryCache(boolean enable)

Kelas

InitConfig.Builder

Parameter

setRegion

Jika aplikasi Anda perlu menggunakan HTTPDNS di lingkungan di luar Tiongkok, Anda dapat menetapkan node layanan startup untuk SDK ini guna meningkatkan efisiensi resolusi. Setelah Anda menetapkan node tersebut, SDK akan menggunakan node tersebut untuk resolusi nama domain dan untuk pembaruan selanjutnya terhadap daftar node penjadwalan.

Definisi Antarmuka

InitConfig.Builder setRegion(Region region)

Kelas

InitConfig.Builder

Parameter

setIPRankingList

Menetapkan daftar preferensi IP. Setelah Anda mengonfigurasi operasi ini, jika nama domain yang sesuai diresolusi, SDK akan melakukan speed test IP pada alamat IP yang dikembalikan. SDK secara dinamis mengurutkan daftar yang dikembalikan untuk memastikan alamat IP pertama memiliki ketersediaan yang lebih baik.

Definisi Antarmuka

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

Kelas

InitConfig.Builder

Parameter

configCacheTtlChanger

Secara default, setiap hasil resolusi menggunakan TTL yang disediakan oleh server untuk menentukan apakah hasil tersebut telah kedaluwarsa. Untuk memodifikasi TTL dari hasil resolusi, Anda dapat mengonfigurasinya menggunakan operasi ini.

Definisi Antarmuka

InitConfig.Builder configCacheTtlChanger(CacheTtlChanger changer)

Kelas

InitConfig.Builder

Parameter

setNotUseHttpDnsFilter

Untuk mencegah nama domain tertentu diresolusi menggunakan HTTPDNS, Anda dapat memfilter nama domain tersebut dengan operasi ini. Nama domain yang difilter akan mengembalikan hasil resolusi kosong. Anda perlu melakukan fallback ke LocalDNS untuk resolusi nama domain.

Definisi Antarmuka

InitConfig.Builder setNotUseHttpDnsFilter(NotUseHttpDnsFilter filter)

Kelas

InitConfig.Builder

Parameter

setSdnsGlobalParams

Menetapkan parameter global untuk resolusi kustom (SDNS). Parameter global ini tidak memengaruhi pengaturan parameter tambahan dari operasi resolusi kustom. Parameter ini digabungkan dengan parameter tambahan dari operasi resolusi kustom. Setiap permintaan resolusi kustom membawa parameter global ini.

Definisi Antarmuka

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

Kelas

InitConfig.Builder

Parameter

setPreResolveHosts

Definisi Antarmuka

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

Kelas

HttpDnsClient

Parameter

Contoh Kode

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

getHttpDnsResultForHostSyncNonBlocking

Definisi Antarmuka

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)

Kelas

HttpDnsClient

Parameter

Nilai Kembalian

Contoh Kode

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

Definisi Antarmuka

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)

Kelas

HttpDnsClient

Parameter

Nilai Kembalian

Contoh Kode

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

getHttpDnsResultForHostAsync

Definisi Antarmuka

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)

Kelas

HttpDnsClient

Parameter

Contoh Kode

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();
                // Gunakan hasil resolusi.
            }
        }
    });

cleanHostCache

Definisi Antarmuka

void cleanHostCache(ArrayList<String> hosts)

Kelas

HttpDnsClient

Parameter

Contoh Kode

// Hapus cache untuk nama domain tertentu.
ArrayList<String> hosts = new ArrayList<>();
hosts.add("www.example.com");
client.cleanHostCache(hosts);

// Hapus semua cache.
client.cleanHostCache(null);

getSessionId

Definisi Antarmuka

String getSessionId()

Kelas

HttpDnsClient

Nilai Kembalian

Contoh Kode

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

getSdkVersion

Definisi Antarmuka

String getSdkVersion()

Kelas

HttpDnsClient

Nilai Kembalian

Contoh Kode

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

HttpDnsLog.enable

Menetapkan apakah akan mengaktifkan pencatatan log untuk HTTPDNS. Secara default dinonaktifkan.

Definisi Antarmuka

static void enable(boolean enable)

Kelas

HttpDnsLog

Parameter

Contoh Kode

HttpDnsLog.enable(true);

HttpDnsLog.setLogger

Anda dapat mengambil log yang dioutput oleh SDK dengan menetapkan kelas callback log.

Definisi Antarmuka

static void setLogger(ILogger logger)

Kelas

HttpDnsLog

Parameter

Contoh Kode

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

HttpDnsLog.removeLogger

Menghapus kelas callback log.

Definisi Antarmuka

static void removeLogger(ILogger logger)

Kelas

HttpDnsLog

Parameter

Contoh Kode

HttpDnsLog.removeLogger(myLogger);

setRegion

Definisi Antarmuka

void setRegion(Region region)

Kelas

HttpDnsClient

Parameter

Contoh Kode

client.setRegion(Region.HK);  // Beralih ke node Tiongkok (Hong Kong).

setAuthCurrentTime

Definisi Antarmuka

void setAuthCurrentTime(long time)

Kelas

HttpDnsClient

Parameter

Contoh Kode

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

getHost

Mengambil nama domain yang sesuai.

Definisi Antarmuka

String getHost()

Nilai Kembalian

getIps

Mengambil alamat IPv4 yang diresolusi.

Definisi Antarmuka

String[] getIps()

Nilai Kembalian

getIpv6s

Mengambil alamat IPv6 yang diresolusi.

Definisi Antarmuka

String[] getIpv6s()

Nilai Kembalian

getExtras

Mengambil parameter tambahan dari resolusi. Hanya resolusi kustom yang memiliki data ini.

Definisi Antarmuka

String getExtras()

Nilai Kembalian

isExpired

Menunjukkan apakah hasil resolusi telah kedaluwarsa. Kedaluwarsa dihitung berdasarkan waktu hasil diperoleh dan TTL yang dikonfigurasi untuk nama domain.

Definisi Antarmuka

boolean isExpired()

Nilai Kembalian

getTtl

Mengambil Time to Live (TTL) dari hasil resolusi.

Definisi Antarmuka

int getTtl()

Nilai Kembalian

onHttpDnsCompleted

Fungsi callback setelah resolusi selesai. Fungsi ini dipanggil baik untuk keberhasilan maupun kegagalan.

Definisi Antarmuka

void onHttpDnsCompleted(HTTPDNSResult result)

Parameter

Contoh Kode

client.getHttpDnsResultForHostAsync("www.example.com", RequestIpType.both, 
    new HttpDnsCallback() {
        @Override
        public void onHttpDnsCompleted(HTTPDNSResult result) {
            if (result != null && result.getIps() != null) {
                // Resolusi berhasil.
            } else {
                // Resolusi gagal atau tidak ada hasil.
            }
        }
    });

log

Metode log.

Definisi Antarmuka

void log(String msg)

Parameter

Contoh Kode

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

changeCacheTtl

Menyesuaikan TTL.

Definisi Antarmuka

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

Parameter

Deskripsi Respons

Contoh Kode

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

Mengonfigurasi nama domain yang tidak boleh diresolusi oleh HTTPDNS.

Definisi Antarmuka

boolean notUseHttpDns(String hostName)

Parameter

Nilai Kembalian

Contoh Kode

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

Konstruktor

IPRankingBean(String hostName, int port)

Parameter

getHostName

Mengambil nama domain.

Definisi Antarmuka

String getHostName()

getPort

Mengambil port.

Definisi Antarmuka

int getPort()

Contoh Kode

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);