全部产品
Search
文档中心

消息队列Kafka版:GetAllowedIpList - 获取IP白名单

更新时间:Nov 18, 2022

调用GetAllowedIpList获取IP白名单。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
InstanceIdstring

实例ID。

alikafka_post-cn-mp91inkw****

返回参数

名称类型描述示例值
object
Codeinteger

返回码。返回200代表成功。

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求的ID。

A421CCD7-5BC5-4B32-8DD8-64668A8FCB56
Successboolean

请求是否成功。

true
AllowedListobject

白名单。

DeployTypeinteger

部署类型。取值:

  • 4:公网/VPC

  • 5:VPC

说明普通用户无需关心该字段,集成商客户可以了解一下。
4
VpcListarray

VPC白名单。

object
PortRangestring

端口范围。取值:

9092/9092

9092/9092
AllowedIpListarray
string

IP白名单。

192.XX.XX.XX/XX
AllowedIpGroupobject
string

ip白名单。

192.XX.XX.XX/XX
InternetListarray

公网白名单。

object
PortRangestring

端口范围。取值:

9093/9093

9093/9093
AllowedIpListarray
string

IP白名单。

0.0.0.0/0
AllowedIpGroupobject

IP白名单分组。

string

ip白名单。

0.0.0.0/0

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "A421CCD7-5BC5-4B32-8DD8-64668A8FCB56",
  "Success": true,
  "AllowedList": {
    "DeployType": 4,
    "VpcList": [
      {
        "PortRange": "9092/9092",
        "AllowedIpList": [
          "192.XX.XX.XX/XX"
        ],
        "AllowedIpGroup": {
          "key": "192.XX.XX.XX/XX"
        }
      }
    ],
    "InternetList": [
      {
        "PortRange": "9093/9093",
        "AllowedIpList": [
          "0.0.0.0/0"
        ],
        "AllowedIpGroup": {
          "key": "0.0.0.0/0"
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-20OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更