Syntax of Fine-Grained Permissions Policies
In actual services, you may need to grant different operation permissions on resources to users of different roles. The IAM service provides fine-grained access control. An IAM administrator (a user in the admin group) can create a custom policy containing required permissions. After a policy is granted to a user group, users in the group can obtain all permissions defined by the policy. In this way, IAM implements fine-grained permission management.
To control the GaussDB(DWS) operations on resources more precisely, you can use the user management function of IAM to grant different operation permissions to users of different roles for fine-grained permission control.
Policy Structure
A fine-grained policy consists of a Version and a Statement. Each policy can have multiple statements.
Policy Syntax
In the navigation pane on the IAM console, click Policies and then click the name of a policy to view its details. The DWS ReadOnlyAccess policy is used as an example to describe the syntax of fine-grained policies.
{
"Version": "1.1",
"Statement": [
{
"Effect": "Allow",
"Action": [
"dws:*:get*",
"dws:*:list*",
"ecs:*:get*",
"ecs:*:list*",
"vpc:*:get*",
"vpc:*:list*",
"evs:*:get*",
"evs:*:list*",
"bss:*:list*",
"bss:*:get*"
]
}
]
}
- Version: Distinguishes between role-based access control (RBAC) and fine-grained policies.
- 1.0: RBAC policies. An RBAC policy consists of permissions for an entire service. Users in a group with such a policy assigned are granted all of the permissions required for that service.
- 1.1: Fine-grained policies. A fine-grained policy consists of API-based permissions for operations on specific resource types. Fine-grained policies, as the name suggests, allow for more fine-grained control than RBAC policies. Users granted permissions of such a policy can only perform specific operations on the corresponding service. Fine-grained policies include system and custom policies.
- Statement: Permissions defined by a policy, including Effect and Action.
- Effect
The valid values for Effect are Allow and Deny. System policies contain only Allow statements. For custom policies containing both Allow and Deny statements, the Deny statements take precedence.
- Action
Permissions in the format of Service name:Resource type:Operation. A policy can contain one or more permissions. The wildcard (*) is allowed to indicate all of the services, resource types, or operations depending on its location in the action.
Example: dws:cluster:create, permissions for create data warehouse clusters.
- Effect
List of Supported Actions
When creating a custom policy on IAM, you can add the operations on GaussDB(DWS) resources or the permissions corresponding to RESTful APIs to the action list of the policy authorization statement so that the policy contains the operation permissions. The following table lists the GaussDB(DWS) permissions.
- REST API
For details about RESTful API actions supported by GaussDB(DWS), see "Permissions Policies and Supported Actions in " in Data Warehouse Service API Reference.
- Management console operations
Table 1 describes the GaussDB(DWS) operations on resources and corresponding permissions.
Some GaussDB(DWS) permissions depend on the actions of ECS, VPC, EVS, ELB, MRS, and OBS. Grant GaussDB(DWS) the required service admin permissions.
Operation |
Permission |
Dependent Permission |
Scope |
|---|---|---|---|
Creating a cluster |
"dws:cluster:create" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*", "vpc:*:get*", "vpc:*:list*", "vpc:*:create*", "vpc:securityGroupRules:delete", "vpc:ports:update", "evs:*:get*", "evs:*:list*", "evs:*:create*", |
|
Obtaining the cluster list |
"dws:cluster:list" |
-- |
|
Obtaining the details of a cluster |
"dws:cluster:getDetail" |
"dws:*:get*", "dws:*:list*", "vpc:vpcs:list", "vpc:securityGroups:get" |
|
Setting automated snapshot policy |
"dws:cluster:setAutomatedSnapshot" |
"dws:backupPolicy:list" |
|
Setting security parameters/parameter groups |
"dws:cluster:setSecuritySettings" |
"dws:*:get*", "dws:*:list*", |
|
Restarting a Cluster |
"dws:cluster:restart" |
"dws:*:get*", "dws:*:list*", |
|
Scaling out clusters |
"dws:cluster:scaleOut" |
"dws:*:get*", "dws:*:list*", "dws:cluster:scaleOutOrOpenAPIResize", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*", "vpc:*:get*", "vpc:*:list*", "vpc:*:create*", "vpc:*:update*", "evs:*:get*", "evs:*:list*", "evs:*:create*", |
|
Scaling out or resizing a cluster via API |
"dws:cluster:scaleOutOrOpenAPIResize" |
"dws:*:get*", "dws:*:list*", "vpc:vpcs:list", "vpc:ports:create", "vpc:ports:get", "vpc:ports:update", "vpc:subnets:get", "vpc:subnets:update", "vpc:subnets:create", "vpc:routers:get", "vpc:routers:update", "vpc:networks:create", "vpc:networks:get", "vpc:networks:update", "ecs:serverInterfaces:use", "ecs:serverInterfaces:get", "ecs:cloudServerFlavors:get" |
|
Resetting Your Password |
"dws:cluster:resetPassword" |
"dws:*:get*", "dws:*:list*", |
|
Deleting a cluster |
"dws:cluster:delete" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:delete*", "vpc:*:get*", "vpc:*:list*", "vpc:*:delete*", "evs:*:get*", "evs:*:list*", "evs:*:delete*", |
|
Configuring maintenance windows |
"dws:cluster:setMaintainceWindow" |
"dws:*:get*", "dws:*:list*", |
|
Binding EIPs |
"dws:eip:operate" |
"dws:*:get*", "dws:*:list*", "eip:*:get*", "eip:*:list*" |
|
Unbinding EIPs |
"dws:eip:operate" |
"dws:*:get*", "dws:*:list*", "eip:*:get*", "eip:*:list*" |
|
MRS data source list |
"dws:MRSSource:list" |
"mrs:cluster:list", "mrs:tag:listResource", "mrs:tag:list", "dws:*:get*", "dws:*:list*" |
|
Adding/Deleting tags |
"dws:tag:addAndDelete" |
"dws:*:get*", "dws:*:list*", "dws:openAPITag:update", "dws:openAPITag:getResourceTag", |
|
Editing tags |
"dws:tag:edit" |
"dws:*:get*", "dws:*:list*", "dws:openAPITag:update", "dws:openAPITag:getResourceTag", |
|
Creating a snapshot |
"dws:snapshot:create" |
"dws:*:get*", "dws:*:list*", |
|
Obtaining the snapshot list |
"dws:snapshot:list" |
-- |
|
Viewing the snapshot list of a cluster |
"dws:clusterSnapshot:list" |
"dws:cluster:list", "dws:openAPICluster:getDetail" |
|
Deleting snapshots |
"dws:snapshot:delete" |
"dws:snapshot:list" |
|
Copying snapshots |
"dws:snapshot:copy" |
"dws:snapshot:list", "dws:snapshot:create" |
|
Restoring data to a new cluster |
"dws:cluster:restore" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*", "vpc:*:get*", "vpc:*:list*", "vpc:*:create*", "evs:*:get*", "evs:*:list*", "evs:*:create*" |
|
Resizing a cluster |
"dws:cluster:resize" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*", "ecs:*:delete*", "vpc:*:get*", "vpc:*:list*", "vpc:*:create*", "vpc:*:delete*", "evs:*:get*", "evs:*:list*", "evs:*:create*", "evs:*:delete*" |
|
Switchback |
"dws:cluster:switchover" |
"dws:*:get*", "dws:*:list*" |
|
Querying the ELB list |
"dws:elb:list" |
"dws:*:get*", "dws:*:list*", "elb:*:get*", "elb:*:list*", |
|
Associating ELB |
"dws:elb:bind" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "vpc:*:get*", "vpc:*:list*", "evs:*:get*", "evs:*:list*", "elb:*:get*", "elb:*:list*", "elb:*:delete*", "elb:*:create*", |
|
Disassociating ELB |
"dws:elb:unbind" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "vpc:*:get*", "vpc:*:list*", "evs:*:get*", "evs:*:list*", "elb:*:get*", "elb:*:list*", "elb:*:delete*", |
|
Querying snapshot configurations |
"dws:snapshotConfig:list" |
"dws:*:get*", "dws:*:list*", |
|
Updating a snapshot policy |
"dws:backupPolicyDetail:update" |
"dws:*:get*", "dws:*:list*", |
|
Deleting a snapshot policy |
"dws:backupPolicy:delete" |
"dws:*:get*", "dws:*:list*", |
|
Querying a snapshot policy |
"dws:backupPolicy:list" |
"dws:cluster:list" |
|
Querying cluster encryption information |
"dws:clusterEncryptInfo:list" |
"dws:*:get*", "dws:*:list*", "KMS Administrator" |
|
Creating an agent |
"dws:createAgency:create" |
"dws:*:get*", "dws:*:list*", "security administrator" |
|
Querying OBS bucket information |
"dws:queryBuckets:list" |
"dws:*:get*", "dws:*:list*", |
|
Adding a node |
"dws:expandWithExistedNodes:update" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*", "vpc:*:get*", "vpc:*:list*", "vpc:*:create*", "vpc:*:update*", "evs:*:get*", "evs:*:list*", "evs:*:create*", |
|
Deleting a DR backup |
"dws:disasterRecovery:delete" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:delete*", "vpc:*:get*", "vpc:*:list*", "vpc:*:delete*", "evs:*:get*", "evs:*:list*", "evs:*:delete*" |
|
Creating a DR backup |
"dws:disasterRecovery:create" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*", "vpc:*:get*", "vpc:*:list*", "vpc:*:create*", "evs:*:get*", "evs:*:list*", "evs:*:create*", |
|
Other DR and backup operations |
"dws:disasterRecovery:otherOperate" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*", "vpc:*:get*", "vpc:*:list*", "vpc:*:create*", "evs:*:get*", "evs:*:list*", "evs:*:create*" |
|
Querying DR and backup operations |
"dws:disasterRecovery:get" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "vpc:*:get*", "vpc:*:list*", "evs:*:get*", "evs:*:list*" |
|
Adding a CN |
"dws:module:install" |
"dws:*:get*", "dws:*:list*", |
|
Deleting a CN |
"dws:module:uninstall" |
"dws:*:get*", "dws:*:list*", |
|
Removing nodes |
"dws:clusterNodes:operate" |
"dws:*:get*", "dws:*:list*" |
|
Updating the node alias |
dws:instanceAliasName:update |
dws:cluster:list |
|
Redistributing data |
"dws:redistribution:operate" |
"dws:*:get*", "dws:*:list*", |
|
Querying redistribution |
"dws:redistributionInfo:list" |
"dws:*:get*", "dws:*:list*", |
|
Stopping redistribution |
"dws:redistribution:suspend" |
"dws:*:get*", "dws:*:list*", |
|
Resuming redistribution |
"dws:redistribution:recover" |
"dws:*:get*", "dws:*:list*", |
|
Querying product specifications |
"dws:specProduct:list" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*" |
|
Binding the management plane IP address |
"dws:bindManageIp:operate" |
"dws:*:get*", "dws:*:list*" |
|
Obtaining user authorization |
"dws:checkAuthorize:operate" |
"dws:*:get*", "dws:*:list*", "dws:checkSupport:operate" |
|
Authorizing a user |
"dws:authorize:operate" |
"dws:*:get*", "dws:*:list*", "dws:checkSupport:operate" |
|
Querying user databases |
"dws:userDatabase:list" |
"dws:*:get*", "dws:*:list*", "dws:checkSupport:operate" |
|
Querying user schemas |
"dws:schemas:list" |
"dws:*:get*", "dws:*:list*", "dws:checkSupport:operate" |
|
Querying user tables |
"dws:tables:list" |
"dws:*:get*", "dws:*:list*", |
|
Restoring tables |
"dws:tableRestore:operate" |
"dws:*:get*", "dws:*:list*", |
|
Checking the name of the table to be restored |
"dws:tableRestoreCheck:operate" |
"dws:*:get*", "dws:*:list*", |
|
Checking whether a cluster supports fine-grained backup |
"dws:checkSupport:operate" |
"dws:*:get*", "dws:*:list*", |
|
Querying the list of flavors that can be changed |
"dws:supportFlavors:list" |
"dws:*:get*", "dws:*:list*", |
|
Changing the node flavor |
"dws:specResize:operate" |
"dws:*:get*", "dws:*:list*", "ecs:*:get*", "ecs:*:list*", "ecs:*:create*" |
|
Stopping snapshot creation |
"dws:snapshot:stop" |
"dws:snapshot:list" |
|
Terminating a session |
"dws:dmsSession:terminate" |
"dws:dmsGrpcOuter:operation" |
|
Workload report operations |
"dws:dmsWorkloadDiagnosisReport:create" |
"dws:dmsGrpcOuter:operation" |
|
Modifying an alarm rule |
"dws:dmsAlarmRule:update" |
"dws:dmsQuery:list" |
|
Enabling an alarm rule |
"dws:dmsAlarmRule:enable" |
"dws:dmsQuery:list" |
|
Enabling a cluster alarm |
"dws:dmsClusterAlarm:enable" |
"dws:dmsQuery:list" |
|
Disabling a cluster alarm |
"dws:dmsClusterAlarm:disable" |
"dws:dmsQuery:list" |
|
gRPC external service |
"dws:dmsGrpcOuter:operation" |
"dws:dmsQuery:list", "dws:cluster:setSecuritySettings", "obs:bucket:ListAllMyBuckets" |
|
Adding a SQL probe |
"dws:dmsProbe:add" |
"dws:dmsGrpcOuter:operation" |
|
Modifying a SQL probe |
"dws:dmsProbe:update" |
"dws:dmsGrpcOuter:operation" |
|
Deleting a SQL probe |
"dws:dmsProbe:delete" |
"dws:dmsGrpcOuter:operation" |
|
Enabling or disabling a SQL probe |
"dws:dmsProbe:enable" |
"dws:dmsGrpcOuter:operation" |
|
Creating a User panel |
"dws:dmsUserBoard:create" |
"dws:dmsQuery:list" |
|
Modifying a user panel |
"dws:dmsUserBoard:update" |
"dws:dmsQuery:list" |
|
Deleting a user panel |
"dws:dmsUserBoard:delete" |
"dws:dmsQuery:list" |
|
Terminating a query |
"dws:dmsQuery:terminate" |
"dws:dmsGrpcOuter:operation" |
|
Enabling or disabling DMS |
"dws:dmsService:enableOrDisable" |
"dws:dmsQuery:list" |
|
Modifying DMS storage configurations |
"dws:dmsStorageConfig:modify" |
"dws:dmsQuery:list" |
|
Obtaining, or creating a DDL review |
"dws:dmsDdlExamine:getOrCreate" |
"dws:dmsGrpcOuter:operation" |
|
Workload snapshot operations |
"dws:dmsWorkloadDiagnosisSnapshot:create" |
"dws:dmsGrpcOuter:operation" |
|
Creating an alarm rule |
"dws:dmsAlarmRule:add" |
"dws:dmsQuery:list" |
|
Deleting an alarm rule |
"dws:dmsAlarmRule:delete" |
"dws:dmsQuery:list" |
|
Executing a SQL probe |
"dws:dmsProbe:execute" |
"dws:dmsGrpcOuter:operation" |
|
Deleting a monitoring item |
"dws:dmsPerformanceMonitor:delete" |
"dws:dmsQuery:list" |
|
Enabling or disabling DMS monitoring metrics |
"dws:dmsCollectItem:enableOrDisable" |
"dws:dmsGrpcOuter:operation" |
|
Modifying DMS monitoring configurations |
"dws:dmsCollectConfig:modify" |
"dws:dmsGrpcOuter:operation" |
|
OpenAPI Conditional Query |
"dws:dmsOpenapiQuery:list" |
"dws:cluster:list" |
|
Disabling an alarm rule |
"dws:dmsAlarmRule:disable" |
"dws:dmsQuery:list" |
|
Deleting an alarm record |
"dws:dmsAlarmRecord:delete" |
"dws:dmsQuery:list" |
|
Checking SQL probes |
"dws:dmsProbe:check" |
"dws:dmsGrpcOuter:operation" |
|
Adding a monitoring item |
"dws:dmsPerformanceMonitor:add" |
"dws:dmsQuery:list" |
|
Modifying monitoring metrics |
"dws:dmsPerformanceMonitor:update" |
"dws:dmsQuery:list" |
|
Downloading historical monitoring trend |
"dws:dmsTrendHistory:down" |
"dws:dmsQuery:list" |
|
Obtaining cluster ring information |
"dws:ring:list" |
"dws:*:get*", "dws:*:list*" |
|
Obtaining the cluster process topology |
"dws:processTopo:list" |
"dws:*:get*", "dws:*:list*" |
|
Querying intelligent O&M information |
"dws:operationalTask:get" |
"dws:*:get*", "dws:*:list*" |
|
Intelligent O&M Operations |
"dws:operationalTask:operate" |
"dws:*:get*", "dws:*:list*" |
|
Creating an endpoint service |
"dws:vpcEndpointService:create" |
"dws:*:get*", "dws:*:list*" |
|
Querying the resource management list |
"dws:workLoadManager:get" |
"dws:*:get*", "dws:*:list*" |
|
Resource management operations |
"dws:workLoadManager:operate" |
"dws:*:get*", "dws:*:list*" |
|
LTS operations |
"dws:ltsAccess:operate" |
"dws:*:get*", "dws:*:list*" |
|
Querying LTS Information |
"dws:ltsAccess:get" |
"dws:*:get*", "dws:*:list*" |
|
Querying events |
"dws:event:list" |
"dws:*:get*", "dws:*:list*" |
|
Querying event specifications |
"dws:event:list" |
"dws:*:get*", "dws:*:list*" |
|
Querying event subscriptions |
"dws:eventSub:list" |
"dws:*:get*", "dws:*:list*" |
|
Creating an event subscription |
"dws:eventSub:create" |
"dws:*:get*", "dws:*:list*", |
|
Updating an event subscription |
"dws:eventSub:update" |
"dws:*:get*", "dws:*:list*" |
|
Deleting an event subscription |
"dws:eventSub:delete" |
"dws:*:get*", "dws:*:list*" |
|
Querying alarm statistics |
"dws:alarmStatistic:list" |
"dws:*:get*", "dws:*:list*" |
|
Querying alarm details |
"dws:alarmDetail:list" |
"dws:*:get*", "dws:*:list*" |
|
Querying alarm configurations |
"dws:alarmConfig:list" |
"dws:*:get*", "dws:*:list*" |
|
Querying alarm subscriptions |
"dws:alarmSub:list" |
"dws:*:get*", "dws:*:list*" |
|
Creating an alarm subscription |
"dws:alarmSub:create" |
"dws:*:get*", "dws:*:list*", |
|
Updating an alarm subscription |
"dws:alarmSub:update" |
"dws:*:get*", "dws:*:list*" |
|
Deleting an alarm subscription |
"dws:alarmSub:delete" |
"dws:*:get*", "dws:*:list*" |
|
Delivering cluster upgrade operations (upgrade, rollback, submission, and retry) |
"dws:cluster:doUpdate" |
"dws:*:get*", "dws:*:list*" |
|
Querying the available upgrade paths of a cluster |
"dws:cluster:getUpgradePaths" |
"dws:*:get*", "dws:*:list*" |
|
Querying cluster upgrade records |
"dws:cluster:getUpgradeRecords" |
"dws:*:get*", "dws:*:list*" |
|
Authorization Using the Fine-Grained Permission Policy
- Log in to the IAM console and create a custom policy.
For details, see "Fine-Grained Policy Management > Creating a Custom Policy" in the Identity and Access Management User Guide.
Refer to the following to create the policy:
- Use the IAM administrator account, that is, the user in the admin user group, because only the IAM administrator has the permissions to create users and user groups and modify user group permissions.
- GaussDB(DWS) is a project-level service, so its Scope must be set to Project-level services. If this policy is required to take effect for multiple projects, authorization is required to each project.
- Two GaussDB(DWS) policy templates are preconfigured on IAM. When creating a custom policy, you can select either of the following templates and modify the policy authorization statement based on the template:
- DWS Admin: has all execution permissions on GaussDB(DWS).
- DWS Viewer: has the read-only permission on GaussDB(DWS).
- You can add permissions corresponding to GaussDB(DWS) operations or RESTful APIs listed in List of Supported Actions to the action list in the policy authorization statement, so that the policy can obtain the permissions.
For example, if dws:cluster:create is added to the action list of a policy statement, the policy has the permission to create or restore clusters.
- If you want to use other services, grant related operation permissions on these services. For details, see the help documents of related services.
For example, when creating a data warehouse cluster, you need to configure the VPC to which the cluster belongs. To obtain the VPC list, add permission vpc:*:get* to the policy statement.
- Create a user group.
For details, see "User and User Group Management > Viewing or Modifying User Group Information > Creating a User Group" in the Identity and Access Management User Guide.
- Add users to the user group and grant the new custom policy to the user group so that users in it can obtain the permissions defined by the policy.
For details, see "User and User Group Management > Viewing or Modifying User Group Information" in the Identity and Access Management User Guide.
Authentication Logic
If a user is granted permissions of multiple policies or of only one policy containing both Allow and Deny statements, then authentication starts from the Deny statements. The following figure shows the authentication logic for resource access.
The actions in each policy bear the OR relationship.
- A user accesses the system and makes an operation request.
- The system evaluates all the permissions policies assigned to the user.
- In these policies, the system looks for explicit deny permissions. If the system finds an explicit deny that applies, it returns a decision of Deny, and the authentication ends.
- If no explicit deny is found, the system looks for allow permissions that would apply to the request. If the system finds an explicit allow permission that applies, it returns a decision of Allow, and the authentication ends.
- If no explicit allow permission is found, IAM returns a decision of Deny, and the authentication ends.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
