> ## 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.
# Obtener regla de caché de imágenes
> Requiere `registry:DescribePullThroughCacheRules`.
Requiere la acción IAM **`registry:DescribePullThroughCacheRules`**. Consulte [REGISTRY permisos](/es/registry/permissions) para la lista completa, el alcance de cada acción y un ejemplo de política.
## OpenAPI
````yaml /es/api-reference/specs/registry.yaml get /v1/pull-through-cache-rules/{prefix}
openapi: 3.0.3
info:
title: API Basaltic Registry
version: 1.0.0
description: >-
Registry de imágenes de contenedores. La API de administración usa
`registry..basaltic.sh`; Docker y los clientes OCI usan
`cr..basaltic.cloud`. Esta referencia describe `/v1`, autenticado
mediante OAuth o sesión de la consola. `/v2` sigue la especificación OCI
Distribution 1.1.
`POST /v1/authorization-token` genera una contraseña para `docker login`,
que la intercambia por tokens por repositorio en `/v2/token`. La contraseña
dura 12 horas, pero las decisiones de autorización usan las políticas
actuales y tokens de cinco minutos. Las referencias de imagen incluyen el
identificador de la cuenta; use la `uri` devuelta por el servidor.
Blobs y manifiestos son inmutables e identificados por SHA-256. Las
etiquetas son punteros mutables, salvo con `tag_mutability: immutable`.
Eliminar por digest borra manifiesto y etiquetas; eliminar por etiqueta
conserva el manifiesto. Las capas se deduplican en toda la cuenta.
`size_bytes` cuenta blobs distintos, y la recolección en segundo plano
libera los que ninguna imagen sigue usando.
Una política de recurso permite acceso entre cuentas o público. El acceso
entre cuentas exige autorización tanto en el recurso como en el IAM del
cliente.
`kms_key` acepta UUID, nombre en la cuenta o CRN de una clave simétrica
habilitada en la misma cuenta y región. Las referencias inválidas devuelven
400; las claves inexistentes devuelven 404. Las respuestas usan ResourceRef
y conservan ID y CRN sin nombre cuando la clave se eliminó.
contact:
name: Basaltic Support
email: ping@basaltic.sh
license:
name: Proprietary
url: https://basaltic.sh/terms
servers:
- url: https://registry.{region}.basaltic.sh
description: Punto final de API regional
variables:
region:
default: sa-saopaulo-1
description: Código de región
security:
- BearerAuth: []
tags:
- name: Authorization
description: Credencial usada por `docker login`
- name: Repositories
description: Ciclo de vida, configuración, imágenes y etiquetas de los repositorios
- name: Policies
description: Políticas de recurso y de ciclo de vida
- name: Encryption
description: Cifrado de capas en reposo
- name: Pull-through cache
description: Caché de imágenes de otro registry en su namespace
paths:
/v1/pull-through-cache-rules/{prefix}:
parameters:
- $ref: '#/components/parameters/CachePrefix'
get:
tags:
- Pull-through cache
summary: Obtener regla de caché de imágenes
description: Requiere `registry:DescribePullThroughCacheRules`.
operationId: describePullThroughCacheRule
responses:
'200':
description: Regla.
content:
application/json:
schema:
$ref: '#/components/schemas/PullThroughCacheRuleResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
components:
parameters:
CachePrefix:
name: prefix
in: path
required: true
description: >-
Prefijo de la regla. Puede contener una barra, como `team/base`;
corresponde al resto de la ruta, no a un único segmento.
schema:
type: string
example: hub
schemas:
PullThroughCacheRuleResponse:
type: object
properties:
pull_through_cache_rule:
$ref: '#/components/schemas/PullThroughCacheRule'
required:
- pull_through_cache_rule
PullThroughCacheRule:
type: object
properties:
crn:
type: string
example: crn:registry:sa-saopaulo-1:my-account:pull-through-cache-rule/hub
prefix:
type: string
description: >-
Componentes iniciales de los nombres de repositorios asociados a la
regla.
example: hub
uri_prefix:
type: string
description: >-
Prefijo de referencia para pull generado por la regla. Use el valor
devuelto para conservar correctamente el namespace de la cuenta.
example: cr.sa-saopaulo-1.basaltic.cloud/my-account/hub
upstream_registry:
type: string
description: >-
Host de origen. `docker.io` se almacena como `registry-1.docker.io`,
que sirve `/v2`, como hace el daemon Docker.
example: registry-1.docker.io
upstream_prefix:
type: string
description: >-
Se añade antes del resto del nombre en el origen. `library` hace que
`hub/nginx` resuelva a `library/nginx` en Docker Hub.
example: library
upstream_username:
type: string
example: robot
has_credential:
type: boolean
description: >-
Indica si hay un secreto almacenado. El secreto nunca se devuelve;
rotarlo exige escribir un nuevo valor.
example: true
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
required:
- crn
- prefix
- uri_prefix
- upstream_registry
- has_credential
- created_at
- updated_at
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- request_id
properties:
code:
type: string
description: Código de error que identifica el tipo de error
example: INVALID_INPUT
message:
type: string
description: Mensaje de error legible por el ser humano
example: Invalid request parameters
params:
type: object
additionalProperties: true
description: >-
Valores no sensibles opcionales para la interpolación de errores
localizados, codificados por código de error. Nunca presente por
errores del servidor.
example:
instances: 2
pools: 0
request_id:
type: string
format: uuid
description: Solicitar ID para depuración
example: 550e8400-e29b-41d4-a716-446655440000
responses:
Unauthorized:
description: Se requiere autenticación o el token no es vá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: Permisos 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: No se encontró el recurso
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: >+
Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
`. Esta es la forma recomendada de autenticación.
Obtén el token intercambiando el par de claves de acceso de una cuenta
de servicio en `POST /v1/oauth/token` con
`grant_type=client_credentials`. Es el flujo estándar de credenciales de
cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
el token por ti.
```
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
```
Los tokens duran una hora por defecto. El mismo par de claves de acceso
también sirve como credencial AWS SigV4 para el endpoint de objetos
compatible con S3, que solo acepta ese método de autenticación.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.