Gerenciar domínios de dados

Visualizar

Este produto ou recurso está sujeito aos "Termos das Soluções Pré-GA" na seção "Termos Gerais de Serviço" dos Termos Específicos de Serviço. Os produtos e recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Este documento descreve como visualizar, atualizar e excluir domínios e subdomínios de dados usando o console Google Cloud e a API REST.

Antes de começar

Antes de gerenciar domínios de dados, verifique se você tem os papéis necessários e as APIs ativadas.

Ativar APIs

Ativar a API Dataplex.

Funções necessárias para ativar APIs

Para ativar APIs, você precisa da permissão serviceusage.services.enable. Se você criou o projeto, provavelmente já tem essa permissão com o papel de Proprietário (roles/owner). Caso contrário, é possível receber essa permissão com o papel de Administrador do Service Usage (roles/serviceusage.serviceUsageAdmin). Saiba como conceder papéis.

Ativar a API

Funções exigidas

Para receber as permissões necessárias para gerenciar domínios de dados, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

• Atualizar domínios de dados e vinculações de recursos: Editor de configuração de domínio de dados do Dataplex (roles/dataplex.dataDomainEditor)
• Confira a configuração do domínio de dados e as vinculações: Leitor de configuração de domínio de dados do Dataplex (roles/dataplex.dataDomainViewer)

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.

Ver domínios e subdomínios de dados

Veja domínios e subdomínios de dados em um projeto específico.

Console

Ver todos os domínios de dados

1. No console do Google Cloud , acesse a página Domínios de dados.

   Acessar "Domínios de dados"

2. A tabela lista os domínios criados. Clique na seta Expandir ao lado do nome do domínio de dados para ver os subdomínios aninhados.

Ver detalhes do domínio e subdomínio de dados

1. No console do Google Cloud , acesse a página Domínios de dados.

   Acessar "Domínios de dados"

2. Clique no nome do domínio ou subdomínio que você quer acessar.

3. A página Detalhes do domínio mostra as seguintes guias:

   • Visão geral: oferece uma visão geral do domínio e a lista de aspectos obrigatórios e opcionais.
   • Recursos: lista os recursos incluídos neste domínio. A lista mostra apenas pastas, projetos e recursos incluídos diretamente no domínio.

REST

Ver domínios e subdomínios de dados

Para ver os domínios de dados, use o método projects.locations.dataDomains.list:

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: o ID do seu projeto do Google Cloud .
• LOCATION_ID: a região do projeto. Por exemplo, us-central1.

Método HTTP e URL:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Ver subdomínios de dados

Para ver subdomínios de dados, use o método projects.locations.dataDomains.listSubdomains:

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: o ID do seu projeto do Google Cloud .
• LOCATION_ID: a região em que o domínio de dados principal existe. Por exemplo, us-central1.
• DOMAIN_ID: o identificador exclusivo do domínio de dados principal.

Método HTTP e URL:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Use o parâmetro filter para listar subdomínios pertencentes a um domínio principal específico:

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: o ID do seu projeto do Google Cloud .
• LOCATION_ID: a região em que o domínio de dados principal existe. Por exemplo, us-central1.
• PARENT_DOMAIN_ID: o identificador exclusivo do domínio de dados principal.

Método HTTP e URL:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID"

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID""

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID"" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Ver detalhes do domínio de dados

Para conferir detalhes do domínio ou subdomínio, use o método projects.locations.dataDomains.get:

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: o ID do seu projeto do Google Cloud .
• LOCATION_ID: a região em que o domínio de dados existe. Por exemplo, us-central1.
• DOMAIN_ID: o identificador exclusivo do domínio ou subdomínio de dados.

Método HTTP e URL:

GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Atualizar um domínio ou subdomínio de dados

É possível atualizar o nome de exibição, a descrição e os rótulos de um domínio. Não é possível mudar o ID ou o local do domínio depois de criá-lo.

Console

1. No console do Google Cloud , acesse a página Domínios de dados.

   Acessar "Domínios de dados"

2. Clique no nome do domínio ou subdomínio para acessar a página de detalhes.

3. Na barra superior, clique em Editar.

4. Atualize o Nome de exibição ou a Descrição.

5. Clique em Salvar.

REST

Para atualizar um domínio de dados, use o método projects.locations.dataDomains.patch:

Observação: especifique quais campos atualizar usando o parâmetro de consulta updateMask para evitar a substituição de outras propriedades.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: o ID do seu projeto do Google Cloud .
• LOCATION_ID: a região em que o domínio de dados existe. Por exemplo, us-central1.
• DOMAIN_ID: o identificador exclusivo do domínio ou subdomínio de dados.

Método HTTP e URL:

PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID?updateMask=description,labels

Corpo JSON da solicitação:

{
  "description": "Updated description for the domain",
  "labels": {
    "status": "active"
  }
}

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID?updateMask=description,labels"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID?updateMask=description,labels" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Excluir um domínio ou subdomínio de dados

Só é possível excluir um domínio de dados vazio. Exclua todos os subdomínios e remova todas as vinculações de recursos associadas ao domínio antes de tentar excluir o domínio em si. Se o domínio não estiver vazio, a solicitação de exclusão vai falhar com um erro.

Console

1. No console do Google Cloud , acesse a página Domínios de dados.

   Acessar "Domínios de dados"

2. Clique no nome do domínio ou subdomínio para acessar a página de detalhes.

3. Na barra superior, clique em Excluir.

4. Confirme a exclusão digitando o nome do domínio ou subdomínio de dados.

5. Clique em Excluir.

REST

Para excluir um domínio de dados, use o método projects.locations.dataDomains.delete:

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: o ID do seu projeto do Google Cloud .
• LOCATION_ID: a região em que o domínio de dados existe. Por exemplo, us-central1.
• DOMAIN_ID: o identificador exclusivo do domínio ou subdomínio de dados.

Método HTTP e URL:

DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI do gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

Execute o seguinte comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você tenha feito login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . Para saber qual é a conta ativa no momento, execute o comando gcloud auth list.

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

A seguir

• Saiba mais sobre domínios de dados.
• Saiba mais sobre vinculação e inclusão de recursos.
• Saiba como criar domínios de dados.
• Saiba como usar domínios de dados.