List RocketMQ Instance Accounts via API - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Retrieves the access accounts for a specified 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:ListInstanceAccount

list

*Instance

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

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	The page number. The first page is 1.	1
pageSize	integer	No	The number of entries to return on each page.	10
username	string	No	The username of the account.	test
accountType	string	No	The type of the account. Valid values: CUSTOMER : custom account DEFAULT : default account	CUSTOMER
accountStatus	string	No	The status of the account. Valid values: DISABLE : Disabled ENABLE : Enabled	ENABLE

Response elements

Element	Type	Description	Example
	object	The response object.
requestId	string	The request ID.	C115601B-8736-5BBF-AC99-7FEAE1245A80
success	boolean	Indicates whether the request is successful.	true
data	object	The data returned.
pageNumber	integer	The current page number.	1
pageSize	integer	The page size.	10
totalCount	integer	The total count of entries.	24
list	array<object>	A list of entries on the current page.
	object	The account information.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
username	string	The username.	test
accountType	string	The account type. Valid values: CUSTOMER : Custom account DEFAULT : Default account	CUSTOMER
accountStatus	string	The account status. Valid values: DISABLE : Disabled ENABLE : Enabled	ENABLE
remark	string	The remark.	test
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
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 of the access denial. This parameter is returned only if the request is denied due to insufficient RAM permissions.	xxx

Examples

Success response

JSON format

{
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE1245A80",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 24,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "username": "test",
        "accountType": "CUSTOMER",
        "accountStatus": "ENABLE",
        "remark": "test"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "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.