文档首页/ 分布式消息服务Kafka版/ API参考（联盟区域）/ API V2（推荐）/ 实例管理/ 修改Kafka的接入方式
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改Kafka的接入方式

功能介绍

修改Kafka的内网或者公网接入方式。

URI

POST /v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

engine

是

String

消息引擎。

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

protocol

否

String

需要开启或者关闭的接入方式。

enable

否

Boolean

  • true：开启指定的接入方式。

  • false：关闭指定的接入方式。

user_name

否

String

首次开启SASL时，需要输入用户名。实例创建后，关闭SASL并不会删除已经创建的用户，再次开启SASL时无需传入用户名，传入的用户名将无效。

pass_word

否

String

首次开启SASL时，需要输入用户名的密码。

sasl_enabled_mechanisms

否

Array of strings

开启SASL后使用的认证机制。仅在第一次开启SASL时传入生效。生效后再次传入无效。

  • PLAIN：简单的用户名密码校验。

  • SCRAM-SHA-512：用户凭证校验，安全性比PLAIN机制更高。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

job_id

String

后台任务id。

protocol

String

开启或者关闭的Kafka接入方式。

enable

Boolean

开启动作或者关闭动作。

请求示例

实例第一次开启内网SASL_SSL，需要传入用户名及密码。

POST https://{endpoint}/v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch

{
  "protocol" : "private_sasl_ssl_enable",
  "enable" : true,
  "user_name" : "root",
  "pass_word" : "password",
  "sasl_enabled_mechanisms" : [ "SCRAM-SHA-512", "PLAIN" ]
}

响应示例

状态码：200

提交修改Kafka接入方式成功。

{
  "job_id" : "ff8080828bdc0f64018bdcadfd8f00d7",
  "protocol" : "private_plain_enable",
  "enable" : true
}

状态码

状态码

描述

200

提交修改Kafka接入方式成功。

错误码

请参见错误码。

父主题： 实例管理