RAM authorization - ApsaraDB for MongoDB

Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. You can use RAM to prevent RAM users from sharing the AccessKey pairs of your Alibaba Cloud account. You can also use RAM to grant minimum permissions to RAM users. RAM uses policies to define permissions.

This topic describes the elements, such as Action, Resource, and Condition, which are defined by MongoDB. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate MongoDB is dds. You can grant permissions on MongoDB at the RESOURCE.

General structure of a policy

Policies can be stored as JSON files. The following code provides an example on the general structure of a policy:

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "<Effect>",
      "Action": "<Action>",
      "Resource": "<Resource>",
      "Condition": {
        "<Condition_operator>": {
          "<Condition_key>": [
            "<Condition_value>"
          ]
        }
      }
    }
  ]
}

The following list describes the fields in the policy:

Effect: specifies the authorization effect. Valid values: Allow, Deny.
Action: specifies one or more API operations that are allowed or denied. For more information, see the Action section of this topic.
Resource: specifies one or more resources to which the policy applies. You can use an Alibaba Cloud Resource Name (ARN) to specify a resource. For more information, see the Resource section of this topic.
Condition: specifies one or more conditions that are required for the policy to take effect. This is an optional field. For more information, see the Condition section of this topic.
- Condition_operator: specifies the conditional operators. Different types of conditions support different conditional operators. For more information, see Policy elements.
- Condition_key: specifies the condition keys.
- Condition_value: specifies the condition values.

Action

MongoDB defines the values that you can use in the Action element of a policy statement. The following table describes the values.

Operation: the value that you can use in the Action element to specify the operation on a resource.
API operation: the API operation that you can call to perform the operation.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition key: the condition keys that are defined by the Alibaba Cloud service. The Condition key column does not list the common condition keys that are defined by Alibaba Cloud. For more information about the common condition keys, see Generic Condition Keyword.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Actions	API operation	Access level	Resource type	Condition key	Associated operation
dds:ReleaseNodePrivateNetworkAddress	ReleaseNodePrivateNetworkAddress	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:DescribeMongoDBLogConfig	DescribeMongoDBLogConfig	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeAccounts	DescribeAccounts	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyTaskInfo	ModifyTaskInfo	update	All Resources *	None	None
dds:CheckRecoveryCondition	CheckRecoveryCondition	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:CreateAccount	CreateAccount	create	DBInstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:DescribeParameters	DescribeParameters	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeUserEncryptionKeyList	DescribeUserEncryptionKeyList	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeSecurityIps	DescribeSecurityIps	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeBackupTasks	DescribeBackupTasks	none	All Resources *	None	None
dds:DescribeAuditRecords	DescribeAuditRecords	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DeleteGlobalSecurityIPGroup	DeleteGlobalSecurityIPGroup	delete	All Resources *	None	None
dds:CreateShardingDBInstance	CreateShardingDBInstance	create	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/*	None	None
dds:DescribeSlowLogRecords	DescribeSlowLogRecords	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyResourceGroup	ModifyResourceGroup	update	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceNetworkType	ModifyDBInstanceNetworkType	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:AllocateNodePrivateNetworkAddress	AllocateNodePrivateNetworkAddress	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:UpgradeDBInstanceEngineVersion	UpgradeDBInstanceEngineVersion	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DestroyInstance	DestroyInstance	delete	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeBackupDBs	DescribeBackupDBs	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyGlobalSecurityIPGroupRelation	ModifyGlobalSecurityIPGroupRelation	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeReplicaSetRole	DescribeReplicaSetRole	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyNodeSpec	ModifyNodeSpec	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeAvailableResource	DescribeAvailableResource	get	All Resources *	None	None
dds:ModifySecurityGroupConfiguration	ModifySecurityGroupConfiguration	update	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeInstanceRecoverTime	DescribeInstanceRecoverTime	none	All Resources *	None	None
dds:DescribeHistoryTasks	DescribeHistoryTasks	list	All Resources *	None	None
dds:DeleteDBInstance	DeleteDBInstance	delete	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeClusterBackups	DescribeClusterBackups	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:DescribeTags	DescribeTags	get	All Resources *	None	None
dds:TransformToPrePaid	TransformToPrePaid	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:CreateDBInstance	CreateDBInstance	create	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/*	None	None
dds:ModifyDBInstanceMonitor	ModifyDBInstanceMonitor	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstanceEncryptionKey	DescribeDBInstanceEncryptionKey	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeRenewalPrice	DescribeRenewalPrice	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DeleteNode	DeleteNode	delete	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifySecurityIps	ModifySecurityIps	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeActiveOperationTaskType	DescribeActiveOperationTaskType	get	All Resources *	None	None
dds:SwitchDBInstanceHA	SwitchDBInstanceHA	none	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeRunningLogRecords	DescribeRunningLogRecords	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:CreateBackup	CreateBackup	create	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ReleasePublicNetworkAddress	ReleasePublicNetworkAddress	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:DescribeBackupStorage	DescribeBackupStorage	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:ModifyNodeSpecBatch	ModifyNodeSpecBatch	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstances	DescribeDBInstances	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/* Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstanceMonitor	DescribeDBInstanceMonitor	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:AllocatePublicNetworkAddress	AllocatePublicNetworkAddress	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:RenewDBInstance	RenewDBInstance	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceMaintainTime	ModifyDBInstanceMaintainTime	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeAvailabilityZones	DescribeAvailabilityZones	list	All Resources *	None	None
dds:CreateNodeBatch	CreateNodeBatch	create	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:DescribeKmsKeys	DescribeKmsKeys	get	All Resources *	None	None
dds:CheckCloudResourceAuthorized	CheckCloudResourceAuthorized	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeRoleZoneInfo	DescribeRoleZoneInfo	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstanceTDEInfo	DescribeDBInstanceTDEInfo	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeActiveOperationTaskCount	DescribeActiveOperationTaskCount	get	All Resources *	None	None
dds:DescribeActiveOperationTasks	DescribeActiveOperationTasks	list	All Resources *	None	None
dds:CreateGlobalSecurityIPGroup	CreateGlobalSecurityIPGroup	create	All Resources *	None	None
dds:CreateNode	CreateNode	create	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:MigrateToOtherZone	MigrateToOtherZone	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:DescribeErrorLogRecords	DescribeErrorLogRecords	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceConnectionString	ModifyDBInstanceConnectionString	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceDescription	ModifyDBInstanceDescription	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:TagResources	TagResources	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstancePerformance	DescribeDBInstancePerformance	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	dds:ResourceTag	None
dds:ModifyDBInstanceDiskType	ModifyDBInstanceDiskType	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeInstanceAutoRenewalAttribute	DescribeInstanceAutoRenewalAttribute	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeParameterModificationHistory	DescribeParameterModificationHistory	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceSpec	ModifyDBInstanceSpec	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyAuditLogFilter	ModifyAuditLogFilter	update	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceSSL	ModifyDBInstanceSSL	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:EvaluateResource	EvaluateResource	none	All Resources *	None	None
dds:ResetAccountPassword	ResetAccountPassword	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:RestartDBInstance	RestartDBInstance	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceTDE	ModifyDBInstanceTDE	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeGlobalSecurityIPGroupRelation	DescribeGlobalSecurityIPGroupRelation	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeBackupPolicy	DescribeBackupPolicy	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeAuditPolicy	DescribeAuditPolicy	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyAccountDescription	ModifyAccountDescription	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstanceSSL	DescribeDBInstanceSSL	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstanceSwitchLog	DescribeDBInstanceSwitchLog	list	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:ModifyBackupPolicy	ModifyBackupPolicy	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeSecurityGroupConfiguration	DescribeSecurityGroupConfiguration	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeBackups	DescribeBackups	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyDBInstanceNetExpireTime	ModifyDBInstanceNetExpireTime	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:TransferClusterBackup	TransferClusterBackup	none	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribePrice	DescribePrice	get	All Resources *	None	None
dds:DescribeHistoryTasksStat	DescribeHistoryTasksStat	list	All Resources *	None	None
dds:DescribeAvailableEngineVersion	DescribeAvailableEngineVersion	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyActiveOperationTasks	ModifyActiveOperationTasks	Write	All Resources *	None	None
dds:ModifyGlobalSecurityIPGroupName	ModifyGlobalSecurityIPGroupName	update	All Resources *	None	None
dds:TransformInstanceChargeType	TransformInstanceChargeType	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	None	None
dds:DescribeGlobalSecurityIPGroup	DescribeGlobalSecurityIPGroup	list	All Resources *	None	None
dds:ListTagResources	ListTagResources	get	All Resources *	None	None
dds:ModifyInstanceAutoRenewalAttribute	ModifyInstanceAutoRenewalAttribute	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeAuditLogFilter	DescribeAuditLogFilter	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:UntagResources	UntagResources	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:MigrateAvailableZone	MigrateAvailableZone	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeClusterRecoverTime	DescribeClusterRecoverTime	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyGlobalSecurityIPGroup	ModifyGlobalSecurityIPGroup	update	All Resources *	None	None
dds:DescribeDBInstancesOverview	DescribeDBInstancesOverview	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/*	None	None
dds:ModifyInstanceVpcAuthMode	ModifyInstanceVpcAuthMode	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyParameters	ModifyParameters	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:UpgradeDBInstanceKernelVersion	UpgradeDBInstanceKernelVersion	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeShardingNetworkAddress	DescribeShardingNetworkAddress	get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:ModifyAuditPolicy	ModifyAuditPolicy	update	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None
dds:DescribeDBInstanceAttribute	DescribeDBInstanceAttribute	get	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	None	None

Resource

MongoDB defines the values that you can use in the Resource. You can attach the policy to a RAM user or a RAM role so that the RAM user or the RAM role can perform a specific operation on a specific resource. The ARN is the unique identifier of the resource on Alibaba Cloud. Take note of the following items:

{#}indicates a variable. {#} must be replaced with an actual value. For example, {#ramcode} must be replaced with the actual code of an Alibaba Cloud service in RAM.
An asterisk (*) is used as a wildcard. Examples:
- {#resourceType} is set to *, all resources are specified.
- {#regionId} is set to *, all regions are specified.
- {#accountId} is set to *, all Alibaba Cloud accounts are specified.

Resource type	ARN
dbinstance	acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
Instance	acs:dds:{#regionId}:{#accountId}:instance/{#InstanceId}
Instance	acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
Instance	acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstance}
Instance	acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
DBInstance	acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
Instance	acs:mongodb:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
Instance	acs:dds:{#regionId}:{#accountId}:dbinstance/*
dbinstance	acs:dds:{#regionId}:{#accountId}:dbinstance/*
DBInstance	acs:dds:{#regionId}:{#accountId}:dbinstance/*
Instance	acs:dds:{#regionId}:{#accountId}:instance/*
Instance	acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceid}

Condition

MongoDB defines the values that you can use in the Condition element of a policy statement. The following table describes the values. The following table describes the service-specific condition keys. The common condition keys that are defined by Alibaba Cloud also apply to MongoDB. For more information about the common condition keys, see Generic Condition Keyword.

The data type determines the conditional operators that you can use to compare the value in a request with the value in a policy statement. You must use conditional operators that are supported by the data type. Otherwise, you cannot compare the value in the request with the value in the policy statement. In this case, the authorization is invalid. For more information about the conditional operators that are supported by each data type, see Policy elements.

Condition key	Description	Data type
acs:ResourceTag	Tag authentication	STRING

What to do next

You can create a custom policy and attach the policy to a RAM user, RAM user group, or RAM role. For more information, see the following topics: