GetInstanceAcl API Overview for RocketMQ ACL Inspection - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Queries the access control list (ACL) details of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. 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 supports 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 Alibaba Cloud Resource Name (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 applicable across all RAM-supported services.
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

Access level

Resource type

Condition key

Dependent action

rocketmq:GetInstanceAcl

get

*Acl

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

GET /instances/{instanceId}/acl/account/{username} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-7e22ody****
username	string	Yes	The username.	abc

Request parameters

Parameter	Type	Required	Description	Example
resourceType	string	Yes	The resource type on which you want to grant permissions. Valid values: Group Topic Valid values: Group : 消费者组 Topic : 主题	Topic
resourceName	string	Yes	The resource name on which you want to grant permissions.	test

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
aclType	string	The authentication type of the instance. Valid values: apache_acl: open source access control list (ACL) default: the default account of the instance	apache_acl
username	string	The username.	abc
resourceType	string	The resource type on which permissions are granted.	Topic
resourceName	string	The resource name on which permissions are granted.	test
decision	string	The authorization decision.	Allow
actions	array	The operations that can be performed on the resource.
	string	The operation that can be performed on the resource.	Pub
ipWhitelists	array	The IP address whitelists.
	string	The IP address whitelist. IP addresses and CIDR blocks are supported.	0.0.0.0/0
code	string	The error code.	MissingInstanceId
message	string	The error message.	The instance cannot be found.
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	xxx
dynamicMessage	string	The dynamic error message.	xxx

Examples

Success response

JSON format

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "aclType": "apache_acl",
    "username": "abc",
    "resourceType": "Topic",
    "resourceName": "test",
    "decision": "Allow",
    "actions": [
      "Pub"
    ],
    "ipWhitelists": [
      "0.0.0.0/0"
    ]
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "xxx",
  "dynamicMessage": "xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.