ListInstanceWhiteList - 查询实例IP/VPCID值
查询实例ip/vpc白名单; 只支持新架构实例,即VPC接入点(或者VPC PrivateLink 接入点)以mq.amqp.aliyuncs.com结尾的实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
amqp:ListInstanceWhiteList |
list |
*全部资源
|
无 | 无 |
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
需要查询白名单的实例 ID |
rabbitmq-cn-xxx |
| whiteListType |
integer |
是 |
白名单类型。 如果 WhiteListItem 中是 IP 类型,WhiteListType 设置为 2;如果 WhiteListItem 中设置 vpcId,则 WhiteListType 设置 1。 vpc 白名单仅针对 vpc 接入点是 anytunnel 类型的实例。最新版本实例 vpc 接入点为 privateLink 类型,因此不能针对此种类型实例设置 vpc 白名单。 枚举值:
|
2 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求唯一 ID |
6DC68EC9-0E76-5435-B8C0-FF9492B4**** |
| Code |
string |
返回码。返回 200 代表成功。 |
200 |
| Message |
string |
请求错误时,返回错误信息 |
xxx failed,xxxx |
| Success |
boolean |
请求是否成功。 |
true |
| Data |
any |
请求结果:VPCID 或者 IP 白名单具体值,包含 id 和 value 两部份。id 是序号,可用于删除;value 是具体值。 |
"Data": [ { "id": 454, "value": "10.1.2.1/30" } ] |
| StatusCode |
string |
调用返回码,200 标识成功 |
200 |
示例
正常返回示例
JSON格式
{
"RequestId": "6DC68EC9-0E76-5435-B8C0-FF9492B4****",
"Code": "200",
"Message": "xxx failed,xxxx",
"Success": true,
"Data": "\"Data\": [\n {\n \"id\": 454,\n \"value\": \"10.1.2.1/30\"\n }\n ]",
"StatusCode": "200"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | InstanceNotExist | The instance resource does not exist. | 实例资源不存在 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。