Este tópico descreve as versões do kit de desenvolvimento de software (SDK) do Quick BI e explica como obter as mais recentes.
Visão geral do SDK
Introdução
O SDK do Quick BI para análise visual encapsula operações de API. Ele usa um par de AccessKey para identificar chamadores e oferece recursos como assinatura automática para facilitar a criação e o gerenciamento de recursos. Para utilizar os recursos de análise visual do Quick BI, instale tanto o SDK do Quick BI quanto a biblioteca principal do Alibaba Cloud. Por exemplo, ao usar o SDK Java, baixe os pacotes aliyun-java-sdk-core e aliyun-java-sdk-quickbi-public.
Observações
Acesse a página do SDK do Alibaba Cloud para baixar o SDK e visualizar as instruções de uso.
Para obter uma lista das operações de API disponíveis, consulte Referência de API.
-
Obtenha o AccessKey ID e o AccessKey secret da sua conta Alibaba Cloud.
Para mais informações, consulte Criar um par de AccessKey.
-
Para chamar operações de API com um SDK, atenda aos dois requisitos abaixo:
Ter feito login no Quick BI com sua conta Alibaba Cloud pelo menos uma vez.
Sua conta Alibaba Cloud deve ter a função de administrador da organização no Quick BI. Um administrador também pode conceder permissões a usuários não administradores para chamar todas as operações de API na página Open Platform. Para mais informações, consulte Visão geral > Controle de acesso.
Linguagens de programação compatíveis
O Quick BI é compatível com desenvolvimento usando kits de desenvolvimento de software (SDKs) em linguagens como Java, Python e C#. Para mais detalhes sobre os SDKs, visite a Plataforma Aberta do Alibaba Cloud.
Guia de versões
Versão publicada | Data de lançamento | Descrição da alteração |
2.0.0 | 04-03-2022 | Lançamento da API V2 com endpoints específicos por região. As operações publicadas cobrem todas as operações da lista original de API. Nota A lista original de API não recebe mais manutenção após o lançamento da API V2. Todas as novas operações de API são adicionadas à V2. |
Links relacionados
O Centro de Desenvolvedores do Alibaba Cloud oferece SDKs para linguagens de programação frequentes. Além disso, fornece conteúdos como tutoriais de início rápido e listas de projetos open source. Para mais informações, consulte Centro de Desenvolvedores do Alibaba Cloud.
Métodos de chamada do SDK
Ao chamar o SDK, observe os seguintes pontos:
Crie e inicialize uma instância DefaultAcsClient usando o AccessKey ID e o AccessKey secret correspondentes à sua conta Alibaba Cloud. Caso contrário, o sistema reportará o seguinte erro:
code: 404, Specified access key is not found. request id: AA7FE476-F206-5C52-95B3-DF35CD30D468.O par de AccessKey deve pertencer a uma conta Alibaba Cloud que tenha a função de administrador da organização no Quick BI e que já tenha sido usada para fazer login no serviço pelo menos uma vez. Especifique o par de AccessKey conforme necessário.
Para mais detalhes sobre como chamar o SDK, consulte a Documentação do SDK.
Limitação de operações de API
A versão das operações de API listadas abaixo é 2022-01-01.
Usuários do Quick BI implantado na nuvem pública e na Finance Cloud podem chamar estas operações de API.
Somente o Quick BI Professional e edições superiores oferecem suporte a chamadas de API.
Categoria | Nome da API | Descrição | QPS (chamadas/segundo) | Timeout (segundos) |
Gerenciamento de organização e usuários | Adiciona um membro a uma organização. | 50 | 10 | |
Atualiza as informações de um membro específico em uma organização. | 50 | 10 | ||
Consulta a lista de membros de uma organização. | 30 | 10 | ||
Exclui um usuário específico de uma organização. | 50 | 10 | ||
Consulta as informações de um membro em uma organização pelo ID do usuário. | 30 | 10 | ||
Consulta as informações de um membro em uma organização pelo ID ou nome da conta Alibaba Cloud. | 30 | 10 | ||
Gerenciamento de tags de usuário | Adiciona metadados para as tags de um membro em uma organização. | 50 | 10 | |
Exclui os metadados das tags de um membro em uma organização. | 50 | 10 | ||
Consulta a lista de metadados das tags dos membros em uma organização. | 30 | 10 | ||
Altera os valores das tags de um membro em uma organização. | 50 | 10 | ||
Consulta a lista de valores de tag para um usuário específico. | 30 | 10 | ||
Atualiza os metadados das tags de um membro em uma organização. | 50 | 10 | ||
Gerenciamento de organização e grupos de usuários | Adiciona um membro da organização a um grupo de usuários específico. | 50 | 10 | |
Adiciona vários usuários a um grupo de usuários específico em lote. | 50 | 10 | ||
Remove um membro específico de um grupo de usuários específico. | 50 | 10 | ||
Cria um grupo de usuários em uma organização específica. | 50 | 10 | ||
Exclui um grupo de usuários de uma organização específica. | 50 | 10 | ||
Atualiza as informações de um grupo de usuários específico em uma organização. | 50 | 10 | ||
Consulta a lista de membros em um grupo de usuários. | 30 | 10 | ||
Consulta as informações dos grupos de usuários filhos de um grupo pai específico. | 30 | 10 | ||
Busca grupos de usuários por palavra-chave do nome do grupo. | 30 | 10 | ||
Consulta a lista de grupos de usuários aos quais um usuário pertence. | 30 | 10 | ||
Remove um usuário de todos os grupos de usuários. | 50 | 10 | ||
Remove vários usuários de grupos de usuários em lote. | 50 | 10 | ||
Consulta as informações de vários grupos de usuários simultaneamente pelo ID do grupo. | 50 | 10 | ||
Compartilhamento e autorização de relatórios | Consulta uma lista de autorizações. | 30 | 10 | |
Adiciona uma política de autorização a um relatório. | 50 | 10 | ||
Consulta a lista de trabalhos autorizados para um usuário. | 30 | 10 | ||
Exclui a política de autorização de um relatório. | 50 | 10 | ||
Autorização de menu do portal de BI | Consulta uma lista de menus do portal de BI. | 30 | 10 | |
Consulta a lista de autorizações de um menu do portal de BI. | 30 | 10 | ||
Adiciona autorizações a menus do portal de BI em lote. | 50 | 10 | ||
Cancela as autorizações de menus do portal de BI em lote. | 50 | 10 | ||
Modifica a visibilidade de um menu do portal de BI. Configure o menu para ser visível apenas para usuários autorizados. | 50 | 10 | ||
Gerenciamento de permissões no nível de linha | Consulta o status da chave de permissões no nível de linha para um conjunto de dados. | 30 | 10 | |
Ativa ou desativa permissões no nível de linha e coluna para um conjunto de dados. | 50 | 10 | ||
Consulta as configurações de permissões no nível de linha e coluna para um conjunto de dados. | 30 | 10 | ||
Configura uma regra para as permissões no nível de linha e coluna em um conjunto de dados. | 50 | 10 | ||
Exclui uma regra para as permissões no nível de linha e coluna em um conjunto de dados. | 50 | 10 | ||
Adiciona incrementalmente usuários com permissões no nível de linha com base em uma regra. | 50 | 10 | ||
Exclui usuários com permissões no nível de linha com base em uma regra. | 50 | 10 | ||
Especifica configurações adicionais para permissões no nível de linha ou coluna. | 50 | 10 | ||
Consulta a lista de permissões para as permissões no nível de linha e coluna em um conjunto de dados. | 30 | 10 | ||
Configura uma lista de permissões para permissões no nível de linha e coluna. | 50 | 10 | ||
Configura incrementalmente uma lista de permissões para permissões no nível de linha e coluna. | 50 | 10 | ||
Gerenciamento de workspace | Altera as funções dos membros em um workspace. | 50 | 10 | |
Consulta uma lista de membros em um workspace específico. | 30 | 10 | ||
Exclui um membro de um workspace específico. | 50 | 10 | ||
Consulta uma lista de workspaces na organização atual. | 30 | 10 | ||
Adiciona um membro a um workspace específico. | 50 | 10 | ||
Adiciona vários membros a um workspace específico em lote. | 50 | 10 | ||
Consulta as informações de função dos membros em um workspace específico. | 30 | 10 | ||
Atualiza as informações de função dos membros em um workspace em lote. | 50 | 10 | ||
Gerenciamento de recursos de relatórios | Consulta uma lista de relatórios em uma organização. | 30 | 10 | |
Consulta uma lista de relatórios em um workspace específico de uma organização. | 30 | 10 | ||
Consulta uma lista de relatórios que um usuário tem permissão para visualizar. | 30 | 10 | ||
Verifica se um usuário tem permissão para visualizar um relatório. | 50 | 10 | ||
Consulta as informações de incorporação sobre relatórios em uma organização. | 30 | 10 | ||
Altera o status de incorporação de um relatório. | 50 | 10 | ||
Consulta as informações sobre um relatório. | 30 | 10 | ||
Consulta a linhagem de dados de um relatório específico. | 30 | 10 | ||
Gerenciamento de recursos de conjuntos de dados | Consulta uma lista de conjuntos de dados em um workspace específico. | 30 | 10 | |
Consulta os detalhes de um conjunto de dados específico. | 30 | 10 | ||
Consulta os detalhes de um conjunto de dados. | 30 | 10 | ||
Gerenciamento de favoritos | Consulta a lista de favoritos. | 30 | 10 | |
Adiciona um trabalho aos favoritos. | 50 | 10 | ||
Remove um trabalho dos favoritos. | 50 | 10 | ||
Gerenciamento da página inicial | Consulta a lista de trabalhos autorizados na página My Dashboards para um usuário específico. | 30 | 10 | |
Consulta a lista de trabalhos favoritos na página My Dashboards para um usuário específico. | 30 | 10 | ||
Consulta a lista de trabalhos visualizados recente ou frequentemente na página My Dashboards para um usuário específico. | 30 | 10 | ||
DataService Studio | Chama uma operação de API criada no DataService Studio. | 10 | 60 | |
Análise incorporada | Gera um ticket para incorporação de terceiros. | 50 | 10 | |
Consulta os detalhes de um ticket usado para incorporar um relatório. | 30 | 10 | ||
Exclui um ticket usado para incorporar um relatório. | 50 | 10 | ||
Atualiza o tempo de expiração de um ticket usado para incorporar um relatório. | 50 | 10 | ||
Atualiza o número de tickets que podem ser usados para incorporar um relatório. | 50 | 10 | ||
Aprovação aberta | Uma operação de API de callback para fluxos de trabalho de aprovação personalizados. Use esta operação para processar fluxos de trabalho de aprovação no Quick BI. | 30 | 10 |
Visualizar a versão do SDK
No arquivo pom.xml, certifique-se de que o valor de version corresponda à versão mais recente disponível no endereço de download do SDK.
Visualize a versão do SDK em https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-quickbi-public.
Como evitar que o número de requisições simultâneas por segundo exceda o limiar de limitação
Descrição do problema: Por motivos de desempenho e segurança, as operações de API do Quick BI implantado na nuvem pública possuem limitação padrão. Se você usar threads simultâneas para chamar as operações de API e o número real de consultas por segundo (QPS) exceder o limiar de limitação, as requisições falharão.
Solução: Utilize a classe RateLimiter do componente Google Guava para limitar o QPS das requisições de API.
-
Se você usa Maven para gerenciar seu projeto Java, adicione a dependência Maven ao arquivo pom.xml.
<dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>${google.guava.version}</version> </dependency>NotaNo arquivo pom.xml, garanta que o valor da versão seja o mais recente disponível no endereço de download. Para a versão mais recente, consulte Guava: Google Core Libraries For Java.
-
Crie e utilize um RateLimiter.
Use o método de fábrica
create()para criar uma instância RateLimiter. Para mais informações, consulte https://www.baeldung.com/guava-rate-limiter.// Create a RateLimiter for throttling with a limit of 30 QPS. RateLimiter rateLimiter = RateLimiter.create(30); // Obtain a permit. If the QPS exceeds 30, the request is blocked and must wait. rateLimiter.acquire(); // An API request can be sent only after a permit is obtained. doSomeAPIRequest();
Consultas por segundo (QPS) representam o número de requisições ou tarefas processadas por segundo.
Concorrência é o número de requisições ou tarefas que o sistema processa simultaneamente.
QPS = Concorrência / Tempo médio de resposta.