Este documento descreve como os solicitantes, aprovadores e administradores de fluxo de trabalho gerenciam solicitações de governança no Knowledge Catalog.
Antes de começar
Para usar fluxos de trabalho de governança, verifique se você ativou as APIs necessárias e se os aprovadores e administradores têm os papéis e permissões necessários do Identity and Access Management (IAM).
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.
Funções exigidas
Para receber as permissões necessárias para usar fluxos de trabalho de governança, peça ao administrador para conceder a você os seguintes papéis do IAM 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) -
Aprovar solicitações de acesso ao produto de dados:
- Editor de produtos de dados do Dataplex (
roles/dataplex.dataProductsEditor) - Administrador de produtos de dados do Dataplex (
roles/dataplex.dataProductsAdmin) - Aprovador de fluxo de trabalho do Dataplex (
roles/dataplex.workflowApprover)
- Editor de produtos de dados do Dataplex (
-
Administrar fluxos de trabalho de governança:
Administrador de fluxo de trabalho do Dataplex (
roles/dataplex.workflowAdmin)
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.
Para mais informações, consulte Papéis do IAM do Knowledge Catalog.
Gerenciar solicitações como um solicitante
Como requerente, você inicia solicitações de mudança, como pedir acesso a produtos de dados. Depois de enviar uma solicitação, é possível monitorar o progresso dela, ver os detalhes, editar os detalhes de solicitações pendentes no estado NEW ou excluir solicitações antes que um aprovador as analise.
Ver solicitações criadas
Para listar todas as solicitações criadas, 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 para ver uma lista com todos os seus pedidos anteriores e pendentes.
REST
Ver solicitações criadas
Para conferir uma lista das solicitações que você criou:
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: a região em que o recurso existe (por exemplo,us-central1).USER_EMAIL: seu endereço de e-mail.
Método HTTP e URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests?filter=author=USER_EMAIL
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{
"changeRequests": [
{
"name": "projects/PROJECT_ID/locations/LOCATION/changeRequests/sample-change-request-1",
"uid": "123e4567-e89b-12d3-a456-426614174000",
"createTime": "2026-07-20T10:00:00Z",
"updateTime": "2026-07-20T10:00:00Z",
"justification": "Proposing a new glossary term definition for business accuracy.",
"author": "USER_EMAIL",
"state": "NEW",
"resource": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"createGlossaryTerm": {
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"termId": "sample-term-id",
"term": {
"displayName": "Sample term name",
"description": "Sample term description",
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary"
}
}
}
]
}
Ver uma solicitação específica
Para ver uma solicitação específica:
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: a região em que o recurso existe (por exemplo,us-central1).CHANGE_REQUEST_ID: o ID da solicitação.
Método HTTP e URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{
"name": "projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID",
"uid": "123e4567-e89b-12d3-a456-426614174000",
"createTime": "2026-07-20T10:00:00Z",
"updateTime": "2026-07-20T10:00:00Z",
"justification": "Proposing a new glossary term definition for business accuracy.",
"author": "user@example.com",
"state": "NEW",
"resource": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"createGlossaryTerm": {
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"termId": "sample-term-id",
"term": {
"displayName": "Sample term name",
"description": "Sample term description",
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary"
}
}
}
Editar uma solicitação
É possível atualizar os detalhes de uma solicitação pendente no estado NEW. Por exemplo, você pode mudar a justificativa fornecida na solicitação.
REST
Para editar uma solicitação, envie uma solicitação PATCH com o campo alterado:
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: a região em que o recurso existe (por exemplo,us-central1).CHANGE_REQUEST_ID: o ID exclusivo da solicitação de mudança.NEW_JUSTIFICATION: a justificativa atualizada para o pedido de mudança.
Método HTTP e URL:
PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID?updateMask=justification
Corpo JSON da solicitação:
{
"justification": "NEW_JUSTIFICATION"
}
Para enviar a solicitação, expanda uma destas opções:
Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.
Excluir uma solicitação
Só é possível excluir solicitações no estado NEW. Para excluir uma solicitação, 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.
Localize a linha que contém a solicitação de destino. Se necessário, aplique um filtro para isolar a entrada.
Clique em Ações e em Excluir.
REST
Para excluir uma solicitação, envie uma solicitação DELETE que inclua o ID da solicitação:
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: a região em que o recurso existe (por exemplo,us-central1).CHANGE_REQUEST_ID: o ID da solicitação que você quer excluir.
Método HTTP e URL:
DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID
Para enviar a solicitação, expanda uma destas opções:
Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.
Gerenciar solicitações como aprovador
Como aprovador, você analisa, avalia e processa as solicitações de governança pendentes enviadas para seus recursos de dados. Quando você aprova ou rejeita uma solicitação, o sistema processa automaticamente a decisão e envia uma notificação por e-mail ao solicitante com os detalhes da decisão e sua justificativa.
Listar solicitações pendentes
Para listar as solicitações pendentes de revisão, siga estas etapas:
Console
No console Google Cloud , acesse a página Fluxos de trabalho de governança do Knowledge Catalog.
Clique na guia Aprovações pendentes para conferir as solicitações que precisam ser analisadas. É possível filtrar solicitações por tipo de recurso, tipo de solicitação ou data.
REST
Para listar solicitações de acesso pendentes de análise em um projeto e local específicos, envie uma solicitação 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: a região em que o recurso existe. Por exemplo,us-central1.
Método HTTP e URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{
"changeRequests": [
{
"name": "projects/PROJECT_ID/locations/LOCATION/changeRequests/sample-change-request-1",
"uid": "123e4567-e89b-12d3-a456-426614174000",
"createTime": "2026-07-20T10:00:00Z",
"updateTime": "2026-07-20T10:00:00Z",
"justification": "Proposing a new glossary term definition for business accuracy.",
"author": "user@example.com",
"state": "NEW",
"resource": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"createGlossaryTerm": {
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"termId": "sample-term-id",
"term": {
"displayName": "Sample term name",
"description": "Sample term description",
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary"
}
}
}
]
}
Aprovar um pedido
Para aprovar uma solicitação, siga estas etapas:
Console
No console Google Cloud , acesse a página Fluxos de trabalho de governança do Knowledge Catalog.
Clique na guia Aprovações pendentes.
Localize a linha com a solicitação que você quer aprovar.
Clique em Ações e em Aprovar.
REST
Para aprovar uma solicitação, envie uma solicitação POST para o método personalizado :approve:
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: a região em que o recurso existe (por exemplo,us-central1).CHANGE_REQUEST_ID: o ID exclusivo da solicitação de mudança que você quer aprovar.
Método HTTP e URL:
POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID:approve
Para enviar a solicitação, expanda uma destas opções:
Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.
Depois de processado, o status da solicitação é atualizado automaticamente, e a entrada é movida para a guia Registro de aprovação.
Rejeitar uma solicitação
Para rejeitar uma solicitação, siga estas etapas:
Console
No console Google Cloud , acesse a página Fluxos de trabalho de governança do Knowledge Catalog.
Clique na guia Aprovações pendentes.
Localize a linha que contém a solicitação que você quer rejeitar.
Clique em Ações e em Rejeitar.
Na caixa de diálogo, insira uma justificativa para a rejeição.
Clique em Rejeitar para confirmar.
REST
Para rejeitar uma solicitação, envie uma solicitação POST para o método personalizado :reject com um payload de justificativa:
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: a região em que o recurso existe (por exemplo,us-central1).CHANGE_REQUEST_ID: o ID exclusivo da solicitação de mudança que você quer rejeitar.REJECTION_REASON: a justificativa para a rejeição.
Método HTTP e URL:
POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID:reject
Corpo JSON da solicitação:
{
"comment": "REJECTION_REASON"
}
Para enviar a solicitação, expanda uma destas opções:
Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.
Um comentário de rejeição claro ajuda os solicitantes a entender a decisão e refinar as justificativas de acesso antes de reenviar o pedido.
Gerenciar solicitações como administrador de fluxo de trabalho
Como administrador de fluxo de trabalho, você supervisiona todas as solicitações de governança na organização, monitora o histórico de aprovações e garante a conformidade. É possível listar todas as solicitações ativas e históricas, rastrear trilhas de auditoria em todos os estados de solicitação (NEW, APPROVED, REJECTED, DELETED) e excluir qualquer solicitação, independente do estado atual dela.
Ver todas as solicitações
Para listar todas as solicitações em um projeto e local específicos, siga estas etapas:
REST
Para listar todas as solicitações de acesso em um projeto e local específicos, envie uma solicitação 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: a região em que o recurso existe. Por exemplo,us-central1.
Método HTTP e URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{
"changeRequests": [
{
"name": "projects/PROJECT_ID/locations/LOCATION/changeRequests/sample-change-request-1",
"uid": "123e4567-e89b-12d3-a456-426614174000",
"createTime": "2026-07-20T10:00:00Z",
"updateTime": "2026-07-20T10:00:00Z",
"justification": "Proposing a new glossary term definition for business accuracy.",
"author": "user@example.com",
"state": "NEW",
"resource": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"createGlossaryTerm": {
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"termId": "sample-term-id",
"term": {
"displayName": "Sample term name",
"description": "Sample term description",
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary"
}
}
}
]
}
Acompanhar o histórico de aprovações
O registro de aprovação oferece visibilidade de auditoria de ponta a ponta para solicitações de acesso a produtos de dados, permitindo que administradores e equipes de compliance acompanhem mudanças e acessos em todos os estados.
Console
No console Google Cloud , acesse a página Fluxos de trabalho de governança.
Acesse a guia Registro de aprovações para conferir aprovações, rejeições e trilhas de auditoria históricas concluídas.
REST
Para listar todas as solicitações de um projeto específico, envie uma solicitação 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: a região em que o recurso existe. Por exemplo,us-central1.
Método HTTP e URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{
"changeRequests": [
{
"name": "projects/PROJECT_ID/locations/LOCATION/changeRequests/sample-change-request-1",
"uid": "123e4567-e89b-12d3-a456-426614174000",
"createTime": "2026-07-20T10:00:00Z",
"updateTime": "2026-07-20T10:00:00Z",
"justification": "Proposing a new glossary term definition for business accuracy.",
"author": "user@example.com",
"state": "NEW",
"resource": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"createGlossaryTerm": {
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary",
"termId": "sample-term-id",
"term": {
"displayName": "Sample term name",
"description": "Sample term description",
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/sample-glossary"
}
}
}
]
}
A seguir
- Saiba mais sobre fluxos de trabalho de governança.