> ## 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.
# Simular política de ciclo de vida
> Simula expirações sem excluir imagens. Usa POST para receber regras candidatas no corpo; corpo vazio simula a política instalada. `size_bytes` conta uma vez cada camada que nenhuma imagem sobrevivente deste repositório referencia.
Exige a ação IAM **`registry:StartLifecyclePolicyPreview`**. Veja [REGISTRY permissões](/pt/registry/permissions) para a lista completa, o escopo de cada ação e um exemplo de política.
## OpenAPI
````yaml /pt/api-reference/specs/registry.yaml post /v1/repositories/{repository_id}/lifecycle-policy/preview
openapi: 3.0.3
info:
title: API Basaltic Registry
version: 1.0.0
description: >-
Registry de imagens de contêiner. A API de gerenciamento usa
`registry..basaltic.sh`; Docker e clientes OCI usam
`cr..basaltic.cloud`. Esta referência descreve `/v1`, autenticado
por OAuth ou sessão do console. `/v2` segue a especificação OCI Distribution
1.1.
`POST /v1/authorization-token` gera uma senha para `docker login`, que a
troca por tokens por repositório em `/v2/token`. A senha dura 12 horas, mas
decisões de autorização usam as políticas atuais e tokens de cinco minutos.
Referências de imagem incluem o identificador da conta; use a `uri`
retornada pelo servidor.
Blobs e manifestos são imutáveis e identificados por SHA-256. Tags são
apontadores mutáveis, salvo com `tag_mutability: immutable`. Excluir por
digest remove manifesto e tags; excluir por tag preserva o manifesto.
Camadas são deduplicadas em toda a conta. `size_bytes` conta blobs
distintos, e a coleta em segundo plano libera os que nenhuma imagem ainda
usa.
Uma política de recurso permite acesso entre contas ou público. Acesso entre
contas exige autorização tanto no recurso como no IAM do chamador.
`kms_key` aceita UUID, nome na conta ou CRN de uma chave simétrica
habilitada na mesma conta e região. Referências inválidas retornam 400;
chaves inexistentes retornam 404. Respostas usam ResourceRef e preservam ID
e CRN sem nome quando a chave foi excluída.
contact:
name: Basaltic Support
email: ping@basaltic.sh
license:
name: Proprietary
url: https://basaltic.sh/terms
servers:
- url: https://registry.{region}.basaltic.sh
description: Endpoint de API regional
variables:
region:
default: sa-saopaulo-1
description: Código de região
security:
- BearerAuth: []
tags:
- name: Authorization
description: Credencial usada por `docker login`
- name: Repositories
description: Ciclo de vida, configurações, imagens e tags dos repositórios
- name: Policies
description: Políticas de recurso e de ciclo de vida
- name: Encryption
description: Criptografia de camadas em repouso
- name: Pull-through cache
description: Cache de imagens de outro registry no seu namespace
paths:
/v1/repositories/{repository_id}/lifecycle-policy/preview:
parameters:
- $ref: '#/components/parameters/RepositoryId'
post:
tags:
- Policies
summary: Simular política de ciclo de vida
description: >-
Simula expirações sem excluir imagens. Usa POST para receber regras
candidatas no corpo; corpo vazio simula a política instalada.
`size_bytes` conta uma vez cada camada que nenhuma imagem sobrevivente
deste repositório referencia.
operationId: startLifecyclePolicyPreview
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/LifecyclePolicyRequest'
responses:
'200':
description: Imagens que a política expiraria.
content:
application/json:
schema:
$ref: '#/components/schemas/LifecyclePreviewResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
components:
parameters:
RepositoryId:
name: repository_id
in: path
required: true
schema:
type: string
format: uuid
example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
schemas:
LifecyclePolicyRequest:
type: object
properties:
rules:
type: array
maxItems: 25
items:
$ref: '#/components/schemas/LifecycleRule'
required:
- rules
LifecyclePreviewResponse:
type: object
properties:
preview:
type: object
properties:
matches:
type: array
items:
type: object
properties:
digest:
type: string
tags:
type: array
items:
type: string
pushed_at:
type: string
format: date-time
last_pulled_at:
type: string
format: date-time
nullable: true
rule_priority:
type: integer
description: Regra que selecionou esta imagem.
required:
- digest
- pushed_at
- rule_priority
total_images:
type: integer
description: >-
Quantidade total de imagens do repositório para comparar com o
número de correspondências.
size_bytes:
type: integer
format: int64
description: >-
Espaço recuperável: somente camadas sem referência por imagens
sobreviventes, contadas uma vez.
required:
- matches
- total_images
- size_bytes
required:
- preview
LifecycleRule:
type: object
properties:
priority:
type: integer
minimum: 1
description: >-
Ordem de avaliação crescente, exclusiva na política. A primeira
regra correspondente assume a imagem.
example: 1
description:
type: string
maxLength: 256
example: Keep the last 10 prod builds
selection:
$ref: '#/components/schemas/LifecycleSelection'
action:
type: string
enum:
- expire
description: >-
Única ação disponível, declarada explicitamente para permitir
futuras ações sem mudar políticas existentes.
required:
- priority
- selection
- action
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
LifecycleSelection:
type: object
properties:
tag_status:
type: string
enum:
- tagged
- untagged
- any
description: >-
`tagged` exige prefixo ou padrão. `any` pode aparecer em apenas uma
regra, com o maior número de prioridade.
tag_prefixes:
type: array
items:
type: string
example:
- prod-
tag_patterns:
type: array
items:
type: string
description: Padrão cujo único curinga é `*`. Um `*` isolado é rejeitado.
example:
- release-*
count_type:
type: string
enum:
- image_count_more_than
- since_image_pushed
- since_image_pulled
description: >-
`image_count_more_than` mantém as N imagens mais recentes.
`since_image_pushed` expira imagens enviadas há mais de N dias.
`since_image_pulled` expira imagens sem pull há N dias; se nunca
houve pull, conta desde o envio.
count_unit:
type: string
enum:
- days
description: Obrigatório nos dois tipos `since_*` e proibido no outro.
count_number:
type: integer
minimum: 1
maximum: 1000000
example: 10
required:
- tag_status
- count_type
- count_number
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
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.