Secure RocketMQ Instance Access with IP Whitelists via API - 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:CreateInstanceIpWhitelist

create

*Instance

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

None

Request syntax

POST /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
body	object	No	The request body.
ipWhitelists	array	Yes	The list of IP address whitelists.
	string	Yes	The IP address whitelist.	0.0.0.0/0

Response elements

Element	Type	Description	Example
	object	Result
requestId	string	The request ID.	A07B41BD-6DD3-5349-9E76-00303DF04BBE
success	boolean	Indicates whether the request is successful.	true
data	boolean	The returned data.	true
code	string	The error code.	MissingInstanceId
message	string	The error message.	The instance cannot be found.
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	InstanceId
accessDeniedDetail	string	The details about the access denial. This field is returned only when access is denied due to insufficient RAM permissions.	xxx

Examples

Success response

JSON format

{
  "requestId": "A07B41BD-6DD3-5349-9E76-00303DF04BBE",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.