调用 EnableOverlayAccess 接口，开启 BMQ 实例的私网访问。
BMQ 实例默认开启私有网络访问，并提供 PLAINTEXT 协议域名和 IP 接入点。您无需对已开启私有网络访问的实例执行该操作，如果执行，将会返回 NO_OPERATION 提示信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
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" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。