文档中心

云原生消息引擎

实例连接管理

EnableOverlayAccess - 开启私有网络访问

调用 EnableOverlayAccess 接口，开启 BMQ 实例的私网访问。

注意事项

BMQ 实例默认开启私有网络访问，并提供 PLAINTEXT 协议域名和 IP 接入点。您无需对已开启私有网络访问的实例执行该操作，如果执行，将会返回 NO_OPERATION 提示信息。

请求说明

请求方式：POST

请求地址：https://open.volcengineapi.com?Action=EnableOverlayAccess&Version=2023-06-01

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：EnableOverlayAccess

要执行的操作，取值：EnableOverlayAccess。

Version string 必选示例值：2023-06-01

API的版本，取值：2023-06-01。

InstanceId string 必选示例值：o-00c0****m46c

需要开启私网访问的实例 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Status string 示例值：SUCCESS

操作状态。

Message string 示例值：OK

操作提示信息。

请求示例

POST /?Action=EnableOverlayAccess&Version=2023-06-01&InstanceId=o-00c0****m46c HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241104T125121Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********​
​
{}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "202411042051301252511400990B****",​
    "Action": "EnableOverlayAccess",​
    "Version": "2023-06-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Status": "SUCCESS",​
    "Message": "OK"​
  }​
}​

错误码

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

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

最近更新时间：2025.08.05 18:34:38

这个页面对您有帮助吗？

有用

无用