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 mq , 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
Actionelement 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
Resourceelement of the policy.For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement 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 |
| mq:ListTagResources | ListTagResources | get |
*All Resource
|
None |
mq:QueryInstanceBaseInfo |
| mq:QueryConsumerStatus | OnsConsumerStatus | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:GetTraceResult | OnsTraceGetResult | get |
*Topic
*Topic
|
None |
mq:QueryInstanceBaseInfo |
| mq:UpdateGroupConsumer | OnsGroupConsumerUpdate |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
|
| mq:ListGroup | OnsGroupList | list |
Group
|
None |
mq:QueryInstanceBaseInfo |
| mq:CreateGroup | OnsGroupCreate | create |
*Instance
|
None |
mq:QueryInstanceBaseInfo |
| mq:QueryMessageTrace | OnsMessageTrace | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:DeleteInstance | OnsInstanceDelete |
*Instance
|
None |
mq:QueryInstanceBaseInfo |
|
| mq:QueryInstanceBaseInfo | OnsInstanceInServiceList | list |
Instance
|
None | None |
| mq:QueryTopicSubDetail | OnsTopicSubDetail | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryMessage | OnsMessageGetByKey | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryConsumerTimeSpan | OnsConsumerTimeSpan | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:ResetConsumerOffset | OnsConsumerResetOffset | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryMessage | OnsMessagePageQueryByTopic | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryTrendGroupOutputTps | OnsTrendGroupOutputTps | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryGroupSubDetail | OnsGroupSubDetail | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryTrendTopicInputTps | OnsTrendTopicInputTps | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryInstanceBaseInfo | OnsInstanceBaseInfo | get |
*Instance
|
None | None |
| mq:ResendDLQMessage | OnsDLQMessageResendById | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:UpdateTopic | OnsTopicUpdate |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
|
| mq:UpdateInstance | OnsInstanceUpdate |
*Instance
|
None |
mq:QueryInstanceBaseInfo |
|
| mq:SUB | OnsMessagePush | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryTrace | OnsTraceQueryByMsgKey | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryDLQMessage | OnsDLQMessageGetById | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryTopicStatus | OnsTopicStatus | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryDLQMessage | OnsDLQMessagePageQueryByGroupId | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryMessageDetail | OnsMessageDetail | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:UntagResources | UntagResources | get |
*All Resource
|
None |
mq:QueryInstanceBaseInfo |
| mq:QueryMessage | OnsMessageGetByMsgId | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:QueryConsumerAccumulate | OnsConsumerAccumulate | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:ListTopic | OnsTopicList | list |
Instance
|
None |
mq:QueryInstanceBaseInfo |
| mq:QueryTrace | OnsTraceQueryByMsgId | get |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
| mq:TagResources | TagResources | update |
*All Resource
|
None |
mq:QueryInstanceBaseInfo |
| mq:CreateInstance | OnsInstanceCreate | create |
*All Resource
|
None | None |
| mq:CreateTopic | OnsTopicCreate |
*Topic
*Topic
|
None |
mq:QueryInstanceBaseInfo |
|
| mq:DeleteTopic | OnsTopicDelete |
Topic
Topic
|
None |
mq:OnsInstanceBaseInfo |
|
| mq:QueryConsumerConnection | OnsConsumerGetConnection | get |
Group
Group
|
None |
mq:OnsInstanceBaseInfo |
| mq:DeleteGroup | OnsGroupDelete | delete |
*Group
*Group
|
None |
mq:QueryInstanceBaseInfo |
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 |
| Group |
|
| Topic |
|
| Instance |
|
Condition
ApsaraMQ 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: