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.

Saiba mais sobre a StorageGRID Tenant Management API

PDFs

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

A Tenant Management API:

  • Utiliza a plataforma de API de código aberto Swagger. O Swagger oferece uma interface de usuário intuitiva que permite que desenvolvedores e não desenvolvedores interajam com a API. A interface de usuário do Swagger fornece detalhes completos e documentação para cada operação da API.

  • Usa "versionamento para suportar atualizações não disruptivas".

Para acessar a documentação Swagger da Tenant Management API:

  1. Faça login no Tenant Manager.

  2. Na parte superior do Tenant Manager, selecione o ícone de ajuda e selecione API documentation.

Operações de API

A Tenant Management API organiza as operações de API disponíveis nas seguintes seções:

  • conta: Operações na conta do locatário atual, incluindo obter informações sobre o uso do armazenamento.

  • auth: Operações para realizar autenticação de sessão do usuário.

    A API de Gerenciamento de Inquilinos oferece suporte ao esquema de autenticação Bearer Token. Para um login de inquilino, você fornece um nome de usuário, senha e accountId no corpo JSON da solicitação de autenticação (ou seja, POST /api/v3/authorize). Se o usuário for autenticado com sucesso, um token de segurança será retornado. Esse token deve ser fornecido no cabeçalho das solicitações de API subsequentes ("Authorization: Bearer token").

    Para obter informações sobre como melhorar a segurança de autenticação, consulte "Proteja contra falsificação de solicitação entre sites".

    Observação Se o login único (SSO) estiver habilitado para o sistema StorageGRID, você deverá executar etapas diferentes para autenticar. Consulte o "Instruções para usar a API de Gerenciamento de Grid".

  • config: Operações relacionadas ao lançamento do produto e às versões da API de Tenant Management. Você pode listar a versão de lançamento do produto e as principais versões da API compatíveis com esse lançamento.

  • containers: Operações em buckets S3.

  • recursos-desativados: operações para visualizar recursos que podem ter sido desativados.

  • endpoints: Operações para gerenciar um endpoint. Os endpoints permitem que um bucket do S3 utilize um serviço externo para StorageGRID CloudMirror replicação, notificações ou integração de pesquisa.

  • grid-federation-connections: Operações em conexões de federação de grids e replicação entre grids.

  • grupos: Operações para gerenciar grupos de locatários locais e recuperar grupos de locatários federados de uma fonte de identidade externa.

  • identity-source: Operações para configurar uma fonte de identidade externa e sincronizar manualmente informações de grupo e usuário federados.

  • ilm: Operações nas configurações de gerenciamento do ciclo de vida das informações (ILM).

  • regiões: Operações para determinar quais regiões foram configuradas para o sistema StorageGRID.

  • s3: Operações para gerenciar chaves de acesso S3 para usuários locatários.

  • s3-object-lock: Operações nas configurações globais de bloqueio de objetos do S3, usadas para dar suporte à conformidade regulamentar.

  • usuários: Operações para visualizar e gerenciar usuários do locatário.

Detalhes da operação

Ao expandir cada operação da API, você pode ver sua ação HTTP, endpoint URL, uma lista de quaisquer parâmetros obrigatórios ou opcionais, um exemplo do corpo da solicitação (quando necessário) e as possíveis respostas.

Exemplo mostrando a operação GET de grupos na API Swagger

Emitir solicitações de API

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. Selecione a ação HTTP para ver os detalhes da solicitação.

  2. 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.

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

  4. Selecione Experimentar.

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

  6. Selecione Executar.

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