ModifyInstanceVpcAuthMode - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Disables password-free access over Virtual Private Cloud (VPC) for an ApsaraDB for MongoDB instance.

Operation description

Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:

The instance is a replica set or sharded cluster instance.
The database engine version of the instance is 4.0 (with the minor version of mongodb_20190408_3.0.11 or later) or 4.2. You can call the DescribeDBInstanceAttribute operation to view the database engine version of the instance. If necessary, you can call the UpgradeDBInstanceEngineVersion operation to upgrade the database engine version of the instance.
The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the ModifyDBInstanceNetworkType operation to change the network type to VPC.
You can only disable but not enable password-free access over VPC.

Debugging

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

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:
- 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.

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

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bpxxxxxxxx
NodeId	string	No	The ID of the mongos node in the sharded cluster instance. Note This parameter can be used only when the instance type is sharded cluster.	s-bpxxxxxxxx
VpcAuthMode	string	No	Specify whether to disable password-free access over VPC. Set the value to Close.	Open

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	BA51E9D9-B14A-4542-B6E6-7DE00BECCB8C

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	ClassicNotSupport	Classic instance does not support this operation	-
403	InstanceCurrentKernelVersionNotSupport	Current DB instance CurrentKernelVersion does not support this operation.	Instance version outdated. This feature supports only instances of version 4.0 and later.

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

Change history

Change time	Summary of changes	Operation

No change history