RAM authorization

Updated at:

Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. Using RAM helps you avoid sharing your Alibaba Cloud account keys with other users and allows you to grant users the least privilege access. RAM uses permission policies to define authorizations. This topic describes the general structure of a RAM policy, and the policy statement elements (Action, Resource, and Condition) defined by PolarDB-X for RAM permission policies. The RAM code (RamCode) for PolarDB-X is drds,polardbx , and the supported authorization granularity is RESOURCE .

General structure of a policy

Permission policies support JSON format with the following general structure:

{
  "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:

  • Version: Specifies the policy version number. It is fixed at 1.

  • Statement:

    • Effect: Specifies the authorization result. Valid values: Allow and Deny.

    • Action: Specifies one or more operations that are allowed or denied.

    • Resource: Specifies the specific objects affected by the operations. You can use Alibaba Cloud Resource Names (ARNs) to describe specific resources.

    • Condition: Specifies the conditions for the authorization to take effect. This field is optional.

      • Condition operator: Specifies the conditional operators. Different types of conditions support different conditional operators.

      • Condition_key: Specifies the condition keys.

      • Condition_value: Specifies the condition values.

Action

The following table lists the actions defined by PolarDB-X. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding ARN in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys that are applicable across all RAM-integrated services. For more information, see Common condition keys.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

API

Access level

Resource type

Condition key

Dependent action

drds:DescribeDrdsDbRdsNameList DescribeDrdsDbRdsNameList get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:SubmitCleanTask SubmitCleanTask

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:RemoveDrdsDbFailedRecord RemoveDrdsDbFailedRecord none

*All Resource

*

None None
drds:EnableSqlAudit EnableSqlAudit update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:ModifyDrdsInstanceDescription ModifyDrdsInstanceDescription update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:GetDrdsDbRdsRelationInfo GetDrdsDbRdsRelationInfo none

*All Resource

*

None None
drds:CreateDrdsDB CreateDrdsDB create

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeDrdsRdsInstances DescribeDrdsRdsInstances none

*All Resource

*

None None
drds:RemoveInstanceAccount RemoveInstanceAccount

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:ModifyDrdsIpWhiteList ModifyDrdsIpWhiteList update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}

None None
drds:CreateInstanceInternetAddress CreateInstanceInternetAddress create

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:ChangeInstanceAzone ChangeInstanceAzone none

*All Resource

*

None None
drds:ModifyRdsReadWeight ModifyRdsReadWeight update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeInstDbSlsInfo DescribeInstDbSlsInfo get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:CreateInstanceAccount CreateInstanceAccount create

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:CheckSqlAuditEnableStatus CheckSqlAuditEnableStatus none

*All Resource

*

None None
drds:CreateShardTask CreateShardTask create

*All Resource

*

None None
drds:DescribePreCheckResult DescribePreCheckResult get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeBroadcastTables DescribeBroadcastTables get

*All Resource

*

None None
drds:DescribeTables DescribeTables get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:RestartDrdsInstance RestartDrdsInstance none

*All Resource

*

None None
drds:FlashbackRecycleBinTable FlashbackRecycleBinTable none

*All Resource

*

None None
drds:PutStartBackup PutStartBackup none

*All Resource

*

None None
drds:DescribeDbInstanceDbs DescribeDbInstanceDbs get

*All Resource

*

None None
drds:DescribeDrdsInstanceDbMonitor DescribeDrdsInstanceDbMonitor get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:SubmitSmoothExpandPreCheck SubmitSmoothExpandPreCheck

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeRestoreOrder DescribeRestoreOrder get

*All Resource

*

None None
drds:SetBackupPolicy SetBackupPolicy update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeDrdsDbInstance DescribeDrdsDbInstance get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeDrdsInstanceLevelTasks DescribeDrdsInstanceLevelTasks get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeShardTaskInfo DescribeShardTaskInfo get

*All Resource

*

None None
drds:DescribeDrdsDBIpWhiteList DescribeDrdsDBIpWhiteList get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:CreateOrderForRds CreateOrderForRds create

*All Resource

*

None None
drds:DescribeDbInstances DescribeDbInstances get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId1}/*

None None
drds:ModifyPolarDbReadWeight ModifyPolarDbReadWeight none

*All Resource

*

None None
drds:SetupBroadcastTables SetupBroadcastTables update

*PolarDBXInstance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeSqlFlashbakTask DescribeSqlFlashbakTask get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeDrdsInstance DescribeDrdsInstance get

*All Resource

*

None None
drds:DescribeBackupPolicy DescribeBackupPolicy get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:UntagResources UntagResources delete

*All Resource

*

None None
drds:DescribeInstanceSwitchAzone DescribeInstanceSwitchAzone get

*All Resource

*

None None
drds:RefreshDrdsAtomUrl RefreshDrdsAtomUrl none

*All Resource

*

None None
drds:DescribeDrdsDB DescribeDrdsDB get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:SubmitSmoothExpandPreCheckTask SubmitSmoothExpandPreCheckTask none

*All Resource

*

None None
drds:RemoveBackupsSet RemoveBackupsSet none

*All Resource

*

None None
drds:UpdateResourceGroupAttribute UpdateResourceGroupAttribute update

*All Resource

*

None None
drds:CheckExpandStatus CheckExpandStatus

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:UpdatePrivateRdsClass UpdatePrivateRdsClass update

*All Resource

*

None None
drds:DescribeBackupTimes DescribeBackupTimes get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:RemoveRecycleBinTable RemoveRecycleBinTable none

*All Resource

*

None None
drds:StartRestore StartRestore update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}

None None
drds:DescribeDrdsShardingDbs DescribeDrdsShardingDbs get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeDrdsDBs DescribeDrdsDBs get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeTable DescribeTable get

*All Resource

*

None None
drds:SubmitHotExpandTask SubmitHotExpandTask none

*All Resource

*

None None
drds:SubmitSqlFlashbackTask SubmitSqlFlashbackTask

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeRecycleBinTables DescribeRecycleBinTables none

*All Resource

*

None None
drds:ModifyAccountPrivilege ModifyAccountPrivilege

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:CheckDrdsDbName CheckDrdsDbName

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeBackMenu DescribeBackMenu get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeDrdsTasks DescribeDrdsTasks get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeExpandLogicTableInfoList DescribeExpandLogicTableInfoList get

*All Resource

*

None None
drds:RemoveDrdsInstance RemoveDrdsInstance

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeDrdsInstanceVersion DescribeDrdsInstanceVersion get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeRDSPerformance DescribeRDSPerformance get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeBackupSets DescribeBackupSets get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeDrdsSqlAuditStatus DescribeDrdsSqlAuditStatus get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeInstanceAccounts DescribeInstanceAccounts get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeDrdsSlowSqls DescribeDrdsSlowSqls get

*All Resource

*

None None
drds:UpdateInstanceNetwork UpdateInstanceNetwork update

*All Resource

*

None None
drds:DescribeBackupDbs DescribeBackupDbs get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:EnableSqlFlashbackMatchSwitch EnableSqlFlashbackMatchSwitch update

*All Resource

*

None None
drds:ValidateShardTask ValidateShardTask none

*PolarDBXInstance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeDrdsInstanceMonitor DescribeDrdsInstanceMonitor get

*All Resource

*

None None
drds:CreateDrdsInstance CreateDrdsInstance create

*All Resource

*

None None
drds:ReleaseInstanceInternetAddress ReleaseInstanceInternetAddress

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:SwitchGlobalBroadcastType SwitchGlobalBroadcastType none

*All Resource

*

None None
drds:ManagePrivateRds ManagePrivateRds

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:EnableInstanceIpv6Address EnableInstanceIpv6Address none

*All Resource

*

None None
drds:SetupDrdsParams SetupDrdsParams update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:TagResources TagResources none

*All Resource

*

None None
drds:ListTagResources ListTagResources get

*All Resource

*

None None
drds:SetupRecycleBinStatus SetupRecycleBinStatus

*All Resource

*

None None
drds:ChangeAccountPassword ChangeAccountPassword none

*All Resource

*

None None
drds:DescribeTableListByType DescribeTableListByType get

*All Resource

*

None None
drds:SubmitHotExpandPreCheckTask SubmitHotExpandPreCheckTask none

*All Resource

*

None None
drds:DescribeDrdsDBCluster DescribeDrdsDBCluster get

*All Resource

*

None None
drds:DescribeRdsSuperAccountInstances DescribeRdsSuperAccountInstances get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:RemoveDrdsDb RemoveDrdsDb

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeDrdsParams DescribeDrdsParams get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeInstDbLogInfo DescribeInstDbLogInfo get

*All Resource

*

None None
drds:DescribeRecycleBinStatus DescribeRecycleBinStatus

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeInstanceSwitchNetwork DescribeInstanceSwitchNetwork get

*All Resource

*

None None
drds:RollbackInstanceVersion RollbackInstanceVersion none

*All Resource

*

None None
drds:UpgradeHiStoreInstance UpgradeHiStoreInstance none

*All Resource

*

None None
drds:DescribeDrdsDbInstances DescribeDrdsDbInstances get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:SetBackupLocal SetBackupLocal

*All Resource

*

None None
drds:DescribeRdsPerformanceSummary DescribeRdsPerformanceSummary get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeDrdsInstances DescribeDrdsInstances get

*All Resource

*

None None
drds:ModifyAccountDescription ModifyAccountDescription

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:SetupTable SetupTable update

*All Resource

*

None None
drds:DisableSqlAudit DisableSqlAudit update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None None
drds:DescribeRdsCommodity DescribeRdsCommodity get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeHotDbList DescribeHotDbList get

*All Resource

*

None None
drds:UpgradeInstanceVersion UpgradeInstanceVersion

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None
drds:DescribeBackupLocal DescribeBackupLocal

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None None

Resource

The following table lists the resources defined by PolarDB-X. Specify them in the Resource element of RAM policy statements to grant permissions for specific operations. They are uniquely identified by ARNs. Format: acs:{#ramcode}:{#regionId}:{#accountId}:{#resourceType}:

  • acs: The initialism of Alibaba Cloud service, which indicates the public cloud of Alibaba Cloud.

  • {#ramcode}: The code used in RAM to indicate an Alibaba Cloud service.

  • {#regionId}: The region ID. If the resource covers all regions, set it to an asterisk (*).

  • {#accountId}: The ID of the Alibaba Cloud account. If the resource covers all Alibaba Cloud accounts, set it to an asterisk (*).

  • {#resourceType}: The service-defined resource identifier. It supports a hierarchical structure, which is similar to a file path. If the statement covers global resources, set it to an asterisk (*).

Resource type

ARN

instance
  • acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}
  • acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*
  • acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}
  • acs:drds:{#regionId}:{#accountId}:instance/{#instanceId1}/*
  • acs:drds:{#regionId}:{#accountId}:instance/*
PolarDBXInstance
  • acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}
  • acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}
Instance
  • acs:drds:{#regionId}:{#accountId}:instance/*

Condition

PolarDB-X does not define product-level condition keys. However, you can use Alibaba Cloud common condition keys for access control. For more information, see Common condition keys.

How to create custom RAM policies?

You can create custom policies and grant them to RAM users, RAM user groups, or RAM roles. For instructions, see: