RAM authorization - ApsaraMQ for RocketMQ - 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 RocketMQ for RAM permission policies. The RAM code (RamCode) for ApsaraMQ for RocketMQ is rocketmq , 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 RocketMQ. 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
rocketmq:GetConsumerGroup	GetConsumerGroup	get	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:GetInstanceIpWhitelist	GetInstanceIpWhitelist	get	*IpWhitelist `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:ListInstanceIpWhitelist	ListInstanceIpWhitelist	list	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:DeleteDisasterRecoveryPlan	DeleteDisasterRecoveryPlan	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:ListMessages	ListMessages	list	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:DeleteDisasterRecoveryItem	DeleteDisasterRecoveryItem	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:AddDisasterRecoveryItem	AddDisasterRecoveryItem	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:CreateTopic	CreateTopic	create	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:ListInstanceAcl	ListInstanceAcl	list	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:ListTraces	ListTraces	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:CreateInstance	CreateInstance	create	Instance `acs:rocketmq:{#regionId}:{#accountId}:Instance/`	None	None
rocketmq:ResetConsumeOffset	ResetConsumeOffset	update	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:VerifySendMessage	VerifySendMessage	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:ListInstanceAccount	ListInstanceAccount	list	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:UpdateDisasterRecoveryItem	UpdateDisasterRecoveryItem	update	*DisasterRecoveryItem `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:ListDisasterRecoveryItems	ListDisasterRecoveryItems	get	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:CreateInstanceIpWhitelist	CreateInstanceIpWhitelist	create	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:StartDisasterRecoveryItem	StartDisasterRecoveryItem	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:ListDisasterRecoveryCheckpoints	ListDisasterRecoveryCheckpoints	list	All Resource ``	None	None
rocketmq:CreateDisasterRecoveryPlan	CreateDisasterRecoveryPlan	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:DeleteConsumerGroupSubscription	DeleteConsumerGroupSubscription	delete	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:ListMigrations	ListMigrations	list	All Resource ``	None	None
rocketmq:TagResources	TagResources	update	All Resource ``	None	None
rocketmq:ListTagResources	ListTagResources	list	All Resource ``	None	None
rocketmq:DeleteInstanceAcl	DeleteInstanceAcl	delete	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:VerifyConsumeMessage	VerifyConsumeMessage	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:ListTopicSubscriptions	ListTopicSubscriptions	list	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:GetConsumerStack	GetConsumerStack	get	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:ListMetricMeta	ListMetricMeta	list	All Resource ``	None	None
rocketmq:GetConsumeTimespan	GetConsumeTimespan	get	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:GetConsumerGroupLag	GetConsumerGroupLag	get	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:DeleteInstance	DeleteInstance	delete	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:UntagResources	UntagResources	update	All Resource ``	None	None
rocketmq:ListTopics	ListTopics	list	Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/`	None	None
rocketmq:ListConsumerConnections	ListConsumerConnections	list	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:DeleteInstanceIpWhitelist	DeleteInstanceIpWhitelist	delete	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:UpdateInstanceAcl	UpdateInstanceAcl	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:GetDisasterRecoveryPlan	GetDisasterRecoveryPlan	get	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:GetConsumerGroupSubscription	GetConsumerGroupSubscription	get	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:GetInstance	GetInstance	get	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:CreateConsumerGroup	CreateConsumerGroup	create	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:UpdateInstanceAccount	UpdateInstanceAccount	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:ChangeResourceGroup	ChangeResourceGroup	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:GetInstanceAcl	GetInstanceAcl	get	*Acl `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:UpdateInstance	UpdateInstance	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:StopDisasterRecoveryItem	StopDisasterRecoveryItem	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:DeleteInstanceAccount	DeleteInstanceAccount	delete	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:UpdateConsumerGroup	UpdateConsumerGroup	update	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:GetTopic	GetTopic	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:ListMigrationOperations	ListMigrationOperations	list	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:UpdateTopic	UpdateTopic	update	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:SyncDisasterRecoveryCheckpoint	SyncDisasterRecoveryCheckpoint	update	All Resource ``	None	None
rocketmq:GetInstanceAccount	GetInstanceAccount	get	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:ListConsumerGroupSubscriptions	ListConsumerGroupSubscriptions	list	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:CreateInstanceAcl	CreateInstanceAcl	create	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:DeleteTopic	DeleteTopic	delete	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:UpdateDisasterRecoveryPlan	UpdateDisasterRecoveryPlan	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:FinishMigrationStage	FinishMigrationStage	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:GetDisasterRecoveryItem	GetDisasterRecoveryItem	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:DeleteConsumerGroup	DeleteConsumerGroup	delete	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	None	None
rocketmq:ListDisasterRecoveryPlans	ListDisasterRecoveryPlans	get	All Resource ``	None	None
rocketmq:ExecuteMigrationOperation	ExecuteMigrationOperation	update	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:ListInstances	ListInstances	list	Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/`	None	None
rocketmq:GetTrace	GetTrace	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:GetMessageDetail	GetMessageDetail	get	*Topic `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}`	None	None
rocketmq:CreateInstanceAccount	CreateInstanceAccount	create	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	None	None
rocketmq:ListConsumerGroups	ListConsumerGroups	list	ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/`	None	None

Resource

The following table lists the resources defined by ApsaraMQ for RocketMQ. 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
ConsumerGroup	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId} acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId} acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*
IpWhitelist	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}
Instance	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId} acs:rocketmq:{#regionId}:{#accountId}:Instance/* acs:rocketmq::{#accountId}: acs:rocketmq:{#regionId}:{#accountId}:instance/* acs:rocketmq:{#regionId}:{#accountId}:*
Topic	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName} acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*
DisasterRecoveryItem	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}
Acl	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

Condition

ApsaraMQ for RocketMQ 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: