文档首页/ 分布式消息服务Kafka版/ API参考/ API V2(推荐)/ 实例管理/ 开启或者关闭Kafka实例公网访问功能 - ModifyKafkaPublicIpAccessSwitch
更新时间:2025-11-24 GMT+08:00
分享

开启或者关闭Kafka实例公网访问功能 - ModifyKafkaPublicIpAccessSwitch

功能介绍

开启或者关闭Kafka实例公网访问功能。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/instances/{instance_id}/public-boundwidth

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

eip_address

String

参数解释

EIP地址。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

public_boundwidth

Integer

参数解释

公网带宽。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

publicIpId

String

参数解释

公网IP的ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:204

修改Kafka实例公网访问开关成功。

请求示例

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/public-boundwidth

响应示例

状态码

状态码

描述

204

修改Kafka实例公网访问开关成功。

错误码

请参见错误码

相关文档