Creación de versiones de la API de gestión de grid
Sugerir cambios
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 3 de la API.
https://hostname_or_ip_address/api/v3/authorize
La versión principal de la API de administración de arrendatarios se bONTAP cuando se realizan cambios que son no compatibles con versiones anteriores. La versión menor de la API de administración de arrendatarios se bONTAP cuando se hacen cambios que are sea compatible 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, sólo se activa la versión más reciente de la API de gestión de grid. 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.
|
Puede utilizar la API de gestión de grid para configurar las versiones compatibles. Consulte la sección «'config'» de la documentación de API de Swagger para obtener más información. Debe desactivar la compatibilidad con la versión anterior después de actualizar todos los clientes de la API de Grid Management para que utilicen 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 v1 API at POST "/api/v1/authorize"
Determinar qué versiones de API son compatibles con la versión actual
Utilice la siguiente solicitud de API para devolver una lista de las versiones principales de API admitidas:
GET https://{{IP-Address}}/api/versions
{
"responseTime": "2019-01-10T20:41:00.845Z",
"status": "success",
"apiVersion": "3.0",
"data": [
2,
3
]
}
Especificar una versión de API para una solicitud
Puede especificar la versión de API mediante un parámetro path (/api/v3) o un encabezado (Api-Version: 3). Si proporciona ambos valores, el valor de encabezado anula el valor de ruta de acceso.
curl https://[IP-Address]/api/v3/grid/accounts curl -H "Api-Version: 3" https://[IP-Address]/api/grid/accounts