全部产品
Search
文档中心

云数据库 MongoDB:ModifyInstanceVpcAuthMode - 开启或关闭实例的专有网络免密访问功能

更新时间:Jan 17, 2023

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

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
dds:ModifyInstanceVpcAuthMode WRITE
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称 类型 必填 描述 示例值
DBInstanceId string

实例ID。

dds-bpxxxxxxxx
NodeId string

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

说明 实例类型为分片集群实例时,本参数才可用。
s-bpxxxxxxxx
VpcAuthMode string

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

  • Open:开启专有网络免密访问。
  • Close:关闭专有网络免密访问。
Open

返回参数

名称 类型 描述 示例值
object
RequestId string

请求ID。

BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C

示例

正常返回示例

JSON格式

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

错误码

Http code 错误码 错误信息 描述
400 ClassicNotSupport Classic instance does not support this operation -
403 InstanceCurrentKernelVersionNotSupport Current DB instance CurrentKernelVersion does not support this operation. 该功能仅支持4.0版本的最新小版本,请先升级至对应版本再启用。

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