Distributed Message Service for RocketMQ (RocketMQ)
IAM provides system-defined identity policies to define common actions supported by cloud services. You can also create custom identity policies using the actions supported by cloud services for more refined access control.
In addition to IAM, the Organizations service also provides Service Control Policies (SCPs) to set access control policies.
SCPs do not actually grant any permissions to an entity. They only set the permissions boundary for the entity. When SCPs are attached to an organizational unit (OU) or a member account, the SCPs do not directly grant permissions to that OU or member account. Instead, the SCPs only determine what permissions are available for that member account or those member accounts under that OU. The granted permissions can be applied only if they are allowed by the SCPs.
To learn more about how IAM is different from Organizations for access control, see How IAM Is Different from Organizations for Access Control?.
This section describes the elements used by IAM custom identity policies and Organizations SCPs. The elements include actions, resources, and conditions.
- For details about how to use these elements to edit an IAM custom identity policy, see Creating a Custom Identity Policy.
- For details about how to use these elements to edit a custom SCP, see Creating an SCP.
Actions
Actions are specific operations that are allowed or denied in an identity policy.
- The Access Level column describes how the action is classified (List, Read, or Write). This classification helps you understand the level of access that an action grants when you use it in an identity policy.
- The Resource Type column indicates whether the action supports resource-level permissions.
- You can use a wildcard (*) to indicate all resource types. If this column is empty (-), the action does not support resource-level permissions and you must specify all resources ("*") in your identity policy statements.
- If this column includes a resource type, you must specify the URN in the Resource element of your identity policy statements.
- Required resources are marked with asterisks (*) in the table. If you specify a resource in a statement using this action, then it must be of this type.
For details about the resource types defined by DMS for RocketMQ, see Resources.
- The Condition Key column contains keys that you can specify in the Condition element of an identity policy statement.
- If the Resource Type column has values for an action, the condition key takes effect only for the listed resource types.
- If the Resource Type column is empty (-) for an action, the condition key takes effect for all resources that action supports.
- If the Condition Key column is empty (-) for an action, the action does not support any condition keys.
For details about the condition keys defined by DMS for RocketMQ, see Conditions.
- The Alias column lists the policy actions that are configured in identity policies. With these actions, you can use APIs for policy-based authorization. For details, see Policies and Identity Policies.
The following table lists the actions that you can define in identity policy statements for DMS for RocketMQ.
|
Action |
Description |
Access Level |
Resource Type (*: required) |
Condition Key |
Alias |
|---|---|---|---|---|---|
|
dms:instance:list |
Grants permission to query instance list. |
List |
rocketmq * |
- |
|
|
dms:instance:create |
Grants permission to create instance. |
Write |
rocketmq * |
- |
|
|
dms:instance:update |
Grants permission to modify instance. |
Write |
rocketmq * |
dms:instance:modify |
|
|
dms:instance:getDetail |
Grants permission to query instance detail information. |
Read |
rocketmq * |
dms:instance:get |
|
|
dms:instance:modifyConfig |
Grants permission to modify instance config. |
Write |
rocketmq |
- |
|
|
dms:instance:delete |
Grants permission to delete instance. |
Write |
rocketmq |
- |
|
|
dms:message:export |
Grants permission to export messages. |
Write |
rocketmq |
dms:instance:modify |
|
|
topic |
- |
||||
|
dms:message:get |
Grants permission to query message detail. |
Read |
rocketmq |
dms:instance:get |
|
|
topic |
- |
||||
|
dms:message:getTrace |
Grants permission to query message trace. |
Read |
rocketmq |
dms:instance:get |
|
|
dms:message:send |
Grants permission to send message. |
Write |
rocketmq |
dms:instance:modify |
|
|
dms:topic:list |
Grants permission to query topic list. |
List |
rocketmq |
dms:instance:get |
|
|
topic * |
- |
||||
|
dms:topic:modify |
Grants permission to modify topics. |
Write |
rocketmq |
dms:instance:modify |
|
|
topic * |
- |
||||
|
dms:topic:create |
Grants permission to create topics. |
Write |
rocketmq |
dms:instance:modify |
|
|
topic |
- |
||||
|
dms:topic:delete |
Grants permission to delete topics. |
Write |
rocketmq |
dms:instance:modify |
|
|
topic * |
- |
||||
|
dms:topic:getAccessPolicy |
Grants permission to get topic access policy. |
Read |
rocketmq |
dms:instance:get |
|
|
topic * |
- |
||||
|
dms:topic:get |
Grants permission to query topic detail. |
Read |
rocketmq |
dms:instance:get |
|
|
topic * |
- |
||||
|
dms:user:list |
Grants permission to list users of instance. |
List |
rocketmq |
dms:instance:get |
|
|
dms:user:get |
Grants permission to get instance user's detailed information. |
Read |
rocketmq |
dms:instance:get |
|
|
dms:user:modify |
Grants permission to modify instance users. |
Write |
rocketmq |
dms:instance:modify |
|
|
dms:user:delete |
Grants permission to delete instance user. |
Write |
rocketmq |
dms:instance:modify |
|
|
dms:user:create |
Grants permission to create instance users. |
Write |
rocketmq |
dms:instance:modify |
|
|
dms:group:get |
Grants permission to get consumer group's detailed information. |
Read |
rocketmq |
dms:instance:get |
|
|
consumerGroup * |
- |
||||
|
dms:group:getAccessPolicy |
Grants permission to get the access policies for consumer group. |
Read |
rocketmq |
dms:instance:get |
|
|
consumerGroup * |
- |
||||
|
dms:group:resetConsumeOffset |
Grants permission to reset the consume offset of consumer group. |
Write |
rocketmq |
dms:instance:modify |
|
|
consumerGroup * |
- |
||||
|
dms:group:list |
Grants permission to list consumer groups. |
List |
rocketmq |
dms:instance:get |
|
|
consumerGroup * |
- |
||||
|
dms:group:modify |
Grants permission to modify consumer group. |
Write |
rocketmq |
dms:instance:modify |
|
|
consumerGroup * |
- |
||||
|
dms:group:create |
Grants permission to create consumer group. |
Write |
rocketmq |
dms:instance:modify |
|
|
consumerGroup * |
- |
||||
|
dms:group:delete |
Grants permission to delete consumer group. |
Write |
rocketmq |
dms:instance:modify |
|
|
consumerGroup * |
- |
||||
|
dms:broker:list |
Grants permission to list brokers of instance. |
List |
rocketmq |
dms:instance:get |
|
|
dms:instance:createMetadataMigrationTask |
Grants permission to create metadata migration task. |
Write |
rocketmq * |
- |
|
|
dms:instance:listMetadataMigrationTasks |
Grants permission to list metadata migration tasks. |
Write |
rocketmq * |
- |
|
|
dms:instance:deleteMetadataMigrationTask |
Grants permission to delete metadata migration task. |
Write |
rocketmq * |
- |
|
|
dms:instance:resendDlqMsg |
Grants permission to resend Dead-Letter Queue Message. |
Write |
rocketmq |
- |
Each API of DMS for RocketMQ usually supports one or more actions. Table 2 lists the supported actions and dependencies.
|
API |
Action |
Dependencies |
|---|---|---|
|
GET /v2/{engine}/{project_id}/instances/{instance_id}/messages |
dms:message:get |
- |
|
POST /v2/{project_id}/instances/{instance_id}/messages/export |
dms:message:export |
- |
|
POST /v2/{project_id}/instances/action |
dms:instance:delete |
- |
|
GET /v2/{project_id}/instances |
dms:instance:list |
- |
|
POST /v2/{project_id}/instances |
dms:instance:create |
|
|
GET /v2/{project_id}/instances/{instance_id} |
dms:instance:getDetail |
|
|
PUT /v2/{project_id}/instances/{instance_id} |
dms:instance:update |
|
|
DELETE /v2/{project_id}/instances/{instance_id} |
dms:instance:delete |
- |
|
GET /v2/{engine}/{project_id}/instances/{instance_id}/trace |
dms:message:getTrace |
- |
|
GET /v2/{project_id}/instances/{instance_id}/topics |
dms:topic:list |
- |
|
POST /v2/{project_id}/instances/{instance_id}/topics |
dms:topic:create |
dms:topic:delete |
|
GET /v2/{project_id}/instances/{instance_id}/users |
dms:user:list |
- |
|
POST /v2/{project_id}/instances/{instance_id}/users |
dms:user:create |
- |
|
GET /v2/{project_id}/instances/{instance_id}/users/{user_name} |
dms:user:get |
- |
|
DELETE /v2/{project_id}/instances/{instance_id}/users/{user_name} |
dms:user:delete |
- |
|
PUT /v2/{project_id}/instances/{instance_id}/users/{user_name} |
dms:user:modify |
- |
|
GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/accesspolicy |
dms:topic:getAccessPolicy |
- |
|
GET /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/accesspolicy |
dms:group:getAccessPolicy |
- |
|
GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/status |
dms:topic:get |
- |
|
GET /v2/{project_id}/instances/{instance_id}/topics/{topic}/groups |
dms:topic:get |
- |
|
GET /v2/{project_id}/instances/{instance_id}/groups/{group}/topics |
dms:group:get |
- |
|
POST /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset |
dms:group:resetConsumeOffset |
- |
|
GET /v2/{project_id}/instances/{instance_id}/brokers |
dms:broker:list |
- |
|
GET /v2/{project_id}/instances/{instance_id}/groups |
dms:group:list |
- |
|
PUT /v2/{project_id}/instances/{instance_id}/groups |
dms:group:modify |
- |
|
POST /v2/{project_id}/instances/{instance_id}/groups |
dms:group:create |
dms:group:delete |
|
GET /v2/{project_id}/instances/{instance_id}/groups/{group} |
dms:group:get |
- |
|
PUT /v2/{project_id}/instances/{instance_id}/groups/{group} |
dms:group:modify |
- |
|
DELETE /v2/{project_id}/instances/{instance_id}/groups/{group} |
dms:group:delete |
- |
|
GET /v2/{project_id}/instances/{instance_id}/topics/{topic} |
dms:topic:get |
- |
|
PUT /v2/{project_id}/instances/{instance_id}/topics/{topic} |
dms:topic:modify |
- |
|
DELETE /v2/{project_id}/instances/{instance_id}/topics/{topic} |
dms:topic:delete |
- |
|
POST /v2/{engine}/{project_id}/instances |
dms:instance:create |
|
|
POST /v2/{project_id}/rocketmq/{instance_id}/tags/action |
dms:instance:update |
- |
|
GET /v2/{project_id}/rocketmq/{instance_id}/tags |
dms:instance:getDetail |
- |
|
GET /v2/{project_id}/rocketmq/tags |
dms:instance:getDetail |
- |
|
GET /v2/rocketmq/{project_id}/instances/{instance_id}/groups/{group}/clients |
dms:group:get |
- |
|
POST /v2/{engine}/{project_id}/instances/{instance_id}/messages/deadletter-resend |
dms:instance:resendDlqMsg |
- |
|
POST /v2/{engine}/{project_id}/instances/{instance_id}/messages/resend |
dms:message:send |
- |
|
POST /v2/{project_id}/instances/{instance_id}/metadata |
dms:instance:createMetadataMigrationTask |
- |
|
GET /v2/{project_id}/instances/{instance_id}/metadata |
dms:instance:listMetadataMigrationTasks |
- |
|
DELETE /v2/{project_id}/instances/{instance_id}/metadata |
dms:instance:deleteMetadataMigrationTask |
- |
|
GET /v2/{project_id}/rocketmq/instances/{instance_id}/configs |
dms:instance:getDetail |
- |
|
PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configs |
dms:instance:modifyConfig |
- |
Resources
A resource type indicates the resources that an identity policy applies to. If you specify a resource type for any action in Table 3, the resource URN must be specified in the identity policy statements using that action, and the identity policy applies only to resources of this type. If no resource type is specified, the Resource element is marked with an asterisk (*) and the identity policy applies to all resources. You can also set condition keys in an identity policy to define resource types.
The following table lists the resource types that you can define in identity policy statements for DMS for RocketMQ.
Conditions
Condition Key Overview
A Condition element lets you specify conditions for when an identity policy is in effect. It contains condition keys and operators.
- The condition key that you specify can be a global condition key or a service-specific condition key.
- Global condition keys (with the g: prefix) apply to all actions. Cloud services do not need to provide user identity information. Instead, the system automatically obtains such information and authenticates users. For details, see Global Condition Keys.
- Service-specific condition keys (with the abbreviation of a service name plus a colon as the prefix, for example, dms for rocketmq) apply only to operations of the xx service. For details, see Table 4.
- The number of values associated with a condition key in the request context of an API call makes the condition key single-valued or multivalued. Single-valued condition keys have at most one value in the request context of an API call. Multivalued condition keys can have multiple values in the request context of an API call. For example, a request can originate from at most one VPC endpoint, so g:SourceVpce is a single-valued condition key. You can tag resources and include multiple tag key-value pairs in a request, so g:TagKeys is a multivalued condition key.
- A condition operator, condition key, and a condition value together constitute a complete condition statement. An identity policy can be applied only when its request conditions are met. For supported condition operators, see operators.
Service-specific condition keys supported by DMS for RocketMQ
The following table lists the condition keys that you can define in identity policies for DMS for RocketMQ. You can include these condition keys to specify conditions for when your identity policy is in effect.
|
Service-specific Condition Key |
Type |
Single-valued/Multivalued |
Description |
|---|---|---|---|
|
dms:ssl |
boolean |
Single-valued |
Filters access based on whether the instance is enabled for SSL access. |
|
dms:publicIp |
boolean |
Single-valued |
Filters access based on whether the instance is enabled for public IP access. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot