Skip to main content
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Control de versiones de la API de gestión de red

PDF

La API de administración de red utiliza versiones para admitir actualizaciones sin interrupciones.

Por ejemplo, esta URL de solicitud especifica la versión 4 de la API.

https://hostname_or_ip_address/api/v4/authorize

La versión principal de la API se actualiza cuando se realizan cambios que no son compatibles con versiones anteriores. La versión menor de la API se actualiza cuando se realizan cambios que son compatibles con versiones anteriores. Los cambios compatibles incluyen la adición de nuevos puntos finales o nuevas propiedades.

El siguiente ejemplo ilustra cómo se actualiza la versión de la API según el tipo de cambios realizados.

Tipo de cambio en la API Versión antigua Nueva versión

Compatible con versiones anteriores

2,1

2,2

No compatible con versiones anteriores

2,1

3,0

Cuando instala el software StorageGRID por primera vez, solo se habilita la versión más reciente de la API. Sin embargo, cuando actualiza a una nueva versión de funciones de StorageGRID, continúa teniendo acceso a la versión anterior de API durante al menos una versión de funciones de StorageGRID .

Nota Puede configurar las versiones compatibles. Consulte la sección config de la documentación de la API de Swagger para obtener más información."API de gestión de red" Para más información. Debe desactivar el soporte para la versión anterior después de actualizar todos los clientes API para usar la versión más nueva.

Las solicitudes obsoletas se marcan como obsoletas de las siguientes maneras:

  • El encabezado de respuesta es "Obsoleto: verdadero".

  • El cuerpo de la respuesta JSON incluye "deprecated": true

  • Se agrega una advertencia obsoleta a nms.log. Por ejemplo:

    Received call to deprecated v2 API at POST "/api/v2/authorize"

Determinar qué versiones de API son compatibles con la versión actual

Utilice el GET /versions Solicitud de API para devolver una lista de las principales versiones de API compatibles. Esta solicitud se encuentra en la sección config de la documentación de la API de Swagger.

GET https://{{IP-Address}}/api/versions
{
  "responseTime": "2023-06-27T22:13:50.750Z",
  "status": "success",
  "apiVersion": "4.0",
  "data": [
    2,
    3,
    4
  ]
}

Especificar una versión de API para una solicitud

Puede especificar la versión de la API utilizando un parámetro de ruta(/api/v4 ) o un encabezado(Api-Version: 4 ). Si proporciona ambos valores, el valor del encabezado anula el valor de la ruta.

curl https://[IP-Address]/api/v4/grid/accounts

curl -H "Api-Version: 4" https://[IP-Address]/api/grid/accounts