ListInstanceIpWhitelist - - Alibaba Cloud Documentation Center

Queries the IP address whitelists 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:ListInstanceIpWhitelist	list	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	none	none

Request syntax

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.	7358418D-83BD-507A-8079-611C63E05674
success	boolean	Indicates whether the call was successful.	true
data	object	The data returned.
pageNumber	long	The page number.	1
pageSize	long	Number of items per page.	10
totalCount	long	The total number of returned entries.	5
list	array	The pagination information.
ipWhitelist	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 details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.	xxx

Examples

Sample success responses

JSONformat

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

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