Attaching a NIC to an ECS

Scenarios

If an ECS requires multiple NICs, you can call the API for creating NICs and attach them to the ECS.

A NIC can be attached by setting the nics parameter during ECS creation or after the ECS is created. This section describes how to attach a NIC to a created ECS.

Involved APIs

Attaching a NIC involves the following APIs:

Creating a Network
Creating a Subnet
Creating a Port
Adding a NIC to an ECS
Querying NICs of an ECS

Procedure

Create a NIC.

Create a network.

API
URI format: POST /v1/{project_id}/vpcs

For details, see Creating a VPC.

Example request

POST https://{Endpoint}/v1/{project_id}/vpcs

Obtain {endpoint} from Regions and Endpoints.

Body:

{
    "vpc": {
        "name": "vpc",
        "description": "test",
        "cidr": "192.168.0.0/16"
    }
}

Example response

{
	"vpc": {
		"id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
		"name": "vpc",
		"description": "test",
		"cidr": "192.168.0.0/16",
		"status": "CREATING",
		"routes": []
	}
}

Record the vpc ID in the response.

Create a subnet.

API
URI format: POST /v2.0/subnets

For details, see Creating a Subnet.

Example request

POST https://{endpoint}/v2.0/subnets

Obtain {endpoint} from Regions and Endpoints.

Body:

{
    "subnet": {
        "name": "testsubnet",
        "enable_dhcp": true,
        "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b",
        "tenant_id": "74610f3a5ad941998e91f076297ecf27",
        "dns_nameservers": [
            "8.8.8.8",
            "8.8.8.7"
        ],
        "allocation_pools": [
            {
                "start": "10.0.10.2",
                "end": "10.0.10.254"
            }
        ],
        "host_routes": [],
        "ip_version": 4,
        "gateway_ip": "10.0.10.1",
        "cidr": "10.0.10.0/24"
    }
}

Example response

{
  "subnet": {
    "name": "testsubnet",
    "cidr": "10.0.10.0/24",
    "id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5",
    "enable_dhcp": true,
    "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b",
    "tenant_id": "74610f3a5ad941998e91f076297ecf27",
    "dns_nameservers": [
      "8.8.8.8",
      "8.8.8.7"
    ],
    "allocation_pools": [
      {
        "start": "10.0.10.2",
        "end": "10.0.10.254"
      }
    ],
    "host_routes": [],
    "ip_version": 4,
    "gateway_ip": "10.0.10.1"
  }
}

Record the subnet ID in the response.

Create a port.

API
URI format: POST /v2.0/ports

For details, see Creating a Port.

Example request

POST https://{endpoint}/v2.0/ports

Obtain {endpoint} from Regions and Endpoints.

Body:

{
    "port": {
        "admin_state_up": true, 

        "fixed_ips": [
            {
                "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5"
            }
        ], 
        "name": "test", 
        "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b",
        "tenant_id": "74610f3a5ad941998e91f076297ecf27"
    }
}

Example response

{
  "port": {
    "id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4",
    "name": "test",
    "status": "DOWN",
    "admin_state_up": true,
    "fixed_ips": [
      {
        "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5",
        "ip_address": "10.0.10.233"
      }
    ],
    "mac_address": "fa:16:3e:db:91:f6",
    "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b",
    "tenant_id": "74610f3a5ad941998e91f076297ecf27",
    "device_id": "",
    "device_owner": "",
    "security_groups": [
      "93031677-2895-4b83-855a-637e309aa9e6"
    ],
    "extra_dhcp_opts": [],
    "allowed_address_pairs": [],
    "binding:vnic_type": "normal",
    "binding:vif_details": {},
    "binding:profile": {}
  }
}

Record the port ID in the response.

Attach the NIC to the ECS.

API
URI format: POST /v2.1/{tenant_id}/servers/{server_id}/os-interface

For details, see Adding a NIC to an ECS.
Example request
POST https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/servers/9f4d9281-95e7-4915-a126-1ee597101e2e/os-interface

Obtain {endpoint} from Regions and Endpoints.

Body:
```
{
    "interfaceAttachment": {
        "port_id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4"
    }
}
```

Example response

{
  "interfaceAttachment": {
    "port_state": "ACTIVE",
    "fixed_ips": [
      {
        "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5",
        "ip_address": "10.0.10.233"
      }
    ],
    "port_id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4",
    "net_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b",
    "mac_addr": "fa:16:3e:db:91:f6"
  }
}

Verify the NIC attachment.

API
URI format: GET /v2.1/{tenant_id}/servers/{server_id}/os-interface

For details, see Querying NICs of an ECS.
Example request
GET https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/servers/9f4d9281-95e7-4915-a126-1ee597101e2e/os-interface

Obtain {endpoint} from Regions and Endpoints.

Example response

{
  "interfaceAttachments": [
    {
      "port_state": "ACTIVE",
      "fixed_ips": [
        {
          "subnet_id": "46712fe4-25bd-4eae-874b-a528abfb76be",
          "ip_address": "192.168.0.50"
        }
      ],
      "port_id": "dd706739-b696-40be-a9f4-477ce478cb18",
      "net_id": "17251a8f-a671-4d7c-85d9-af5415962994",
      "mac_addr": "fa:16:3e:a5:e0:3c"
    },
{
      "port_state": "ACTIVE",
      "fixed_ips": [
        {
          "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5",
          "ip_address": "10.0.10.233"
        }
      ],
      "port_id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4",
      "net_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b",
      "mac_addr": "fa:16:3e:db:91:f6"
    }
  ]
}

Parent topic: Application Examples

Previous topic: Attaching a Disk to an ECS

Next topic: Querying the EIP Associated with an ECS