調用GetInstanceIpWhitelist查詢IP白名單-雲訊息佇列 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:GetInstanceIpWhitelist

get

*IpWhitelist

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

None

Request syntax

GET /instances/{instanceId}/ip/whitelists 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
ipWhitelists	array	No	The filter IP address whitelists.
	string	No	The filter IP address whitelist.	0.0.0.0/0

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	0B962390-D84B-5D44-8C11-79DF40299D41
success	boolean	Indicates whether the call was successful.	true
data	object	The data returned.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
ipWhitelists	array	The IP address whitelists.
	string	The IP address whitelist.	0.0.0.0/0
code	string	The error code.	Instance.NotFound
message	string	The error message.	xxx
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Success response

JSON format

{
  "requestId": "0B962390-D84B-5D44-8C11-79DF40299D41",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "ipWhitelists": [
      "0.0.0.0/0"
    ]
  },
  "code": "Instance.NotFound",
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.