Listar os endereços IP

200

Endereços do VPS

{
  "data": [
    {
      "address": "31.207.34.214",
      "type": "IPv4",
      "primary": true,
      "reverse": "vps116807.serveur-vps.net"
    },
    {
      "address": "2a00:7ee0:9:1:11:6807:1:1",
      "type": "IPv6",
      "primary": true,
      "reverse": "vps116807.serveur-vps.net"
    },
    {
      "address": "51.83.12.98",
      "type": "IPv4",
      "primary": false,
      "reverse": null
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 3,
    "total": 3,
    "total_pages": 1
  }
}

Campos da resposta 10

data object[]

obrigatório
address string
type string

um de: IPv4, IPv6
primary boolean

Endereço principal do VPS
reverse string

DNS reverso; null se ausente ou não resolvido
meta object

Paginação. As listas não paginadas devolvem tudo e meta reflete o número devolvido.

PaginationMeta

obrigatório
page integer (int64)

Página devolvida

Exemplo: 1
per_page integer (int64)

Tamanho da página

Exemplo: 25
total integer (int64)

Número total de elementos

Exemplo: 887
total_pages integer (int64)

Número total de páginas

Exemplo: 36

401

Autenticação recusada: invalid_token — cabeçalho Authorization ausente ou mal formado, ou chave desconhecida; access_disabled — acesso à API cortado para esta conta, ou serviço de API momentaneamente suspenso pela LWS.

cabeçalho Authorization ausente ou mal formado, ou chave desconhecida

{
  "type": "https://docs.lws.fr/kvm/errors/invalid-token",
  "title": "Authentification invalide",
  "status": 401,
  "code": "invalid_token",
  "detail": "Clé inconnue ou révoquée.",
  "request_id": "3f9a1c07b2e45d18"
}

acesso à API cortado para esta conta, ou serviço de API momentaneamente suspenso pela LWS

{
  "type": "https://docs.lws.fr/kvm/errors/access-disabled",
  "title": "Accès API désactivé",
  "status": 401,
  "code": "access_disabled",
  "detail": "L'accès API est désactivé pour ce compte. Réactivez-le depuis la page « API / MCP » du panel.",
  "request_id": "3f9a1c07b2e45d18"
}

Campos da resposta 18

type string (uri)

Exemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obrigatório
title string

Título curto

Exemplo: VPS introuvable

obrigatório
status integer (int64)

Estado HTTP

Exemplo: 404

obrigatório
code string

Código de máquina estável (ver «Erros» em Primeiros passos)

Exemplo: vm_not_found

obrigatório
detail string

Mensagem detalhada

Exemplo: Aucun VPS 999999 sur ce compte.

obrigatório
request_id string

Identificador do pedido, a comunicar ao suporte

Exemplo: 3f9a1c07b2e45d18

obrigatório
errors object

validation_failed: mensagem por parâmetro incorreto
required_level string

insufficient_scope: nível exigido pela operação

um de: read, exploitation, full
task_id string

task_already_running: tarefa em curso neste VPS

Exemplo: tsk_000002d5
family string

rate_limited: família de quota esgotada

um de: read, mutation, heavy
limit integer (int64)

rate_limited: limite horário da família
retry_after integer (int64)

rate_limited: segundos a aguardar
lock string

server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

Exemplo: snapshot
reason string

server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

um de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)
kind string

um de: works, incident
started_at string (date-time)
expected_end string (date-time)

403

Acesso recusado: ip_not_allowed — endereço de chamada não autorizado.

{
  "type": "https://docs.lws.fr/kvm/errors/ip-not-allowed",
  "title": "Adresse non autorisée",
  "status": 403,
  "code": "ip_not_allowed",
  "detail": "L'adresse 203.0.113.10 ne figure pas parmi les adresses autorisées de ce compte.",
  "request_id": "3f9a1c07b2e45d18"
}

Campos da resposta 18

type string (uri)

Exemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obrigatório
title string

Título curto

Exemplo: VPS introuvable

obrigatório
status integer (int64)

Estado HTTP

Exemplo: 404

obrigatório
code string

Código de máquina estável (ver «Erros» em Primeiros passos)

Exemplo: vm_not_found

obrigatório
detail string

Mensagem detalhada

Exemplo: Aucun VPS 999999 sur ce compte.

obrigatório
request_id string

Identificador do pedido, a comunicar ao suporte

Exemplo: 3f9a1c07b2e45d18

obrigatório
errors object

validation_failed: mensagem por parâmetro incorreto
required_level string

insufficient_scope: nível exigido pela operação

um de: read, exploitation, full
task_id string

task_already_running: tarefa em curso neste VPS

Exemplo: tsk_000002d5
family string

rate_limited: família de quota esgotada

um de: read, mutation, heavy
limit integer (int64)

rate_limited: limite horário da família
retry_after integer (int64)

rate_limited: segundos a aguardar
lock string

server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

Exemplo: snapshot
reason string

server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

um de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)
kind string

um de: works, incident
started_at string (date-time)
expected_end string (date-time)

404

Recurso não encontrado: vm_not_found — VPS inexistente ou fora do âmbito da chave.

{
  "type": "https://docs.lws.fr/kvm/errors/vm-not-found",
  "title": "VPS introuvable",
  "status": 404,
  "code": "vm_not_found",
  "detail": "Aucun VPS 999999 sur ce compte.",
  "request_id": "3f9a1c07b2e45d18"
}

Campos da resposta 18

type string (uri)

Exemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obrigatório
title string

Título curto

Exemplo: VPS introuvable

obrigatório
status integer (int64)

Estado HTTP

Exemplo: 404

obrigatório
code string

Código de máquina estável (ver «Erros» em Primeiros passos)

Exemplo: vm_not_found

obrigatório
detail string

Mensagem detalhada

Exemplo: Aucun VPS 999999 sur ce compte.

obrigatório
request_id string

Identificador do pedido, a comunicar ao suporte

Exemplo: 3f9a1c07b2e45d18

obrigatório
errors object

validation_failed: mensagem por parâmetro incorreto
required_level string

insufficient_scope: nível exigido pela operação

um de: read, exploitation, full
task_id string

task_already_running: tarefa em curso neste VPS

Exemplo: tsk_000002d5
family string

rate_limited: família de quota esgotada

um de: read, mutation, heavy
limit integer (int64)

rate_limited: limite horário da família
retry_after integer (int64)

rate_limited: segundos a aguardar
lock string

server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

Exemplo: snapshot
reason string

server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

um de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)
kind string

um de: works, incident
started_at string (date-time)
expected_end string (date-time)

429

Quota excedida: rate_limited — quota horária da família esgotada.

{
  "type": "https://docs.lws.fr/kvm/errors/rate-limited",
  "title": "Quota dépassé",
  "status": 429,
  "code": "rate_limited",
  "detail": "Quota dépassé pour les opérations de type « read » : 3600 appels par heure. Réessayez dans 37 seconde(s).",
  "request_id": "3f9a1c07b2e45d18",
  "family": "read",
  "limit": 3600,
  "retry_after": 37
}

Campos da resposta 18

type string (uri)

Exemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obrigatório
title string

Título curto

Exemplo: VPS introuvable

obrigatório
status integer (int64)

Estado HTTP

Exemplo: 404

obrigatório
code string

Código de máquina estável (ver «Erros» em Primeiros passos)

Exemplo: vm_not_found

obrigatório
detail string

Mensagem detalhada

Exemplo: Aucun VPS 999999 sur ce compte.

obrigatório
request_id string

Identificador do pedido, a comunicar ao suporte

Exemplo: 3f9a1c07b2e45d18

obrigatório
errors object

validation_failed: mensagem por parâmetro incorreto
required_level string

insufficient_scope: nível exigido pela operação

um de: read, exploitation, full
task_id string

task_already_running: tarefa em curso neste VPS

Exemplo: tsk_000002d5
family string

rate_limited: família de quota esgotada

um de: read, mutation, heavy
limit integer (int64)

rate_limited: limite horário da família
retry_after integer (int64)

rate_limited: segundos a aguardar
lock string

server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

Exemplo: snapshot
reason string

server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

um de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)
kind string

um de: works, incident
started_at string (date-time)
expected_end string (date-time)

502

Dependência inacessível: upstream_unavailable — inventário dos VPS momentaneamente indisponível.

{
  "type": "https://docs.lws.fr/kvm/errors/upstream-unavailable",
  "title": "Service momentanément indisponible",
  "status": 502,
  "code": "upstream_unavailable",
  "detail": "Inventaire des VM indisponible.",
  "request_id": "3f9a1c07b2e45d18"
}

Campos da resposta 18

type string (uri)

Exemplo: https://docs.lws.fr/kvm/errors/vm-not-found

obrigatório
title string

Título curto

Exemplo: VPS introuvable

obrigatório
status integer (int64)

Estado HTTP

Exemplo: 404

obrigatório
code string

Código de máquina estável (ver «Erros» em Primeiros passos)

Exemplo: vm_not_found

obrigatório
detail string

Mensagem detalhada

Exemplo: Aucun VPS 999999 sur ce compte.

obrigatório
request_id string

Identificador do pedido, a comunicar ao suporte

Exemplo: 3f9a1c07b2e45d18

obrigatório
errors object

validation_failed: mensagem por parâmetro incorreto
required_level string

insufficient_scope: nível exigido pela operação

um de: read, exploitation, full
task_id string

task_already_running: tarefa em curso neste VPS

Exemplo: tsk_000002d5
family string

rate_limited: família de quota esgotada

um de: read, mutation, heavy
limit integer (int64)

rate_limited: limite horário da família
retry_after integer (int64)

rate_limited: segundos a aguardar
lock string

server_locked: bloqueio aplicado pelo hipervisor (backup, snapshot, suspended…)

Exemplo: snapshot
reason string

server_locked: operation_in_progress, há uma operação em curso, tente novamente após Retry-After; suspended, o VPS está em hibernação, inicie-o primeiro; support_notified, bloqueio anómalo, a equipa LWS foi avisada e está a intervir

um de: operation_in_progress, suspended, support_notified
maintenance object

server_maintenance: natureza da intervenção, início e fim previsto (null para um incidente)
kind string

um de: works, incident
started_at string (date-time)
expected_end string (date-time)

Parâmetros do caminho

Respostas

Comunicar um erro

Assistente IA