WAPI - WEDOS DNS - WEDOS Documentation & Knowledge Base

Este artículo trata de los comandos WAPI específicos para el servicio DNS de WEDOS. Para obtener información sobre cómo configurar WAPI y solucionar problemas comunes, consulte el artículo WAPI - Manual.

Este artículo ofrece información sobre las siguientes solicitudes:

dns-domains-list - lista de dominios DNS en la cuenta del usuario
dns-domain-info - información sobre el dominio
dns-domain-add - añadir dominio a DNS
dns-domain-delete - eliminar dominio del DNS
dns-domain-axfr-run - solicitar transferencia AXFR desde el servidor primario a nuestro DNS
dns-domain-copy - añadir un dominio a DNS copiando otro dominio
dns-domain-update-keyset - editar conjunto de claves de dominio
dns-domain-commit - guardar cambios DNS
dns-rows-list - recuperar lista de registros de dominio
dns-row-detail - recuperar detalle de registro
dns-row-add - añadir registro
dns-row-update - editar registro
dns-row-delete - borrar registro

dns-domains-list

Utilice la petición dns-domains-list para listar los dominios DNS del usuario.

Parámetros

search - cadena para buscar entre los nombres de dominio - opcional
estado - filtrar por estado (activo, desactivado) - opcional
type - filtrar por tipo de dominio (primario, secundario) - opcional
page - número de página (por defecto: 1) - opcional
page_limit - número de entradas por página (por defecto: 50) - opcional
orderby - ordena las entradas por created_date o domain, seguido de asc/desc - opcional, ver plantilla

Valores de retorno

1000 - OK

Datos de respuesta

La petición devuelve una lista de dominios que utilizan esta plantilla:

dominio
- nombre - nombre de dominio
- status - estado del dominio en el sistema
- tipo - tipo (primario/secundario)

Plantillas

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

Respuesta 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

Utilice la petición dns-domain-info para encontrar información básica sobre el dominio en el sistema WEDOS DNS (WDNS).

Parámetros

nombre - nombre de dominio - obligatorio

Valores de retorno

1000 = OK
2201 = TLD no soportado
2202 = nombre de dominio no válido
3222 = no se ha podido abrir el dominio
3223 = error de autorización
3305 = dominio bloqueado para edición
3306 = dominio eliminado

Devolver datos

Si tiene éxito, la petición devuelve el detalle del dominio en WDNS en el nodo datos/dominio.

Plantillas

Solicitud JSON:

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

Respuesta 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

Utilice la petición dns-domain-add para añadir un nuevo dominio a DNS.

Parámetros

nombre - nombre de dominio - obligatorio
type - tipo de registro de dominio (primario/secundario) - opcional (por defecto: primario)
axfr_enabled - ¿está activado el axfr saliente? (0/1) - sólo dominios primarios - opcional (por defecto: 0)
axfr_ip - lista de direcciones ip habilitadas para axfr (sólo para la entrada primaria, necesaria si axfr_enabled=1)
ip - dirección ip para axfr saliente
primary_ip - dirección ip del servidor dns primario (obligatorio si type=secondary)

Valores de retorno

1000 = ok
2100 = falta el parámetro requerido
2101 = parámetros de entrada no válidos
2201 = TLD no soportado
2202 = nombre de dominio no válido
2301 = formato incorrecto del tipo
2302 = falta el parámetro primary_ip
2303 = formato incorrecto de primary_ip
2304 = formato no válido axfr_enabled
2305 = falta el parámetro requerido axfr_ips
2306 = formato no válido de axfr_ips
2308 = formato no válido de ns
2322 = límite alcanzado de dominios en el DNS por usuario
3302 = error al añadir dominio a DNS
3303 = el dominio ya existe en DNS

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

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

Respuesta JSON (OK):

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

dns-domain-delete

Utilice la petición dns-domain-delete para eliminar un dominio de DNS, incluyendo todos sus registros.

Parámetros

nombre - nombre de dominio - obligatorio

Valores de retorno

1000 = ok
3222 = fallo al abrir el dominio
3223 = acceso denegado
3301 = no se puede eliminar el registro
3305 = dominio bloqueado para edición
3306 = dominio eliminado

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

Solicitud JSON:

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

Respuesta JSON (OK):

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

dns-domain-axfr-run

La petición dns-domain-axfr-run actualiza los registros DNS desde el servidor autoritativo primario vía AXFR lo antes posible (en pocos minutos). Se utiliza para dominios secundarios, en los que descargamos el contenido de la zona a nuestro sistema desde otro servidor.

Sin esta solicitud, AXFR utiliza los datos REFRESH y RETRY del registro SOA.

Parámetros

nombre - nombre de dominio - obligatorio

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio no válido o no admitido
2319 = sólo puede hacerse para el tipo de dominio secundario
3222 = fallo al abrir el dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado

Devolver datos

next_run - hora de la próxima actualización

Plantillas

Solicitud JSON:

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

Respuesta 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

Utilice el comando dns-domain-copy para añadir un dominio a DNS copiando la configuración y los registros de otro existente.

Parámetros

name - nombre del dominio original (el que desea copiar) - obligatorio
name_new - nombre del dominio recién creado - obligatorio

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio existente no válido o no admitido
2320 = nombre no válido o no compatible del nuevo dominio
2321 = TLD no soportado del nuevo nombre de dominio
2322 = límite alcanzado del número de dominios en el DNS por usuario
3222 = fallo al abrir el dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado
3311 = copia fallida
3312 = el nuevo dominio ya existe en DNS

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

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

Respuesta JSON (OK):

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

dns-domain-update-keyset

La petición dns-domain-update-keyset permite realizar cambios en la configuración KEYSET del dominio, es decir, habilitar, deshabilitar o actualizar la configuración DNSSEC.

Parámetros

nombre - nombre de dominio - obligatorio
keyset - Configuración KEYSET - obligatoria
0 = sin KEYSET / DNSSEC desactivado
1 = nuestro KEYSET / nuestro DNSSEC (si el dominio utiliza nuestros servidores DNS y está configurado como primario)
string = el nombre de su propio KEYSET (si el dominio no utiliza nuestros servidores DNS o está configurado como secundario)

Valores de retorno

1000 = OK
2202 = nombre de dominio existente no válido o no admitido
2264 = nombre KEYSET inválido
2265 = sin soporte DNSSEC
2266 = acción no admitida para el dominio secundario
2267 = acción no admitida para el dominio primario
3260 = la orden DNSSEC pendiente ya existe
3258 = tiempo de inactividad del registro en curso
3263 = el dominio no utiliza nuestro DNS
3222 = fallo al abrir el dominio
3223 = acceso denegado
3259 = KEYSET no está disponible
3262 = Error en la configuración DNSSEC
3264 = KEYSET está bloqueado

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

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

Respuesta JSON (OK):

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

dns-domain-commit

Utilice la petición dns-domain-commit después de realizar cualquier cambio en el dominio o en sus registros DNS. Confirma los cambios y solicita su distribución a los servidores DNS.

Si no ejecuta el comando dns-domain-commit, el sistema lo realizará automáticamente 5 minutos después del último cambio.

Parámetros

nombre - nombre de dominio - obligatorio

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio no válido o no soportado
3222 = fallo al abrir el dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

Solicitud JSON:

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

Respuesta JSON (OK):

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

dns-rows-list

Utilice la petición dns-rows-list para obtener una lista de registros de dominio en DNS junto con información básica.

Para obtener información más detallada sobre un registro concreto, utilice la petición dns-row-detail.

Parámetros

dominio - nombre de dominio - obligatorio

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio no válido o no soportado
2318 = no se puede realizar en el tipo de dominio secundario
3222 = fallo al abrir el dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado

Datos de respuesta

fila - registro
- ID - ID del registro
- name - nombre del registro
- ttl - TTL de registro
- rdtype - tipo de registro
- rdata - registro de datos
- changed_date - fecha de modificación
- author_comment - comentario

Plantillas

Solicitud JSON:

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

Respuesta 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

La petición dns-row-detail devuelve información detallada sobre un registro DNS de dominio específico.

Para obtener una lista completa de los registros de un dominio, utilice la petición dns-rows-list.

Parámetros

nombre - nombre de dominio - obligatorio
row_id - ID del registro - obligatorio, obtenido de dns-rows-list

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio no válido o no soportado
2318 = Esta acción no puede realizarse en el tipo de dominio secundario
3222 = fallo en la apertura del dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado
3309 = el registro DNS necesario para el dominio no existe

Devolver datos

fila - registro
- ID - ID del registro
- name - nombre del registro
- ttl - TTL de registro
- rdtype - tipo de registro
- rdata - registro de datos
- changed_date - fecha de modificación
- author_comment - comentario

Plantillas

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

Respuesta 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

La petición dns-row-add añade un nuevo registro DNS al dominio.

Parámetros

dominio - nombre de dominio - obligatorio
name - nombre del registro - obligatorio, pero puede estar vacío
ttl - Valor TTL - obligatorio
type - tipo de registro - obligatorio
rdata - datos de registro - obligatorio
auth_comment - comentario del autor - opcional

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio no válido o no soportado
2309 = tipo de registro no válido
2310 = no se puede añadir otro registro al dominio
2311 = nombre no válido
2312 = nombre no válido para ese tipo de registro
2313 = CNAME no válido para este nombre
2314 = datos no válidos del registro
2315 = TLD no válido
2316 = este registro ya existe
2317 = TTL no válido
2318 = no se puede realizar la acción en el tipo de dominio secundario
3222 = fallo en la apertura del dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

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

Solicitud JSON (OK):

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

dns-row-update

Utilice la petición dns-row-update para cambiar un registro DNS.

No puede cambiar el nombre y el tipo de un registro. En tal caso, elimine el registro original y cree uno nuevo.

Parámetros

dominio - nombre de dominio - obligatorio
row_id - ID del registro - obligatorio, obtenido de dns-rows-list
ttl - Valor TTL - obligatorio
rdata - datos de registro - obligatorio

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio no válido o no soportado
2309 = tipo de registro no válido
2310 = no se puede añadir otro registro al dominio
2311 = nombre no válido
2312 = nombre no válido para este tipo de registro
2313 = CNAME no válido para este título
2314 = registro de datos no válido
2315 = TLD no válido
2316 = este registro ya existe
2317 = TTL no válido
2318 = no se puede realizar la acción en el tipo de dominio secundario
3222 = fallo al abrir el dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado
3309 = el registro de ese ID no existe
3310 = modificación de registro fallida

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

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

Respuesta JSON (OK):

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

dns-row-delete

Utilice la petición dns-row-delete para eliminar un registro DNS de un dominio.

Parámetros

dominio - nombre de dominio - obligatorio
row_id - ID del registro - obligatorio, obtenido de dns-rows-list

Valores de retorno

1000 = ok
2201 = TLD no soportado
2202 = nombre de dominio no válido o no soportado
2318 = acción no válida para el tipo de dominio secundario
3222 = fallo en la apertura del dominio
3223 = acceso denegado
3305 = dominio bloqueado para edición
3306 = dominio eliminado
3308 = fallo en la eliminación del registro
3309 = el registro con este ID no existe

Devolver datos

La solicitud no devuelve ningún dato.

Plantillas

Solicitud JSON:

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

Solicitud JSON (OK):

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

¿Te ha resultado útil?

Gracias por sus comentarios.

WAPI - WEDOS DNS

dns-domains-list

Parámetros

Valores de retorno

Datos de respuesta

Plantillas

dns-domain-info

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-domain-add

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-domain-delete

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-domain-axfr-run

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-domain-copy

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-domain-update-keyset

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-domain-commit

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-rows-list

Parámetros

Valores de retorno

Datos de respuesta

Plantillas

dns-row-detail

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-row-add

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-row-update

Parámetros

Valores de retorno

Devolver datos

Plantillas

dns-row-delete

Parámetros

Valores de retorno

Devolver datos

Plantillas

¿Te ha resultado útil?

Artículo TOC

Examinar categorías