Controle de versão da API Grid Management
Sugerir alterações
PDFs
A API de gerenciamento de grade usa o controle de versão para suportar atualizações sem interrupções.
Por exemplo, este URL de solicitação especifica a versão 3 da API.
https://hostname_or_ip_address/api/v3/authorize
A versão principal da API de Gerenciamento do Tenant é desfocada quando são feitas alterações que são not compatible com versões mais antigas. A versão menor da API de Gerenciamento do Tenant é desfocada quando são feitas alterações que are compatíveis com versões mais antigas. As alterações compatíveis incluem a adição de novos endpoints ou novas propriedades. O exemplo a seguir ilustra como a versão da API é carregada com base no tipo de alterações feitas.
| Tipo de alteração para API | Versão antiga | Nova versão |
|---|---|---|
Compatível com versões mais antigas |
2,1 |
2,2 |
Não compatível com versões mais antigas |
2,1 |
3,0 |
Quando você instala o software StorageGRID pela primeira vez, apenas a versão mais recente da API de gerenciamento de grade está ativada. No entanto, quando você atualiza para uma nova versão de recurso do StorageGRID, você continua tendo acesso à versão mais antiga da API para pelo menos uma versão de recurso do StorageGRID.
|
Você pode usar a API Grid Management para configurar as versões suportadas. Consulte a seção "config" da documentação da API Swagger para obter mais informações. Você deve desativar o suporte para a versão mais antiga depois de atualizar todos os clientes da API Grid Management para usar a versão mais recente. |
As solicitações desatualizadas são marcadas como obsoletas das seguintes maneiras:
-
O cabeçalho de resposta é "Deprecated: True"
-
O corpo de resposta JSON inclui "obsoleto": True
-
Um aviso obsoleto é adicionado ao nms.log. Por exemplo:
Received call to deprecated v1 API at POST "/api/v1/authorize"
Determine quais versões de API são suportadas na versão atual
Use a seguinte solicitação de API para retornar uma lista das principais versões da API suportada:
GET https://{{IP-Address}}/api/versions
{
"responseTime": "2019-01-10T20:41:00.845Z",
"status": "success",
"apiVersion": "3.0",
"data": [
2,
3
]
}
Especifique uma versão da API para uma solicitação
Você pode especificar a versão da API usando um parâmetro de caminho (/api/v3) ou um cabeçalho (Api-Version: 3). Se você fornecer ambos os valores, o valor do cabeçalho substitui o valor do caminho.
curl https://[IP-Address]/api/v3/grid/accounts curl -H "Api-Version: 3" https://[IP-Address]/api/grid/accounts