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.

Use a API de gerenciamento de grade

Colaboradores

Você pode executar tarefas de gerenciamento do sistema usando a API REST do Grid Management 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 nível superior

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

  • /grid: O acesso é restrito aos usuários do Grid Manager e é baseado 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, "Use uma conta de locatário"consulte .

  • /private: O acesso é restrito aos 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 grade usa 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 do usuário Swagger fornece detalhes completos e documentação para cada operação da API.

Antes de começar
Cuidado Todas as operações de API executadas usando a página da Documentação da API são operações ativas. 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 Documentação da API.

    Menu Ajuda
  2. Para executar uma operação com a API privada, selecione ir para 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 de API, você pode ver 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 todos os parâmetros necessários ou opcionais, um exemplo do corpo da solicitação (quando necessário) e as possíveis respostas.

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

  6. Determine se você precisa modificar o corpo de solicitação de exemplo. Em caso afirmativo, você pode selecionar modelo para aprender os requisitos para cada campo.

  7. Selecione Experimente.

  8. Forneça quaisquer parâmetros necessários ou modifique o corpo do pedido conforme necessário.

  9. Selecione Executar.

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