Retrieve RocketMQ IP Whitelist via ListInstanceIpWhitelist - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

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:ListInstanceIpWhitelist

list

*Instance

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

None

Request syntax

GET /instances/{instanceId}/ip/whitelist 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. Default value: 1.	1
pageSize	integer	No	The number of entries to return on each page.	10
ipWhitelist	string	No	The IP address whitelist to filter by.	0.0.0.0/0

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	7358418D-83BD-507A-8079-611C63E05674
success	boolean	Indicates 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 returned entries.	5
list	array	The IP whitelist entries.
	string	The IP address whitelist.	0.0.0.0/0
code	string	The error code.	Instance.NotFound
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 access denial details. Returned only when access is denied due to insufficient RAM user permissions.	xxx

Examples

Success response

JSON format

{
  "requestId": "7358418D-83BD-507A-8079-611C63E05674",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 5,
    "list": [
      "0.0.0.0/0"
    ]
  },
  "code": "Instance.NotFound\n",
  "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.