Updated on 2025-12-31 GMT+08:00

Configuring Public Access to a Kafka Instance

Function

This API is used to enable or disable public access to a Kafka instance.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

eip_address

No

String

Definition

EIP.

Constraints

N/A

Range

N/A

Default Value

N/A

public_boundwidth

No

Integer

Definition

Public network bandwidth.

Constraints

N/A

Range

N/A

Default Value

N/A

publicip_id

No

String

Definition

Public IP address ID. To obtain the EIP ID, call the API for querying the EIP list by referring to Elastic IP API Reference.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 204

Kafka instance public access switch modified.

None

Example Requests

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

Example Responses

None

Status Codes

Status Code

Description

204

Kafka instance public access switch modified.

Error Codes

See Error Codes.