Zaoxu, Li 4edaa4a4cc ECS API 20231016 version

Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>

2024-04-29 11:04:13 +00:00

21 KiB

Raw Blame History

Adding a NIC to an ECS

Function

This API is used to add a NIC to an ECS.

URI

POST /v2.1/{project_id}/servers/{server_id}/os-interface

POST /v2/{project_id}/servers/{server_id}/os-interface

Table 1 describes the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.
server_id	Yes	Specifies the ECS ID.

Request

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
interfaceAttachment	Yes	Object	Specifies the NICs to be added. For details, see Table 3.

**Table 3** **interfaceAttachment** field description
Parameter	Mandatory	Type	Description
port_id	No	String	Specifies the port ID. The port_id and net_id cannot be specified at the same time.
net_id	No	String	Specifies the network ID. The port_id and net_id cannot be specified at the same time.
fixed_ips	No	Array of objects	Specifies a private IP address. This parameter cannot be specified when port_id is used. This parameter must be used with net_id. Only the first element in the list is valid. If two or more elements are used, an error will be reported. For details, see Table 4.

**Table 4** **fixed_ips** field description
Parameter	Mandatory	Type	Description
ip_address	No	String	Specifies the IP address.

Response

Table 5 describes the response parameters.

**Table 5** Response parameters
Parameter	Type	Description
interfaceAttachment	Object	Specifies ECS NICs. For details, see Table 6.

**Table 6** **interfaceAttachment** field description
Parameter	Type	Description
port_state	String	Specifies the port state.
fixed_ips	Array of objects	Specifies IP addresses for NICs. For details, see Table 7.
port_id	String	Specifies the port ID.
net_id	String	Specifies the network ID.
mac_addr	String	Specifies the MAC address.

**Table 7** **fixed_ips** field description
Parameter	Type	Description
subnet_id	String	Specifies the ID of the subnet used by the NIC.
ip_address	String	Specifies the NIC IP address.

Example Request

Add a NIC whose network ID is 3cb9bc59-5699-4588-a4b1-b87f96708bc6.

POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface
POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface

{
    "interfaceAttachment" : {
        "fixed_ips" : [ 
            {
                "ip_address" : "192.168.1.3"
            } 
         ],
    "net_id" : "3cb9bc59-5699-4588-a4b1-b87f96708bc6"
    }
}

Add a NIC whose port ID is ce531f90-199f-48c0-816c-13e38010b442.

POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface
POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface

{
    "interfaceAttachment" : {
        "fixed_ips" : [ 
            {
                "ip_address" : "192.168.1.3"
            } 
         ],
    "port_id" : "ce531f90-199f-48c0-816c-13e38010b442"
    }
}

Example Response

{
    "interfaceAttachment": {
        "port_state": "DOWN",
        "fixed_ips": [
            {
                "subnet_id": "d9cfef77-0151-4c2a-9ed5-d951ada8adf3",
                "ip_address": "10.0.1.11"
            }
        ],
        "port_id": " ce531f90-199f-48c0-816c-13e38010b442",
        "net_id": "0dc714fa-9022-4a03-bb22-9821a396bb9d",
        "mac_addr": "fa:16:3e:63:75:b2"
    }
}

Returned Values

See Returned Values for General Requests.

Parent topic: NIC Management

21 KiB Raw Blame History