All Products
Search
Document Center

ApsaraDB for MongoDB:ModifyDBInstanceNetworkType

Last Updated:Mar 15, 2024

Changes the network type of an ApsaraDB for MongoDB instance.

Operation description

This operation is applicable to replica set instances and sharded cluster instances, but not standalone instances. You can call this operation to change the network of an instance from a classic network to a VPC.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:ModifyDBInstanceNetworkTypeWRITE
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

dds-bp11483712c1****
NetworkTypestringYes

The network type to switch to. Valid value:

  • VPC
VPC
VpcIdstringNo

The ID of the VPC.

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

The ID of the vSwitch in the VPC.

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

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
ClassicExpiredDaysintegerNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
500InstanceVpcAuthMode.NotSupportedInstance VpcAuthMode is NotSupported.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
2023-06-27The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ZoneId