Este documento é destinado a consumidores de produtos de dados do Knowledge Catalog (antigo Dataplex Universal Catalog) que querem descobrir e usar produtos de dados para os casos de uso deles.
Para mais informações sobre a arquitetura e os conceitos principais dos produtos de dados, consulte Sobre produtos de dados.
Antes de começar
-
Ative as APIs Dataplex e BigQuery.
Funções necessárias para ativar APIs
Para ativar as APIs, é necessário ter o papel do IAM de administrador de uso do serviço (
roles/serviceusage.serviceUsageAdmin), que contém a permissãoserviceusage.services.enable. Saiba como conceder papéis.
Funções exigidas
Para receber as permissões necessárias para pesquisar, acessar e usar produtos de dados, peça ao administrador para conceder a você os seguintes papéis do IAM no produto de dados ou no projeto:
-
Pesquisar produtos de dados:
Leitor do Dataplex Catalog (
roles/dataplex.catalogViewer) -
Pesquise recursos de dados e solicite acesso:
Consumidor de produtos de dados do Dataplex (
roles/dataplex.dataProductsConsumer) -
Acesso somente leitura para visualizar definições e metadados de produtos de dados:
Leitor de produtos de dados do Dataplex (
roles/dataplex.dataProductsViewer)
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.
Como consumidor de produtos de dados, para ver os metadados de um recurso, você precisa ter a permissão
viewer para acessar o recurso correspondente no sistema de origem. Por
exemplo, para pesquisar metadados de um conjunto de dados ou uma tabela em um produto de dados,
é necessário ter o papel de Leitor de metadados do BigQuery (roles/bigquery.metadataViewer).
Para mais informações, consulte
Papéis necessários para acessar os resultados da pesquisa.
Pesquisar produtos de dados
Console
No console Google Cloud , acesse a página Pesquisa do Knowledge Catalog.
Pesquise usando palavras-chave ou linguagem natural. Para mais informações, consulte Pesquisar recursos.
Nos resultados da pesquisa, clique no produto de dados para acessar os detalhes. Você pode analisar a descrição, os recursos, o contrato, os aspectos, os detalhes de contato e outras documentações associadas ao produto de dados.
REST
Para pesquisar um produto de dados, use o método
searchEntries.
Por exemplo, envie a seguinte solicitação POST:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d \
'{
"query": "ADDITIONAL_KEYWORDS (type=(DATA_PRODUCT))",
"pageSize": 10
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/global:searchEntries"
Substitua:
- ADDITIONAL_KEYWORDS (opcional): palavras-chave ou critérios de pesquisa adicionais para restringir os resultados (por exemplo,
displayName:'My Data Product'oudescription:'sales') - PROJECT_ID: o ID do seu projeto Google Cloud em que o produto de dados é criado
Solicitar acesso a produtos de dados
Como consumidor de um produto de dados, se você não tiver permissões do IAM para acessar um produto de dados, poderá solicitar acesso usando os fluxos de trabalho integrados de aprovação de acesso.
Enviar uma solicitação de acesso
Console
No console Google Cloud , acesse a página Produtos de dados do Knowledge Catalog.
Clique no produto de dados que você quer acessar.
Clique em Solicitar acesso.
No painel Detalhes da solicitação, especifique os seguintes parâmetros:
- Grupos de acesso: selecione o grupo de acesso funcional de que você quer participar.
Próprio ou Conta de serviço: selecione o tipo de principal:
Se você estiver pedindo acesso para si mesmo, selecione Próprio.
Se você estiver solicitando acesso para uma identidade programática, selecione Conta de serviço. Essa opção só está disponível se o produto de dados for compatível com contas de serviço.
Justificativa: insira uma justificativa comercial para sua solicitação.
Clique em Enviar.
Uma nova solicitação de mudança é gerada para o proprietário do produto de dados analisar. Você vai receber uma notificação por e-mail com o status final assim que o pedido for aprovado ou recusado.
REST
Os consumidores de produtos de dados com a permissão dataplex.dataProducts.get
podem solicitar acesso criando um recurso ChangeRequest. Envie uma solicitação POST ao endpoint de recurso do produto de dados usando o método personalizado :requestAccess:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"parent": "projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID",
"change_request": {
"justification": "JUSTIFICATION_TEXT",
"data_product_access_request": {
"parent": "projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID",
"access_group_id": "DATA_PRODUCT_ACCESS_GROUP_ID"
}
}
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID:requestAccess"
Substitua:
PROJECT_ID: ID do projeto Google Cloud
LOCATION: a região em que o produto de dados está localizado (por exemplo,
us-central1)DATA_PRODUCT_ID: o identificador exclusivo do produto de dados de destino
JUSTIFICATION_TEXT: o motivo comercial que explica por que o acesso é necessário
DATA_PRODUCT_ACCESS_GROUP_ID: o ID do grupo de acesso específico a que você está pedindo para participar.
Ver o status das solicitações de acesso
Como consumidor de produtos de dados, você pode monitorar o progresso e o ciclo de vida dos pedidos de acesso enviados. O Knowledge Catalog rastreia e mostra essas solicitações usando estados de status distintos, dependendo se você está visualizando uma lista unificada de fluxos de trabalho ou um resumo de acesso de um produto específico.
Conferir uma lista unificada dos seus pedidos de acesso
Para conferir uma lista completa de todos os pedidos de acesso enviados em todos os produtos de dados, siga estas etapas:
Console
No console Google Cloud , acesse a página Fluxos de trabalho de governança do Knowledge Catalog.
Clique na guia Meus pedidos.
Revise a lista unificada que mostra seus pedidos passados e pendentes, além dos status atuais do fluxo de trabalho:
Novo: a solicitação de acesso foi criada e está pendente de análise pelo aprovador.
Aprovada: a solicitação foi aprovada, mas os sistemas de back-end ainda estão provisionando o acesso.
Recusada: o pedido foi negado. Analise os comentários do aprovador para entender o motivo da rejeição.
REST
Envie uma solicitação GET usando o método de coleta personalizada :listMine:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests:listMine"
Ver o resumo de acesso de um produto de dados específico
Além da lista de fluxo de trabalho global, você pode verificar sua postura de acesso para um produto de dados individual. Assim, você pode verificar se já tem acesso herdado a um grupo de recursos sem precisar enviar uma nova solicitação.
Para conferir o resumo de acesso de um produto de dados, siga estas etapas:
Console
No console Google Cloud , acesse a página Produtos de dados do Knowledge Catalog.
Clique no produto de dados específico que você quer inspecionar.
Clique na guia Resumo de acesso. Revise seu status em todos os grupos de acesso para esse produto de dados.
A guia Resumo do acesso usa os seguintes estados de status:
Status Descrição Sem acesso Você não tem acesso ao grupo de acesso e ainda não solicitou acesso. Em revisão Você enviou um pedido de acesso, e ele está pendente de revisão por um aprovador. Approved Seu pedido de acesso foi aprovado, mas a propagação da associação ao Grupo do Google subjacente ainda está em processamento. Acesso concedido O acesso está totalmente ativo. Você é membro do grupo de acesso e pode interagir com os recursos do produto de dados. Rejeitada Sua solicitação de acesso a este grupo de acesso foi recusada.
REST
Envie uma solicitação GET usando o ID exclusivo retornado quando a solicitação foi
criada originalmente:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID"
Substitua:
PROJECT_ID: ID do projeto Google Cloud
LOCATION: a região em que o produto de dados está localizado (por exemplo,
us-central1)CHANGE_REQUEST_ID: o ID exclusivo da solicitação de mudança enviada
Excluir uma solicitação de acesso
No console Google Cloud , acesse a página Fluxos de trabalho de governança do Knowledge Catalog.
Clique na guia Meus pedidos.
Localize a linha que contém sua solicitação de produto de dados de destino. Se necessário, aplique um filtro para isolar a entrada.
Clique em Ações e em Excluir.
Consumir produtos de dados
Para usar um produto de dados, confira se você tem as permissões necessárias. Consulte Solicitar acesso aos produtos de dados.
Depois que o proprietário do produto de dados conceder permissão, você poderá acessar o produto e os recursos dele. Por exemplo, se você tiver permissão para acessar uma tabela do BigQuery, poderá consultá-la diretamente no BigQuery para gerar insights.
Acessar recursos usando credenciais de usuário
Se o pedido de acesso foi aprovado para suas credenciais de usuário, siga estas etapas para acessar os recursos:
- Pesquise o produto de dados.
- Nos resultados da pesquisa, clique no produto de dados que você quer usar.
- Clique na guia Recursos.
Clique no recurso para ver os detalhes. A página de detalhes da entrada será aberta.
Você pode acessar detalhes como esquema, insights e linhagem. Se o recurso for uma tabela ou visualização do BigQuery, clique em Abrir no BigQuery para acessar o BigQuery Studio e consultar os resultados.
Acessar recursos usando uma conta de serviço
Se a solicitação de acesso a uma conta de serviço for aprovada, você vai receber o papel do IAM de
Criador de token da conta de serviço (roles/iam.serviceAccountTokenCreator)
na conta de serviço do produtor de dados. Isso permite
criar uma cadeia de representação para acessar os recursos subjacentes.
Para acessar recursos usando uma conta de serviço, siga estas etapas:
Para identificar as contas de serviço configuradas para o produto de dados, acesse a guia Ativos de dados na página de detalhes do produto.
Para representar a conta de serviço do produtor de dados, crie uma cadeia de representação para sua conta de serviço usando o seguinte comando da Google Cloud CLI:
gcloud config set auth/impersonate_service_account CONSUMER_SERVICE_ACCOUNT,PRODUCER_SERVICE_ACCOUNTSubstitua:
CONSUMER_SERVICE_ACCOUNT: o endereço de e-mail totalmente qualificado da conta de serviço pertencente ao consumidor do produto de dados.
PRODUCER_SERVICE_ACCOUNT: o endereço de e-mail totalmente qualificado da conta de serviço mapeada para o grupo de acesso ao produto de dados.
Para mais informações, consulte Usar a identidade temporária de conta de serviço.
Acessar produtos de dados usando o servidor MCP remoto
Para aplicativos cliente e ferramentas para desenvolvedores que interagem com seus produtos de dados fora do ecossistema do Google Cloud , use um servidor remoto do Protocolo de Contexto de Modelo (MCP). Esse padrão arquitetônico permite que clientes desenvolvedores externos consultem e descubram com segurança ativos de dados catalogados, mantendo limites de governança unificados.
Para saber como implantar e se conectar a um servidor externo, consulte Usar o servidor MCP remoto do Knowledge Catalog.
A seguir
- Saiba mais sobre produtos de dados.
- Saiba como criar um produto de dados.
- Saiba mais sobre gerenciar produtos de dados.