AllocateNodePrivateNetworkAddress - ApsaraDB for MongoDB

Operation description

This operation is applicable only to sharded cluster instances. For more information, see Apply for an endpoint for a shard or Configserver node.

Note

The allocated endpoints can be used only for internal access. To gain Internet access, you must call the AllocatePublicNetworkAddress operation to apply for public endpoints.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:AllocateNodePrivateNetworkAddress

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
ZoneId	string	No	The ID of the zone to which the instance belongs. Note You can call the DescribeDBInstanceAttribute operation to query the zone ID of the instance.	cn-hangzhou-b
DBInstanceId	string	Yes	The ID of the sharded cluster instance.	dds-bp1fa5efaa93****
NodeId	string	Yes	The ID of the shard or Configserver node. Note You can call the DescribeDBInstanceAttribute operation to query the ID of the shard or Configserver node.	d-bp124beeb0ac****
AccountName	string	No	The username of the account. Note The username must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The username must start with a lowercase letter. You must configure the account and password only when you apply for the endpoint of a shard or Configserver node for the first time. The account and password are required for all shard and Configserver nodes. The permissions of this account are fixed to read-only.	shardcsaccount
AccountPassword	string	No	The password for the account. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! # $ % ^ & * ( ) _ + - =` The password must be 8 to 32 characters in length.	Test123456

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	60EEBD77-227C-5B39-86EA-D89163C5****

Examples

Success response

JSON format

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccountName.Forbid	Specified account name is a keyword.	The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.