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. 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 RocketMQ. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate RocketMQ is [{"popCode":"RocketMQ","ramCodes":["rocketmq"]}]. You can grant permissions on RocketMQ 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

RocketMQ 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
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:DeleteInstance	DeleteInstance	delete	Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
rocketmq:UpdateInstance	UpdateInstance	update	Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
rocketmq:ResetConsumeOffset	ResetConsumeOffset	update	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}	None	None
rocketmq:DeleteTopic	DeleteTopic	delete	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:CreateInstance	CreateInstance	create	Instance acs:rocketmq:{#regionId}:{#accountId}:Instance/*	None	None
rocketmq:GetConsumerGroup	GetConsumerGroup	get	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:UpdateConsumerGroup	UpdateConsumerGroup	update	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}	None	None
rocketmq:ChangeResourceGroup	ChangeResourceGroup	update	Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
rocketmq:ListConsumerGroups	ListConsumerGroups	list	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*	None	None
rocketmq:ListConsumerGroupSubscriptions	ListConsumerGroupSubscriptions	list	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}	None	None
rocketmq:ListTopics	ListTopics	list	Topic acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*	None	None
rocketmq:ListTopicSubscriptions	ListTopicSubscriptions	list	Topic acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}	None	None
rocketmq:UpdateTopic	UpdateTopic	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:ListConsumerConnections	ListConsumerConnections	list	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}	None	None
rocketmq:ListInstances	ListInstances	list	Instance acs:rocketmq:{#regionId}:{#accountId}:instance/*	None	None

Resource

RocketMQ 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
Topic	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}
Instance	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}
Instance	acs:rocketmq:{#regionId}:{#accountId}:instance/*
ConsumerGroup	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}
Instance	acs:rocketmq:{#regionId}:{#accountId}:*
Instance	acs:rocketmq:{#regionId}:{#accountId}:Instance/*
ConsumerGroup	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*
Instance	acs:rocketmq::{#accountId}:
Topic	acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*

Condition

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