DocsICP FilingConsole
官方文档
首页

RAM authorization

更新时间：
复制 MD 格式
产品详情
我的收藏

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:DescribeDBInstanceAttribute DescribeDBInstanceAttribute get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeAccountAuthority DescribeAccountAuthority get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:StopDBInstance StopDBInstance update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeDBInstanceConfigChangeLog DescribeDBInstanceConfigChangeLog none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ModifySecurityIPList ModifySecurityIPList update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ModifyDBInstanceConnectionString ModifyDBInstanceConnectionString update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ResetAccountPassword ResetAccountPassword update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeDBInstanceDataSources DescribeDBInstanceDataSources get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:CreateDB CreateDB create

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ModifyAccountAuthority ModifyAccountAuthority update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ChangeResourceGroup ChangeResourceGroup update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:UpgradeMinorVersion UpgradeMinorVersion update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ListInstanceLinkedWhitelistTemplates ListInstanceLinkedWhitelistTemplates get

*All Resource

*

 None None
clickhouse:ListClickHouseDBTimezones ListClickHouseDBTimezones none

*All Resource

*

 None None
clickhouse:DeleteWhitelistTemplate DeleteWhitelistTemplate delete

*All Resource

*

 None None
clickhouse:DescribeSlowLogTrend DescribeSlowLogTrend none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ModifyBackupPolicy ModifyBackupPolicy none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DeleteEndpoint DeleteEndpoint delete

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DetachWhitelistTemplateToInstance DetachWhitelistTemplateToInstance update

*All Resource

*

 None None
clickhouse:DescribeAccounts DescribeAccounts list

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DeleteBackupPolicy DeleteBackupPolicy none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:KillProcess KillProcess none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ModifyDBInstanceClass ModifyDBInstanceClass update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ListWhitelistTemplates ListWhitelistTemplates get

*All Resource

*

 None None
clickhouse:CreateDBInstance CreateDBInstance create

*All Resource

*

 None None
clickhouse:DeleteDB DeleteDB delete

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeBackups DescribeBackups none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:CreateEndpoint CreateEndpoint create

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:RestartDBInstance RestartDBInstance update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeDBInstances DescribeDBInstances get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:StartDBInstance StartDBInstance update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeEndpoints DescribeEndpoints none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:CreateBackupPolicy CreateBackupPolicy none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeSlowLogRecords DescribeSlowLogRecords list

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeBackupPolicy DescribeBackupPolicy none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeRegions DescribeRegions get

*All Resource

*

 None None
clickhouse:CreateWhitelistTemplate CreateWhitelistTemplate create

*All Resource

*

 None None
clickhouse:ModifyAccountDescription ModifyAccountDescription update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeProcessList DescribeProcessList list

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeSecurityIPList DescribeSecurityIPList get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:GetWhitelistTemplate GetWhitelistTemplate get

*All Resource

*

 None None
clickhouse:ModifyDBInstanceAttribute ModifyDBInstanceAttribute update

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DescribeDBInstanceConfig DescribeDBInstanceConfig get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:ModifyDBInstanceConfig ModifyDBInstanceConfig none

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:AttachWhitelistTemplateToInstance AttachWhitelistTemplateToInstance update

*All Resource

*

 None None
clickhouse:CreateAccount CreateAccount create

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:DeleteAccount DeleteAccount delete

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 None None
clickhouse:UpdateWhitelistTemplate UpdateWhitelistTemplate update

*All Resource

*

 None None
clickhouse:DeleteDBInstance DeleteDBInstance delete

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

 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
EnterpriseDBCluster
  • acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

Condition

The following table lists the product-level condition keys defined by ApsaraDB for ClickHouse. You can also use Alibaba Cloud's Common condition keys. Specify these keys in the Condition element of RAM policy statements to define granular authorization rules. In the condition key, specify the condition values in the Condition_value element of the policy.

Each condition key has a specific data type, such as string, number, Boolean, or IP address. The data type determines which conditional operators can be used to compare the request values against policy values. You must specify the conditional operators compatible with the data type of the condition key. Mismatched operators will invalidate the policy. See Condition operator for valid combinations.

Condition key

Description

Data type
clickhouse:EncryptionType The encryption type. Array

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:

Previous：EndpointsNext：API change records