Skip to main content
Uma versão mais recente deste produto está disponível.
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.

Use a API de gerenciamento de grid do StorageGRID

PDFs

Você pode executar tarefas de gerenciamento do sistema usando a API REST de gerenciamento do Grid em vez da interface de usuário do Grid Manager. Por exemplo, você pode querer usar a API para automatizar operações ou criar várias entidades, como usuários, mais rapidamente.

Recursos de alto nível

A API de gerenciamento de grid fornece os seguintes recursos de nível superior:

  • /grid: O acesso é restrito aos usuários do Grid Manager e baseia-se nas permissões de grupo configuradas.

  • /org: O acesso é restrito a usuários que pertencem a um grupo LDAP local ou federado para uma conta de locatário. Para obter detalhes, consulte "Use uma conta de tenant".

  • /private: O acesso é restrito a usuários do Grid Manager e é baseado nas permissões de grupo configuradas. As APIs privadas estão sujeitas a alterações sem aviso prévio. Os endpoints privados do StorageGRID também ignoram a versão da API da solicitação.

Emitir solicitações de API

A API de Gerenciamento de Grid utiliza a plataforma de API de código aberto Swagger. O Swagger fornece uma interface de usuário intuitiva que permite que desenvolvedores e não desenvolvedores realizem operações em tempo real no StorageGRID com a API.

A interface de usuário Swagger fornece detalhes completos e documentação para cada operação da API.

Antes de começar
Cuidado Qualquer operação de API realizada por meio da página de documentação da API é uma operação em tempo real. Tenha cuidado para não criar, atualizar ou excluir dados de configuração ou outros dados por engano.
Passos

  1. No cabeçalho do Gerenciador de Grade, selecione o ícone de ajuda e selecione API documentation.

    Menu de Ajuda

  2. Para executar uma operação com a API privada, selecione Acessar a documentação da API privada na página da API de gerenciamento do StorageGRID.

    As APIs privadas estão sujeitas a alterações sem aviso prévio. Os endpoints privados do StorageGRID também ignoram a versão da API da solicitação.

  3. Selecione a operação desejada.

    Ao expandir uma operação da API, você pode visualizar as ações HTTP disponíveis, como GET, PUT, UPDATE e DELETE.

  4. Selecione uma ação HTTP para ver os detalhes da solicitação, incluindo o URL do endpoint, uma lista de parâmetros obrigatórios ou opcionais, um exemplo do corpo da solicitação (quando necessário) e as possíveis respostas.

    Exemplo da Swagger UI

  5. Determine se a solicitação requer parâmetros adicionais, como um ID de grupo ou de usuário. Em seguida, obtenha esses valores. Pode ser necessário fazer uma solicitação de API diferente primeiro para obter as informações de que você precisa.

  6. Determine se você precisa modificar o corpo da solicitação de exemplo. Caso precise, selecione Model para conhecer os requisitos de cada campo.

  7. Selecione Experimentar.

  8. Forneça todos os parâmetros necessários ou modifique o corpo da solicitação conforme necessário.

  9. Selecione Executar.

  10. Analise o código de resposta para determinar se a solicitação foi bem-sucedida.