Todos os produtos
Search

Este produto

    DataWorks:Use uma API para fornecer serviços de dados

    Central de documentação

    DataWorks:Use uma API para fornecer serviços de dados

    Última atualização: Jul 10, 2026

    O DataService Studio expõe tabelas de dados processados como APIs REST para outras aplicações de negócios. Este tutorial orienta você na criação, configuração, teste e publicação de uma API que fornece dados da tabela de perfil de usuário ads_user_info_1d.

    Pré-requisitos

    Criar uma API de perfil de usuário

    Após a sincronização e o processamento dos dados, a tabela ads_user_info_1d estará pronta. Para expô-la como API, use o recurso de API do DataService Studio para gerar uma API no Wizard Mode ou no Script Mode.

    Etapa 1: Gerar a API de perfil de usuário

    1. Faça login no console do DataWorks. Na região de destino, clique em Data Analysis and Service > DataService Studio no painel de navegação à esquerda. Selecione um workspace na lista suspensa e clique em Go to DataService Studio.

    2. Crie um service de API.

      Na página do DataService Studio, clique no ícone image e escolha Create API > Generate API. Na caixa de diálogo Generate API, selecione Wizard Mode para gerar a API.

      Nota

      O DataService Studio oferece suporte a dois modos de geração de APIs: wizard mode e script mode.

    Etapa 2: Configurar a API de perfil de usuário

    1. Configure a API.

      No wizard mode, defina os seguintes parâmetros para criar uma API para sua fonte de dados do MaxCompute. Para mais detalhes, consulte Gerar uma API a partir de uma fonte de dados (API Gateway).

      Seção

      Parâmetro

      Descrição

      Exemplo

      Table

      Data Source Type

      Selecione o tipo da fonte de dados.

      Nota

      O DataService Studio não oferece suporte a fontes de dados Hive. Os tipos disponíveis estão listados no menu suspenso.

      Este tutorial utiliza uma fonte de dados do MaxCompute.

      Data Source Name

      Escolha a fonte de dados.

      Selecione a fonte de dados de negócios.

      Data Source Environment

      • Production Environment

      • Development Environment

      Selecione Production Environment.

      Data Table Name

      Selecione a tabela a ser exposta pela API.

      Selecione a tabela ads_user_info_1d.

      Select Parameters

      Pagination for Return Results

      Define se os resultados são paginados. Essa configuração afeta os parâmetros de solicitação e resposta.

      Defina o número máximo de registros por solicitação nas configurações do grupo de recursos do service. Para mais informações, consulte Gerar uma API a partir de uma fonte de dados (API Gateway).

      Desative Pagination for Return Results.

      Set as Req Param

      Defina um ou mais campos da tabela como parâmetros de solicitação.

      Configure o campo de partição dt como Request Parameters.

      Set as Resp Param

      Escolha os campos da tabela a incluir na resposta da API.

      Defina todos os campos da tabela ads_user_info_1d como Response Parameters.

      Sorting Fields

      Opcional. Para ordenar resultados, selecione primeiro os campos desejados na lista de parâmetros.

      Não aplicar ordenação.

    2. Configure o grupo de recursos do service.

      Após configurar a API no wizard mode, clique em Resource Group for DataService Studio no painel de navegação à direita para configurar o grupo de recursos. Para mais informações, consulte Configurar um grupo de recursos de service de API.

      Seção

      Parâmetro

      Descrição

      Resource Group Type

      Scheme

      Exclusive Resource Group for DataService Studio.

      Exclusive Resource Group for DataService Studio

      Selecione um grupo de recursos serverless (recomendado) ou um grupo de recursos exclusivo para o DataService Studio.

      Importante

      • Se já tiver adquirido um grupo de recursos exclusivo para o DataService Studio, use-o diretamente.

      • Se não possuir um grupo de recursos, recomendamos adquirir um grupo de recursos serverless de uso geral. Para mais informações, consulte Usar um grupo de recursos serverless.

        Se um grupo de recursos serverless recém-adquirido estiver esmaecido e indisponível para seleção, aloque primeiro uma cota para o service Data Services nesse grupo de recursos. Para mais informações, consulte Alocar cotas de CU para tarefas.

      Environment Configuration

      Timeout

      Defina o tempo limite como 30.000 ms.

      Maximum Number of Data Records for a Single Request

      Defina o limite como 2.000.

    Etapa 3: Testar e publicar a API

    1. Teste a API para verificar se ela retorna os parâmetros corretos. Para mais informações, consulte Testar uma API.

      1. Ao concluir a configuração, clique no ícone Salvar image e, em seguida, no ícone Testar image para abrir a página de teste da API.

      2. Na caixa de diálogo API Test, insira valores para os parâmetros de solicitação.

      3. Clique em Start Test para executar o teste.

    2. Publicar a API implanta-a no API Gateway e gera um endpoint público. Para mais informações, consulte Teste, publicação e gerenciamento de versão de API.

      1. Depois que a API passar no teste, retorne à página de edição da API e clique no ícone Enviar image. Isso cria uma nova versão da API. Clique em Version no painel direito para visualizar os detalhes.image

      2. Clique em Publish para publicar o service de API.

      3. Após a publicação, gerencie a API clicando em Service Management no painel Version ou acessando Service Management > API Management > Published APIs. Para mais informações, consulte Gerenciar e manter APIs.

    Próximas etapas

    Após publicar a API, autorize aplicações a chamar a API. Para mais informações, consulte Autorizar uma API e Chamar uma API.