Dieser Artikel befasst sich mit WAPI-Befehlen speziell für den WEDOS-DNS-Dienst. Informationen zur Einrichtung von WAPI und zur Fehlerbehebung bei allgemeinen Problemen finden Sie im Artikel WAPI - Handbuch.
Dieser Artikel enthält Informationen zu den folgenden Anträgen:
- dns-domains-list - Liste der DNS-Domänen im Konto des Benutzers
- dns-domain-info - Informationen über die Domäne
- dns-domain-add - Domäne zum DNS hinzufügen
- dns-domain-delete - Domäne aus dem DNS löschen
- dns-domain-axfr-run - Anforderung der AXFR-Übertragung vom Primärserver zu unserem DNS
- dns-domain-copy - Hinzufügen einer Domäne zum DNS durch Kopieren einer anderen Domäne
- dns-domain-update-keyset - Domänenschlüsselsatz bearbeiten
- dns-domain-commit - DNS-Änderungen speichern
- dns-rows-list - Liste der Domäneneinträge abrufen
- dns-row-detail - Abrufen von Datensatzdetails
- dns-row-add - Datensatz hinzufügen
- dns-row-update - Datensatz bearbeiten
- dns-row-delete - Datensatz löschen
dns-domains-list
Verwenden Sie die Anfrage dns-domains-list, um die DNS-Domänen des Benutzers aufzulisten.
Parameter
- search - Zeichenfolge für die Suche unter den Domänennamen - optional
- Status - Filter nach Status (aktiv, deaktiviert) - optional
- Typ - Filter nach Domänentyp (primär, sekundär) - optional
- page - Seitennummer (Standard: 1) - optional
- page_limit - Anzahl der Einträge pro Seite (Standard: 50) - optional
- orderby - Reihenfolge der Einträge nach created_date oder domain, gefolgt von asc/desc - optional, siehe Vorlage
Rückgabewerte
- 1000 - OK
Antwortdaten
Die Anfrage liefert eine Liste der Domains, die diese Vorlage verwenden:
- Domain
- name - Domänenname
- status - Status der Domäne im System
- Typ - Typ (primär/sekundär)
Schablonen
JSON-Anfrage:
{
"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"
}
}
}
JSON-Antwort (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
Verwenden Sie die Anfrage dns-domain-info, um grundlegende Informationen über die Domäne im WEDOS-DNS-System (WDNS) zu finden.
Parameter
- name - Domänenname - erforderlich
Rückgabewerte
- 1000 = OK
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger Domänenname
- 3222 = Domäne kann nicht geöffnet werden
- 3223 = Autorisierungsfehler
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
Daten zurücksenden
Bei Erfolg gibt die Abfrage die Domänenangaben im WDNS im Knoten Daten/Domäne zurück.
Schablonen
JSON-Anfrage:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "dns-domain-info",
"clTRID": "your ID",
"data": {
"name": "domain name"
}
}
}
JSON-Antwort (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
Verwenden Sie die Anfrage dns-domain-add, um eine neue Domäne zum DNS hinzuzufügen.
Parameter
- name - Domänenname - erforderlich
- type - Typ des Domäneneintrags (primär/sekundär) - optional (Standard: primär)
- axfr_enabled - ist ausgehendes axfr aktiviert? (0/1) - nur primäre Domänen - optional (Standard: 0)
- axfr_ip - Liste der aktivierten IP-Adressen für axfr (nur für primären Eintrag, erforderlich, wenn axfr_enabled=1)
- ip - ip-Adresse für ausgehende axfr
- primary_ip - IP-Adresse des primären DNS-Servers (erforderlich bei type=secondary)
Rückgabewerte
- 1000 = gut
- 2100 = fehlender erforderlicher Parameter
- 2101 = ungültige Eingabeparameter
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger Domänenname
- 2301 = falsches Format des Typs
- 2302 = fehlender Parameter primary_ip
- 2303 = falsches Format für primary_ip
- 2304 = ungültiges Format axfr_enabled
- 2305 = fehlender erforderlicher Parameter axfr_ips
- 2306 = ungültiges Format von axfr_ips
- 2308 = ungültiges Format von ns
- 2322 = erreichtes Limit an Domains im DNS pro Benutzer
- 3302 = Hinzufügen der Domäne zum DNS fehlgeschlagen
- 3303 = Domäne existiert bereits im DNS
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
JSON-Anfrage:
{
"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"
}
}
}
}
JSON-Antwort (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "dns-domain-add" } }
dns-domain-delete
Verwenden Sie die Anfrage dns-domain-delete, um eine Domäne aus dem DNS zu löschen, einschließlich aller ihrer Einträge.
Parameter
- name - Domänenname - erforderlich
Rückgabewerte
- 1000 = gut
- 3222 = Öffnen der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3301 = Datensatz kann nicht entfernt werden
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
JSON-Anfrage:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "dns-domain-delete",
"clTRID": "your ID",
"data": {
"name": "domain name"
}
}
}
JSON-Antwort (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID",, "command": "dns-domain-delete" } }
dns-domain-axfr-run
Die Anforderung dns-domain-axfr-run aktualisiert DNS-Einträge vom primären autoritativen Server über AXFR so schnell wie möglich (innerhalb weniger Minuten). Sie wird für sekundäre Domänen verwendet, bei denen wir den Inhalt der Zone von einem anderen Server auf unser System herunterladen.
Ohne diese Anforderung verwendet AXFR die REFRESH- und RETRY-Daten im SOA-Datensatz.
Parameter
- name - Domänenname - erforderlich
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Domänenname
- 2319 = kann nur für den sekundären Domänentyp durchgeführt werden
- 3222 = Öffnen der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
Daten zurücksenden
- next_run - Zeitpunkt für die nächste Aktualisierung
Schablonen
JSON-Anfrage:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "dns-domain-axfr-run",
"clTRID": "your ID",
"data": {
"name": "domain name"
}
}
}
JSON-Antwort (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
Verwenden Sie den Befehl dns-domain-copy, um eine Domäne zu DNS hinzuzufügen, indem Sie die Einstellungen und Datensätze einer anderen bestehenden Domäne kopieren.
Parameter
- name - Name der ursprünglichen Domäne (die Sie kopieren möchten) - erforderlich
- name_new - Name der neu angelegten Domäne - erforderlich
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Name einer bestehenden Domain
- 2320 = ungültiger oder nicht unterstützter Name der neuen Domäne
- 2321 = nicht unterstützte TLD des neuen Domänennamens
- 2322 = erreichtes Limit für die Anzahl der Domains im DNS pro Benutzer
- 3222 = Öffnen der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
- 3311 = Kopieren fehlgeschlagen
- 3312 = neue Domäne existiert bereits im DNS
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
JSON-Anfrage:
{
"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"
}
}
}
JSON-Antwort (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "dns-domain-copy" } }
dns-domain-update-keyset
Mit der Anfrage dns-domain-update-keyset können Sie Änderungen an den KEYSET-Einstellungen für die Domain vornehmen, d. h. DNSSEC-Einstellungen aktivieren, deaktivieren oder aktualisieren.
Parameter
- name - Domänenname - erforderlich
- keyset - KEYSET-Einstellungen - erforderlich
0 = kein KEYSET / DNSSEC deaktivieren
1 = unser KEYSET / unser DNSSEC (wenn die Domain unsere DNS-Server nutzt und als primär eingestellt ist)
string = der Name Ihres eigenen KEYSET (wenn die Domain unsere DNS-Server nicht nutzt oder als sekundär eingestellt ist)
Rückgabewerte
- 1000 = OK
- 2202 = ungültiger oder nicht unterstützter Name einer bestehenden Domain
- 2264 = ungültiger KEYSET-Name
- 2265 = keine DNSSEC-Unterstützung
- 2266 = nicht unterstützte Aktion für sekundäre Domäne
- 2267 = nicht unterstützte Aktion für primäre Domäne
- 3260 = ausstehender DNSSEC-Auftrag existiert bereits
- 3258 = Ausfallzeit der Registrierung in Bearbeitung
- 3263 = Domäne verwendet nicht unseren DNS
- 3222 = Öffnen der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3259 = KEYSET ist nicht verfügbar
- 3262 = DNSSEC-Einrichtung fehlgeschlagen
- 3264 = KEYSET ist gesperrt
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
JSON-Anfrage:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "dns-domain-update-keyset",
"clTRID": "your ID",
"data": {
"name": "domain name",
"keyset": "0/1/string",
}
}
}
JSON-Antwort (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "dns-domain-update-keyset" } }
dns-domain-commit
Verwenden Sie die Anforderung dns-domain-commit, nachdem Sie Änderungen an der Domäne oder ihren DNS-Einträgen vorgenommen haben. Sie bestätigen die Änderungen und fordern ihre Verteilung an die DNS-Server an.
Wenn Sie den Befehl dns-domain-commit nicht ausführen, führt das System ihn automatisch 5 Minuten nach der letzten Änderung aus.
Parameter
- name - Domänenname - erforderlich
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Domänenname
- 3222 = Öffnen der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
JSON-Anfrage:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "dns-domain-commit",
"clTRID": "your ID",
"data": {
"name": "domain name"
}
}
}
JSON-Antwort (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "dns-domain-commit" } }
dns-rows-list
Verwenden Sie die Abfrage dns-rows-list, um eine Liste der Domäneneinträge im DNS zusammen mit grundlegenden Informationen zu erhalten.
Um detailliertere Informationen über einen bestimmten Datensatz zu erhalten, verwenden Sie die Abfrage dns-row-detail.
Parameter
- domain - Domänenname - erforderlich
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Domänenname
- 2318 = kann beim sekundären Domänentyp nicht durchgeführt werden
- 3222 = Öffnen der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
Antwortdaten
- Zeile - Rekord
- ID - Datensatz-ID
- name - Name des Datensatzes
- ttl - Aufzeichnung TTL
- rdtype - Datensatztyp
- rdata - Daten aufzeichnen
- changed_date - Datum der Änderung
- autor_kommentar - kommentar
Schablonen
JSON-Anfrage:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "dns-rows-list",
"clTRID": "your ID",
"data": {
"domain": "domain name"
}
}
}
JSON-Antwort (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
Die Abfrage dns-row-detail liefert detaillierte Informationen über einen bestimmten DNS-Domäneneintrag.
Um eine vollständige Liste der Einträge einer Domäne zu erhalten, verwenden Sie die Abfrage dns-rows-list.
Parameter
- name - Domänenname - erforderlich
- row_id - Datensatz-ID - erforderlich, gewonnen aus dns-rows-list
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Domänenname
- 2318 = Diese Aktion kann für den sekundären Domänentyp nicht durchgeführt werden
- 3222 = Öffnung der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
- 3309 = erforderlicher DNS-Eintrag für die Domäne existiert nicht
Daten zurücksenden
- Zeile - Rekord
- ID - Datensatz-ID
- name - Name des Datensatzes
- ttl - Aufzeichnung TTL
- rdtype - Datensatztyp
- rdata - Daten aufzeichnen
- changed_date - Datum der Änderung
- autor_kommentar - kommentar
Schablonen
JSON-Anfrage:
{ "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" } } }
JSON-Antwort (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
Die dns-row-add-Anforderung fügt der Domäne einen neuen DNS-Eintrag hinzu.
Parameter
- domain - Domänenname - erforderlich
- name - Datensatzname - erforderlich, kann aber leer sein
- ttl - TTL-Wert - erforderlich
- Typ - Datensatztyp - erforderlich
- rdata - Datensatzdaten - erforderlich
- auth_comment - Kommentar des Autors - optional
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Domänenname
- 2309 = ungültiger Satztyp
- 2310 = kann keinen weiteren Eintrag zur Domäne hinzufügen
- 2311 = ungültiger Name
- 2312 = ungültiger Name für diesen Typ des Datensatzes
- 2313 = ungültiger CNAME für diesen Namen
- 2314 = ungültige Daten des Datensatzes
- 2315 = ungültige TLD
- 2316 = dieser Datensatz existiert bereits
- 2317 = ungültige TTL
- 2318 = Aktion kann für den sekundären Domänentyp nicht durchgeführt werden
- 3222 = Öffnung der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
JSON-Anfrage:
{
"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"
}
}
}
JSON-Anfrage (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "dns-row-add", } }
dns-row-update
Verwenden Sie die Anfrage dns-row-update, um einen DNS-Eintrag zu ändern.
Sie können den Namen und den Typ eines Datensatzes nicht ändern. Löschen Sie in einem solchen Fall den ursprünglichen Datensatz und legen Sie einen neuen Datensatz an.
Parameter
- domain - Domänenname - erforderlich
- row_id - Datensatz-ID - erforderlich, gewonnen aus dns-rows-list
- ttl - TTL-Wert - erforderlich
- rdata - Datensatzdaten - erforderlich
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Domänenname
- 2309 = ungültiger Satztyp
- 2310 = Sie können der Domäne keinen weiteren Eintrag hinzufügen
- 2311 = ungültiger Name
- 2312 = ungültiger Name für diese Art von Datensatz
- 2313 = ungültiger CNAME für diesen Titel
- 2314 = ungültiger Datensatz
- 2315 = ungültige TLD
- 2316 = dieser Datensatz existiert bereits
- 2317 = ungültige TTL
- 2318 = Aktion kann für den sekundären Domänentyp nicht durchgeführt werden
- 3222 = Domäne öffnen fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
- 3309 = Datensatz mit dieser ID existiert nicht
- 3310 = Änderung des Datensatzes fehlgeschlagen
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
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"
}
}
}
JSON-Antwort (OK):
{ "response": { "code": 1000, "result": "OK", "timestamp": "UTF timestamp", "clTRID": "your ID", "svTRID": "server ID", "command": "dns-row-update" } }
dns-row-delete
Verwenden Sie die Anfrage dns-row-delete, um einen DNS-Eintrag für eine Domäne zu löschen.
Parameter
- domain - Domänenname - erforderlich
- row_id - Datensatz-ID - erforderlich, gewonnen aus dns-rows-list
Rückgabewerte
- 1000 = gut
- 2201 = nicht unterstützte TLD
- 2202 = ungültiger oder nicht unterstützter Domänenname
- 2318 = ungültige Aktion für sekundären Domänentyp
- 3222 = Öffnung der Domäne fehlgeschlagen
- 3223 = Zugriff verweigert
- 3305 = Domäne ist für die Bearbeitung gesperrt
- 3306 = Domäne wird gelöscht
- 3308 = das Löschen des Datensatzes ist fehlgeschlagen
- 3309 = Datensatz mit dieser ID existiert nicht
Daten zurücksenden
Die Anfrage liefert keine Daten.
Schablonen
JSON-Anfrage:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "dns-row-delete",
"clTRID": "your ID",
"data": {
"domain": "domain name",
"row_id": "record ID"
}
}
}
JSON-Anfrage (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "dns-row-delete",
}
}