GetInstanceIpWhitelist - 查询IP白名单详情 - 云消息队列 RocketMQ 版

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:GetInstanceIpWhitelist

get

*IpWhitelist

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	rmq-cn-7e22ody****

请求参数

名称	类型	必填	描述	示例值
ipWhitelists	array	否	IP 白名单过滤列表
	string	否	IP 白名单	0.0.0.0/0

返回参数

名称	类型	描述	示例值
	object	返回结果
requestId	string	请求 ID	0B962390-D84B-5D44-8C11-79DF40299D41
success	boolean	是否成功	true
data	object	返回数据对象
regionId	string	区域 ID	cn-hangzhou
instanceId	string	实例 ID	rmq-cn-7e22ody****
ipWhitelists	array	IP 白名单列表
	string	IP 白名单	0.0.0.0/0
code	string	错误码。	Instance.NotFound
message	string	错误信息	xxx
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息。	instanceId

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。