Docs Menu
Docs Home
/ /
API de administración
Docs Home
/
Gestión
/
APIs
/
API de administración
Docs Home
/
Gestión
/
APIs
/
API de administración

Migrar a la nueva versión de la API de administración de Atlas

Con la introducción de la API de administración de Atlas versionada (a la que aquí se hace referencia como /v2), le recomendamos que migre de la API de administración de Atlas heredada (conocida como /v1) a la nueva API de administración de Atlas con versiones (/v2).

Introducción a la API de administración de Atlas versionada

La nueva versión de la API de Administración de Atlas ofrece una experiencia general significativamente mejorada al acceder a Atlas mediante programación. Esta API proporciona una experiencia predecible y consistente con los cambios de la API y ofrece una mejor visibilidad de las nuevas funciones y cambios.

Ciclo de vida de la API de administración de Atlas versionada

Atlas expone una nueva versión de un recurso existente Punto de conexión deAPI cuando Atlas introduce cambios importantes en la versión estable actual del punto de conexión de API. Cuando Atlas expone una nueva versión del recurso, desactualiza automáticamente la versión anterior. Atlas elimina automáticamente la versión desactualizada doce meses después de su desactualización. Aunque Atlas seguirá ofreciendo soporte para la versión anterior del recurso en su entorno de producción durante un máximo de doce meses, debería migrar a la nueva versión del punto de conexión de API lo antes posible. Para obtener más información, consulte el ejemplo en Esquema de versiones.

Tenga en cuenta que, con el control de versiones a nivel de recurso, cada recurso de la API de administración de Atlas versionada podría introducir una nueva versión independientemente de los demás recursos. Solo debe actuar cuando los recursos que utiliza estén obsoletos.

Ejemplo

Supongamos que Atlas introduce un nuevo recurso en 2023-06-01, pero /backup no presenta cambios importantes y permanece en 2023-02-01. Debe migrar a 2023-06-01 solo si utiliza ese recurso. Si no ha implementado el recurso, no necesita realizar ninguna acción.

Atlas mantendrá la versión obsoleta del recurso durante al menos doce meses hasta su eliminación, lo que le brinda tiempo para planificar y migrar a la nueva versión. Puede consultar los cambios de cada nuevo recurso en el registro de cambios de la API y los detalles de la versión de la API en la especificación de la API.

Procedimiento

Para migrar a la nueva API de administración de Atlas con versiones, debe hacer lo siguiente:

1

Especifique el número que representa la API versionada en la URL base del recurso.

URL base
https://cloud.mongodb.com/api/atlas/<version-number>/

Ejemplo

Considere la siguiente URL base para la versión heredada de un recurso de API de administración de Atlas:

https://cloud.mongodb.com/api/atlas/v1.0/

Con la introducción de la API de administración versionada, la URL base anterior indica que se utilizan recursos sin versionar. Para enviar una solicitud al recurso de la API de administración versionada de Atlas/v2 (), debe enviarla a la siguiente URL base:

https://cloud.mongodb.com/api/atlas/v2/

Para obtener más información sobre cómo enviar solicitudes a los puntos finales de la API de administración de Atlas en diferentes estados, consulte Esquema de versiones.

2

Agregue el Accept encabezado de versión a las solicitudes.

Para usar la API de administración de Atlas versionada, debe proporcionar una versión para sus recursos. La primera versión es la misma para todos los recursos y, para la migración inicial de la API heredada sin versionar a la API versionada, debe usar el número de versión correspondiente a la fecha de la versión del recurso.

Ejemplo

El siguiente comando curl es un ejemplo de una solicitud a un punto final de la API de administración de Atlas versionada (v2) con el encabezado:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/vnd.atlas.{yyyy-mm-dd}+json" \
  --request {GET|DELETE}
  "https://cloud.mongodb.com/api/atlas/v2/{RESOURCE}/{ENDPOINT}?{PARAMS}"

También debe especificar el tipo de contenido para las solicitudes POST, PUT o PATCH. El valor del tipo de contenido puede ser uno de los siguientes:

  • application/json

  • application/vnd.atlas.{yyyy-mm-dd}+json

Ejemplo

El siguiente comando curl es un ejemplo de una solicitud a un punto final de la API de administración de Atlas versionada (v2) con el encabezado y el tipo de contenido:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Content-Type: application/vnd.atlas.{yyyy-mm-dd}+json" \
  --header "Accept: application/vnd.atlas.{yyyy-mm-dd}+json" \
  --request {POST|PUT|PATCH}
  "https://cloud.mongodb.com/api/atlas/v2/{RESOURCE}/{ENDPOINT}?{PARAMS}"

Para obtener más información sobre los encabezados de API de administración de Atlas versionados, consulte Ciclo de vida de la API en Esquema de versiones.

3

Revise el registro de cambios para determinar los cambios de sintaxis para el punto final de la API de administración de Atlas en la nueva versión del recurso.

Las nuevas versiones de recursos de los puntos finales de la API podrían incluir cambios importantes. Asegúrese de que su solicitud al nuevo recurso incorpore dichos cambios y que el encabezado de la solicitud incluya el estado del punto final al que se envía la solicitud.

Nota

No es necesario consultar el registro de cambios de la API para la migración inicial de la API de administración de Atlas sin versión a la API de administración de Atlas con versión en las versiones del recurso 2023-02-, a01 menos que esté migrando el /v1.0/clusters recurso al recurso2 /clusters de la API de administración de Atlas con versión (v). La versión inicial de la API de administración de Atlas con versión en 2023-02-01 contiene cambios de sintaxis solo para el /clusters recurso. Para obtener más información, consulte la especificación de la API para Clústeres.

4

(Opcional) Migre el recurso de clústeres de la API de administración de Atlas v1.0 sin versión al recurso de clústeres de la API de administración de Atlas (v2) con versión.

La versión 2023-02-01 de la API versionada de administración de Atlas contiene los siguientes cambios de sintaxis para el recurso clústeres:

Tipo de solicitud de punto final de la API de administración de Atlas versionada (v2)
Registro de cambios

PUBLICAR

Incluye los siguientes cambios:

  • Elimina las siguientes propiedades de solicitud:

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • Agrega la propiedad de solicitud replicationSpecs.regionConfigs

  • Elimina las siguientes propiedades opcionales de la respuesta:

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • Agrega la propiedad de respuesta replicationSpecs.regionConfigs

OBTENER (todos)

Incluye los siguientes cambios:

  • Elimina las siguientes propiedades opcionales de la respuesta:

    • results.items.mongoURIWithOptions

    • results.items.providerBackupEnabled

    • results.items.mongoURIUpdated

    • results.items.srvAddress

    • results.items.replicationSpec

    • results.items.mongoURI

    • results.items.numShards

    • results.items.autoScaling

    • results.items.providerSettings

    • results.items.replicationFactor

    • results.items.replicationSpecs.regionsConfig

  • Agrega la propiedad de respuesta results.items.replicationSpecs.regionConfigs

OBTENER (uno)

Incluye los siguientes cambios:

  • Elimina las siguientes propiedades opcionales de la respuesta:

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • Agrega la propiedad de respuesta results.items.replicationSpecs.regionConfigs

PARCHE (uno)

Incluye los siguientes cambios:

  • Elimina las siguientes propiedades opcionales de la respuesta:

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • Agrega la propiedad de respuesta results.items.replicationSpecs.regionConfigs

  • Elimina las siguientes propiedades opcionales de la respuesta:

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • Agrega la propiedad de respuesta replicationSpecs.regionConfigs

Si utiliza el recurso /clusters de la API de administración de Atlas sin versión para crear uno, obtener uno, obtener todos,modificar uno o eliminar un clúster, migre a los puntos finales:oas-bump-atlas-op:,:oas-bump-atlas-op:,:oas-bump-atlas-op:,:oas-bump-atlas-op: y:oas-bump-atlas-op: en el2 recurso Clústeres de la API de administración de Atlas con versión (v).

Si aún no desea migrar a la 2023-02-01 versión, realice solo los pasos 1 y 2 del procedimiento para usar la 2023-01-01 versión de la API. Tenga 2023-01-01 en cuenta que la versión está obsoleta.

Volver

Versioning Overview

Next

Actualizaciones de API

En esta página