Tento návod řeší příkazy WAPI pro práci s DNS. V některých případech u domén CZ nepracujete s DNS, ale s NSSET. Návod na práci s NSSET najdete v článku WAPI – NSSET.
Pokud jste WAPI ještě nepoužívali, projděte si nejprve článek WAPI – Manuál.
V tomto článku najdete informace k následujícím příkazům:
- dns-domains-list – výpis seznamu domén uživatele v DNS
- dns-domain-info – informace o doméně
- dns-domain-add – přidání domény do DNS
- dns-domain-delete – smazání domény
- dns-domain-axfr-run – vyžádání AXFR přenosu z primárního serveru do našeho DNS
- dns-domain-copy – přidání domény do DNS vytvořením kopie jiné domény
- dns-domain-update-keyset – úprava údajů keysetu domény
- dns-domain-commit – dokončení změn DNS
- dns-rows-list – získání seznamu záznamů domény
- dns-row-detail – získání detailu záznamu
- dns-row-add – přidání záznamu
- dns-row-update – editace záznamu
- dns-row-delete – smazání záznamu
dns-domains-list
Příkazem dns-domains-list vypíšete seznam domén uživatele v DNS.
Parametry
Příkaz nepřijímá žádné parametry.
Návratové hodnoty
- 1000 – OK
Návratová data
Příkaz vrací seznam domén v tomto tvaru:
- domain
- name – název domény
- status – stav
- type – typ (primary/secondary)
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-domains-list",
"clTRID": "vlastní id kód",
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domains-list", "data": { "domain1": { "name": "název domény v DNS", "type": "typ (primary/secondary)", "status": "stav" } } } }
dns-domain-info
Příkazem dns-domain-info zjistíte základní informace o doméně v DNS systému WEDOS (WDNS).
Parametry
- name – název domény
Návratové hodnoty
- 1000 – OK
- 2201 – nepodporované TLD
- 2202 – neplatný název domény
- 3222 – selhalo otevření domény
- 3223 – chyba autorizace
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
Návratová data
V případě úspěchu vrací příkaz detail o doméně ve WDNS v uzlu data/domain.
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-domain-info",
"clTRID": "vlastní id kód",
"data": {
"name": "název domény"
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domain-info", "data": { "domain": { "name": "název domény", "status": "", "type": "", "tlock": "", "autocommit": "", "axfr_enabled": "povoleno odchozí axfr? (0/1)", "axfr_ips": "seznam povolených ip adres pro axfr", "changed": "", "changed_date": "", "commit_date": "", "reload_pending": "", "reload_pending_date": "", "reload_date": "", "disabled_date": "", "enabled_date": "", "add_date": "", "rname": "", "serial": "", "refresh": "", "retry": "", "expire": "", "minimum": "", "rr_cnt6": "", "ns_out": "", "ns1": "" } } } }
dns-domain-add
Příkazem dns-domain-add přidáte novou doménu do DNS.
Parametry
- name – název domény – povinné
- type – typ záznamu domény (primární/sekundární) – nepovinné (výchozí: primární)
- axfr_enabled – povoleno odchozí axfr? (0/1) – pouze u primární domény – nepovinné (výchozí: 0)
- axfr_ip – seznam povolených IP adres pro axfr (pouze u primárního záznamu, pokud axfr_enabled=1 povinné)
- ip – IP adresa pro odchozí axfr
- primary_ip – IP adresa dns serveru s primárním záznamem domény – povinné u sekundárního záznamu
- template_id – ID vzoru (ID domény typu vzor) – pouze u primární domény, nepovinné
Pokud je zadán typ domény ‚primární‘ a zadáno ‚template_id‘, pak systém ostatní parametry ignoruje a vlastnosti domény nastaví podle konfigurace domény typu vzor.
Návratové hodnoty
- 1000 – ok
- 2100 – chybí vyžadovaný parametr
- 2101 – neplatné vstupní parametry
- 2201 – nepodporované TLD
- 2202 – neplatný název domény
- 2301 – chybný formát položky type
- 2302 – chybí parametr primary_ip
- 2303 – chybný formát položky primary_ip
- 2304 – neplatný formát axfr_enabled
- 2305 – chybí povinný parametr axfr_ips
- 2306 – neplatný formát položky axfr_ips
- 2308 – neplatný formát položky ns
- 2322 – překročen limit počtu domén v DNS na uživatele
- 2323 – vzor nebyl nalezen
- 2324 – vzor lze použít pouze pro vytvoření primární domény
- 2325 – nebyl definován žádný vzor
- 3302 – přidání domény do DNS selhalo
- 3303 – doména již v DNS existuje
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-domain-add",
"clTRID": "vlastní id kód",
"data": {
"name": "název domény",
"axfr_enabled": "0 nebo 1",
"axfr_ips": {
"ip1": "povolená ip adresa AXFR"
}
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domain-add" } }
dns-domain-delete
Použitím příkazu dns-domain-delete smažete doménu z DNS včetně všech jejích záznamů.
Parametry
- name – název domény – povinné
Návratové hodnoty
- 1000 – ok
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3301 – záznam se nepodařilo odstranit
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-domain-delete",
"clTRID": "vlastní id kód",
"data": {
"name": "název domény"
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domain-delete" } }
dns-domain-axfr-run
Příkaz dns-domain-axfr-run aktualizuje v nejbližší možné době (během několika minut) DNS záznamy z primárního serveru přes AXFR. Používá se u sekundárních domén, kde si obsah zóny do naše systému stahujeme z jiného serveru.
Bez používání tohoto příkazu se AXFR řídí údaji REFRESH a RETRY v SOA záznamu.
Parametry
- name – název domény – povinné
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný, nebo nepodporovaný název domény
- 2319 – lze provést pouze u sekundární domény
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
Návratová data
- next_run – čas, kdy dojde k aktualizaci záznamu
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-domain-axfr-run",
"clTRID": "vlastní id kód",
"data": {
"name": "název domény"
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domain-axfr-run", "data": { "next_run": "datum a čas další aktualizace záznamu" } } }
dns-domain-copy
Použitím příkazu dns-domain-copy přidáte doménu do DNS zkopírováním nastavení a záznamů z jiné již existující.
Parametry
- name – název původní domény (kterou kopírujete) – povinné
- name_new – název nové domény – povinné
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný, nebo nepodporovaný název domény
- 2320 – neplatný, nebo nepodporovaný název nové domény
- 2321 – nepodporované TLD nového názvu domény
- 2322 – překročen limit počtu domén v DNS na uživatele
- 3222 – otevření domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
- 3311 – kopírování selhalo
- 3312 – nová doména v DNS již existuje
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-domain-copy",
"clTRID": "vlastní id kód",
"data": {
"name": "název původní domény",
"name_new": "název nové domény"
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domain-copy" } }
dns-domain-update-keyset
Příkaz dns-domain-update-keyset umožňuje provést změny nastavení KEYSETu u domény, tedy zapínat, vypínat a měnit nastavení DNSSECu.
Parametry
- name – název domény včetně koncovky – povinné
- keyset – nastavení KEYSETu – povinné
0 = žádný KEYSET / nepoužívat DNSSEC
1 = náš KEYSET / náš DNSSEC (v případě, že doména používá naše DNS servery a v DNS je primární)
string = název vlastního KEYSETu (v případě, že doména nevyužívá naše DNS servery nebo je u nás jako sekundární)
Návratové hodnoty
- 1000 – ok
- 2202 – chybný doménový název
- 2264 – chybný název KEYSETu
- 2265 – DNSSEC není podporováno
- 2266 – nepodporovaná akce pro sekundární doménu
- 2267 – nepodporovaná akce pro primární doménu
- 3260 – již existuje nevyřízená objednávka nastavení DNSSEC
- 3258 – probíhá odstávka registru
- 3263 – doména nepoužívá naše DNS
- 3222 – nepodařilo se načíst doménu
- 3223 – doména je v jiném zákaznickém účtu
- 3259 – KEYSET není dostupný
- 3262 – nepodařilo se nastavení DNSSEC
- 3264 – KEYSET je blokován
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{ "request": { "user": "váš@login.tld", "auth": "vygenerovaný autorizační řetězec", "command": "dns-domain-update-keyset", "clTRID": "vlastní id kód", "data": { "name": "název domény", "keyset": "0/1/string", } } }
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domain-update-keyset" } }
dns-domain-commit
Příkaz dns-domain-commit používáte po provedení jakýchkoliv změn u domény či jejích DNS záznamech. Potvrzujete jím změny a vyžadujete jejich distribuci na DNS servery.
Bez použití příkazu dns-domain-commit jej systém provede automaticky 5 minut od poslední změny.
Parametry
- name – název domény – povinné
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný nebo nepodporovaný název domény
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{ "request": { "user": "váš@login.tld", "auth": "vygenerovaný autorizační řetězec", "command": "dns-domain-commit", "clTRID": "vlastní id kód", "data": { "name": "název domény" } } }
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-domain-commit" } }
dns-rows-list
Příkazem dns-rows-list získáte seznam záznamů dané domény v DNS s jejich základními údaji.
Pro získání detailnějších informací o jednom konkrétním záznamu použijte příkaz dns-row-detail.
Parametry
- domain – název domény – povinné
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný nebo nepodporovaný název domény
- 2318 – nelze provést u sekundární domény
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
Návratová data
- row – záznam
- ID – ID záznamu
- name – jméno záznamu
- ttl – TTL záznamu
- rdtype – typ záznamu
- rdata – data záznamu
- changed_date – datum změny
- author_comment – komentář
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-rows-list",
"clTRID": "vlastní id kód",
"data": {
"domain": "název domény"
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-rows-list", "data": { "row1": { "ID": "ID záznamu", "name": "název záznamu (může být prázdné)", "ttl": "TTL", "rdtype": "typ záznamu", "rdata": "data záznamu", "changed_date": "Datum a čas změny", "author_comment": "Komentář autora změny" } } } }
dns-row-detail
Příkazem dns-row-detail vrátí podrobné informace o jednom konkrétním DNS záznamu u domény.
Pro získání seznamu všech záznamů u domény použijte příkaz dns-rows-list.
Parametry
- name – název domény – povinné
- row_id – ID záznamu – povinné, zjistíte z příkazu dns-rows-list
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný nebo nepodporovaný název domény
- 2318 – tuto akci nelze provést u sekundární domény
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
- 3309 – požadovaný DNS záznam u domény neexistuje
Návratová data
- row – záznam
- ID – ID záznamu
- name – jméno záznamu
- ttl – TTL záznamu
- rdtype – typ záznamu
- rdata – data záznamu
- changed_date – datum změny
- author_comment – komentář
Šablony
JSON příkaz:
{ "request": { "user": "váš@login.tld", "auth": "vygenerovaný autorizační řetězec", "command": "dns-row-detail", "clTRID": "vlastní id kód", "data": { "name": "název domény", "row_id": "ID záznamu" } } }
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-row-detail", "data": { "row1": { "ID": "ID záznamu", "name": "název záznamu (může být prázdné)", "ttl": "TTL", "rdtype": "typ záznamu", "rdata": "data záznamu", "changed_date": "Datum a čas změny", "author_comment": "Komentář autora změny" } } } }
dns-row-add
Příkaz dns-row-add přidá nový DNS záznam k doméně.
Parametry
- domain – název domény – povinné
- name – název záznamu – povinné (ale může být prázdný)
- ttl – hodnota TTL – povinné
- type – typ záznamu – povinné
- rdata – data záznamu – povinné
- auth_comment – komentář autora (nepovinné)
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný nebo nepodporovaný název domény
- 2309 – neplatný typ záznamu
- 2310 – nelze přidat další záznam k doméně
- 2311 – neplatný název
- 2312 – neplatný název pro daný typ záznamu
- 2313 – neplatné CNAME pro tento název
- 2314 – neplatná data záznamu
- 2315 – neplatné TTL
- 2316 – tento záznam již existuje
- 2317 – neplatné TTL
- 2318 – akci nelze provést u sekundární domény
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-row-add",
"clTRID": "vlastní id kód",
"data": {
"domain": "název domény",
"name": "název záznamu (může být prázdný)",
"ttl": "TTL",
"type": "typ záznamu",
"rdata": "data záznamu"
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-row-add", } }
dns-row-update
Příkazem dns-row-update provedete změnu v DNS záznamu domény.
U záznamu nelze měnit jeho název (name) a typ (type). V takové situaci původní záznam smažte a poté vytvořte nový.
Parametry
- domain – název domény – povinné
- row_id – ID záznamu – povinné, zjistíte z výpisu dns-rows-list
- ttl – hodnota TTL – povinné
- rdata – data záznamu – povinné
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný nebo nepodporovaný název domény
- 2309 – neplatný typ záznamu
- 2310 – nelze přidat další záznam k doméně
- 2311 – neplatný název
- 2312 – neplatný název pro daný typ záznamu
- 2313 – neplatné CNAME pro tento název
- 2314 – neplatná data záznamu
- 2315 – neplatné TLD
- 2316 – tento záznam již existuje
- 2317 – neplatný TTL
- 2318 – akci nelze provést u sekundární domény
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
- 3309 – záznam tohoto ID neexistuje
- 3310 – úprava záznamu selhala
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{
"request": {
"user": "váš@login.tld",
"auth": "vygenerovaný autorizační řetězec",
"command": "dns-row-update",
"clTRID": "vlastní id kód",
"data": {
"domain": "název domény",
"row_id": "ID řádku",
"ttl": "TTL",
"rdata": "data záznamu"
}
}
}
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-row-update", } }
dns-row-delete
Příkazem dns-row-delete smažete DNS záznam u domény.
Parametry
- domain – název domény – povinné
- row_id – ID záznamu – povinné, zjistíte z výpisu dns-rows-list
Návratové hodnoty
- 1000 – ok
- 2201 – nepodporované TLD
- 2202 – neplatný nebo nepodporovaný název domény
- 2318 – akci nelze provést u sekundární domény
- 3222 – otevírání domény selhalo
- 3223 – přístup zamítnut
- 3305 – doména je uzamčena pro editaci
- 3306 – doména je smazaná
- 3308 – mazání záznamu selhalo
- 3309 – záznam tohoto ID neexistuje
Návratová data
Příkaz nevrací žádná data.
Šablony
JSON příkaz:
{ "request": { "user": "váš@login.tld", "auth": "vygenerovaný autorizační řetězec", "command": "dns-row-delete", "clTRID": "vlastní id kód", "data": { "domain": "název domény", "row_id": "ID řádku" } } }
JSON odpověď (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF čas", "clTRID": "vlastní id kód", "svTRID": "id kód serveru", "command": "dns-row-delete", } }