Binding an EIP

API Description

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

Restrictions

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.

URI

URI format
POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/bind-eip

Table 1 Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token
project_id	string	path	Yes	The project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
node_id	string	path	Yes	The node ID. Select the mongos node in a cluster instance. Select the primary or secondary node in a replica set instance.

Requests

Parameter description

Table 2 Parameter description
Name

Type

Mandatory

Description

public_ip_id

String

Yes

The ID of the EIP.

public_ip

String

Yes

EIP.

Table 2 Parameter description
Name	Type	Mandatory	Description
public_ip_id	String	Yes	The ID of the EIP.
public_ip	String	Yes	EIP.

Request example

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

Responses

Parameter description

Table 3 Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	The workflow ID.
node_name	String	Yes	The node name.
node_id	String	Yes	The node ID.
public_ip_id	String	Yes	The ID of the EIP.
public_ip	String	Yes	EIP.

Response example

{
    "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"
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management

Предыдущая статья

Changing a Security Group

Следующая статья

Unbinding an EIP

Была ли эта статья полезна?

Поддержка Юридические документы