RAM authorization - ApsaraMQ for RabbitMQ - 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 RAM permission policies. The RAM code (RamCode) for ApsaraMQ is amqp , 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. 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
amqp:DeleteStaticAccount	DeleteAccount	delete	All Resource ``	None	amqp:GetInstance
amqp:GetInstance	ListBindings	list	All Resource ``	None	amqp:ListQueue amqp:ListExchange
amqp:GetExchange	DeleteBinding	delete	Queue `acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}/vhosts/{#VirtualHostName}/queues/`	None	amqp:CreateExchange amqp:CreateQueue amqp:GetVhost
amqp:DeleteExchange	DeleteExchange	delete	*Exchange `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/exchanges/{#exchangeName}`	None	amqp:GetVhost
amqp:ListQueue	ListQueues	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:GetInstance
amqp:CreateVhost	CreateVirtualHost	create	VirtualHost `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/`	None	None
amqp:UpdateInstance	UpdateInstance	update	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	amqp:InstanceType amqp:SupportEIP amqp:ServerlessChargeType	None
amqp:UpdateInstance	UpdateInstanceName	update	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:GetInstance
amqp:GetInstance	GetInstance	get	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}`	None	None
amqp:CreateExchange	CreateExchange	create	Exchange `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/exchanges/`	None	amqp:GetVhost
amqp:GetInstance	GetMetadataAmount	get	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	None
amqp:ListStaticAccounts	ListAccounts	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:GetInstance
amqp:DeleteQueue	DeleteQueue	delete	*Queue `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/queues/{#queueName}`	None	None
amqp:DeleteVhost	DeleteVirtualHost	delete	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}`	None	amqp:GetVhost amqp:GetInstance
amqp:GetInstance	ListDownStreamBindings	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:ListExchange amqp:ListQueue
amqp:GetInstance	ListExchanges	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:ListExchange
amqp:ListVhost	ListVirtualHosts	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:GetInstance
amqp:CreateInstance	CreateInstance	create	All Resource ``	amqp:InstanceType amqp:SupportEIP amqp:ServerlessChargeType	None
amqp:ListInstance	ListInstances	list	All Resource ``	None	None
amqp:CreateQueue	CreateQueue	create	Queue `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/queues/`	None	None
amqp:GetInstance	ListExchangeUpStreamBindings	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:ListExchange amqp:ListQueue
amqp:GetExchange	CreateBinding	create	Queue `acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}/vhosts/{#vhostName}/queues/`	None	amqp:CreateExchange amqp:CreateQueue amqp:GetVhost
amqp:GetInstance	ListQueueUpStreamBindings	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}`	None	amqp:ListQueue amqp:ListExchange
amqp:GetQueue	ListQueueConsumers	list	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:GetInstance
amqp:FetchStaticAccount	CreateAccount	create	*Instance `acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}`	None	amqp:GetInstance

Resource

The following table lists the resources defined by ApsaraMQ. 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:amqp:{#regionId}:{#accountId}:/instance/{#InstanceId} acs:amqp:{#regionId}:{#accountId}:instance/{#InstanceId} acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId} acs:amqp:{#regionId}:{#accountId}:/instances/*
Queue	acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}/vhosts/{#VirtualHostName}/queues/* acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/queues/{#queueName} acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/queues/*
Exchange	acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/exchanges/{#exchangeName} acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/{#vhostName}/exchanges/*
VirtualHost	acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/*

Condition

The following table lists the product-level condition keys defined by ApsaraMQ. 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
amqp:InstanceType	The primary edition of the instance	String
amqp:SupportEIP	whether to enable the Internet access feature	String
amqp:ServerlessChargeType	Serverless instance billing type	String

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: