DataWorks:APIs de service de dados

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

Execute as etapas a seguir no DataService Studio.

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 uma API.

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

   Nota

   É possível gerar uma API no Wizard Mode ou no Script Mode. Este exemplo utiliza o Wizard Mode.

   • Para saber como gerar uma API no Wizard Mode, consulte Generate an API from a data source (API Gateway).

   • Para aprender a gerar uma API no Script Mode, consulte Generate an API in Script Mode.

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

1. Configure a API.

   No Wizard Mode, defina os parâmetros abaixo para criar uma API de service de dados para uma fonte de dados do MaxCompute. Para mais detalhes, consulte Generate an API from a data source (API Gateway).

   Módulo	Parâmetro	Descrição	Exemplo
   Table	Data Source Type	Selecione o tipo de fonte de dados. Nota As APIs de service de dados não suportam fontes de dados Hive. Os tipos disponíveis limitam-se às opções da lista suspensa.	Este exemplo usa uma fonte de dados do MaxCompute.
   	Data Source Name	Escolha uma fonte de dados existente.	Utilize sua fonte de dados de negócios.
   	Data Source Environment	Production Environment Development Environment	Selecione Production Environment.
   	Data Table Name	Escolha a tabela para a API.	Selecione a tabela ads_user_info_1d.
   Select Parameters	Pagination for Return Results	Ative ou desative a paginação dos resultados. Essa configuração afeta os parâmetros de solicitação e resposta da API. No painel Service Resource Group à direita, defina o número máximo de registros de dados por solicitação única conforme o tipo de grupo de recursos. Para mais informações, consulte Generate an API from a data source (API Gateway).	Desative a opção Pagination for Return Results.
   	Set as Req Param	Escolha os campos a serem usados como parâmetros de solicitação.	Defina o campo de partição dt como Request Parameters.
   	Set as Resp Param	Selecione os campos a serem usados como parâmetros de resposta.	Configure todos os campos da tabela ads_user_info_1d como Response Parameters.
   Sorting Fields	O campo de ordenação é opcional. Caso deseje ordenar por um campo específico, selecione-o primeiro na lista de parâmetros.		Não aplicar ordenação.

2. Configure o grupo de recursos de service.

   Após configurar a API, clique em Resource Group for DataService Studio no painel de navegação à direita para definir seus recursos. A tabela a seguir descreve os parâmetros. Para mais detalhes, consulte Configure a service resource group for an API.

   Módulo	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 Exclusive Resource Group for DataService Studio. Importante Caso já tenha adquirido um Exclusive Resource Group for DataService Studio, utilize-o diretamente. Se você não possui um grupo de recursos, recomendamos adquirir um grupo de recursos serverless de uso geral. Para mais informações, consulte Use a serverless resource group. Se um grupo de recursos serverless recém-adquirido aparecer esmaecido e indisponível para seleção durante a configuração do grupo de recursos de service, aloque uma cota para o uso de Data Services desse grupo. Para mais detalhes, consulte Allocate CU quotas to tasks.
   Environment Configuration	Timeout	Defina o valor como 30000 ms.
   	Maximum Number of Data Records for a Single Request	Insira o valor 2000.

Etapa 3: Testar e publicar a API

1. Teste a API para verificar se ela retorna os parâmetros de resposta esperados. Para mais informações, consulte Test an API.

   1. Após concluir a configuração, clique no ícone para salvar a API e, em seguida, clique no ícone para abrir a página de teste.

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

   3. Clique em Start Test para iniciar o teste da API.

2. A publicação da API a adiciona ao API Gateway e gera um endpoint online. Para mais detalhes, consulte Test, publish, and manage versions of an API.

   1. Depois que a API passar no teste, clique no ícone na página de edição da API para enviá-la. Uma nova versão da API será gerada. No painel à direita da página de detalhes da API, clique na aba Version para acessar a página de gerenciamento de versões. Localize a versão com o status Publishable, como v1.

   2. Clique em Publish para publicar a API.

   3. Após a publicação, clique em Service Management na seção de gerenciamento de versões ou acesse Service Management > API Management > Published APIs. Para mais informações, consulte Manage and maintain APIs.