You need to enable JavaScript to run this app.
文档中心
文档数据库 MongoDB 版

文档数据库 MongoDB 版

复制全文
下载 pdf
连接管理
ModifyDBEndpointPrivateDNSVisibility
复制全文
下载 pdf
ModifyDBEndpointPrivateDNSVisibility
调用 ModifyDBEndpointPrivateDNSVisibility 接口为目标 MongoDB 实例开启或关闭公网解析功能。
请求类型
异步请求。
注意事项
  • 由于公网环境复杂,无法确保域名解析的准确性与时效性,因此该功能仅限用于非生产环境。如果是生产环境强烈建议采用 DNS Forward 方案,即在本地的 DNS 服务器中配置 Forward 到火山引擎 DNS,其中 100.96.0.2100.96.0.3 为火山引擎使用的 DNS 服务器,以实现私网环境下的域名解析。
  • 针对分片集群实例,若在开启公网解析之后又执行了增加 Mongos 节点的操作,那么在实例配置变更完成后,您需要先关闭再重新开启公网解析功能,否则新增的 Mongos 节点所对应的私网地址域名将无法被解析为私网。更多详情,请参见开启和关闭公网解析
  • 仅如下实例或节点的私网地址支持开启或关闭公网解析功能:
  • 副本集实例的私网地址。
  • 分片集群中 Mongos 节点的私网地址。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
InstanceId String 必选 示例值:mongo-replica-e405f8e2****
实例 ID。
说明
您可以调用 DescribeDBInstances接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。
PrivateDNSVisibility Boolean 必选 示例值:true
开启或关闭实例的公网解析功能。取值范围如下:
  • true:开启公网解析。
  • false:关闭公网解析。
返回参数
本接口无特有的返回参数。更多信息请见返回结构
示例
请求示例
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyDBEndpointPrivateDNSVisibility&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
"InstanceId": "mongo-replica-e405f8e2****",
"PrivateDNSVisibility": true
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420100232280022D31****",
"Action": "ModifyDBEndpointPrivateDNSVisibility",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
错误码
更多详情,请参见错误码
最近更新时间:2026.06.17 16:25:53
这个页面对您有帮助吗?
有用
有用
无用
无用