Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagetext
titleMulti-cloud network API for VF-C
linenumberstrue
collapsetrue
Create Network

Request

    {
        "tenant": "tenant1",
        "networkName": "ommnet",
        "shared": 1,
        "vlanTransparent": 1,
        "networkType": "vlan",
        "segmentationId": 202,
        "physicalNetwork": "ctrl",
        "routerExternal": 0
    }

Response

    {
        "returnCode": 0,
        "vimId": "11111",
        "vimName": "11111",
        "status": "ACTIVE",
        "id": "3c9eebdbbfd345658269340b9ea6fb73d32019d3-bc6e-4319-9c1d-6722fc136a22",
        "name": "net1",
        "tenant": "tenant1",
        "networkName": "ommnet",
        "shared": 1,
        "vlanTransparent": 1,
        "networkType": "vlan",
        "segmentationId": 202,
        "physicalNetwork": "physnet1",
        "routerExternal": 0
    }

Code Block
languagetext
titleMulti-cloud subnet API for VF-C
linenumberstrue
collapsetrue
Create Subnets


Request


    {
        "tenant": "tenant1",
        "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
        "subnetName": "subnet1",
        "cidr": "10.43.35.0/24",
        "ipVersion": 4,
        "enableDhcp": 1,
        "gatewayIp": "10.43.35.1",
        "dnsNameservers": [],
        "allocationPools": [{
            "start": "192.168.199.2",
            "end": "192.168.199.254"
        }],
        "hostRoutes": []
    }

Response

    {
        "returnCode": 0,
        "vimId": "11111",
        "vimName": "11111",
        "status": " ACTIVE",
        "id": " d62019d3-bc6e-4319-9c1d-6722fc136a23",
        "tenant": "tenant1",
        "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
        "name": "subnet1",
        "cidr": "10.43.35.0/24",
        "ipVersion": 4,
        "enableDhcp": 1,
        "gatewayIp": "10.43.35.1",
        "dnsNameservers": [],
        "allocationPools": [{
            "start": "192.168.199.2",
            "end": "192.168.199.254"
        }],
        "hostRoutes": []
    }
code
Code Block
languagetext
titleMulti-cloud server Port API for VF-C
linenumberslanguagetruetext
titleMulti-cloud Port API for VF-C
linenumberscollapsetrue
Create Virtual Port

Request
   +------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
| **Parameter**          | **Qualifier**   | **Cardinality**   | **Content**   | **Description**     {
        "networkId": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
        "subnetId": "c17afb1c-ab84-11e8-bfaa-77f95f421148",
        "name": "port1",
        "macAddress": "d4:5d:df:09:9e:19",
        "ip": "192.168.199.3",
        "vnicType": "direct"
    }

Response

    {
        "returnCode": 1,
        "vimId": "11111",
        "vimName": "11111",
        "cloud-owner": "cloudowner",
    | +========================+=================+===================+===============+=======================================================+ | networkId   "cloud-region-id": "cloudregion",
        "status": "success",
 | M           "id": "393905cc-ab85-11e8-bb60-1f10d99adcef",
   | 1    "name": "port_a",
        "tenantId": "55ab62ae-ab85-11e8-ba44-03ef3e9bc9d6",
 | string      "networkName":  | Network UUID   "ommnet",
        "networkId": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
        "subnetName": "subnet1",
        "subnetId": "c17afb1c-ab84-11e8-bfaa-77f95f421148",
        "macAddress": "d4:5d:df:09:9e:19",
        |
+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
| subnetId"ip": "192.168.199.3",
        "vnicType": "direct",
    }
Code Block
languagetext
titleMulti-cloud server API for VF-C
collapsetrue
Create Server

Request
  | O  {
        "tenant": "tenant1",
        "name": "vm1",
    | 1   "availabilityZone": "az1",
        "flavorName": "vm_large",
  | string     "boot": {
 | Subnet UUID         "type": 1,
            " volumeName": "volume1"
        },
        |
+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
| name"flavorId": "vm_large_134213",
        "contextArray": [{
          | M  "fileName": "test.yaml",
            "fileData": "…."
     | 1   }],
        "volumeArray": [{
            "volumeName": "vol1",
       | string}],
       | Port name"nicArray": [{
            "portId": "port_a"
        }],
        "metada": [{
           |
+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
| macAddress "keyName": "foo",
             | O"value": "foo value"
        }],
     | 1  "userdata": "abcdedf"
    }

Response

    {
| string        | Mac address"vimId": "11111",
        "vimName": "11111",
        "cloud-owner": "cloudowner",
        "cloud-region-id": "cloudregion",
        "returnCode": "success",
      |
+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
| ip  "id": "1234-23545",
        "name": "vm1",
        "tenantId": "tenant1",
        "boot": {
            | O"type": 1,
            "  | 1volumeName": "volume1"
        },
        | string"volumeArray": [{
       | Ip address                                            |
+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
| vnicType               | O               | 1                 | string        | Virtual network card type,                            |
|                        |                 |                   |               |                                                       |
|                        |                 |                   |               | the value of three kinds of normal/direct/macvtap     |
+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+
| \ **securityGroups**   | **O**           | **1**             | **string**    | **The IDs of security groups applied to the port.**   |
+------------------------+-----------------+-------------------+---------------+-------------------------------------------------------+

Response

+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**   | **Description**                                     |
+======================+=================+===================+===============+=====================================================+
| returnCode           | M               | 1                 | int           | 0: Already exist 1: Newly created                   |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| vimId                | M               | 1                 | String        | vim id                                              |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| vimName              | O               | 1                 | string        | vim name                                            |
+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------+
| cloud-owner       | M               | 1                 | String                    | cloud owner                                |
+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------+
| cloud-region-id   | M               | 1                 | string                    | cloud region id                            |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| status               | M               | 1                 | string        | status                                              |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| id                   | M               | 1                 | string        | Port Id                                             |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| name                 | M               | 1                 | string        | Port name                                           |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| tenantId             | M               | 1                 | String        | Tenant UUID                                         |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| networkName          | M               | 1                 | string        | Network name                                        |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| networkId            | M               | 1                 | string        | Network Id                                          |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| subnetName           | M               | 1                 | string        | Subnet name                                         |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| subnetId             | M               | 1                 | string        | SubnetId                                            |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| macAddress           | O               | 1                 | string        | Mac address                                         |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| ip                   | O               | 1                 | string        | Ip address                                          |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| vnicType             | O               | 1                 | string        | Virtual network card type,                          |
|                      |                 |                   |               |                                                     |
|                      |                 |                   |               | the value of three kinds of normal/direct/macvtap   |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+
| **securityGroups**   | **O**           | **1**             | **string**    | **List of security group names.**                   |
+----------------------+-----------------+-------------------+---------------+-----------------------------------------------------+



Create Server

Request
    {
        "tenant": "tenant1",
        "name": "vm1",
        "availabilityZone": "az1",
        "flavorName": "vm_large",
        "boot": {
            "type": 1,
            " volumeName": "volume1"
        },
        "flavorId": "vm_large_134213",
        "contextArray": [{
            "fileName": "test.yaml",
            "fileData": "…."
        }],
        "volumeArray": [{
            "volumeName": "vol1",
        }],
        "nicArray": [{
            "portId": "port_a"
        }],
        "metada": [{
            "keyName": "foo",
            "value": "foo value"
        }],
        "userdata": "abcdedf"
    }

Response

+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**        | **Qualifier**   | **Cardinality**   | **Content**                          | **Description**                                                                                                                                                                        |
+======================+=================+===================+======================================+========================================================================================================================================================================================+
| vimId                | M               | 1                 | String                               | vim id                                                                                                                                                                                 |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vimName              | O               | 1                 | string                               | vim name                                                                                                                                                                               |
+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
| cloud-owner       | M               | 1                 | String                    | cloud owner                                            |
+-------------------+-----------------+-------------------+---------------------------+--------------------------------------------------------+
| cloud-region-id   | M               | 1                 | string                    | cloud region id                                        |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| returnCode           |                 | 1                 | int                                  | 0: Already exist 1: Newly created                                                                                                                                                      |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id                   | M               | 1                 | string                               | server id                                                                                                                                                                              |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name                 |                 | 1                 | string                               | server name                                                                                                                                                                            |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenantId             | M               | 1                 | String                               | Tenant UUID                                                                                                                                                                            |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| boot                 | M               | 1                 | String                               | Start parameters                                                                                                                                                                       |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nicArray             | O               | 1..n              | List of nic                          | List of nic                                                                                                                                                                            |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| volumeArray          | O               | 1..n              | list of volume                       | list of volume                                                                                                                                                                         |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availabilityZone     | O               | 1                 | string                               | Usable field                                                                                                                                                                           |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flavorId             | M               | 1                 | String                               | server Flavor                                                                                                                                                                          |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| metadata             | O               | 1                 | List of metadata                     | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.                                                                                        |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **securityGroups**   | **O**           | **1**             | **List of name of security group**   | **One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group.**   |
|                      |                 |                   |                                      |                                                                                                                                                                                        |
|                      |                 |                   |                                      | **[TBD]**                                                                                                                                                                              |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **serverGroup**      | **O**           | **1**             | **string**                           | the ServerGroup for anti-affinity and affinity                                                                                                                                         |
|                      |                 |                   |                                      |                                                                                                                                                                                        |
|                      |                 |                   |                                      | [TBD]                                                                                                                                                                                  |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **status**           | **M**           | **1**             | **string**                           | Server status, 0:INACTIVE,1:ACTIVE,2:ERROR                                                                                                                                             |
+----------------------+-----------------+-------------------+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

202: accepted

500: failed

::

    {

    "id": "3c9eebdbbfd345658269340b9ea6fb73",

    "name": "vm1",

    "returnCode": 1,
"volumeName": "vol1",
        }],
        "nicArray": [{
            "portId": "port_a"
        }],
        "availabilityZone": "zone1",
        "flavorId": "tenant1",
        "metada": [{
            "keyName": "foo",
            "value": "foo value"
        }],
    }


HPA VF-C Casablanca Stories

...