ModifyDBInstanceNetworkType - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:ModifyDBInstanceNetworkType	update	*Instance `acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp11483712c1****
NetworkType	string	Yes	The network type to switch to. Valid value: VPC	VPC
VpcId	string	No	The ID of the VPC. Note This parameter is required when the NetworkType parameter is set to VPC.	vpc-bp1n3i15v90el48nx****
VSwitchId	string	No	The ID of the vSwitch in the VPC. 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
ZoneId	string	Yes	可用区 ID，您可以通过调用 DescribeRegions 接口查询可用区 ID。	cn-hangzhou-b

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D0E605FD-6ECE-5FBE-84A4-99AAB1B8****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
500	InstanceVpcAuthMode.NotSupported	Instance VpcAuthMode is NotSupported.	This operation is not supported for a VPC password-free logon instance.

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

Change history

Change time	Summary of changes	Operation
2023-08-08	The Error code has changed	View Change Details
2023-06-27	The Error code has changed. The request parameters of the API has changed	View Change Details