文档

UpdateAllowedIp - 变更IP白名单

更新时间:

您可以编辑访问云消息队列 Kafka 版的白名单,配置在白名单中的IP地址与端口才允许访问云消息队列 Kafka 版实例,本文介绍如何调用UpdateAllowedIp变更IP白名单。

调试

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

授权信息

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

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

请求参数

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

实例的地域 ID。

cn-hangzhou
UpdateTypestring

变更类型。取值:

  • add:增加。

  • delete:删除。

add
PortRangestring

端口范围。取值:

  • 9092/9092:专有网络 VPC-默认接入点。

  • 9093/9093:公网。

  • 9094/9094:专有网络 VPC-SASL 接入点。

  • 9095/9095:专业网络 VPC-SSL 接入点。

该参数需要与 AllowdedListType 对应。

9092/9092
AllowedListTypestring

白名单的类型。取值:

  • vpc:专有网络 VPC。

  • internet:公网。

vpc
AllowedListIpstring

IP 列表。可以是网段,例如:192.168.0.0/16

  • UpdateTypeadd 时,可以填写多项,以英文逗号(,)分隔。

  • UpdateTypedelete 时,一次只能填写单项。

  • 删除需谨慎。

0.0.0.0/0
InstanceIdstring

实例 ID。

alikafka_pre-cn-0pp1cng20***
Descriptionstring

白名单描述。

tf-testAccEcsImageConfigBasic3549descriptionChange

返回参数

名称类型描述示例值
object
Codeinteger

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

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求 ID。

17D425C2-4EA3-4AB8-928D-E10511ECF***
Successboolean

请求是否成功。

true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "17D425C2-4EA3-4AB8-928D-E10511ECF***",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400WHITE.PARAM.ERROR%s. Please check and try again later.参数不合法。
400WHITE.OVER.LENGTH.ERROR%s. Please check and try again later.允许的IP超过长度,最大长度为10。
400WHITE.IPLIST.OVERLONG.ERROR%s. Please check and try again later.所有IP列表长度过长,最大长度200。
400WHITE.IP.ILLEGAL.ERROR%s. Please check and try again later.所允许的IP不合法。
400WHITE.IP.ALREADY.EXISTS.ERROR%s. Please check and try again later.输入的IP已经存在,请检查。
400WHITE.DELETE.ERROR%s. Please check and try again later.删除时,允许的IP地址只能有一个。

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

变更历史

变更时间变更内容概要操作
2022-09-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
入参OpenAPI 入参发生变更
    新增入参:Description
  • 本页导读 (1)
文档反馈