You need to enable JavaScript to run this app.
导航
CreatePublicAddress - 开启公网访问
最近更新时间:2024.11.18 10:21:06首次发布时间:2023.05.19 15:47:10

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

使用说明

创建实例时如果未开启公网访问,可以在创建实例后调用此接口绑定弹性公网IP(EIP),开启实例的公网访问方式。EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。公网地址将绑定您的弹性公网 IP(EIP),费用由 EIP 收取。

注意事项

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

调试

请求参数

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

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

CreatePublicAddress

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

Version
String

2022-01-01

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

EipId
String

eip-2zeujxs*****6cd

EIP ID。

InstanceId
String

rbtmq-5b293870****

实例 ID。

返回参数

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

请求示例

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

{
   "InstanceId": "rbtmq-9283a61f****",
   "EipId": "eip-36sveyn9wy39c383g0wbs****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023021717563303023552D2E1FF86C7F6",
        "Action": "CreatePublicAddress",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-guangzhou"
    },
    "Result": null
}

错误码

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

状态码
错误码
错误信息
说明
400
InvalidParameter
The specified parameter %s is not valid.

参数值%s无效。

400
MissingParameter
The request body is missing a required parameter %s.

缺少%s参数。

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

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

403
OperationDenied.InvalidInstanceStatus
The operation is not valid for the current status of the instance.

当前实例状态不允许执行该操作。

403
OperationDenied.TaskIsRunning
An operation is currently in progress. Try again later.

后台任务正在运行中,请稍后再试。

404
InvalidInstanceId.NotFound
The specified Instance ID does not exist.

实例不存在。

500
InternalError
The request failed due to some unknown error, exception or failure.

内部错误,请稍后重试。