RAM authorization - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

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 ApsaraDB for ClickHouse for RAM permission policies. The RAM code (RamCode) for ApsaraDB for ClickHouse is clickhouse , 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 ApsaraDB for ClickHouse. 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
clickhouse:ModifyDBClusterMaintainTime	ModifyDBClusterMaintainTime	update	All Resource ``	None	None
clickhouse:DescribeActiveOperationTasks	DescribeActiveOperationTasks	get	All Resource ``	None	None
clickhouse:ModifyAutoRenewAttribute	ModifyAutoRenewAttribute	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:TransferVersion	TransferVersion	create	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CreateServiceLinkedRole	CreateServiceLinkedRole	create	All Resource ``	None	None
clickhouse:DescribeAccountAuthority	DescribeAccountAuthority	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyDBClusterConfig	ModifyDBClusterConfig	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeAllDataSource	DescribeAllDataSource	get	All Resource ``	None	None
clickhouse:CancelActiveOperationTasks	CancelActiveOperationTasks	none	All Resource ``	None	None
clickhouse:ResetAccountPassword	ResetAccountPassword	update	All Resource ``	None	None
clickhouse:DescribeConfigVersionDifference	DescribeConfigVersionDifference	get	All Resource ``	None	None
clickhouse:ModifyDBClusterConfigInXML	ModifyDBClusterConfigInXML	update	All Resource ``	None	None
clickhouse:CheckServiceLinkedRole	CheckServiceLinkedRole	get	All Resource ``	None	None
clickhouse:DeleteSyndb	DeleteSyndb	delete	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeSlowLogTrend	DescribeSlowLogTrend	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyDBClusterDescription	ModifyDBClusterDescription	update	All Resource ``	None	None
clickhouse:DescribeUserEncryptionKeyList	DescribeUserEncryptionKeyList	get	All Resource ``	None	None
clickhouse:DescribeDBConfig	DescribeDBConfig	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DeleteDBCluster	DeleteDBCluster	delete	All Resource ``	None	None
clickhouse:CreateAccountAndAuthority	CreateAccountAndAuthority	create	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}`	None	None
clickhouse:CancelRestartInstance	CancelRestartInstance	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:RestartInstanceNodeList	RestartInstanceNodeList	update	All Resource ``	None	None
clickhouse:DescribeSchemas	DescribeSchemas	get	All Resource ``	None	None
clickhouse:DeleteSLB	DeleteSLB	delete	All Resource ``	None	None
clickhouse:DescribeDBClusterPerformance	DescribeDBClusterPerformance	get	All Resource ``	None	None
clickhouse:DescribeDBClusters	DescribeDBClusters	get	All Resource ``	None	None
clickhouse:ModifyBackupPolicy	ModifyBackupPolicy	update	All Resource ``	None	None
clickhouse:TagResources	TagResources	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeDBClusterAttribute	DescribeDBClusterAttribute	get	All Resource ``	None	None
clickhouse:CreateOSSStorage	CreateOSSStorage	create	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeBackups	DescribeBackups	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeSynDbs	DescribeSynDbs	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyActiveOperationMaintainConf	ModifyActiveOperationMaintainConf	none	All Resource ``	None	None
clickhouse:DescribeDBClusterNetInfoItems	DescribeDBClusterNetInfoItems	get	All Resource ``	None	None
clickhouse:CreateSLB	CreateSLB	create	All Resource ``	None	None
clickhouse:ModifyAccountAuthority	ModifyAccountAuthority	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeOSSStorage	DescribeOSSStorage	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CreateSQLAccount	CreateSQLAccount	create	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CreateRDSToClickhouseDb	CreateRDSToClickhouseDb	create	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeTransferHistory	DescribeTransferHistory	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CheckMonitorAlert	CheckMonitorAlert	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyMinorVersionGreadeType	ModifyMinorVersionGreadeType	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeColumns	DescribeColumns	get	All Resource ``	None	None
clickhouse:UpgradeMinorVersion	UpgradeMinorVersion	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CheckScaleOutBalanced	CheckScaleOutBalanced	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeAllDataSources	DescribeAllDataSources	get	All Resource ``	None	None
clickhouse:CreateMonitorDataReport	CreateMonitorDataReport	create	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeDBClusterAccessWhiteList	DescribeDBClusterAccessWhiteList	get	All Resource ``	None	None
clickhouse:ModifyRDSToClickhouseDb	ModifyRDSToClickhouseDb	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeAccounts	DescribeAccounts	get	All Resource ``	None	None
clickhouse:CreateDBInstance	CreateDBInstance	create	All Resource ``	None	None
clickhouse:DeleteAccount	DeleteAccount	delete	All Resource ``	None	None
clickhouse:ModifyDBCluster	ModifyDBCluster	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeConfigHistory	DescribeConfigHistory	get	All Resource ``	None	None
clickhouse:AllocateClusterPublicConnection	AllocateClusterPublicConnection	update	All Resource ``	None	None
clickhouse:DescribeBackupPolicy	DescribeBackupPolicy	get	All Resource ``	None	None
clickhouse:DescribeProcessList	DescribeProcessList	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CreateAccount	CreateAccount	create	All Resource ``	None	None
clickhouse:DescribeSlowLogRecords	DescribeSlowLogRecords	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyDBConfig	ModifyDBConfig	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyDBClusterAccessWhiteList	ModifyDBClusterAccessWhiteList	update	All Resource ``	None	None
clickhouse:DeleteBackupPolicy	DeleteBackupPolicy	delete	All Resource ``	None	None
clickhouse:DescribeAutoRenewAttribute	DescribeAutoRenewAttribute	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeDBClusterNodeInfos	DescribeDBClusterNodeInfos	get	All Resource ``	None	None
clickhouse:DescribeActiveOperationMaintainConf	DescribeActiveOperationMaintainConf	get	All Resource ``	None	None
clickhouse:KillProcess	KillProcess	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeDBClusterConfig	DescribeDBClusterConfig	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyActiveOperationTasks	ModifyActiveOperationTasks	update	All Resource ``	None	None
clickhouse:RestartInstance	RestartInstance	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ModifyAccountDescription	ModifyAccountDescription	update	All Resource ``	None	None
clickhouse:DescribeDBClusterConfigInXML	DescribeDBClusterConfigInXML	get	All Resource ``	None	None
clickhouse:DescribeTables	DescribeTables	get	All Resource ``	None	None
clickhouse:ListTagResources	ListTagResources	list	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:ReleaseClusterPublicConnection	ReleaseClusterPublicConnection	update	All Resource ``	None	None
clickhouse:CreatePortsForClickHouse	CreatePortsForClickHouse	create	All Resource ``	None	None
clickhouse:UntagResources	UntagResources	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CheckModifyConfigNeedRestart	CheckModifyConfigNeedRestart	get	All Resource ``	None	None
clickhouse:ChangeResourceGroup	ChangeResourceGroup	update	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CheckClickhouseToRDS	CheckClickhouseToRDS	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:DescribeSynDbTables	DescribeSynDbTables	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	None	None
clickhouse:CreateBackupPolicy	CreateBackupPolicy	create	All Resource ``	None	None

Resource

The following table lists the resources defined by ApsaraDB for ClickHouse. 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
DBCluster	acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} acs:clickhouse:{#regionId}:{#accountId}:dbcluster/*

Condition

ApsaraDB for ClickHouse 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: