You need to enable JavaScript to run this app.
导航
CreatePublicAddress - 开启公网访问
最近更新时间:2024.09.26 15:55:17首次发布时间:2023.03.30 19:59:25

调用 CreatePublicAddress 接口开启 Kafka 实例的公网访问。

使用说明

创建实例时如果未开启公网访问,可以在创建实例后调用此接口绑定弹性公网 IP(EIP),开启实例的公网访问方式。
开启公网访问后,消息队列 Kafka版为实例提供公网接入点,用于客户端通过公网访问 Kafka 实例,您可以根据是否需要 SSL 认证选择对应的接入点。支持客户端对服务端证书的单向 SSL 认证,数据加密传输,相较于普通公网访问方式具备更高的安全性。

  • EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。公网地址将绑定您的弹性公网 IP(EIP),费用由 EIP 收取。
  • 开启公网访问后,消息队列 Kafka版为实例提供公网接入点,用于客户端通过公网访问 Kafka 实例,连接方式请参考使用 SASL_SSL 接入点连接实例

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreatePublicAddress

要执行的操作,取值:CreatePublicAddress。

Version
String

2022-05-01

API的版本,取值:2022-05-01。

EipId
String

eip-2zeujxs*****6cd

EIP 的 ID。

InstanceId
String

kafka-cnngqkfgdudt****

实例 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST /?Action=CreatePublicAddress&Version=2022-05-01 HTTP/1.1
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-cnng3s31v076****",
  "EipId": "eip-mio5dafp42685smt1b37****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230227191417E460FF199EB6A16E7B23",
        "Action": "CreatePublicAddress",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter.EipNumber
The EIP number is insufficient.

EIP数量不足。

403
OperationDenied.InternetAccessEnabled
Internet access is enabled for the instance.

该实例已开启公网访问方式。

404
InvalidEip.NotFound
The specified EIP does not exist.

该EIP不存在。