RAM authorization - ApsaraDB for ClickHouse

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 ClickHouse. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate ClickHouse is clickhouse. You can grant permissions on ClickHouse 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

ClickHouse 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
clickhouse:DeleteAccount	DeleteAccount	delete	All Resources *	None	None
clickhouse:DescribeDBClusterNetInfoItems	DescribeDBClusterNetInfoItems	get	All Resources *	None	None
clickhouse:DescribeDBClusters	DescribeDBClusters	get	All Resources *	None	None
clickhouse:DescribeDBClusterAttribute	DescribeDBClusterAttribute	get	All Resources *	None	None
clickhouse:ModifyDBClusterMaintainTime	ModifyDBClusterMaintainTime	update	All Resources *	None	None
clickhouse:DeleteDBCluster	DeleteDBCluster	delete	All Resources *	None	None
clickhouse:CreateAccount	CreateAccount	create	All Resources *	None	None
clickhouse:DescribeDBClusterAccessWhiteList	DescribeDBClusterAccessWhiteList	get	All Resources *	None	None
clickhouse:ReleaseClusterPublicConnection	ReleaseClusterPublicConnection	WRITE	All Resources *	None	None
clickhouse:ModifyDBClusterDescription	ModifyDBClusterDescription	update	All Resources *	None	None
clickhouse:ResetAccountPassword	ResetAccountPassword	WRITE	All Resources *	None	None
clickhouse:AllocateClusterPublicConnection	AllocateClusterPublicConnection	WRITE	All Resources *	None	None

Resource

ClickHouse 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
DBCluster	acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

Condition

ClickHouse does not define service-specific condition keys. For more information about common condition keys that are defined by Alibaba Cloud, see Generic Condition Keyword.

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: