Quick BI:Criar uma API

Procedimento

Para criar uma API no DataService Studio:

1. Na página inicial do Quick BI, crie uma nova API conforme ilustrado abaixo.

   

2. Na página Create API > Basic Information Configuration, insira o API Name, o Interface Workspace, o Interface Dataset, o Data Return Type e a API Description. Em seguida, clique em Next.

3. Na página Create API > Add API Parameters, configure os parâmetros de solicitação e retorno. Depois, clique em Save ou Save And Debug.

   Nota

   A opção Save salva a configuração atual. A opção Save And Debug redireciona você para a página Debug API.

4. Clique em Save And Debug para abrir a página Debug API. Insira os valores dos parâmetros e selecione os parâmetros de retorno.

5. Clique em Run Debug. A página Debug Results exibe o Returned JSON e a Data Preview.

   Nota

   Para invocar uma API do DataService Studio, a conta da Alibaba Cloud solicitante deve ter as funções de administrador da organização e administrador de permissões do Quick BI, além de ter acessado o Quick BI pelo menos uma vez.

Operações relacionadas

Após criar uma API, visualize seu ID, nome, conjunto de dados e workspace no módulo DataService Studio. As APIs e operações disponíveis variam conforme a aba selecionada.

• A aba My lista todas as APIs criadas por você. Operações disponíveis:

  • Visualize

    Clique no ícone ao lado do ID da API para visualizar Basic Information, Request Parameters e Return Parameters. Nesta janela, também é possível Edite, Debug, Exclua ou Transfer a API.

  • Edite

    Clique no ícone para abrir a página Edit API. Modifique as Basic Information e Parameter Information e clique em Save ou Save and Test.

  • Debug

    Clique no ícone para abrir a página Debug API. Atualize os parâmetros e clique em Execute Debug.

  • Statistics

    Clique no ícone para visualizar dados de chamada na página API Call Statistics > Details. Consulte Estatísticas de chamadas de API.

  • Transfer

    Clique no ícone . Na página Transfer API > Creator, selecione o novo criador e clique em Confirme.

    Nota

    Por padrão, a função de criador inclui permissões de chamada e gerenciamento da API.

    

  • Exclua

    Clique no ícone e clique em Confirme para excluir a API.

• A aba All lista todas as APIs do tenant atual.

  • APIs criadas por você: Gerencie e visualize detalhes. As operações são idênticas às da aba My.

  • APIs criadas por outros: Visualize apenas os detalhes. As operações de gerenciamento não estão disponíveis.