ModifyOverlayAccess - 修改私有网络--云原生消息引擎-火山引擎

文档中心

立即注册

导航

ModifyOverlayAccess - 修改私有网络

最近更新时间：2024.12.11 16:59:16首次发布时间：2024.03.06 14:28:32

调用 ModifyOverlayAccess 接口，修改 BMQ 实例的私有网络，支持启停协议、添加 VPC、移除 VPC 等操作。

使用说明

BMQ 实例默认提供私网访问。私有网络接入点地址支持 PLAINTEXT、SASL_PLAINTEXT 和 SSL 协议的接入点，默认仅启用并提供 PLAINTEXT 协议的接入点，您可以按需启停不同协议的接入点。
如果实例需要跨 VPC 访问，您可以为实例添加多个 VPC。添加后，处于这些 VPC 环境内的客户端可以直接访问实例。当某些 VPC 环境内的客户端无需继续访问实例，您也可以选择移除 VPC。移除后，处于这些 VPC 环境内的客户端无法继续访问实例。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyOverlayAccess	要执行的操作，取值：ModifyOverlayAccess。
Version	String	是	2023-06-01	API的版本，取值：2023-06-01。
InstanceId	String	是	o-00c0****m46c	需要修改私有网络的实例 ID。
AddVpcs	Array of String	否	["vpc-1","vpc-2"]	需要添加的 VPC 列表，使用英文逗号（,）分隔。
DelVpcs	Array of String	否	["vpc-3","vpc-4"]	需要移除的 VPC 列表，使用英文逗号（,）分隔。您可调用 ListAvailableVPCForBMQ 接口，查看指定实例的 VPC。
Protocols	Array of String	否	["SASL_PLAINTEXT","SSL"]	需要启用的协议，多个协议之间使用英文逗号（,）分隔。取值如下： PLAINTEXT SASL_PLAINTEXT SSL 取值中未包含某一协议时，表示关闭该协议的接入点。

返回参数

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

参数	类型	示例值	描述
Status	String	SUCCESS	操作状态。
Message	String	OK	操作提示信息。

请求示例

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

{
   "InstanceId":  "o-00c0****m46c",
   "AddVpcs": ["vpc-1","vpc-2"]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202411042105230901372491618B*****",
    "Action": "ModifyOverlayAccess",
    "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	参数编码异常，请联系技术支持或提交工单。