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.

Entenda a API de gerenciamento de locatários

PDFs

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

API de gerenciamento de inquilinos:

Para acessar a documentação do Swagger para a API de gerenciamento de locatários:

  1. Sign in no Gerenciador de Inquilinos.

  2. Na parte superior do Gerenciador de Tenants, selecione o ícone de ajuda e selecione Documentação da API.

Operações de API

A API de gerenciamento de locatários organiza as operações de API disponíveis nas seguintes seções:

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

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

    A API de gerenciamento de locatários oferece suporte ao esquema de autenticação de token de portador. Para um login de locatário, 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. Este token deve ser fornecido no cabeçalho de solicitações de API subsequentes ("Autorização: Token do portador").

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

    Observação Se o logon único (SSO) estiver habilitado para o sistema StorageGRID , você deverá executar etapas diferentes para autenticar. Veja o"instruções para usar a API de gerenciamento de grade" .

  • config: Operações relacionadas ao lançamento do produto e versões da API de gerenciamento de locatários. Você pode listar a versão de lançamento do produto e as principais versões da API suportadas por essa versão.

  • contêineres: Operações em buckets S3 ou contêineres Swift.

  • deactivated-features: Operações para visualizar recursos que podem ter sido desativados.

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

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

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

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

  • ilm: Operações em configurações de gerenciamento do ciclo de vida da informação (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 objeto S3, usadas para dar suporte à conformidade regulatória.

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

Detalhes da operação

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

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

Emitir solicitações de API

Cuidado Todas as operações de API que você realiza usando a página de 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. 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 usuário. Então, obtenha esses valores. Talvez seja necessário emitir uma solicitação de API diferente primeiro para obter as informações necessárias.

  3. Determine se você precisa modificar o corpo da solicitação de exemplo. Se sim, você pode selecionar Modelo para saber os requisitos de cada campo.

  4. Selecione Experimentar.

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

  6. Selecione Executar.

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