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.

Creación de versiones de la API de gestión de grid

Colaboradores
PDF

La API de gestión de grid utiliza versiones para permitir 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 salta cuando se realizan cambios que son no compatibles con versiones anteriores. La versión secundaria de la API se salta cuando se realizan cambios que son compatibles con versiones anteriores. Los cambios compatibles incluyen la adición de nuevos extremos o nuevas propiedades.

En el ejemplo siguiente se muestra cómo la versión de API se bONTAP en función del tipo de cambios realizados.

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

Compatible con versiones anteriores

2,1

2,2

No es compatible con versiones anteriores

2,1

3,0

Al instalar el software StorageGRID por primera vez, solo se habilita la versión más reciente de la API. Sin embargo, cuando actualice a una versión de función nueva de StorageGRID, seguirá teniendo acceso a la versión de API anterior para al menos una versión de función de StorageGRID.

Nota Puede configurar las versiones admitidas. Consulte la sección config de la documentación de API de Swagger para "API de gestión de grid"obtener más información. Debe desactivar la compatibilidad con la versión anterior después de actualizar todos los clientes API para que usen la versión más reciente.

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

  • El encabezado de la respuesta es "Dedeprecated: True"

  • El cuerpo de respuesta JSON incluye "obsoleto": TRUE

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

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

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

Utilice GET /versions la solicitud de API para devolver una lista de las versiones principales de la API admitidas. 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
  ]
}

Especifique una versión API para una solicitud

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

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

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