CreatePublicAddress - 开启公网访问--消息队列 RocketMQ版-火山引擎

文档中心

导航

CreatePublicAddress - 开启公网访问

最近更新时间：2024.11.18 10:27:31首次发布时间：2023.07.12 16:22:34

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

使用说明

创建实例时如果未开启公网访问，可以在创建实例后调用此接口绑定弹性公网 IP（EIP），开启实例的公网访问方式。RocketMQ 实例公网访问方式支持设置 SSL 连接策略，选择在公网访问实例时是否可忽略 SSL 认证。目前支持客户端对服务端证书的 SSL 单向认证，数据加密传输，相较于普通公网访问方式具备更高的安全性，但实例性能会有所下降。

EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。公网地址将绑定您的弹性公网 IP（EIP），费用由 EIP 收取。
公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。
开启公网访问前，请先创建和 RocketMQ 实例相同地域的 EIP，建议该 EIP 的带宽上限大于预估的公网业务流量峰值。详细操作请参考申请公网IP。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreatePublicAddress	要执行的操作，取值：CreatePublicAddress。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	rocketmq-cnai1f0c29ca****	实例 ID。
EipId	String	是	eip-xxxxxxxxxx	实例绑定的 EIP 等信息。
SSLMode	String	否	false	实例的公网连接策略。支持设置为： enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。 permissive：（默认）通过公网访问实例时，可以选择是否经由 SSL 认证。创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。

返回参数

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

请求示例

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

{
  "InstanceId": "rocketmq-cnai1f0c29ca****",
  "EipId": "eip-xxxxxxxxxx",
  "SSLMode": "false"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230227191417E460FF199EB6A16E7B23",
        "Action": "CreatePublicAddress",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": null
}

错误码

公共错误码请参见公共错误码文档。