Network¶

This page describes operations you can perform on networks. List, create, get details for, update, and delete.

List Network¶

List all visible networks.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/networks

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Network description.	no
id	query	string	hyph-uuid	-	Network unique id.	no
name	query	string	-	-	Network name.	no
plane	query	string	-	['storage', 'data']	Type of the traffic for which network will be used.	no
status	query	string	-	-	The network status.	no
tenant_id	query	string	non-hyph-uuid	-	The name of the network owner.	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
networks	array<object>	Network	-
admin_state_up	boolean	-	The administrative state of the network
description	string	-	Network description.
id	string	hyph-uuid	Network unique id.
name	string	-	Network name.
plane	string	-	Type of the traffic for which network will be used.
shared	boolean	-	Indicates whether this network is shared across all tenants (not supported)
status	string	-	The network status.
subnets	array<string>	hyph-uuid	The associated subnets.
tags	object	-	Network tags.
tenant_id	string	non-hyph-uuid	The name of the network owner.

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "networks": [
    {
      "admin_state_up": true,
      "description": "Example network 1 description.",
      "id": "6a9a64f6-45e7-46b2-b0e8-0a850896ff55",
      "name": "Example network 1",
      "plane": "data",
      "shared": false,
      "status": "ACTIVE",
      "subnets": [],
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "admin_state_up": true,
      "description": "Example network 2 description.",
      "id": "ba6ecce0-3491-4ec7-928f-911339b88f7e",
      "name": "Example network 2",
      "plane": "storage",
      "shared": false,
      "status": "ACTIVE",
      "subnets": [
        "c3343200-b267-4939-8f47-dfa9165a8417",
        "58d2eebb-785b-4558-ad13-e2e8c8b3f308"
      ],
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Create Network¶

Create network.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

POST

HTTP Request Path¶

{endpoint}/v2.0/networks

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Default	Description	Required
network	plain	object	Network	-	-	-	yes
admin_state_up	plain	boolean	-	-	True	The administrative state of the network	no
description	plain	string	-	-	""	Network description.	no
name	plain	string	-	-	""	Network name.	no
plane	plain	string	-	['storage', 'data']	"data"	Type of the traffic for which network will be used.	no
tags	plain	object	-	-	{}	Network tags.	no
tenant_id	plain	string	non-hyph-uuid	-	See notes.	The name of the network owner.	no

注釈

tenant_id: The ID of default tenant to which user belongs.

Response¶

HTTP Response Code List¶

Response Code	Description
201	OK
400	Bad Request
401	UnAuthorized
404	Not Found
409	Conflict
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
network	object	Network	-
admin_state_up	boolean	-	The administrative state of the network
description	string	-	Network description.
id	string	hyph-uuid	Network unique id.
name	string	-	Network name.
plane	string	-	Type of the traffic for which network will be used.
shared	boolean	-	Indicates whether this network is shared across all tenants (not supported)
status	string	-	The network status.
subnets	array<string>	hyph-uuid	The associated subnets.
tags	object	-	Network tags.
tenant_id	string	non-hyph-uuid	The name of the network owner.

Examples¶

Sample Request Body¶

{
  "network": {
    "admin_state_up": true,
    "description": "Example network 1 description.",
    "name": "Example network 1",
    "plane": "data",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body¶

{
  "network": {
    "admin_state_up": true,
    "description": "Example network 1 description.",
    "id": "6a9a64f6-45e7-46b2-b0e8-0a850896ff55",
    "name": "Example network 1",
    "plane": "data",
    "shared": false,
    "status": "PENDING_CREATE",
    "subnets": [],
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Network¶

Show details for network.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/networks/{network_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
network_id	URI	string	hyph-uuid	-	Network unique id.	yes

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
network	object	Network	-
admin_state_up	boolean	-	The administrative state of the network
description	string	-	Network description.
id	string	hyph-uuid	Network unique id.
name	string	-	Network name.
plane	string	-	Type of the traffic for which network will be used.
shared	boolean	-	Indicates whether this network is shared across all tenants (not supported)
status	string	-	The network status.
subnets	array<string>	hyph-uuid	The associated subnets.
tags	object	-	Network tags.
tenant_id	string	non-hyph-uuid	The name of the network owner.

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "network": {
    "admin_state_up": true,
    "description": "Example network 1 description.",
    "id": "6a9a64f6-45e7-46b2-b0e8-0a850896ff55",
    "name": "Example network 1",
    "plane": "data",
    "shared": false,
    "status": "ACTIVE",
    "subnets": [],
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Update Network¶

Update network.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/networks/{network_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
network_id	URI	string	hyph-uuid	-	Network unique id.	yes
network	plain	object	Network	-	-	yes
admin_state_up	plain	boolean	-	-	The administrative state of the network	no
description	plain	string	-	-	Network description.	no
name	plain	string	-	-	Network name.	no
tags	plain	object	-	-	Network tags.	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
409	Conflict
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
network	object	Network	-
admin_state_up	boolean	-	The administrative state of the network
description	string	-	Network description.
id	string	hyph-uuid	Network unique id.
name	string	-	Network name.
plane	string	-	Type of the traffic for which network will be used.
shared	boolean	-	Indicates whether this network is shared across all tenants (not supported)
status	string	-	The network status.
subnets	array<string>	hyph-uuid	The associated subnets.
tags	object	-	Network tags.
tenant_id	string	non-hyph-uuid	The name of the network owner.

Examples¶

Sample Request Body¶

{
  "network": {
    "admin_state_up": true,
    "description": "Example network 1 description.",
    "name": "Example network 1",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    }
  }
}

Sample Response Body¶

{
  "network": {
    "admin_state_up": true,
    "description": "Example network 1 description.",
    "id": "6a9a64f6-45e7-46b2-b0e8-0a850896ff55",
    "name": "Example network 1",
    "plane": "data",
    "shared": false,
    "status": "PENDING_UPDATE",
    "subnets": [],
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Delete Network¶

Delete network.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

DELETE

HTTP Request Path¶

{endpoint}/v2.0/networks/{network_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
network_id	URI	string	hyph-uuid	-	Network unique id.	yes

Response¶

HTTP Response Code List¶

Response Code	Description
204	No Content
400	Bad Request
401	UnAuthorized
404	Not Found
409	Conflict
500	Internal Server Error

HTTP Response Parameters¶

This operation does not receive a response body.

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

This operation does not receive a response body.

L2 Network Service

Subnet