> ## 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 a proteção contra redução de um membro > Protege ou remove a proteção de um membro de um pool de instâncias do cliente contra redução manual e automática. Membros já em retirada retornam 409. A proteção se aplica a esta VM e não impede uma atualização explícita, a substituição de uma VM com falha, a exclusão da instância ou do pool. VMs substitutas começam sem proteção. > [!NOTE] > > Requer a ação do IAM **`compute:UpdateInstancePool`**. Consulte [permissões de computação](https://docs.basaltic.sh/pt/compute/permissions.md) para obter a lista completa, o que cada uma abrange e um exemplo de política. ## OpenAPI ````yaml /pt/api-reference/specs/compute.yaml patch /v1/instance-pools/{pool_id}/instances/{instance_id} openapi: 3.0.3 info: title: API de Basaltic Compute version: 1.0.0 description: > Instâncias de máquina virtual e as imagens, os tipos e os pools de instâncias a partir dos quais elas são criadas. Abrange todo o ciclo de vida da instância: iniciar, parar, reiniciar, redimensionar e reinstalar. contact: name: Basaltic Support email: ping@basaltic.sh license: name: Proprietary url: https://basaltic.sh/terms servers: - url: https://compute.{region}.basaltic.sh description: Endpoint de API regional variables: region: default: sa-saopaulo-1 description: Código de região security: - BearerAuth: [] paths: /v1/instance-pools/{pool_id}/instances/{instance_id}: parameters: - name: pool_id in: path required: true schema: type: string format: uuid - name: instance_id in: path required: true schema: type: string format: uuid patch: tags: - Compute summary: Atualizar a proteção contra redução de um membro description: >- Protege ou remove a proteção de um membro de um pool de instâncias do cliente contra redução manual e automática. Membros já em retirada retornam 409. A proteção se aplica a esta VM e não impede uma atualização explícita, a substituição de uma VM com falha, a exclusão da instância ou do pool. VMs substitutas começam sem proteção. operationId: updateInstancePoolMemberProtection requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InstancePoolMemberProtectionRequest' responses: '200': description: Pool atualizado, incluindo os UUIDs dos membros protegidos. content: application/json: schema: $ref: '#/components/schemas/InstancePoolResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' security: - BearerAuth: [] components: schemas: InstancePoolMemberProtectionRequest: type: object additionalProperties: false required: - scale_in_protected properties: scale_in_protected: type: boolean description: >- Protege este membro contra redução manual e automática. Remova a proteção antes de selecioná-lo para redução. Não é possível alterar um membro em retirada. Atualização explícita, substituição de instâncias com falha, exclusão de instância e exclusão do pool não são afetadas. Instâncias substitutas começam sem proteção. InstancePoolResponse: type: object properties: instance_pool: $ref: '#/components/schemas/InstancePool' required: - instance_pool InstancePool: type: object required: - faults - subnets - vpc description: >- Um modelo de lançamento mais uma contagem desejada. A criação de um pool gera instâncias de desired_count; um reconciliador converge member_count para desired_count à medida que ele muda. member_count é quantos membros o pool tem; live_count é quantos deles estão em execução. Um pool carrega dois conjuntos de tags e eles respondem a perguntas diferentes. `tags` rotula o recurso do pool — é o que uma condição do IAM lê como `basalt:ResourceTag/` e o que um relatório de custo agrupa, e não atinge nenhuma instância. `template.tags` é o conjunto estampado em cada réplica que o pool lança. properties: subnets: type: array items: $ref: '#/components/schemas/ResourceRef' description: Sub-redes elegíveis para alocação na mesma conta, região e VPC. vpc: anyOf: - $ref: '#/components/schemas/ResourceRef' - type: object nullable: true enum: - null autoscaling: $ref: '#/components/schemas/AutoscalingPolicy' autoscaling_status: $ref: '#/components/schemas/AutoscalingStatus' rollout_surge: type: boolean readOnly: true description: >- Capacidade de implantação temporária; desired_count permanece o alvo estável. scale_in_protected_instances: type: array readOnly: true items: type: string format: uuid description: >- UUIDs das instâncias protegidas contra redução manual e automática. A proteção não impede atualização, substituição de instância com falha ou exclusão explícita. scale_in_blocked_reason: type: string readOnly: true description: >- Por que a proteção contra redução está impedindo a redução solicitada. Omitido quando não há bloqueio. retiring_instances: type: array readOnly: true items: $ref: '#/components/schemas/RetiringPoolMember' id: type: string format: uuid readOnly: true example: 8f2a1c3d-4e5b-4a6f-9c0d-1e2f3a4b5c6d crn: type: string readOnly: true description: >- Nome do recurso da nuvem. Esse é o valor que uma declaração de política do IAM deve nomear para escopo de uma permissão somente para esse pool; uma política escrita contra qualquer outra coisa não corresponderá. example: crn:compute:sa-saopaulo-1:my-account:instance-pool/web-pool name: description: >- Os nomes de recursos não devem começar com o prefixo literal crn: ou ser UUIDs (formas canônicas, compactas, entre colchetes ou urn:uuid:, em qualquer caso). type: string example: web-asg description: type: string example: Front-end autoscaling group desired_count: type: integer minimum: 0 maximum: 100 example: 2 min_count: type: integer minimum: 0 maximum: 100 example: 1 max_count: type: integer minimum: 0 maximum: 100 description: >- Um valor de 0 significa que o pool não possui membros até que max_count seja aumentado. example: 3 live_count: type: integer readOnly: true description: > Quantos membros estão UP — instâncias vinculadas cujo current_state é `running`. example: 2 member_count: type: integer readOnly: true description: >- Quantas instâncias o pool contém, em execução ou não. Isso é o que o conciliador converge para desired_count e o que `status` reflete, então member_count == desired_count com live_count abaixo dele significa que o pool tem os membros que foi solicitado e alguns deles não estão ativos. example: 2 refresh_in_progress: type: boolean readOnly: true description: >- True enquanto uma substituição contínua solicitada por meio de POST /v1/instance-pools/{pool_id}/refresh ainda estiver em execução. Ele se limpa quando todos os membros estão no modelo atual. O pool lê `scaling` para a duração, uma vez que ele executa uma instância sobre seu alvo enquanto uma substituição aparece. example: false stale_instance_count: type: integer readOnly: true description: >- Quantos membros foram lançados a partir de um modelo diferente do atual do pool, ou seja, quantos seriam substituídos por uma atualização. Não-zero após editar o `template` e antes de atualizar, que é o sinal de que uma mudança de modelo ainda não foi lançada. example: 0 status: type: string enum: - active - scaling - error - deleting readOnly: true description: > Onde o pool está contra o seu alvo. `active` significa member_count == desired_count — o pool contém os membros que foram solicitados. Não é uma afirmação de que todos eles estão ativos; leia live_count para isso. `scaling` significa que não, e o conciliador está convergindo-o: após uma criação, após uma alteração de desired_count, e pelo tempo de uma atualização de instância, que executa o pool uma instância sobre seu alvo enquanto uma substituição aparece. `error` significa que existe uma falha de erro ativa. As falhas de capacidade permanecem elegíveis para reconciliação; a exclusão com falha mantém sua intenção de desmontagem e nunca recria membros. `deleting` é desmontado sem um erro ativo. example: active faults: type: array readOnly: true description: >- Falhas ativas, mais recentes primeiro. Vazio para uma pool saudável. A recuperação resolve apenas os códigos da operação bem-sucedida. items: $ref: '#/components/schemas/Fault' managed_by: type: string readOnly: true example: customer tags: allOf: - $ref: '#/components/schemas/Tags' description: >- Rótulos no próprio POOL, para condições do IAM (`basalt:ResourceTag/`) e atribuição de custo. Eles não estão ligados a mais nada: nenhuma instância que o pool lança os carrega. As tags com as quais uma réplica é lançada são `template.tags`. Ao contrário dos outros campos de nível superior ao lado deste, `tags` não é uma projeção do modelo de lançamento — é o próprio conjunto do pool, e PATCHable por conta própria. template: allOf: - $ref: '#/components/schemas/InstancePoolTemplate' readOnly: true description: > A configuração de lançamento do pool, na forma instance create takes. O único lugar onde aparece: uma cópia plana ao lado desta era duas ortografias de uma coisa, e duas ortografias de deriva. 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 ResourceRef: type: object required: - id - crn properties: id: type: string format: uuid example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1 crn: type: string example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1 name: type: string description: >- Rótulo no momento da resposta: o nome do recurso, quando houver, ou seu rótulo legível (número de fatura, nome de exibição da conta). Ausente quando o destino não existe mais. Não é uma chave de consulta. example: Brazil AutoscalingPolicy: type: object additionalProperties: false required: - enabled - metrics description: > Rastreamento de destino compartilhado por pools de instâncias e balanceadores de carga. As atualizações substituem a política. Defina enabled=false para manter as configurações e usar o dimensionamento manual. Cada métrica recomenda uma contagem desejada; a maior recomendação vence. Observações ausentes, obsoletas ou incompletas impedem o dimensionamento, mas não bloqueiam o dimensionamento recomendado por outra métrica válida. As decisões obedecem aos recursos min_count/max_count, warmup, cooldown, estabilização, limites de passo e cotas. O estado sobrevive às reinicializações do controlador. As políticas ativas possuem desired_count; as alterações manuais são aceitas e a avaliação automática é retomada após o tempo de espera. A telemetria personalizada requer telemetria:ReadMetrics na mesma conta. properties: enabled: type: boolean example: true metrics: type: array minItems: 1 maxItems: 5 items: $ref: '#/components/schemas/ScalingMetric' warmup_seconds: type: integer minimum: 30 maximum: 3600 default: 180 cooldown_seconds: type: integer minimum: 30 maximum: 3600 default: 60 scale_down_stabilization_seconds: type: integer minimum: 60 maximum: 3600 default: 300 max_scale_out_step: type: integer minimum: 1 maximum: 100 default: 4 max_scale_in_step: type: integer minimum: 1 maximum: 100 default: 1 drain_seconds: type: integer minimum: 30 maximum: 3600 default: 120 description: >- Período de carência após a retirada de rota e confirmações de proxy, antes de excluir um membro aposentado. Sessões TCP/UDP de longa duração podem terminar no prazo; ganchos de desligamento de aplicativos arbitrários não são suportados. AutoscalingStatus: type: object readOnly: true required: - status - reason - history properties: status: type: string enum: - pending - disabled - stable - scaling - waiting - warming_up - metrics_unavailable - stabilizing - cooldown - draining - scale_in_blocked reason: type: string example: waiting for sustained lower demand evaluated_at: type: string format: date-time last_scaled_at: type: string format: date-time history: type: array maxItems: 50 items: type: object required: - at - from - to - reason properties: at: type: string format: date-time from: type: integer minimum: 0 to: type: integer minimum: 0 reason: type: string RetiringPoolMember: allOf: - $ref: '#/components/schemas/Retirement' - type: object required: - instance_id properties: instance_id: type: string format: uuid Fault: type: object required: - code - severity - message - details - first_at - last_at - occurrences properties: code: type: string description: >- Código estável legível por máquina pertencente à operação de relatório. example: BACKUP_FAILED severity: type: string enum: - error - warning message: type: string example: Backup upload failed. details: type: object nullable: true additionalProperties: true description: >- Contexto estruturado; cadeias de caracteres legadas são preservadas em legacy_text. first_at: type: string format: date-time description: Primeira observação nesta série de ocorrências ativas. last_at: type: string format: date-time description: Última observação nesta série de ocorrências ativas. occurrences: type: integer minimum: 1 example: 1 Tags: type: object additionalProperties: type: string example: environment: production team: backend InstancePoolTemplate: type: object description: >- Configuração de lançamento armazenada com relações ResourceRef. Use id ou crn da referência como seletor de string correspondente ao substituir o modelo. As identidades das imagens permanecem fixadas até a substituição do modelo. properties: addresses: type: array items: $ref: '#/components/schemas/AddressRequest' description: >- Famílias de endereços alocadas na única interface do membro. Endereços fixos não são permitidos. security_groups: type: array items: $ref: '#/components/schemas/ResourceRef' floating_ip_assignment: type: string enum: - none - ipv4 - ipv6 - dual_stack - auto default: none description: >- Atribuição de IPs flutuantes públicos por membro. Famílias explícitas exigem endereços e rotas para a internet em todas as sub-redes selecionadas. user_data: type: string format: byte description: >- Dados de usuário codificados em Base64 (cloud-init), carimbados em cada réplica. metadata: $ref: '#/components/schemas/Metadata' tags: allOf: - $ref: '#/components/schemas/Tags' description: >- Tags carimbadas em cada instância que este modelo lança. Estas são as tags das réplicas, não do pool — as próprias etiquetas do pool são as `tags` de nível superior, e as duas são independentes. Alterá-los afeta apenas lançamentos FUTUROS. As instâncias já em execução mantêm as tags com as quais foram lançadas, então entre a mudança e uma atualização, o pool contém membros que carregam dois conjuntos de tags diferentes; `stale_instance_count` é quantos ainda estão na antiga. POST /v1/instance-pools/{pool_id}/refresh rolls them onto the current template. iam_role: anyOf: - $ref: '#/components/schemas/ResourceRef' - type: object nullable: true enum: - null description: >- Função atribuída às réplicas, ou null quando nenhuma está configurada. example: id: 550e8400-e29b-41d4-a716-446655440005 crn: crn:iam:::role/550e8400-e29b-41d4-a716-446655440005 name: instance-role volumes: type: array items: $ref: '#/components/schemas/InstanceVolume' description: > Discos por réplica, o disco de inicialização incluído — marque-o com `boot: true`. Cada nova réplica recebe o desempenho provisionado configurado. O desempenho omitido usa a franquia incluída. Os volumes existentes e as programações de instantâneos não são suportados em modelos de pool. flavor: allOf: - $ref: '#/components/schemas/ResourceRef' example: id: 550e8400-e29b-41d4-a716-446655440003 crn: crn:compute:sa-saopaulo-1:platform:flavor/s1.small name: s1.small image: anyOf: - $ref: '#/components/schemas/ResourceRef' - type: object nullable: true enum: - null description: >- Imagem de origem fixada até a substituição do modelo, ou null quando nenhuma imagem está selecionada. example: id: 550e8400-e29b-41d4-a716-446655440004 crn: >- crn:compute:sa-saopaulo-1:platform:image/ubuntu/architecture/amd64/version/24.04 name: ubuntu required: - flavor - image - iam_role - security_groups - floating_ip_assignment ScalingMetric: type: object additionalProperties: false required: - source - target_type - target_value description: > CPU usa source=cpu, target\_type=utilization e um alvo de porcentagem \<=100. Utilização é o número de segundos de CPU por segundo dividido pelas vCPUs alocadas em todos os membros prontos. O dimensionamento de CPU habilitado requer min\_count\>=1. A demanda personalizada usa source=telemetry e target_type=average_value. O nome e os rótulos da métrica selecionam séries na conta, organização e região do recurso. A agregação temporal é aplicada dentro de cada série antes de combinar séries; amostras de medidores repetidas nunca são somadas como demanda extra. A contagem desejada é ceil(combined value / target_value): 750 trabalhos pendentes com uma meta de 100 por instância recomenda 8. A demanda personalizada pode escalar um grupo de clientes a partir de 0. Os produtores devem publicar zeros novos para filas ociosas; dados ausentes não são zero. properties: source: type: string enum: - cpu - telemetry example: telemetry target_type: type: string enum: - utilization - average_value example: average_value target_value: type: number minimum: 0 exclusiveMinimum: true example: 100 name: type: string pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]{0,199}$ example: queue_depth labels: type: object maxProperties: 10 additionalProperties: type: string maxLength: 256 description: >- Rótulos de correspondência exata; rótulos de locação e __name__ não podem ser fornecidos. example: queue: orders sample_aggregation: type: string enum: - last - avg - max - rate default: last description: >- Use last para medidores de fila; rate para contadores que aumentam monotonicamente, com manipulação de reset. series_aggregation: type: string enum: - sum - avg - max default: sum expected_series: type: integer minimum: 1 maximum: 1000 default: 1 description: >- Cardinalidade exata esperada; seletores incompletos ou ambíguos não estão disponíveis. window_seconds: type: integer minimum: 30 maximum: 3600 default: 120 max_age_seconds: type: integer minimum: 30 maximum: 3600 default: 90 description: >- Idade real da observação mais recente por série; não deve exceder window_seconds. O padrão é o menor de 90 e a janela. Retirement: type: object readOnly: true required: - requested_at - drain_seconds properties: requested_at: type: string format: date-time drain_seconds: type: integer minimum: 30 maximum: 3600 agent_acknowledged_at: type: string format: date-time drain_until: type: string format: date-time description: >- Tempo de exclusão mais cedo; ausente enquanto a retirada está pendente. AddressRequest: type: object properties: family: type: string enum: - ipv4 - ipv6 address: type: string description: >- Endereço fixo opcional ao criar uma interface ou instância NIC. Para IPv6, use o primeiro endereço de um /96 alinhado dentro da sub-rede /64 (últimos 32 bits zero); o primeiro e o último intervalo /96 são reservados. Omitir para alocação automática. Nós de banco de dados gerenciados e a operação de adicionar endereço exigem alocação automática. required: - family additionalProperties: false Metadata: type: object additionalProperties: type: string example: environment: production team: backend InstanceVolume: type: object required: - size_gb description: > Um disco criado com a instância. `boot: true` marca o clone de image_id; cada outra entrada é um volume em branco que o agente convidado formata e monta. properties: boot: type: boolean default: false example: false description: > Marca o disco de inicialização. Não precisa de mount_path ou fstype — ambos vêm da imagem — e o envio de qualquer um é recusado em vez de ignorado. size_gb: type: integer minimum: 1 example: 20 volume_type: type: string example: nvme description: Tier; omitido = o padrão da região. performance: $ref: '#/components/schemas/VolumePerformanceRequest' mount_path: type: string example: /data fstype: type: string example: ext4 description: Sistema de arquivos com o qual o agente convidado formata o volume. delete_on_termination: type: boolean default: true example: true description: Destruido com a instância, a menos que seja definido como false. VolumePerformanceRequest: type: object additionalProperties: false description: > Desempenho de leitura/gravação combinado total sustentado de provisionamento independente. As dimensões omitidas mantêm seu valor atual (incluído na criação). O SSD permite até 8000 IOPS e 250 MiB/s; o NVMe até 12000 e 500 MiB/s. O mínimo é a cota incluída do volume; cotas maiores permanecem disponíveis gratuitamente. O rendimento é inteiro MiB/s, exceto uma fração exata de permissão de legado pode ser selecionada para remover o complemento pago. Os aumentos exigem cota de conta, capacidade regional e armazenamento saudável. Fatura de extras aplicados por duração decorrido, incluindo enquanto desligado ou parado. properties: iops: type: integer minimum: 1 example: 6000 throughput_mib_s: type: number minimum: 0 example: 250 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 Conflict: description: Conflito de recursos (por exemplo, já existe, estado inválido) content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: CONFLICT message: Resource with this name already exists 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.