WAPI - WEDOS DNS - Dokumentace a znalostní báze systému WEDOS

Tento článek se zabývá příkazy WAPI konkrétně pro službu WEDOS DNS. Informace o nastavení WAPI a řešení běžných problémů naleznete v článku WAPI - manuál.

Tento článek obsahuje informace o následujících žádostech:

dns-domains-list - seznam domén DNS v uživatelském účtu
dns-domain-info - informace o doméně
dns-domain-add - přidání domény do DNS
dns-domain-delete - odstraní doménu z DNS
dns-domain-axfr-run - vyžádá si přenos AXFR z primárního serveru do našeho DNS.
dns-domain-copy - přidání domény do DNS zkopírováním jiné domény
dns-domain-update-keyset - úprava sady klíčů domény
dns-domain-commit - uložení změn DNS
dns-rows-list - načte seznam doménových záznamů
dns-row-detail - načtení detailu záznamu
dns-row-add - přidat záznam
dns-row-update - editace záznamu
dns-row-delete - odstranění záznamu

dns-domains-list

Pomocí požadavku dns-domains-list můžete vypsat seznam domén DNS uživatele.

Parametry

search - řetězec pro vyhledávání mezi názvy domén - nepovinné
status - filtrování podle stavu (aktivní, zakázaný) - nepovinné
type - filtr podle typu domény (primární, sekundární) - nepovinné
page - číslo stránky (výchozí: 1) - nepovinné
page_limit - počet záznamů na stránku (výchozí: 50) - nepovinné
orderby - seřadí záznamy podle data vytvoření nebo domény, následované asc/desc - nepovinné, viz šablona

Návratové hodnoty

1000 - OK

Údaje o odezvě

Požadavek vrátí seznam domén, které používají tuto šablonu:

doména
- name - název domény
- status - stav domény v systému
- type - typ (primární/sekundární)

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domains-list",
    "clTRID": "your ID",
    "data": { 
      "search": "search term in domain name",
      "status": "active|disabled",
      "type": "primary|secondary",
      "page": "page number",
      "page_limit": "number of entries per page",
      "orderby":"domain|created_date asc|desc"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domains-list",
    "data": {
      "domain": [
        {
          "name": "domain1 name in DNS",
          "type": "type (primary|secondary)",
          "status": "active|disabled"
        }
      ],
      "total": "počet položek celkem",
      "page": "číslo stránky",
      "page_limit": "počet položek na stránku"
    }
  }
}

dns-domain-info

Pomocí požadavku dns-domain-info zjistíte základní informace o doméně v systému WEDOS DNS (WDNS).

Parametry

name - název domény - povinné

Návratové hodnoty

1000 = OK
2201 = nepodporovaná TLD
2202 = neplatný název domény
3222 = nepodařilo se otevřít doménu
3223 = chyba autorizace
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána

Vrátit data

V případě úspěchu požadavek vrátí detail domény v systému WDNS v uzlu data/doména.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-info",
    "clTRID": "your ID",
    "data": {
      "name": "domain name"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-info",
    "data": {
      "domain": {
        "name": "domain name",
        "status": "",
        "type": "",
        "tlock": "",
        "autocommit": "",
        "axfr_enabled": "outgoing axfr enabled? (0/1)",
        "axfr_ips": "allowed axfr IPs list",
        "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

Pomocí požadavku dns-domain-add přidáte novou doménu do systému 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 - je povolen odchozí axfr? (0/1) - pouze primární domény - nepovinné (výchozí: 0)
axfr_ip - seznam povolených ip adres pro axfr (pouze pro primární položku, vyžadováno, pokud axfr_enabled=1)
ip - ip adresa pro odchozí axfr
primary_ip - ip adresa primárního serveru DNS (povinné, pokud type=secondary)

Návratové hodnoty

1000 = ok
2100 = chybějící požadovaný parametr
2101 = neplatné vstupní parametry
2201 = nepodporovaná TLD
2202 = neplatný název domény
2301 = chybný formát typu
2302 = chybí parametr primary_ip
2303 = chybný formát primary_ip
2304 = neplatný formát axfr_enabled
2305 = chybí požadovaný parametr axfr_ips
2306 = neplatný formát axfr_ips
2308 = neplatný formát ns
2322 = dosažený limit domén v DNS na uživatele
3302 = přidání domény do DNS se nezdařilo
3303 = doména již existuje v systému DNS

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-add",
    "clTRID": "your ID",
    "data": {
      "name": "domain name",
      "axfr_enabled": "0 or 1",
      "axfr_ips": {
        "ip1": "allowed AXFR address"
      }
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-add"
  }
}

dns-domain-delete

Požadavek dns-domain-delete slouží k odstranění domény ze systému DNS včetně všech jejích záznamů.

Parametry

name - název domény - povinné

Návratové hodnoty

1000 = ok
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3301 = záznam nelze odstranit
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-delete",
    "clTRID": "your ID",
    "data": {
      "name": "domain name"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",,
    "command": "dns-domain-delete"
  }
}

dns-domain-axfr-run

Požadavek dns-domain-axfr-run co nejdříve (během několika minut) aktualizuje záznamy DNS z primárního autoritativního serveru prostřednictvím AXFR. Používá se pro sekundární domény, u kterých stahujeme obsah zóny do našeho systému z jiného serveru.

Bez tohoto požadavku použije AXFR údaje REFRESH a RETRY v záznamu SOA.

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 pro sekundární typ domény
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána

Vrátit data

next_run - čas pro příští aktualizaci

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-axfr-run",
    "clTRID": "your ID",
    "data": {
      "name": "domain name"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-axfr-run",
    "data": {
      "next_run": "date and time of next update"
    }
  }
}

dns-domain-copy

Pomocí příkazu dns-domain-copy můžete přidat doménu do systému DNS zkopírováním nastavení a záznamů z jiné existující domény.

Parametry

name - název původní domény (té, kterou chcete zkopírovat) - povinný údaj
name_new - název nově vytvořené domény - povinný údaj

Návratové hodnoty

1000 = ok
2201 = nepodporovaná TLD
2202 = neplatný nebo nepodporovaný název existující domény
2320 = neplatný nebo nepodporovaný název nové domény
2321 = nepodporovaná TLD nového názvu domény
2322 = dosažený limit počtu domén v DNS na uživatele
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána
3311 = kopírování se nezdařilo
3312 = nová doména již existuje v systému DNS

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-copy",
    "clTRID": "your ID",
    "data": {
      "name": "original domain name",
      "name_new": "new domain name"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-copy"
  }
}

dns-domain-update-keyset

Požadavek dns-domain-update-keyset umožňuje provést změny nastavení KEYSET pro doménu, tj. povolit, zakázat nebo aktualizovat nastavení DNSSEC.

Parametry

name - název domény - povinné
keyset - nastavení KEYSET - povinné
0 = žádný KEYSET / vypnout DNSSEC
1 = náš KEYSET / náš DNSSEC (pokud doména používá naše DNS servery a je nastavena jako primární)
string = název vašeho vlastního KEYSET (pokud doména nepoužívá naše DNS servery nebo je nastavena jako sekundární)

Návratové hodnoty

1000 = OK
2202 = neplatný nebo nepodporovaný název existující domény
2264 = neplatný název KEYSET
2265 = bez podpory DNSSEC
2266 = nepodporovaná akce pro sekundární doménu
2267 = nepodporovaná akce pro primární doménu
3260 = příkaz DNSSEC již existuje
3258 = probíhající odstávka registru
3263 = doména nepoužívá náš DNS
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3259 = KEYSET není k dispozici
3262 = nastavení DNSSEC se nezdařilo
3264 = KEYSET je blokován

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-update-keyset",
    "clTRID": "your ID",
    "data": {
      "name": "domain name",
      "keyset": "0/1/string",
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-update-keyset"
  }
}

dns-domain-commit

Po provedení změn v doméně nebo jejích záznamech DNS použijte požadavek dns-domain-commit. Potvrdíte změny a vyžádáte si jejich distribuci na servery DNS.

Pokud příkaz dns-domain-commit neprovedete, systém jej provede automaticky 5 minut po poslední změně.

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ření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-commit",
    "clTRID": "your ID",
    "data": {
      "name": "domain name"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-commit"
  }
}

dns-rows-list

Pomocí požadavku dns-rows-list získáte seznam doménových záznamů v systému DNS spolu se základními informacemi.

Chcete-li získat podrobnější informace o konkrétním záznamu, použijte požadavek 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ího typu domény
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána

Údaje o odezvě

řádek - záznam
- ID - ID záznamu
- name - název záznamu
- ttl - záznam TTL
- rdtype - typ záznamu
- rdata - data záznamů
- changed_date - datum změny
- author_comment - komentář

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-rows-list",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-rows-list",
    "data": {
      "row1": {
        "ID": "record ID",
        "name": "record name (may be empty)",
        "ttl": "TTL",
        "rdtype": "record type",
        "rdata": "record data",
        "changed_date": "date and time of last update",
        "author_comment": "comment"
      }
    }
  }
}

dns-row-detail

Požadavek dns-row-detail vrací podrobné informace o konkrétním záznamu DNS domény.

Chcete-li získat úplný seznam záznamů domény, použijte požadavek dns-rows-list.

Parametry

name - název domény - povinné
row_id - ID záznamu - povinné, získané z 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 na sekundárním typu domény.
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána
3309 = požadovaný záznam DNS pro doménu neexistuje

Vrátit data

řádek - záznam
- ID - ID záznamu
- name - název záznamu
- ttl - záznam TTL
- rdtype - typ záznamu
- rdata - data záznamů
- changed_date - datum změny
- author_comment - komentář

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-detail",
    "clTRID": "your ID",
    "data": {
      "name": "název domény",
      "row_id": "ID záznamu"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-detail",
    "data": {
      "row1": {
        "ID": "record ID",
        "name": "record name (may be empty)",
        "ttl": "TTL",
        "rdtype": "record type",
        "rdata": "record data",
        "changed_date": "date and time of last update",
        "author_comment": "comment"
      }
    }
  }
}

dns-row-add

Požadavek dns-row-add přidá doméně nový záznam DNS.

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 - údaje o 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 do domény
2311 = neplatný název
2312 = neplatný název pro daný typ záznamu
2313 = neplatné CNAME pro tento název
2314 = neplatné údaje záznamu
2315 = neplatná TLD
2316 = tento záznam již existuje
2317 = neplatné TTL
2318 = akci nelze provést na sekundárním typu domény
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-add",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name",
      "name": "record name (may be empty)",
      "ttl": "TTL",
      "type": "record type",
      "rdata": "record data"
    }
  }
}

Požadavek JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-add",
  }
}

dns-row-update

Ke změně záznamu DNS použijte požadavek dns-row-update.

Název a typ záznamu nelze změnit. 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é, získané z dns-rows-list
ttl - hodnota TTL - povinná
rdata - údaje o 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 = k doméně nelze přidat další záznam
2311 = neplatný název
2312 = neplatný název pro tento typ záznamu
2313 = neplatné CNAME pro tento titul
2314 = neplatný datový záznam
2315 = neplatná TLD
2316 = tento záznam již existuje
2317 = neplatné TTL
2318 = akci nelze provést na sekundárním typu domény
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána
3309 = záznam tohoto ID neexistuje
3310 = změna záznamu se nezdařila

Vrátit data

Požadavek nevrací žádná data.

Šablony

JSON příkaz:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-update",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name",
      "row_id": "row ID",
      "ttl": "TTL",
      "rdata": "record data"
    }
  }
}

Odpověď JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-update"
  }
}

dns-row-delete

Požadavek dns-row-delete slouží k odstranění záznamu DNS pro doménu.

Parametry

domain - název domény - povinné
row_id - ID záznamu - povinné, získané z dns-rows-list

Návratové hodnoty

1000 = ok
2201 = nepodporovaná TLD
2202 = neplatný nebo nepodporovaný název domény
2318 = neplatná akce pro sekundární typ domény
3222 = otevření domény se nezdařilo
3223 = přístup odepřen
3305 = doména je uzamčena pro úpravy
3306 = doména je smazána
3308 = smazání záznamu se nezdařilo
3309 = záznam s tímto ID neexistuje

Vrátit data

Požadavek nevrací žádná data.

Šablony

Požadavek JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-delete",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name",
      "row_id": "record ID"
    }
  }
}

Požadavek JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-delete",
  }
}

Bylo to užitečné?

Děkujeme za váš názor!

WAPI - WEDOS DNS

dns-domains-list

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

dns-domain-info

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-domain-add

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-domain-delete

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-domain-axfr-run

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-domain-copy

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-domain-update-keyset

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-domain-commit

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-rows-list

Parametry

Návratové hodnoty

Údaje o odezvě

Šablony

dns-row-detail

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-row-add

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-row-update

Parametry

Návratové hodnoty

Vrátit data

Šablony

dns-row-delete

Parametry

Návratové hodnoty

Vrátit data

Šablony

Bylo to užitečné?

Článek TOC

Procházet kategorie