On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Instance Management/ Modifying Kafka Access Modes

Modifying Kafka Access Modes

Updated on 2025-05-06 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to modify private or public access for Kafka.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
engine	Yes	String	Message engine.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
protocol	No	String	Access modes to be enabled or disabled.
enable	No	Boolean	true: Enable false: Disable
user_name	No	String	Username is required when SASL is enabled for the first time. After an instance is created, disabling SASL does not delete the created user. Enabling SASL again does not require the username and an entered username will be invalid.
pass_word	No	String	Password is required when SASL is enabled for the first time.
sasl_enabled_mechanisms	No	Array of strings	Authentication mechanism used after SASL is enabled. Validated only when SASL is enabled for the first time. Reuses are invalid. PLAIN: simple username and password verification. SCRAM-SHA-512: user credential verification, which is more secure than PLAIN.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	Background task ID.
protocol	String	Enabling or disabling the Kafka access mode.
enable	Boolean	Enablement or disablement.

Example Requests

Requiring the username and password when SASL_SSL is enabled for the first time

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" ]
}

Example Responses

Status code: 200

Successful

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

Status Codes


Status Code	Description
200	Successful

Error Codes

See Error Codes.

Parent Topic: Instance Management

Previous topic: Reassigning Replicas of a Topic for a Kafka Instance

Next topic: Querying the Disk Usage Status of Topics

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot