WAPI - WEDOS DNS - Dokumentacja i baza wiedzy WEDOS

Ten artykuł dotyczy poleceń WAPI specjalnie dla usługi WEDOS DNS. Aby uzyskać informacje na temat konfigurowania WAPI i rozwiązywania typowych problemów, zobacz artykuł WAPI - Podręcznik.

Ten artykuł zawiera informacje na temat następujących żądań:

dns-domains-list - lista domen DNS na koncie użytkownika
dns-domain-info - informacje o domenie
dns-domain-add - dodaje domenę do DNS
dns-domain-delete - usunięcie domeny z DNS
dns-domain-axfr-run - żądanie transferu AXFR z serwera głównego do naszego DNS.
dns-domain-copy - dodanie domeny do DNS poprzez skopiowanie innej domeny
dns-domain-update-keyset - edycja zestawu kluczy domeny
dns-domain-commit - zapisuje zmiany DNS
dns-rows-list - pobieranie listy rekordów domeny
dns-row-detail - pobieranie szczegółów rekordu
dns-row-add - dodaj rekord
dns-row-update - edycja rekordu
dns-row-delete - usunięcie rekordu

dns-domains-list

Użyj żądania dns-domains-list, aby wyświetlić listę domen DNS użytkownika.

Parametry

search - ciąg znaków do wyszukania wśród nazw domen - opcjonalne
status - filtrowanie według statusu (aktywny, wyłączony) - opcjonalne
type - filtrowanie według typu domeny (podstawowa, drugorzędna) - opcjonalne
page - numer strony (domyślnie: 1) - opcjonalne
page_limit - liczba wpisów na stronę (domyślnie: 50) - opcjonalne
orderby - porządkowanie wpisów według created_date lub domain, a następnie asc/desc - opcjonalnie, patrz szablon

Zwracane wartości

1000 - OK

Dane odpowiedzi

Żądanie zwraca listę domen korzystających z tego szablonu:

domena
- name - nazwa domeny
- status - status domeny w systemie
- typ - typ (podstawowy/dodatkowy)

Szablony

Żądanie 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"
    }
  }
}

Odpowiedź 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

Użyj żądania dns-domain-info, aby znaleźć podstawowe informacje o domenie w systemie WEDOS DNS (WDNS).

Parametry

name - nazwa domeny - wymagane

Zwracane wartości

1000 = OK
2201 = nieobsługiwana TLD
2202 = nieprawidłowa nazwa domeny
3222 = nie udało się otworzyć domeny
3223 = błąd autoryzacji
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta

Dane zwrotne

Jeśli żądanie się powiedzie, zwróci szczegóły domeny w WDNS w węźle data/domain.

Szablony

Żądanie JSON:

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

Odpowiedź 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

Użyj żądania dns-domain-add, aby dodać nową domenę do DNS.

Parametry

name - nazwa domeny - wymagane
type - typ rekordu domeny (podstawowy/dodatkowy) - opcjonalny (domyślnie: podstawowy)
axfr_enabled - czy wychodzący axfr jest włączony? (0/1) - tylko domeny podstawowe - opcjonalne (domyślnie: 0)
axfr_ip - lista włączonych adresów IP dla axfr (tylko dla głównego wpisu, wymagane jeśli axfr_enabled=1)
ip - adres ip dla wychodzącego axfr
primary_ip - adres IP podstawowego serwera dns (wymagany, jeśli type=secondary)

Zwracane wartości

1000 = ok
2100 = brak wymaganego parametru
2101 = nieprawidłowe parametry wejściowe
2201 = nieobsługiwana TLD
2202 = nieprawidłowa nazwa domeny
2301 = nieprawidłowy format typu
2302 = brak parametru primary_ip
2303 = nieprawidłowy format primary_ip
2304 = nieprawidłowy format axfr_enabled
2305 = brak wymaganego parametru axfr_ips
2306 = nieprawidłowy format axfr_ips
2308 = nieprawidłowy format ns
2322 = osiągnięty limit domen w DNS na użytkownika
3302 = dodanie domeny do DNS nie powiodło się
3303 = domena już istnieje w DNS

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

Żądanie 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"
      }
    }
  }
}

Odpowiedź JSON (OK):

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

dns-domain-delete

Użyj żądania dns-domain-delete, aby usunąć domenę z DNS, w tym wszystkie jej rekordy.

Parametry

name - nazwa domeny - wymagane

Zwracane wartości

1000 = ok
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3301 = rekord nie może zostać usunięty
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

Żądanie JSON:

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

Odpowiedź JSON (OK):

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

dns-domain-axfr-run

Żądanie dns-domain-axfr-run aktualizuje rekordy DNS z głównego serwera autorytatywnego za pośrednictwem AXFR tak szybko, jak to możliwe (w ciągu kilku minut). Jest on używany dla domen drugorzędnych, gdzie pobieramy zawartość strefy do naszego systemu z innego serwera.

Bez tego żądania AXFR używa danych REFRESH i RETRY w rekordzie SOA.

Parametry

name - nazwa domeny - wymagane

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa domeny
2319 = może być wykonane tylko dla drugorzędnego typu domeny
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta

Dane zwrotne

next_run - czas do przeprowadzenia następnej aktualizacji

Szablony

Żądanie JSON:

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

Odpowiedź 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

Użyj polecenia dns-domain-copy, aby dodać domenę do DNS, kopiując ustawienia i rekordy z innej istniejącej domeny.

Parametry

name - nazwa oryginalnej domeny (tej, którą chcesz skopiować) - wymagane
name_new - nazwa nowo utworzonej domeny - wymagane

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa istniejącej domeny
2320 = nieprawidłowa lub nieobsługiwana nazwa nowej domeny
2321 = nieobsługiwana TLD nowej nazwy domeny
2322 = osiągnięty limit liczby domen w DNS na użytkownika
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta
3311 = kopiowanie nie powiodło się
3312 = nowa domena już istnieje w DNS

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

Żądanie 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"
    }
  }
}

Odpowiedź JSON (OK):

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

dns-domain-update-keyset

Żądanie dns-domain-update-keyset umożliwia wprowadzenie zmian w ustawieniach KEYSET dla domeny, tj. włączenie, wyłączenie lub aktualizację ustawień DNSSEC.

Parametry

name - nazwa domeny - wymagane
keyset - ustawienia KEYSET - wymagane
0 = brak KEYSET / wyłącz DNSSEC
1 = nasz KEYSET / nasz DNSSEC (jeśli domena korzysta z naszych serwerów DNS i jest ustawiona jako podstawowa)
string = nazwa własnego KEYSET (jeśli domena nie korzysta z naszych serwerów DNS lub jest ustawiona jako drugorzędna)

Zwracane wartości

1000 = OK
2202 = nieprawidłowa lub nieobsługiwana nazwa istniejącej domeny
2264 = nieprawidłowa nazwa KEYSET
2265 = brak obsługi DNSSEC
2266 = nieobsługiwana akcja dla domeny dodatkowej
2267 = nieobsługiwana akcja dla domeny podstawowej
3260 = oczekujące zlecenie DNSSEC już istnieje
3258 = trwa przestój rejestru
3263 = domena nie używa naszego DNS
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3259 = KEYSET jest niedostępny
3262 = Konfiguracja DNSSEC nie powiodła się
3264 = KEYSET jest zablokowany

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

Żądanie 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",
    }
  }
}

Odpowiedź JSON (OK):

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

dns-domain-commit

Użyj żądania dns-domain-commit po wprowadzeniu jakichkolwiek zmian w domenie lub jej rekordach DNS. Potwierdzasz zmiany i żądasz ich dystrybucji do serwerów DNS.

Jeśli nie wykonasz polecenia dns-domain-commit, system wykona je automatycznie 5 minut po ostatniej zmianie.

Parametry

name - nazwa domeny - wymagane

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa domeny
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

Żądanie JSON:

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

Odpowiedź JSON (OK):

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

dns-rows-list

Użyj żądania dns-rows-list, aby uzyskać listę rekordów domen w DNS wraz z podstawowymi informacjami.

Aby uzyskać bardziej szczegółowe informacje o konkretnym rekordzie, należy użyć zapytania dns-row-detail.

Parametry

domena - nazwa domeny - wymagana

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa domeny
2318 = nie można wykonać w drugorzędnym typie domeny
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta

Dane odpowiedzi

rząd - rekord
- ID - identyfikator rekordu
- name - nazwa rekordu
- ttl - rekord TTL
- rdtype - typ rekordu
- rdata - dane rekordu
- changed_date - data zmiany
- author_comment - komentarz

Szablony

Żądanie JSON:

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

Odpowiedź 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

Żądanie dns-row-detail zwraca szczegółowe informacje o konkretnym rekordzie DNS domeny.

Aby uzyskać pełną listę rekordów domeny, należy użyć polecenia dns-rows-list.

Parametry

name - nazwa domeny - wymagane
row_id - identyfikator rekordu - wymagany, uzyskany z dns-rows-list

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa domeny
2318 = Tej akcji nie można wykonać w domenie drugorzędnej.
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta
3309 = wymagany rekord DNS dla domeny nie istnieje

Dane zwrotne

rząd - rekord
- ID - identyfikator rekordu
- name - nazwa rekordu
- ttl - rekord TTL
- rdtype - typ rekordu
- rdata - dane rekordu
- changed_date - data zmiany
- author_comment - komentarz

Szablony

Żądanie 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"
    }
  }
}

Odpowiedź 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

Żądanie dns-row-add dodaje nowy rekord DNS do domeny.

Parametry

domena - nazwa domeny - wymagana
name - nazwa rekordu - wymagana, ale może być pusta
ttl - wartość TTL - wymagana
typ - typ rekordu - wymagany
rdata - dane rekordu - wymagane
auth_comment - komentarz autora - opcjonalnie

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa domeny
2309 = nieprawidłowy typ rekordu
2310 = nie można dodać kolejnego rekordu do domeny
2311 = nieprawidłowa nazwa
2312 = nieprawidłowa nazwa dla tego typu rekordu
2313 = nieprawidłowy CNAME dla tej nazwy
2314 = nieprawidłowe dane rekordu
2315 = nieprawidłowa TLD
2316 = ten rekord już istnieje
2317 = nieprawidłowy TTL
2318 = akcja nie może być wykonana na drugorzędnym typie domeny
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

Żądanie 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"
    }
  }
}

Żądanie JSON (OK):

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

dns-row-update

Użyj żądania dns-row-update, aby zmienić rekord DNS.

Nie można zmienić nazwy i typu rekordu. W takiej sytuacji należy usunąć oryginalny rekord, a następnie utworzyć nowy.

Parametry

domena - nazwa domeny - wymagana
row_id - identyfikator rekordu - wymagany, uzyskany z dns-rows-list
ttl - wartość TTL - wymagana
rdata - dane rekordu - wymagane

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa domeny
2309 = nieprawidłowy typ rekordu
2310 = nie można dodać kolejnego rekordu do domeny
2311 = nieprawidłowa nazwa
2312 = nieprawidłowa nazwa dla tego typu rekordu
2313 = nieprawidłowy CNAME dla tego tytułu
2314 = nieprawidłowy rekord danych
2315 = nieprawidłowa TLD
2316 = ten rekord już istnieje
2317 = nieprawidłowy TTL
2318 = akcja nie może być wykonana na drugorzędnym typie domeny
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta
3309 = rekord o tym identyfikatorze nie istnieje
3310 = modyfikacja rekordu nie powiodła się

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

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"
    }
  }
}

Odpowiedź JSON (OK):

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

dns-row-delete

Użyj żądania dns-row-delete, aby usunąć rekord DNS dla domeny.

Parametry

domena - nazwa domeny - wymagana
row_id - identyfikator rekordu - wymagany, uzyskany z dns-rows-list

Zwracane wartości

1000 = ok
2201 = nieobsługiwana TLD
2202 = nieprawidłowa lub nieobsługiwana nazwa domeny
2318 = nieprawidłowe działanie dla typu domeny drugorzędnej
3222 = otwarcie domeny nie powiodło się
3223 = odmowa dostępu
3305 = domena jest zablokowana do edycji
3306 = domena została usunięta
3308 = usunięcie rekordu nie powiodło się
3309 = rekord o tym identyfikatorze nie istnieje

Dane zwrotne

Żądanie nie zwraca żadnych danych.

Szablony

Żądanie JSON:

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

Żądanie JSON (OK):

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

Czy to było pomocne?

Dziękujemy za opinię!

WAPI - WEDOS DNS

dns-domains-list

Parametry

Zwracane wartości

Dane odpowiedzi

Szablony

dns-domain-info

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-domain-add

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-domain-delete

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-domain-axfr-run

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-domain-copy

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-domain-update-keyset

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-domain-commit

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-rows-list

Parametry

Zwracane wartości

Dane odpowiedzi

Szablony

dns-row-detail

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-row-add

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-row-update

Parametry

Zwracane wartości

Dane zwrotne

Szablony

dns-row-delete

Parametry

Zwracane wartości

Dane zwrotne

Szablony

Czy to było pomocne?

Spis treści artykułu

Przeglądaj kategorie