> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.
# Atualizar IP flutuante
> Atualize a descrição / tags. O endereço IP é imutável.
Requer a ação do IAM **`network:UpdateFloatingIP`**. Consulte [permissões de redes](/pt/networking/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
## OpenAPI
````yaml /pt/api-reference/specs/network.yaml patch /v1/floating-ips/{floating_ip_id}
openapi: 3.0.3
info:
title: API da Basaltic Network
version: 1.0.0
description: >
A superfície da VPC — redes e sub-redes, interfaces, tabelas de rotas,
grupos de segurança, internet, NAT e gateways somente de saída e IPs
flutuantes.
As entradas de relacionamento usam um campo de referência: UUID, CRN ou um
nome exato quando a solicitação fornece seu escopo pai necessário.Sub-redes
e tabelas de rotas são escopo de VPC; interfaces são escopo de
sub-rede./subnet/, vpc//route-table/, e
vpc//subnet//interface/. Os nomes são imutáveis.
Campos de solicitação desconhecidos e parâmetros de lista são rejeitados.
Referências vazias fornecidas são inválidas e as pesquisas com falha nunca
retornam a outro tipo de referência.
contact:
name: Basaltic Support
email: ping@basaltic.sh
license:
name: Proprietary
url: https://basaltic.sh/terms
servers:
- url: https://network.{region}.basaltic.sh
description: Endpoint de API regional
variables:
region:
default: sa-saopaulo-1
description: Código de região
security:
- BearerAuth: []
paths:
/v1/floating-ips/{floating_ip_id}:
patch:
tags:
- Networking
summary: Atualizar IP flutuante
description: Atualize a descrição / tags. O endereço IP é imutável.
operationId: updateFloatingIp
parameters:
- $ref: '#/components/parameters/FloatingIpId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FloatingIpUpdateRequest'
responses:
'200':
description: IP flutuante atualizado
content:
application/json:
schema:
$ref: '#/components/schemas/FloatingIpResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- BearerAuth: []
components:
parameters:
FloatingIpId:
name: floating_ip_id
in: path
description: ID de IP flutuante
required: true
schema:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
schemas:
FloatingIpUpdateRequest:
type: object
additionalProperties: false
properties:
description:
type: string
nullable: true
example: Public IP for the web load balancer
tags:
type: object
additionalProperties:
type: string
health_check:
type: object
nullable: true
allOf:
- $ref: '#/components/schemas/FloatingIpHealthCheck'
description: >
Definir (um objeto) ou limpar (nulo) a verificação de prontidão do
endereço. Omita o campo para deixá-lo inalterado.
FloatingIpResponse:
type: object
properties:
floating_ip:
$ref: '#/components/schemas/FloatingIp'
FloatingIpHealthCheck:
type: object
description: >
Uma verificação de prontidão para membros de um IP flutuante
compartilhado (anycast) — o mesmo vocabulário que uma verificação de
integridade de grupo alvo de balanceador de carga, que você já conhece.
A plataforma verifica o endereço privado de cada membro dentro da VPC.
Um membro que falha pára de receber tráfego através do IP flutuante e
retorna quando ele passa novamente. Se TODOS os membros falharem, o
endereço inteiro fica escuro — uma verificação mal configurada é uma
interrupção visível causada por você, não a plataforma anunciando
silenciosamente algo que acredita estar inativo.
A verificação é feita no endereço, não por membro: os membros são
backends intercambiáveis, e um pool os deriva. Um endereço sem
verificação se comporta exatamente como antes — liveness apenas para
membros do pool, sempre anunciado para os anexados à mão.
required:
- protocol
- port
- interval_sec
- timeout_sec
- healthy_threshold
- unhealthy_threshold
properties:
protocol:
type: string
enum:
- tcp
- http
- https
default: tcp
description: >
`tcp` abre uma conexão; `http`/`https` emite um GET e compara o
status com o `matcher`. Não há `udp`: uma sonda de prontidão precisa
de uma resposta — verifique um serviço udp em uma porta de saúde tcp
em vez disso.
example: http
path:
type: string
example: /healthz
description: Caminho HTTP sondado; ignorado para tcp.
port:
type: integer
minimum: 1
maximum: 65535
example: 8080
description: Porta sondada no membro.
interval_sec:
type: integer
minimum: 1
maximum: 300
default: 30
example: 30
timeout_sec:
type: integer
minimum: 1
maximum: 60
default: 5
example: 5
description: Tempo limite por sonda; deve ser menor que interval_sec.
healthy_threshold:
type: integer
minimum: 1
maximum: 10
default: 3
example: 3
description: Passagens consecutivas antes de um membro virar saudável.
unhealthy_threshold:
type: integer
minimum: 1
maximum: 10
default: 3
example: 3
description: Falha consecutiva antes de um membro virar insalubre.
matcher:
type: string
default: '200'
example: 200-299
description: Status ou intervalo HTTP que conta como passando; ignorado para tcp.
FloatingIp:
type: object
required:
- id
- crn
- address
- family
- attached_to
- members
- tags
- created_at
- updated_at
- visibility
properties:
id:
type: string
format: uuid
readOnly: true
crn:
type: string
readOnly: true
example: crn:network:sa-saopaulo-1:my-account:floating-ip/
description:
type: string
example: Public IP for the web load balancer
family:
$ref: '#/components/schemas/IpFamily'
attached_to:
type: string
nullable: true
readOnly: true
description: >
CRN canônico da interface vinculada, pool de instâncias ou
balanceador de carga; nulo quando não conectado. Um endereço de
propriedade do pool nomeia seu pool mesmo quando o pool tem zero
membros. Somente endereços de propriedade do pool podem ter vários
membros de NIC. Gerencie suas ligações através dos endpoints IP
flutuantes do pool de instâncias; a conexão e o desconexão diretos
são recusados.
example: >-
crn:network:sa-saopaulo-1:my-account:vpc/prod/subnet/public/interface/eth0
members:
type: array
description: >
Os bindings do IP flutuante. Um IP flutuante faz frente a 0 membros
(alocados, não anexados), 1 membro (o caso comum) ou N membros para
um pool de instâncias — um IP flutuante anycast, onde um IP público
é entregue a N NICs de VM em hosts (cada um anunciado como um /32 do
host que o mantém).
Os membros podem compartilhar um hypervisor. Dois deles em um host
costumava significar que um era servido e o outro silenciosamente
obscuro; a regra de encaminhamento de um membro agora nomeia o
membro, e o host divide conexões entre os membros que ele possui,
então onde os membros ficam é uma decisão de capacidade em vez de
uma decisão de correção. O endereço de um pool de instâncias obtém
seus membros das réplicas ativas do pool — cada uma delas — para que
uma escalabilidade externa se junte e uma escalabilidade interna
saia sem um anexo por réplica.
Com mais de um membro UM membro serve cada conexão, escolhida por
hash dos endereços e portas do fluxo, e cada pacote dessa conexão
vai para o mesmo. Os membros são instâncias separadas que não
compartilham nada, então isso espalha conexões e sobrevive à perda
de um host — não é um balanceador de carga: nada verifica se o
serviço dentro da instância está ativo, e as conexões em andamento
para um membro que sai não são movidas, elas terminam.
O endereço de um POOL é a exceção, e somente para inicialização. Uma
réplica se junta ao endereço assim que é colocada, mas não recebe
tráfego até que tenha alcançado o serviço de metadados da instância
— evidência de que o convidado inicializou, e não de que sua máquina
virtual foi iniciada. Até então é um membro com `health`
`unhealthy`. Uma réplica cuja imagem nunca entra em contato com o
serviço de metadados é admitida de qualquer maneira após alguns
minutos, então uma imagem incomum atrasa o tráfego em vez de nunca
obtê-lo.
items:
$ref: '#/components/schemas/FloatingIpMember'
tags:
type: object
additionalProperties:
type: string
health_check:
allOf:
- $ref: '#/components/schemas/FloatingIpHealthCheck'
description: >
A verificação de prontidão aplicada aos membros deste endereço.
Ausente quando nenhum está configurado. Consulte
`FloatingIpHealthCheck`.
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
address:
type: string
description: Endereço público ou privado alocado.
example: 212.66.52.71
visibility:
type: string
enum:
- public
- private
subnet_id:
type: string
format: uuid
nullable: true
description: Sub-rede de alocação para IPs flutuantes privados.
vpc_id:
type: string
format: uuid
description: Alocação VPC para IPs flutuantes privados.
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- request_id
properties:
code:
type: string
description: Código de erro identificando o tipo de erro
example: INVALID_INPUT
message:
type: string
description: Mensagem de erro legível pelo ser humano
example: Invalid request parameters
params:
type: object
additionalProperties: true
description: >-
Valores não sensíveis opcionais para interpolação de erros
localizados, codificados por código de erro. Nunca presente para
erros de servidor.
example:
instances: 2
pools: 0
request_id:
type: string
format: uuid
description: Solicitar ID para depuração
example: 550e8400-e29b-41d4-a716-446655440000
IpFamily:
type: string
enum:
- ipv4
- ipv6
description: >
A família de endereços IP. Os IPs flutuantes suportam qualquer família e
podem ter visibilidade pública ou privada. Os IPs flutuantes públicos
alocam do pool de endereços públicos da região; os IPs flutuantes
privados alocam do intervalo de sub-rede selecionado para essa família.
A anexação de um IP flutuante a uma interface requer um endereço da
mesma família nessa interface. O IPv6 não requer que o IPv4 seja ativado
na sub-rede. A acessibilidade à Internet também depende de rotas e
regras de segurança.
A anexação de um IP flutuante IPv6 não desabilita o endereço IPv6
roteável globalmente nativo da interface. Ambos os endereços permanecem
acessíveis quando as regras de roteamento e segurança permitirem, e as
respostas a conexões de entrada retêm o endereço que recebeu a conexão.
Um endereço IPv6 privado não se torna diretamente roteável pela internet
ao anexar um IP flutuante.
example: ipv6
FloatingIpMember:
type: object
description: Uma ligação de um IP flutuante.
required:
- interface
- health
- reason
- created_at
properties:
interface:
type: object
nullable: true
description: >-
Resumo de NIC vinculada; nulo para uma vinculação de balanceador de
carga nomeada por attached_to.
required:
- id
- crn
- instance
properties:
id:
type: string
format: uuid
crn:
type: string
example: >-
crn:network:sa-saopaulo-1:my-account:vpc/prod/subnet/public/interface/eth0
instance:
type: object
nullable: true
description: >-
Instância proprietária; nulo quando a interface não tem
instância proprietária.
required:
- id
- crn
- name
properties:
id:
type: string
format: uuid
crn:
type: string
example: crn:compute:sa-saopaulo-1:my-account:instance/web
name:
type: string
health:
type: string
enum:
- unknown
- healthy
- unhealthy
description: >
O que a plataforma sabe sobre este membro.
`unknown` — não há verificação em execução. Esse é o estado de um
membro anexado manualmente a um endereço sem verificação de
integridade: você escolheu quando anexá-lo, e a plataforma não
recebe sinais sobre o que está em execução na instância. O membro
continua anunciado.
`healthy` — a plataforma tem evidências de que o membro está ativo
e, se houver uma verificação de integridade configurada no endereço,
de que ela está passando.
`unhealthy` — a plataforma ainda não recebeu essa confirmação ou uma
verificação configurada está falhando. O membro permanece associado
ao endereço, mas não recebe tráfego até se recuperar.
Sem uma verificação de integridade, `healthy` confirma apenas que o
sistema da instância está ativo, não que o serviço esteja aceitando
conexões. Configure `health_check` no IP flutuante para verificar
também se a aplicação está pronta.
example: unknown
reason:
type: string
enum:
- unprobed
- booting
- probe_failed
- passing
description: >
Por que o membro lê a `health` que ele faz — para que você possa
dizer "seu serviço não está respondendo" de "o convidado ainda não
iniciou".
`unprobed` — ninguém está verificando (sem verificação de saúde,
anexado à mão). `booting` — a plataforma ainda não viu o guest
aparecer. `probe_failed` — a verificação de integridade configurada
está falhando. `passing` — o convidado está ativo e, se uma
verificação estiver configurada, ele passa.
example: unprobed
created_at:
type: string
format: date-time
readOnly: true
address_id:
type: string
format: uuid
nullable: true
description: Endereço de filho de destino na interface de membro.
responses:
BadRequest:
description: Parâmetros de solicitação inválidos
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INVALID_INPUT
message: Invalid request parameters
request_id: 550e8400-e29b-41d4-a716-446655440000
Unauthorized:
description: Autenticação necessária ou token inválido
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: Authentication required
request_id: 550e8400-e29b-41d4-a716-446655440000
Forbidden:
description: Permissões insuficientes
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ACCESS_DENIED
message: You don't have permission to perform this action
request_id: 550e8400-e29b-41d4-a716-446655440000
NotFound:
description: Página não encontrada
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: NOT_FOUND
message: Resource not found
request_id: 550e8400-e29b-41d4-a716-446655440000
InternalServerError:
description: Erro interno do servidor
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INTERNAL_ERROR
message: An internal error occurred
request_id: 550e8400-e29b-41d4-a716-446655440000
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >+
Um token bearer OAuth 2.0, enviado como `Authorization: Bearer `.
Esta é a forma recomendada de autenticação.
Obtenha o token trocando o par de chaves de acesso de uma conta de
serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
com OAuth podem obter e renovar o token para você.
```
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
```
Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
também serve como credencial AWS SigV4 para o endpoint de objetos
compatível com S3, que aceita somente esse método de autenticação.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.