全部产品
Search
文档中心

云数据库 MongoDB:ModifyDBInstanceNetworkType - 切换实例的网络类型

更新时间:Mar 15, 2024

切换MongoDB实例的网络类型。

接口说明

  • 该接口适用于副本集实例和分片集群实例,暂不支持单节点实例。且仅支持经典网络类型转换至 VPC 网络类型。
  • 该接口仅支持 MongoDB 4.2 及以下版本的本地盘版实例。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

dds-bp11483712c1****
NetworkTypestring

实例要切换的目标网络类型,取值说明:

  • VPC:将网络类型切换为专有网络。
VPC
VpcIdstring

专有网络 ID。

说明 NetworkType 参数配置为 VPC 时,需要配置该参数。
vpc-bp1n3i15v90el48nx****
VSwitchIdstring

专有网络中的交换机 ID。

说明 NetworkType 参数配置为 VPC 时,需要配置该参数。
vsw-bp1vj604nj5a9zz74****
RetainClassicstring

切换网络类型为 VPC 时,设置是否保留原经典网络地址,取值说明:

  • True:保留原经典网络地址。
  • False:不保留原经典网络地址。
说明
  • NetworkType 参数配置为 VPC 时,需要配置该参数。
  • 当该参数配置为 True 时,还需要配置 ClassicExpiredDays 参数。
  • False
    ClassicExpiredDaysinteger

    切换网络类型为 VPC 时,设置保留原经典网络地址的时长。取值为 143060120,单位为天。

    说明 NetworkType 参数配置为 VPCRetainClassic 参数配置为 True 时,需要配置该参数。
    30
    ZoneIdstring

    可用区 ID,您可以通过调用 DescribeRegions 接口查询可用区 ID。

    cn-hangzhou-b

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    D0E605FD-6ECE-5FBE-84A4-99AAB1B8****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "D0E605FD-6ECE-5FBE-84A4-99AAB1B8****"
    }

    错误码

    HTTP status code错误码错误信息
    500InstanceVpcAuthMode.NotSupportedInstance VpcAuthMode is NotSupported.

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

    变更历史

    变更时间变更内容概要操作
    2023-08-08OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    2023-06-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:ZoneId