All Products
Search

This Product

    ApsaraDB for MongoDB:ModifyDBInstanceNetworkType

    Document Center

    ApsaraDB for MongoDB:ModifyDBInstanceNetworkType

    Last Updated:Jan 17, 2023

    Changes the network type of an ApsaraDB for MongoDB instance.

    Operation Description

    This operation is applicable only to replica set instances and sharded cluster instances.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
    • Condition keyword: refers to the condition keyword defined by the cloud product itself.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    Operate access level Resource type conditional keyword Association operation
    dds:ModifyDBInstanceNetworkType WRITE
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    DBInstanceId string Yes

    The ID of the instance.

    		 dds-bp11483712c1****
    NetworkType string Yes

    The network type to switch to. Valid values:

    • VPC
    • Classic
    		 VPC
    VpcId string No

    The ID of the virtual private cloud (VPC).

    Note This parameter is required when the NetworkType parameter is set to VPC.
    		vpc-bp1n3i15v90el48nx****
    VSwitchId string No

    The ID of the vSwitch.

    Note This parameter is required when the NetworkType parameter is set to VPC.
    		vsw-bp1vj604nj5a9zz74****
    RetainClassic string No

    Specifies whether to retain the original classic network address when you change the network type to VPC. Valid values:

    • True: retains the original classic network address.
    • False: does not retain the original classic network address.
    Note
  • This parameter is required when the NetworkType parameter is set to VPC.
  • If you set this parameter to True, you must also specify the ClassicExpiredDays parameter.
    •
    		False
    ClassicExpiredDays integer No

    The retention period of the original classic network address when you change the network type to VPC. Valid values: 14, 30, 60, and 120. Unit: days.

    Note This parameter is required when the NetworkType parameter is set to VPC and the RetainClassic parameter is set to True.
    		30

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

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

    Example

    Normal return example

    JSONFormat

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

    Error codes

    Http code Error code Error message
    500 InstanceVpcAuthMode.NotSupported Instance VpcAuthMode is NotSupported.

    For a list of error codes, visit the API error center.