List Instance ACLs via ListInstanceAcl API for Access Control - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Queries the access control lists (ACLs) 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:ListInstanceAcl

list

*Instance

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

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	The page number. Pages start from page 1.	1
pageSize	integer	No	The number of entries per page.	10
filter	string	No	The filter condition for ACLs. If this parameter is not specified, all ACLs are returned.	CID-TEST

Response elements

Element	Type	Description	Example
	object	The result.
requestId	string	The request ID.	DA4D2F89-E2C8-5F04-936B-60D55B055FA7
success	boolean	Whether the request was successful.	true
data	object	The returned data.
pageNumber	integer	The page number.	1
pageSize	integer	The number of entries per page.	10
totalCount	integer	The total number of entries returned.	24
list	array<object>	The pagination information.
	object	The ACL.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
aclType	string	The ACL type. Valid value: APACHE: open source ACL. Valid values: APACHE : 开源 ACL	APACHE
username	string	The username.	test
resourceType	string	The resource type. Valid values: Group Topic Valid values: Group : 消费者组 Topic : 主题	Topic
resourceName	string	The resource name.	test
decision	string	The decision result. Valid values: Deny: Access is denied. Allow: Access is allowed. Valid values: Deny : 拒绝访问 Allow : 允许访问	Allow
actions	array	The operation types allowed by the ACL.
	string	The operation type allowed by the ACL. Valid values: SUB: message subscription. Pub: message sending. Valid values: Sub : 订阅 Pub : 发送	Pub
ipWhitelists	array	The IP address whitelists.
	string	The IP address whitelist.	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.	InstanceId
dynamicMessage	string	The dynamic error message.	InstanceId
accessDeniedDetail	string	The access denial details. Returned only when a RAM user lacks the required permissions.	xxx

Examples

Success response

JSON format

{
  "requestId": "DA4D2F89-E2C8-5F04-936B-60D55B055FA7",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 24,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "aclType": "APACHE",
        "username": "test",
        "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": "InstanceId",
  "dynamicMessage": "InstanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.