本文档介绍了如何使用治理工作流对业务术语库类别和术语以及 Knowledge Catalog(以前称为 Dataplex Universal Catalog)条目提出单资源更改建议。
准备工作
如需使用治理工作流进行元数据更改,请确保您已启用所需的 API,并且拥有必要的 Identity and Access Management (IAM) 角色和权限。
启用 Dataplex API(如果尚未启用)。
启用 API 所需的角色
如需启用 API,您需要拥有 serviceusage.services.enable 权限。如果您创建了项目,则可能已经通过 Owner 角色 (roles/owner) 拥有此权限。否则,您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。了解如何授予角色。
所需的角色
如需获得请求元数据更改所需的权限,请让管理员为您授予项目、术语表或条目组的以下 IAM 角色:
-
请求元数据更改:Dataplex Catalog Viewer (
roles/dataplex.catalogViewer) -
批准元数据更改:
- Dataplex Workflow Approver (
roles/dataplex.workflowApprover) - Dataplex Catalog Editor (
roles/dataplex.catalogEditor) - Dataplex Entry Owner (
roles/dataplex.entryOwner)
- Dataplex Workflow Approver (
-
管理治理工作流:Dataplex Workflow Admin (
roles/dataplex.workflowAdmin)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
如需详细了解角色和权限,请参阅 Knowledge Catalog IAM 角色。
请求更改术语表类别
如果您没有直接写入权限来创建、更新或删除词汇表类别,则可以使用治理工作流请求进行此类更改。提交元数据更改请求后,请求者、审批者和工作流管理员可以在请求的整个生命周期内监控和管理请求。
创建类别
控制台
请按照以下步骤申请类别:
在 Google Cloud 控制台中,前往 Knowledge Catalog 术语库页面。
选择要在其中创建类别的术语库,然后点击创建类别。
输入类别的显示名称。
可选:在标签部分中,为术语库添加标签。
可选:在理由部分,向审批人提供更改理由。
在高级设置部分中,如果您想更改自动生成的 ID,可以修改类别 ID。
点击提交审核。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求创建类别,请使用 glossaries.requestGlossaryChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"createCategoryRequest": {
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"categoryId": "sample-category-id",
"category": {
"displayName": "Sample category name",
"description": "Sample category description",
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID"
}
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID:requestGlossaryChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:术语表所在的区域,例如us-central1。GLOSSARY_ID:父级术语表的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的更改请求并通知审批者
更新类别
控制台
如需对类别提出更改建议,请按以下步骤操作:
在 Google Cloud 控制台中,前往 Knowledge Catalog 术语库页面。
选择包含要更新的类别的术语库。
点击类别名称以打开类别详情窗格。
如需添加或更新类别详细信息,请点击要更新的部分旁边的 添加或 修改。
点击提交审核。某些商品可能需要提供额外的更改理由。提供理由,然后点击继续提交更改。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求更新类别显示名称和说明,请使用 glossaries.requestGlossaryChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"updateCategoryRequest": {
"category": {
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID/categories/CATEGORY_ID",
"displayName": "Sample new name",
"description": "Sample new description"
},
"updateMask": {
"paths": [
"display_name",
"description"
]
}
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID:requestGlossaryChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:术语表所在的区域,例如us-central1。GLOSSARY_ID:父级术语表的 ID。CATEGORY_ID:要更新的目标类别的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的更改请求并通知审批者
删除类别
控制台
如需请求删除类别,请按以下步骤操作:
在 Google Cloud 控制台中,前往 Knowledge Catalog 术语库页面。
展开相应术语库,然后点击要删除的类别。
在类别详情窗格中,从菜单中选择 删除。
可选:在理由部分,向审批人提供更改原因。
点击提交审核。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求删除类别,请使用 glossaries.requestGlossaryChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"deleteCategoryRequest": {
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID/categories/CATEGORY_ID"
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID:requestGlossaryChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:术语表所在的区域,例如us-central1。GLOSSARY_ID:父级术语表的 ID。CATEGORY_ID:要删除的目标类别的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的更改请求并通知审批者
请求更改某个术语
如果您没有直接写入权限来创建、更新或删除术语表术语,则可以使用治理工作流请求此类更改。
创建术语表术语
控制台
如需请求创建术语表条目,请按以下步骤操作:
在 Google Cloud 控制台中,前往 Knowledge Catalog 术语库页面。
选择要在其中创建术语的术语库或类别,以打开详细信息窗格。
- 如果您从术语库详情页面创建术语,请从菜单中选择创建术语。
- 如果您从类别详情页面创建术语,请从菜单中选择添加术语。
输入类别的显示名称。
可选:在标签部分中,为该字词添加标签。
可选:在理由部分,向审批人提供更改理由。
在高级设置部分中,您可以修改字词 ID,以更改自动生成的 ID。
点击提交审核。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求创建术语表字词,请使用 glossaries.requestGlossaryChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"createTermRequest": {
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"termId": "sample-term-id",
"term": {
"displayName": "Sample term name",
"description": "Sample term description",
"parent": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID"
}
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID:requestGlossaryChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:术语表所在的区域,例如us-central1。GLOSSARY_ID:父级术语表的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的更改请求并通知审批者
更新术语表术语
控制台
如需申请更改某个术语,请按以下步骤操作:
在 Google Cloud 控制台中,前往 Knowledge Catalog 术语库页面。
选择包含要更新的字词的术语库。
点击术语名称以打开术语详情窗格。
点击要更新的部分旁边的 添加或 修改,添加或更新条款详情。
点击提交审核。在某些部分中,您可能需要提供额外的理由,然后才能提交请求。提供理由,然后点击继续提交更改。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求更新术语库字词显示名称和说明,请使用 glossaries.requestGlossaryChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"updateTermRequest": {
"term": {
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID/terms/TERM_ID",
"displayName": "Sample new name",
"description": "Sample new description"
},
"updateMask": {
"paths": [
"display_name",
"description"
]
}
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID:requestGlossaryChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:术语表所在的区域,例如us-central1。GLOSSARY_ID:父级术语表的 ID。TERM_ID:要更新的目标字词的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的更改请求并通知审批者
删除术语表术语
控制台
如需申请删除字词,请按以下步骤操作:
在 Google Cloud 控制台中,前往 Knowledge Catalog 术语库页面。
选择包含要删除的字词的术语库。
点击术语名称以打开术语详情窗格。
点击删除。
点击提交审核。在某些部分中,您可能需要提供额外的理由,然后才能提交请求。提供理由,然后点击继续提交更改。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求删除术语表中的字词,请使用 glossaries.requestGlossaryChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID",
"deleteTermRequest": {
"name": "projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID/terms/TERM_ID"
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/glossaries/GLOSSARY_ID:requestGlossaryChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:术语表所在的区域,例如us-central1。GLOSSARY_ID:父级术语表的 ID。TERM_ID:要删除的目标字词的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个 RequestGlossaryChangeResponse,其中包含 ChangeRequest 的资源名称。系统会记录新的变更请求并通知审批者。
请求更改条目
如果您没有直接写入权限来创建、修改或删除知识目录条目,则可以使用治理工作流请求进行此类更改。
创建条目
控制台
如需请求创建条目,请按以下步骤操作:
在 Google Cloud 控制台中,前往 Knowledge Catalog 元数据类型页面。
点击条目组标签页。
选择要在其中创建条目的条目组,然后点击创建条目。
输入条目的 ID 和显示名称。
选择条目类型。
可选:提供方面详细信息或添加说明。
点击提交审核。在某些部分中,您可能需要提供额外的理由,然后才能提交请求。提供理由,然后点击继续提交更改。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求创建条目,请使用 entryGroups.requestCatalogChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"createEntryRequest": {
"parent": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"entryId": "sample-entry-id",
"entry": {
"entryType": "projects/PROJECT_ID/locations/LOCATION/entryTypes/ENTRY_TYPE_ID",
"entrySource": {
"displayName": "Sample entry name",
"description": "Sample entry description"
}
}
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID:requestCatalogChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:条目组所在的区域,例如us-central1。ENTRY_GROUP_ID:父级条目组的 ID。ENTRY_TYPE_ID:条目类型的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的变更请求并通知审批者。
更新条目
控制台
请按照以下步骤请求更新条目:
- 在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索或目录页面。
- 搜索并选择要更新的条目。
- 点击该条目以打开条目详情页面。
- 点击要更新的部分旁边的 添加。
- 更新该部分。
- 点击提交审核。在某些部分中,您可能需要提供额外的理由,然后才能提交请求。提供理由,然后点击继续提交更改。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页中跟踪请求进度。
REST
如需请求更新条目来源显示名称和说明,请使用 entryGroups.requestCatalogChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"updateEntryRequest": {
"entry": {
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
"entrySource": {
"displayName": "Sample new name",
"description": "Sample new description"
}
},
"updateMask": {
"paths": [
"entry_source.display_name",
"entry_source.description"
]
}
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID:requestCatalogChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:条目组所在的区域,例如us-central1。ENTRY_GROUP_ID:父级条目组的 ID。ENTRY_ID:目标条目的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的变更请求并通知审批者。
删除条目
控制台
如需请求删除条目,请按以下步骤操作:
- 在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索或目录页面。
- 搜索并选择要删除的条目。
- 点击该条目以打开条目详情页面。
- 点击删除。
- 点击提交审核。在某些部分中,您可能需要提供额外的理由,然后才能提交请求。提供理由,然后点击继续提交更改。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求删除条目,请使用 entryGroups.requestCatalogChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"deleteEntryRequest": {
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID"
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID:requestCatalogChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:条目组所在的区域,例如us-central1。ENTRY_GROUP_ID:父级条目组的 ID。ENTRY_ID:要删除的目标条目的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的变更请求并通知审批者。
更新切面
控制台
请按照以下步骤请求更新方面:
- 在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索页面。
- 搜索并选择您要请求更改的条目。
- 点击该条目以打开条目详情页面。
- 前往切面部分,然后点击 添加。
- 提供切面详细信息。
- 可选:提供更改理由。
- 点击提交审核。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求在条目上附加或更新联系人切面,请使用 entryGroups.requestCatalogChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"updateEntryRequest": {
"entry": {
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
"aspects": {
"dataplex-types.global.contacts": {
"data": {
"identities": [
{
"role": "Data Steward",
"name": "Dana",
"id": "dana@example.com"
}
]
}
}
}
},
"updateMask": {
"paths": [
"aspects"
]
},
"aspectKeys": [
"dataplex-types.global.contacts"
]
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID:requestCatalogChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:条目组所在的区域,例如us-central1。ENTRY_GROUP_ID:父级条目组的 ID。ENTRY_ID:目标条目的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的变更请求并通知审批者。
创建条目链接
控制台
请按照以下步骤请求创建条目链接,例如附加术语表字词:
在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索页面。
搜索并选择要将术语关联到的数据资产条目。
在条目详情页面上,执行以下操作之一:
- 如需将术语关联到条目,请在详细信息标签页的术语库术语部分中,点击添加。
- 如需将术语关联到列,请在架构标签页上选择相应列,然后点击添加业务术语。
搜索并选择要关联的术语。
可选:提供更改理由。
点击提交审核。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求在术语库术语和数据资产条目之间创建定义链接,请使用 entryGroups.requestCatalogChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"createEntryLinkRequest": {
"parent": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"entryLinkId": "sample-definition-link",
"entryLink": {
"entryLinkType": "projects/dataplex-types/locations/global/entryLinkTypes/definition",
"entryReferences": [
{
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
"type": "SOURCE"
},
{
"name": "projects/PROJECT_ID/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_ID/locations/global/glossaries/GLOSSARY_ID/terms/TERM_ID",
"type": "TARGET"
}
]
}
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID:requestCatalogChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:条目组所在的区域,例如us-central1。ENTRY_GROUP_ID:父级条目组的 ID。ENTRY_ID:目标条目的 ID。GLOSSARY_ID:包含该术语的术语库的 ID。TERM_ID:术语库术语的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的变更请求并通知审批者。
删除条目链接
控制台
请按照以下步骤请求删除条目链接,例如,移除附加的术语表字词:
在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索页面。
搜索并选择要从中移除关联术语的数据资产条目。
在条目详情页面上,执行以下操作之一:
- 如需从条目中移除术语,请在详细信息标签页的术语库术语部分中,点击该术语,然后点击 移除。
- 如需从列中移除术语,请在架构标签页中,点击该术语旁边的 移除。
可选:提供更改理由。
点击提交审核。
系统会记录新的变更请求并通知审批者。您可以在治理工作流页面的我的请求标签页下跟踪请求进度。
REST
如需请求删除术语表字词与数据资产条目之间的条目链接,请使用 entryGroups.requestCatalogChange 方法:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
"deleteEntryLinkRequest": {
"name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID"
},
"justification": "JUSTIFICATION"
}' \
"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID:requestCatalogChange"
替换以下内容:
PROJECT_ID:您的Google Cloud 项目的 ID。LOCATION:条目组所在的区域,例如us-central1。ENTRY_GROUP_ID:父级条目组的 ID。ENTRY_LINK_ID:要删除的目标条目链接的 ID。JUSTIFICATION:说明您提议更改的原因。
该服务会返回一个响应,其中包含变更请求的资源名称。系统会记录新的变更请求并通知审批者。