ListInstanceIpWhitelist - 查询IP白名单列表_云消息队列 RocketMQ 版(RocketMQ)-阿里云帮助中心

查询访问控制IP白名单列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rocketmq:ListInstanceIpWhitelist	list	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	无	无

请求语法

GET /instances/{instanceId}/ip/whitelist HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID。	rmq-cn-7e22ody****
pageNumber	integer	是	当前页码，从 1 开始。	1
pageSize	integer	是	分页大小	10
ipWhitelist	string	否	过滤条件，IP 白名单。	0.0.0.0/0

返回参数

名称	类型	描述	示例值
	object	Result
requestId	string	请求 ID	7358418D-83BD-507A-8079-611C63E05674
success	boolean	是否成功	true
data	object	返回结果
pageNumber	long	当前页码	1
pageSize	long	分页大小	10
totalCount	long	总记录数	5
list	array	分页数据
ipWhitelist	string	IP 白名单	0.0.0.0/0
code	string	错误码	Instance.NotFound
message	string	错误信息	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息	instanceId
accessDeniedDetail	string	访问拒绝详细信息，有且仅有在因 RAM 无权限拒绝用户访问的场景	xxx

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。