RAM authorization - ApsaraMQ for Kafka - 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 ApsaraMQ for Kafka for RAM permission policies. The RAM code (RamCode) for ApsaraMQ for Kafka is alikafka , 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 ApsaraMQ for Kafka. 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
alikafka:ReleaseInstance	ReleaseInstance	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:DeleteGroup	DeleteConsumerGroup	delete	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateTopic	ModifyTopicRemark	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListGroup	GetConsumerProgress	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListTopic	GetTopicList	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:StartInstance	StartInstance	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	alikafka:DeployModule alikafka:SpecType alikafka:Acl alikafka:DiskEncryption	None
alikafka:UpgradePostPayOrder	UpgradePostPayOrder	update	All Resource ``	alikafka:DeployModule	None
alikafka:ListTopic	GetTopicStatus	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ChangeResourceGroup	ChangeResourceGroup	update	All Resource ``	None	None
alikafka:UpdateInstance	UpdateAllowedIp	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:CreatePrePayOrder	CreatePrePayOrder	create	All Resource ``	alikafka:SpecType alikafka:DeployModule	None
alikafka:UpdateInstanceReopen	ReopenInstance	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:CreatePrePayInstance	CreatePrePayInstance	create	All Resource ``	alikafka:SpecType alikafka:DeployModule	None
alikafka:CreateGroup	CreateConsumerGroup	create	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateInstance	DeleteScheduledScalingRule	delete	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateInstance	ModifyInstanceName	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ReleaseInstance	StopInstance	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListSaslUser	DescribeAclResourceName	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UntagResources	UntagResources	update	All Resource ``	None	None
alikafka:UpdateTopic	UpdateTopicConfig	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListGroup	GetConsumerList	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateTopic	ModifyPartitionNum	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateInstance	UpgradeInstanceVersion	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListInstance	GetAllInstanceIdList	get	All Resource ``	None	None
alikafka:DeleteSaslUser	DeleteSaslUser	delete	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:TagResources	TagResources	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListKafkaClientIp	GetKafkaClientIp	get	All Resource ``	None	None
alikafka:ListAcl	DescribeAcls	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpgradePrePayOrder	UpgradePrePayOrder	update	All Resource ``	alikafka:DeployModule	None
alikafka:ListInstance	GetAutoScalingConfiguration	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListTagResources	ListTagResources	get	All Resource ``	None	None
alikafka:UpdateInstanceUpdateAutoCreateGroupStatus	EnableAutoGroupCreation	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:DeleteAcl	DeleteAcl	delete	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListTopic	GetTopicSubscribeStatus	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateInstance	CreateScheduledScalingRule	create	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ReleaseInstance	DeleteInstance	delete	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateInstance	ModifyScheduledScalingRule	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:CreateSaslUser	CreateSaslUser	create	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:CreatePostPayInstance	CreatePostPayInstance	create	All Resource ``	alikafka:DeployModule alikafka:SpecType	None
alikafka:UpdateInstance	UpdateInstanceConfig	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListSaslUser	DescribeSaslUsers	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateInstance	EnableAutoTopicCreation	update	All Resource ``	None	None
alikafka:QueryMessage	QueryMessage	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:CreateAcl	CreateAcl	create	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListInstance	GetInstanceList	get	All Resource ``	None	None
alikafka:CreatePostPayOrder	CreatePostPayOrder	create	All Resource ``	alikafka:DeployModule alikafka:SpecType	None
alikafka:ListInstance	GetAllowedIpList	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ConvertPostPayOrder	ConvertPostPayOrder	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListRisk	GetRiskList	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:DeleteTopic	DeleteTopic	delete	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:CreateTopic	CreateTopic	create	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListGroup	ListRebalanceInfo	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:UpdateGroup	UpdateConsumerOffset	update	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None
alikafka:ListTopic	GetQuotaTip	get	*Instance `acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}`	None	None

Resource

The following table lists the resources defined by ApsaraMQ for Kafka. 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:alikafka:{#regionId}:{#accountId}:{#InstanceId} acs:alikafka:{#regionId}:{#accountId}:instance/{#InstanceId} acs:alikafka:{#regionId}:{#accountId}:* acs:alikafka:{#regionId}:{#accountId}:instance/*

Condition

The following table lists the product-level condition keys defined by ApsaraMQ for Kafka. 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
alikafka:DeployModule	The deployment mode of the instance	String
alikafka:SpecType	The edition of the instance	String
alikafka:Acl	Whether to enable ACL	Boolean
alikafka:DiskEncryption	Whether to enable Disk Encryption	Boolean

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: