All Products
Search
Document Center

ApsaraMQ for RocketMQ:RAM authorization

Last Updated:Aug 01, 2024
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 Ons. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate Ons is mq. You can grant permissions on Ons 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

Ons 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.
ActionsAPI operationAccess levelResource typeCondition keyAssociated operation
mq:DeleteGroupOnsGroupDeleteWrite
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:QueryTrendTopicInputTpsOnsTrendTopicInputTpsget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:ResetConsumerOffsetOnsConsumerResetOffsetget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:ListTagResourcesListTagResourcesget
All Resources
*
NoneNone
mq:DeleteInstanceOnsInstanceDeleteWrite
Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
NoneNone
mq:QueryDLQMessageOnsDLQMessagePageQueryByGroupIdget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:QueryMessageTraceOnsMessageTraceget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:QueryTopicStatusOnsTopicStatusget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:QueryGroupSubDetailOnsGroupSubDetailget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:QueryMessageOnsMessageGetByKeyget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:QueryMessageDetailOnsMessageDetailget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:QueryTopicSubDetailOnsTopicSubDetailget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:DeleteTopicOnsTopicDeleteWrite
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:QueryConsumerTimeSpanOnsConsumerTimeSpanget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:TagResourcesTagResourcesupdate
All Resources
*
NoneNone
mq:QueryInstanceBaseInfoOnsInstanceBaseInfoget
Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
NoneNone
mq:ListGroupOnsGroupListlist
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
NoneNone
mq:QueryConsumerAccumulateOnsConsumerAccumulateget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:ListTopicOnsTopicListlist
Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
NoneNone
mq:ResendDLQMessageOnsDLQMessageResendByIdget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:QueryConsumerConnectionOnsConsumerGetConnectionget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:CreateGroupOnsGroupCreateWrite
Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
NoneNone
mq:UpdateGroupConsumerOnsGroupConsumerUpdateWrite
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:QueryMessageOnsMessageGetByMsgIdget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:UpdateInstanceOnsInstanceUpdateWrite
Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
NoneNone
mq:QueryTraceOnsTraceQueryByMsgIdget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:CreateTopicOnsTopicCreateWrite
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:SUBOnsMessagePushget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:QueryConsumerStatusOnsConsumerStatusget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:QueryTraceOnsTraceQueryByMsgKeyget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:CreateInstanceOnsInstanceCreateWrite
All Resources
*
NoneNone
mq:QueryInstanceBaseInfoOnsInstanceInServiceListlist
Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
NoneNone
mq:QueryTrendGroupOutputTpsOnsTrendGroupOutputTpsget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone
mq:GetTraceResultOnsTraceGetResult
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
NoneNone
mq:UntagResourcesUntagResourcesget
All Resources
*
NoneNone
mq:QueryMessageOnsMessagePageQueryByTopicget
Topic
acs:mq:{#regionId}:{#accountId}:{#TopicName}
Topic
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
NoneNone
mq:QueryDLQMessageOnsDLQMessageGetByIdget
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
NoneNone

Resource

Ons 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 typeARN
Groupacs:mq:{#regionId}:{#accountId}:{#InstanceId}
Groupacs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
Topicacs:mq:{#regionId}:{#accountId}:{#TopicName}
Topicacs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
Instanceacs:mq:{#regionId}:{#accountId}:{#InstanceId}
Groupacs:mq:{#regionId}:{#accountId}:{#GroupName}
Instanceacs:mq:{#regionId}:{#accountId}:*

Condition

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