Identity and Access Management (IAM) 可讓您在專案、Spanner 執行個體、Spanner 資料庫、備份和備份排程層級,控管使用者和群組對 Spanner 資源的存取權。舉例來說,您可以指定使用者對專案中特定執行個體的特定資料庫擁有完整控制權,但無法建立、修改或刪除專案中的任何執行個體。使用 IAM 存取控管功能,即可將權限授予使用者或群組,不必個別修改每個 Spanner 執行個體或資料庫權限。
本文著重於與 Spanner 相關的 IAM 權限,以及授予這些權限的 IAM 角色。如需 IAM 及其功能的詳細說明,請參閱 IAM 開發人員指南。請特別參閱「管理 IAM 政策」一節。
權限
擁有權限的使用者才能對 Spanner 資源執行特定操作。舉例來說,spanner.databases.read 權限允許使用者透過 Spanner 的讀取 API 讀取資料庫,而 spanner.databases.select 則允許使用者在資料庫上執行 SQL select 陳述式。您不會直接授予使用者權限,而是授予預先定義的角色或自訂角色,這些角色會繫結一或多項權限。
下表列出與 Spanner 相關聯的 IAM 權限。
執行個體設定
下列權限適用於 Spanner 執行個體設定。詳情請參閱 REST 和 RPC API 的執行個體設定參考資料。
| 執行個體設定權限名稱 | 說明 |
|---|---|
spanner.instanceConfigs.create |
建立自訂執行個體設定。 |
spanner.instanceConfigs.delete |
刪除自訂執行個體設定。 |
spanner.instanceConfigs.get |
取得執行個體設定。 |
spanner.instanceConfigs.list |
列出一組執行個體設定。 |
spanner.instanceConfigs.update |
更新自訂執行個體設定。 |
執行個體設定作業
下列權限適用於 Spanner 執行個體設定作業。詳情請參閱下列 API 參考資料:
- REST:
projects.instanceConfigOperations和projects.instanceConfigs.operations - RPC:
ListInstanceConfigOperations和Operations
| 執行個體設定作業權限名稱 | 說明 |
|---|---|
spanner.instanceConfigOperations.cancel |
取消執行個體設定作業。 |
spanner.instanceConfigOperations.delete |
刪除執行個體設定作業。 |
spanner.instanceConfigOperations.get |
取得執行個體設定作業。 |
spanner.instanceConfigOperations.list |
列出執行個體設定作業。 |
執行個體
下列權限適用於 Spanner 執行個體。詳情請參閱 REST 和 RPC API 的執行個體參考資料。
| 執行個體權限名稱 | 說明 |
|---|---|
spanner.instances.create |
建立執行個體。 |
spanner.instances.createTagBinding |
將標記附加至執行個體。 |
spanner.instances.delete |
刪除執行個體。 |
spanner.instances.deleteTagBinding |
將標記從執行個體卸離。 |
spanner.instances.get |
取得特定執行個體的設定。 |
spanner.instances.getIamPolicy |
取得執行個體的 IAM 政策。 |
spanner.instances.list |
列出執行個體。 |
spanner.instances.listEffectiveTags |
列出附加至執行個體或由執行個體繼承的標記。 |
spanner.instances.listTagBindings |
列出直接附加至執行個體的標記。 |
spanner.instances.setIamPolicy |
設定執行個體的 IAM 政策。 |
spanner.instances.update |
更新執行個體。 |
執行個體作業
下列權限適用於 Spanner 執行個體作業。詳情請參閱 REST 和 RPC API 的執行個體參考資料。
| 執行個體作業權限名稱 | 說明 |
|---|---|
spanner.instanceOperations.cancel |
取消執行個體作業。 |
spanner.instanceOperations.delete |
刪除執行個體作業。 |
spanner.instanceOperations.get |
取得特定執行個體作業。 |
spanner.instanceOperations.list |
列出執行個體作業。 |
執行個體分區
下列權限適用於 Spanner 執行個體分區。詳情請參閱 REST 和 RPC API 的執行個體分區參考資料。
| 執行個體分區權限名稱 | 說明 |
|---|---|
spanner.instancePartitions.create |
建立執行個體分區。 |
spanner.instancePartitions.delete |
刪除執行個體分區。 |
spanner.instancePartitions.get |
取得特定執行個體分區的設定。 |
spanner.instancePartitions.list |
列出執行個體分區。 |
spanner.instancePartitions.update |
更新執行個體分區。 |
執行個體分區作業
下列權限適用於 Spanner 執行個體分區作業。詳情請參閱下列 API 參考資料:
- REST:
projects.instances.instancePartitionOperations和projects.instances.instancePartitions.operations - RPC:
ListInstancePartitionOperations和Operations
| 執行個體分區作業權限名稱 | 說明 |
|---|---|
spanner.instancePartitionOperations.cancel |
取消執行個體分區作業。 |
spanner.instancePartitionOperations.delete |
刪除執行個體分區作業。 |
spanner.instancePartitionOperations.get |
取得特定執行個體分區作業。 |
spanner.instancePartitionOperations.list |
列出執行個體分區作業。 |
資料庫
下列權限適用於 Spanner 資料庫。詳情請參閱 REST 和 RPC API 的資料庫參考資料。
| 資料庫權限名稱 | 說明 |
|---|---|
spanner.databases.adapt |
允許 Spanner Adapter API 直接與 Spanner 互動。此外,還需要 spanner.sessions.create 才能建立轉接程式工作階段,以及 spanner.databases.select 或 spanner.databases.write 才能透過轉接程式讀取或修改資料。 |
spanner.databases.addSplitPoints |
在資料庫的資料表和索引中新增分割點。 |
spanner.databases.beginOrRollbackReadWriteTransaction |
在 Spanner 資料庫上開始或復原讀寫交易。 |
spanner.databases.beginPartitionedDmlTransaction |
在 Spanner 資料庫上啟動分區 DML 交易。在交易中執行 UPDATE 或 DELETE 陳述式也需要 spanner.databases.write。 |
spanner.databases.beginReadOnlyTransaction |
在 Spanner 資料庫上啟動唯讀交易。 |
spanner.databases.changequorum |
變更雙區域執行個體設定中資料庫的仲裁。 |
spanner.databases.create |
建立資料庫。 |
spanner.databases.createBackup |
從資料庫建立備份。此外,也需要 spanner.backups.create 才能建立備份資源。 |
spanner.databases.drop |
捨棄資料庫。 |
spanner.databases.get |
取得資料庫中繼資料。 |
spanner.databases.getDdl |
取得資料庫結構定義。 |
spanner.databases.getIamPolicy |
取得資料庫的 IAM 政策。 |
spanner.databases.list |
列出資料庫。 |
spanner.databases.partitionQuery |
將 SQL 查詢分區,以便平行讀取資料。 |
spanner.databases.partitionRead |
將讀取要求分區,以便平行讀取資料。 |
spanner.databases.read |
使用讀取 API 從資料庫中讀取。 |
spanner.databases.runGraphAlgorithms |
在 Spanner Graph 資料庫執行圖形演算法。 |
spanner.databases.select |
在資料庫上執行 SQL Select 陳述式。 |
spanner.databases.setIamPolicy |
設定資料庫的 IAM 政策。 |
spanner.databases.update |
更新資料庫中繼資料。 |
spanner.databases.updateDdl |
更新資料表結構定義。 |
spanner.databases.useDataBoost |
使用 Spanner Data Boost 的運算資源,執行分區查詢和讀取作業。 |
spanner.databases.useRoleBasedAccess |
使用精細的存取控管。 |
spanner.databases.write |
寫入資料庫。 |
資料庫角色
下列權限適用於 Spanner 資料庫角色。詳情請參閱 REST 和 RPC API 的資料庫參考資料。
| 資料庫角色權限名稱 | 說明 |
|---|---|
spanner.databaseRoles.list |
列出資料庫角色。 |
spanner.databaseRoles.use |
使用指定的資料庫角色。 |
資料庫作業
下列權限適用於 Spanner 資料庫作業。詳情請參閱下列 API 參考資料:
- REST:
projects.instances.databaseOperations和projects.instances.databases.operations - RPC:
ListDatabaseOperations和Operations
| 資料庫作業權限名稱 | 說明 |
|---|---|
spanner.databaseOperations.cancel |
取消資料庫作業。 |
spanner.databaseOperations.get |
取得特定資料庫作業。 |
spanner.databaseOperations.list |
列出資料庫和還原資料庫作業。 |
備份
下列權限適用於 Spanner 備份。詳情請參閱 REST 和 RPC API 的備份參考資料。
| 備份權限名稱 | 說明 |
|---|---|
spanner.backups.copy |
複製備份。目的地執行個體也必須具備 spanner.backups.create。 |
spanner.backups.create |
建立備份。此外,來源資料庫也必須具備 spanner.databases.createBackup。 |
spanner.backups.delete |
刪除備份。 |
spanner.backups.get |
取得備份。 |
spanner.backups.getIamPolicy |
取得備份的 IAM 政策。 |
spanner.backups.list |
列出備份。 |
spanner.backups.restoreDatabase |
從備份還原資料庫。此外,也需要 spanner.databases.create 才能在目標執行個體上建立還原的資料庫。 |
spanner.backups.setIamPolicy |
設定備份的 IAM 政策。 |
spanner.backups.update |
更新備份。 |
備份作業
下列權限適用於 Spanner 備份作業。詳情請參閱 REST 和 RPC API 的資料庫參考資料。
| 備份作業權限名稱 | 說明 |
|---|---|
spanner.backupOperations.cancel |
取消備份作業。 |
spanner.backupOperations.get |
取得特定備份作業。 |
spanner.backupOperations.list |
列出備份作業。 |
備份排程
下列權限適用於 Spanner 備份排程。詳情請參閱 REST 和 RPC API 的備份排程參考資料。
| 備份排程權限名稱 | 說明 |
|---|---|
spanner.backupSchedules.create |
建立備份排程。此外,來源資料庫也必須具備 spanner.databases.createBackup。 |
spanner.backupSchedules.delete |
刪除備份排程。 |
spanner.backupSchedules.get |
取得備份排程。 |
spanner.backupSchedules.getIamPolicy |
取得備份排程的 IAM 政策。 |
spanner.backupSchedules.list |
列出備份排程。 |
spanner.backupSchedules.setIamPolicy |
設定備份排程的 IAM 政策。 |
spanner.backupSchedules.update |
更新備份排程。 |
工作階段
下列權限適用於 Spanner 工作階段。詳情請參閱 REST 和 RPC API 的資料庫參考資料。
| 工作階段權限名稱 | 說明 |
|---|---|
spanner.sessions.create |
建立工作階段。 |
spanner.sessions.delete |
刪除工作階段。 |
spanner.sessions.get |
取得工作階段。 |
spanner.sessions.list |
列出工作階段。 |
預先定義的角色
預先定義的角色是一組權限。舉例來說,預先定義的角色 roles/spanner.databaseUser 包含 spanner.databases.read 和 spanner.databases.write 等權限。
下表列出 IAM 預先定義角色的存取控管,以及與各角色相關聯的權限清單:
| Role | Permissions |
|---|---|
Cloud Spanner Admin( Has complete access to all Spanner resources in a Google Cloud project. A principal with this role can:
Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Editor( Editor role for Cloud Spanner |
|
Cloud Spanner Viewer( A principal with this role can:
For example, you can combine this role with the This role is recommended at the Google Cloud project level for users interacting with Cloud Spanner resources in the Google Cloud console. Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Backup Admin( A principal with this role can:
This role cannot restore a database from a backup. Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Backup Writer( This role is intended to be used by scripts that automate backup creation. A principal with this role can create backups, but cannot update or delete them. Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Database Admin( A principal with this role can:
Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Database Reader( A principal with this role can:
Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Database Reader with DataBoost( Includes all permissions in the spanner.databaseReader role enabling access to read and/or query a Cloud Spanner database using instance resources, as well as the permission to access the database with Data Boost, a fully managed serverless service that provides independent compute resources. Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Database Role User( In conjunction with the IAM role Cloud Spanner Fine-grained Access User, grants permissions to individual Spanner database roles. Add a condition for each desired Spanner database role that includes the resource type of `spanner.googleapis.com/DatabaseRole` and the resource name ending with `/YOUR_SPANNER_DATABASE_ROLE`. Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Database User( A principal with this role can:
Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Fine-grained Access User( Grants permissions to use Spanner's fine-grained access control framework. To grant access to specific database roles, also add the `roles/spanner.databaseRoleUser` IAM role and its necessary conditions. Lowest-level resources where you can grant this role:
|
|
Cloud Spanner Database Graph Intelligence features user( Access to Graph Intelligence features. |
|
Cloud Spanner Restore Admin( A principal with this role can restore databases from backups. If you need to restore a backup to a different instance, apply this role at the project level or to both instances. This role cannot create backups. Lowest-level resources where you can grant this role:
|
|
Service agent roles
Service agent roles should only be granted to service agents.
| Role | Permissions |
|---|---|
Cloud Spanner API Service Agent( Cloud Spanner API Service Agent |
|
基本角色
基本角色是專案層級的角色,在 IAM 推出前就已存在。詳情請參閱「基本角色」。
雖然 Spanner 支援下列基本角色,但建議您盡可能使用前述的預先定義角色。基本角色包含適用於所有 Google Cloud 資源的廣泛權限;相較之下,Spanner 的預先定義角色則包含僅適用於 Spanner 的精細權限。
| 基本角色 | 說明 |
|---|---|
roles/editor |
可執行 roles/viewer 的所有操作,也能建立、更新及刪除 Spanner 資源,包括自訂執行個體設定、執行個體、執行個體分區、資料庫、備份和備份排程,以及將資料寫入資料庫。 |
roles/owner |
可執行 roles/editor 的所有操作,還能修改執行個體、資料庫、備份和備份排程的存取權,以及在執行個體上附加或卸離標記。 |
roles/viewer |
能夠列出並取得結構定義和執行個體的中繼資料,也可以在資料庫上使用 SQL 進行讀取與查詢。 |
自訂角色
如果 Spanner 的預先定義角色無法滿足您的業務需求,您可以使用自訂角色,並設定這些角色的權限。
建立自訂角色前,您必須先找出需要執行的工作。接著,您可以找出每項工作所需的權限,並將這些權限新增至自訂角色。
服務帳戶工作的自訂角色
對大多數的工作而言,需要新增哪些權限到自訂的角色是顯而易見的。舉例來說,如果您希望服務帳戶能夠建立資料庫,請將 spanner.databases.create 權限新增至自訂角色。
不過,在 Spanner 資料表中讀取或寫入資料時,您必須在自訂角色中新增多項權限。下表列出讀取和寫入資料所需的權限。
| 服務帳戶工作 | 所需權限 |
|---|---|
| 建立備份 | spanner.backups.createspanner.databases.createBackup |
| 使用 SQL 查詢讀取資料 | spanner.databases.selectspanner.sessions.createspanner.sessions.delete |
| 使用讀取 API 讀取資料 | spanner.databases.readspanner.sessions.createspanner.sessions.delete |
| 在唯讀交易中讀取資料 | spanner.databases.beginReadOnlyTransaction,以及使用 SQL 查詢或讀取 API 讀取資料的權限 |
| 並行讀取資料 | spanner.databases.partitionQuery 或 spanner.databases.partitionRead,以及在唯讀交易中讀取資料的權限 |
| 還原資料庫 | spanner.backups.restoreDatabasespanner.databases.create |
| 插入、更新或刪除資料 | spanner.databases.beginOrRollbackReadWriteTransactionspanner.sessions.createspanner.sessions.deletespanner.databases.write如要在同一筆交易中讀取資料,請一併新增 spanner.databases.select 或 spanner.databases.read。 |
| 使用分區 DML 更新或刪除資料 | spanner.databases.beginPartitionedDmlTransactionspanner.databases.writespanner.sessions.createspanner.sessions.delete |
Google Cloud 控制台工作的自訂角色
如要找出在Google Cloud 控制台中執行特定工作所需的權限清單,請判斷該工作的流程,並彙整該流程的權限。舉例來說,如要查看資料表中的資料,請在 Google Cloud 控制台中按照下列步驟操作:
| 步驟 | 權限 |
|---|---|
| 1. 存取專案 | resourcemanager.projects.get |
| 2. 檢視執行個體清單 | spanner.instances.list、spanner.instanceConfigs.list |
| 3. 選取執行個體 | spanner.instances.get、spanner.instanceConfigs.list、spanner.databases.list |
| 4. 檢視資料庫清單 | spanner.databases.list |
| 5. 選取資料庫與資料表 | spanner.databases.getDdl、spanner.databases.select、spanner.databases.beginReadOnlyTransaction、spanner.sessions.create |
| 6. 檢視資料表中的資料 | spanner.databases.select、spanner.databases.beginReadOnlyTransaction、spanner.sessions.create、spanner.sessions.delete |
在這個範例中,您需要以下權限:
resourcemanager.projects.getspanner.databases.beginReadOnlyTransactionspanner.databases.getDdlspanner.databases.listspanner.databases.selectspanner.instanceConfigs.listspanner.instances.getspanner.instances.listspanner.sessions.createspanner.sessions.delete
下表列出在Google Cloud 控制台執行動作所需的權限。
| 權限 | 動作 |
|---|---|
spanner.databases.setIamPolicy |
在「資料庫詳細資料」頁面的「權限」分頁新增主體 |
spanner.instances.setIamPolicy |
在執行個體頁面的「權限」分頁新增主體 |
spanner.backups.setIamPolicy |
在「備份/還原」頁面的權限面板中,將主體新增至備份 |
spanner.backups.createspanner.databases.createBackupspanner.databases.list1spanner.backupOperations.list1 |
建立備份 |
spanner.backupSchedules.createspanner.databases.createBackup |
建立備份排程 |
spanner.databases.createspanner.databases.getspanner.databaseOperations.getspanner.databaseOperations.list |
建立資料庫 |
spanner.instancePartitions.listspanner.instanceConfigs.listspanner.instancePartitionOperations.getspanner.instancePartitions.create |
建立執行個體分區 |
spanner.databaseOperations.getspanner.databaseOperations.listspanner.databases.updateDdl |
建立資料表 更新資料表結構定義 |
spanner.instanceConfigs.listspanner.instanceOperations.getspanner.instances.create |
建立執行個體 |
spanner.backups.delete |
刪除備份 |
spanner.backupSchedules.delete |
刪除備份排程 |
spanner.databases.drop |
刪除資料庫 |
spanner.instancePartitions.listspanner.instancePartitionOperations.getspanner.instancePartitions.delete |
刪除執行個體分區 |
spanner.instances.delete |
刪除執行個體 |
spanner.instancePartitions.listspanner.instanceConfigs.listspanner.instancePartitionOperations.getspanner.instancePartitions.update |
修改執行個體分區 |
spanner.instanceOperations.getspanner.instances.update |
修改執行個體 |
spanner.databases.beginOrRollbackReadWriteTransactionspanner.databases.selectspanner.databases.writespanner.sessions.createspanner.sessions.delete |
修改資料表中的資料 |
spanner.instanceConfigs.listspanner.instances.getspanner.backups.getspanner.backups.restoreDatabasespanner.instances.listspanner.databases.create |
從備份還原資料庫 |
spanner.databases.getspanner.databases.getDdlspanner.databases.selectspanner.databases.beginReadOnlyTransactionspanner.sessions.create |
從資料庫清單中選取一個資料庫並在「資料庫詳細資料」頁面中檢視結構定義 |
spanner.instances.getspanner.instanceConfigs.listspanner.databases.list |
從執行個體清單中選取執行個體,以檢視「執行個體詳細資料」頁面 |
spanner.backups.getspanner.backups.update |
更新備份 |
spanner.backupSchedules.update |
更新備份排程 |
spanner.databases.selectspanner.databases.beginReadOnlyTransactionspanner.sessions.createspanner.sessions.delete |
在「資料庫詳細資料」頁面的「資料」分頁中查看資料 建立及執行查詢 |
spanner.backups.listspanner.backups.get |
查看「備份/還原」頁面 |
monitoring.metricDescriptors.getmonitoring.metricDescriptors.listmonitoring.timeSeries.listspanner.instances.get |
在「執行個體詳細資料」或「資料庫詳細資料」頁面上的「監控」分頁檢視圖表 |
spanner.backupOperations.list |
查看備份作業清單 |
spanner.databases.list |
在「執行個體詳細資料」頁面上檢視資料庫清單 |
resourcemanager.projects.getspanner.instances.listspanner.instanceConfigs.list |
檢視「執行個體」頁面上的執行個體清單 |
spanner.backups.getIamPolicy |
在「備份/還原」頁面的權限面板中,查看備份的主體清單 |
spanner.databaseOperations.list |
查看還原作業清單 |
spanner.databases.getIamPolicy |
檢視「資料庫詳細資料」頁面「權限」分頁上的清單 |
spanner.instances.getIamPolicy |
檢視「執行個體」頁面「權限」分頁上的清單 |
Spanner IAM 政策管理
您可以使用 Spanner 執行個體、資料庫、備份和備份排程資源上的 REST 或 RPC API,取得、設定及測試 IAM 政策。您也可以測試資料庫角色的權限。
執行個體
| REST API | RPC API |
|---|---|
projects.instances.getIamPolicy |
GetIamPolicy |
projects.instances.setIamPolicy |
SetIamPolicy |
projects.instances.testIamPermissions |
TestIamPermissions |
資料庫
| REST API | RPC API |
|---|---|
projects.instances.databases.getIamPolicy |
GetIamPolicy |
projects.instances.databases.setIamPolicy |
SetIamPolicy |
projects.instances.databases.testIamPermissions |
TestIamPermissions |
備份
| REST API | RPC API |
|---|---|
projects.instances.backups.getIamPolicy |
GetIamPolicy |
projects.instances.backups.setIamPolicy |
SetIamPolicy |
projects.instances.backups.testIamPermissions |
TestIamPermissions |
備份排程
資料庫角色
資料庫角色僅支援測試權限。您無法取得或設定資料庫角色的 IAM 政策。
| REST API | RPC API |
|---|---|
projects.instances.databases.databaseRoles.testIamPermissions |
TestIamPermissions |