ListInstanceAcl - - Alibaba Cloud Documentation Center

Queries the access control lists (ACLs) of an instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
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 key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:ListInstanceAcl	list	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-7e22ody****
pageNumber	integer	Yes	The page number. Pages start from page 1.	1
pageSize	integer	Yes	The number of entries per page.	10
filter	string	No	The condition that you specify to filter the ACLs. If you do not specify this parameter, all ACLs are queried.	CID-TEST

Response parameters

Parameter	Type	Description	Example
	object	The result.
requestId	string	The request ID.	DA4D2F89-E2C8-5F04-936B-60D55B055FA7
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
pageNumber	long	The page number.	1
pageSize	long	The number of entries per page.	10
totalCount	long	The total number of entries returned.	24
list	array<object>	The pagination information.
aclDatas	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.	APACHE
username	string	The username.	test
resourceType	string	The resource type. 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.	Allow
actions	array	The types of the operations that are allowed by the ACL.
action	string	The type of the operation that is allowed by the ACL. Valid values: SUB: message subscription. Pub: message sending.	Pub
ipWhitelists	array	The IP address whitelists.
ipWhitelist	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 details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.	xxx

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.