You need to enable JavaScript to run this app.
导航

CreatePublicAddress

最近更新时间2023.08.11 14:31:54

首次发布时间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

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

rocketmq-cnai1f0c29ca****

实例 ID。

Net

PublicNetObject

/

实例绑定的 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****",
  "Net": {
       "VpcID": "vpc-8h1npd6fyry88k0t****",
       "SubnetID": "subnet-min6uy01kuf45smt1a2i****",
       "EipIDs": [
           "eip-mio5dafp42685smt1b37****"
        ]
        }
}

响应示例

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