调用ModifyInstanceVpcAuthMode接口开启或关闭MongoDB实例的专有网络免密访问功能。

调用本接口时,实例必须满足以下条件:

  • 实例的类型为副本集实例或分片集群实例。
  • 实例的数据库版本为4.0版本,数据库小版本为mongodb_20190408_3.0.11及以上版本,您可以通过调用DescribeDBInstanceAttribute接口查看版本信息。如果版本过低请调用UpgradeDBInstanceEngineVersion接口升级数据库版本。
  • 实例的网络类型为专有网络。如果网络类型为经典网络,请调用ModifyDBInstanceNetworkType接口将网络类型切换为专有网络。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
DBInstanceId String dds-bpxxxxxxxx

实例ID。

Action String ModifyInstanceVpcAuthMode

要执行的操作,取值ModifyInstanceVpcAuthMode

NodeId String s-bpxxxxxxxx

分片集群实例的Mongos节点ID。

说明 实例类型为分片集群实例时,本参数才可用。
VpcAuthMode String Open

设置专有网络免密访问功能,取值:

  • Open:开启专有网络免密访问。
  • Close:关闭专有网络免密访问。
RegionId String cn-hangzhou

实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。

AccessKeyId String LTAIgbTGpxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
RequestId String BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C

请求ID。

示例

请求示例


http(s)://mongodb.aliyuncs.com/?Action=ModifyInstanceVpcAuthMode
&DBInstanceId=dds-bpxxxxxxxx
&VpcAuthMode=Open
&<公共请求参数>

正常返回示例

XML 格式

<ModifyInstanceVpcAuthModeResponse>
	  <RequestId>BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C</RequestId>
</ModifyInstanceVpcAuthModeResponse>

JSON 格式

{
	"RequestId":"BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C"
}

错误码

访问错误中心查看更多错误码。