Skip to main content
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Visão geral das APIs REST de instalação

Colaboradores
PDFs

O StorageGRID fornece duas APIs REST para executar tarefas de instalação: A API de instalação do StorageGRID e a API do instalador do dispositivo StorageGRID.

Ambas as APIs usam a plataforma de API de código aberto Swagger para fornecer a documentação da API. O Swagger permite que desenvolvedores e não desenvolvedores interajam com a API em uma interface de usuário que ilustra como a API responde a parâmetros e opções. Esta documentação pressupõe que você esteja familiarizado com as tecnologias da Web padrão e o formato de dados JSON.

Cuidado Todas as operações de API que você executa usando a página da Web do API Docs são operações ativas. Tenha cuidado para não criar, atualizar ou excluir dados de configuração ou outros dados por engano.

Cada comando REST API inclui o URL da API, uma ação HTTP, quaisquer parâmetros de URL necessários ou opcionais e uma resposta de API esperada.

API de instalação do StorageGRID

A API de instalação do StorageGRID só está disponível quando você estiver configurando inicialmente o sistema StorageGRID e se precisar executar uma recuperação do nó de administração principal. A API de instalação pode ser acessada por HTTPS a partir do Gerenciador de Grade.

Para acessar a documentação da API, vá para a página da Web de instalação no nó de administração principal e selecione Ajuda > Documentação da API na barra de menus.

A API de instalação do StorageGRID inclui as seguintes seções:

  • Config: Operações relacionadas à versão do produto e versões da API. Você pode listar a versão de lançamento do produto e as principais versões da API suportadas por essa versão.

  • Grid: Operações de configuração em nível de grade. Você pode obter e atualizar configurações de grade, incluindo detalhes de grade, sub-redes de rede de grade, senhas de grade e endereços IP de servidor NTP e DNS.

  • Nodes: Operações de configuração em nível de nó. Você pode recuperar uma lista de nós de grade, excluir um nó de grade, configurar um nó de grade, exibir um nó de grade e redefinir a configuração de um nó de grade.

  • Provisão: Operações de provisionamento. Você pode iniciar a operação de provisionamento e exibir o status da operação de provisionamento.

  • Recovery: Operações de recuperação do nó de administração primário. Você pode redefinir informações, carregar o pacote de recuperação, iniciar a recuperação e exibir o status da operação de recuperação.

  • Recovery-package: Operações para baixar o Recovery Package.

  • Sites: Operações de configuração no nível do site. Você pode criar, exibir, excluir e modificar um site.

API do instalador do dispositivo StorageGRID

A API do instalador do dispositivo StorageGRID pode ser acessada por HTTPS a partir `Controller_IP:8443`do .

Para acessar a documentação da API, vá para o Instalador do StorageGRID Appliance no appliance e selecione Ajuda > Documentação da API na barra de menus.

A API do instalador do StorageGRID Appliance inclui as seguintes seções:

  • Clone: Operações para configurar e controlar a clonagem de nós.

  • Criptografia de unidade (StorageGRID 11,8 e posterior): Operações para gerenciar a criptografia da unidade e exibir o status da criptografia da unidade.

  • Encryption: Operações para gerenciar a criptografia de nós e visualizar o status da criptografia de nós.

  • Hardware config: Operações para configurar as configurações do sistema no hardware conetado.

  • Instalação: Operações para iniciar a instalação do aparelho e para monitorar o status da instalação.

  • Rede: Operações relacionadas à configuração de rede, administrador e rede cliente para um dispositivo StorageGRID e configurações de porta de dispositivo.

  • Setup: Operações para ajudar na configuração inicial da instalação do dispositivo, incluindo solicitações para obter informações sobre o sistema e atualizar o IP do nó de administração principal.

  • Support: Operações para reiniciar o controlador e obter logs.

  • Update-config: Operações para atualizar a configuração do StorageGRID Appliance.

  • Upgrade: Operações relacionadas à atualização do firmware do appliance.

  • * Uploadsg*: Operações para upload de arquivos de instalação do StorageGRID.