Binding an EIP

API Description

This API is used to bind an EIP to a node in a DB instance.

Constraints

• This operation cannot be performed on frozen or abnormal instances.
• The shard and config nodes of a cluster instance, the read-only node of a replica set, and the hidden node do not support this operation.
• Multiple EIPs cannot be bound to the same node.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
  dds:instance:bindEIP	write	instance	g:EnterpriseProjectId	dds:instance:bindPublicIp	-

URI

• URI format

  POST /v3/{project_id}/nodes/{node_id}/bind-eip

• URI example

  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/nodes/4709a6332ce348718b5675aadb5e2bccno02/bind-eip

Request

• Parameter description

  Table 2 Parameter description

  Name	Type	Mandatory	Description
  public_ip_id	String	Yes	Definition The ID of the EIP. Constraints N/A Range N/A Default Value N/A
  public_ip	String	Yes	Definition EIP. Constraints N/A Range N/A Default Value N/A

Example Request

{
    "public_ip": "10.145.51.128",
    "public_ip_id": "45da4782-e0c8-4aa4-a290-b8740014f710"
}

Response

• Parameter description

  Table 3 Parameter description

  Name	Type	Mandatory	Description
  job_id	String	Yes	Definition Task ID. Range N/A
  node_name	String	Yes	Definition The node name. Range N/A
  node_id	String	Yes	Definition The node ID. Range N/A
  public_ip_id	String	Yes	Definition The ID of the EIP. Range N/A
  public_ip	String	Yes	Definition EIP. Range N/A

• Example Response

  {
      "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
      "node_id":"52a4c096bb1f455d8d866956a959519eno02",
      "node_name":"mongodb-8977_mongos_node_1",
      "public_ip":"10.145.51.128",
      "public_ip_id":"45da4782-e0c8-4aa4-a290-b8740014f710"
  }

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.