Internet Gateway¶

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

List Internet Gateway¶

List all visible internet_gateways.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/internet_gateways

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Description of the Internet Gateway resource	no
id	query	string	hyph-uuid	-	Unique ID of the Internet Gateway resource	no
internet_service_id	query	string	hyph-uuid-or-empty	-	Internet Service instantiated by this Gateway	no
name	query	string	-	-	Name of the Internet Gateway resource	no
qos_option_id	query	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	no
status	query	string	-	-	The Internet Gateway status.	no
tenant_id	query	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	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
internet_gateways	array<object>	datatype_internet_gateway	-
description	string	-	Description of the Internet Gateway resource
id	string	hyph-uuid	Unique ID of the Internet Gateway resource
internet_service_id	string	hyph-uuid-or-empty	Internet Service instantiated by this Gateway
name	string	-	Name of the Internet Gateway resource
qos_option_id	string	hyph-uuid-or-empty	Quality of Service options selected for this Gateway
status	string	-	The Internet Gateway status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "internet_gateways": [
    {
      "description": "",
      "id": "03a07645-980a-42a4-9e2e-ebfb04391841",
      "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
      "name": "Lab3-Internet-Service-Provider-01",
      "qos_option_id": "e497bbc3-1127-4490-a51d-93582c40ab40",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "description": "",
      "id": "05db9b0e-65ed-4478-a6b3-d3fc259c8d07",
      "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
      "name": "6_performance",
      "qos_option_id": "be985a60-e918-4cca-98f1-8886333f6f5e",
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Create Internet Gateway¶

Create internet_gateway.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

POST

HTTP Request Path¶

{endpoint}/v2.0/internet_gateways

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Default	Description	Required
internet_gateway	plain	object	datatype_internet_gateway	-	-	-	yes
description	plain	string	-	-	""	Description of the Internet Gateway resource	no
internet_service_id	plain	string	hyph-uuid-or-empty	-	-	Internet Service instantiated by this Gateway	yes
name	plain	string	-	-	""	Name of the Internet Gateway resource	no
qos_option_id	plain	string	hyph-uuid-or-empty	-	-	Quality of Service options selected for this Gateway	yes
tenant_id	plain	string	non-hyph-uuid	-	See notes.	Tenant ID of the owner (UUID)	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
internet_gateway	object	datatype_internet_gateway	-
description	string	-	Description of the Internet Gateway resource
id	string	hyph-uuid	Unique ID of the Internet Gateway resource
internet_service_id	string	hyph-uuid-or-empty	Internet Service instantiated by this Gateway
name	string	-	Name of the Internet Gateway resource
qos_option_id	string	hyph-uuid-or-empty	Quality of Service options selected for this Gateway
status	string	-	The Internet Gateway status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples¶

Sample Request Body¶

{
  "internet_gateway": {
    "description": "",
    "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
    "name": "Lab3-Internet-Service-Provider-01",
    "qos_option_id": "e497bbc3-1127-4490-a51d-93582c40ab40",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body¶

{
  "internet_gateway": {
    "description": "",
    "id": "03a07645-980a-42a4-9e2e-ebfb04391841",
    "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
    "name": "Lab3-Internet-Service-Provider-01",
    "qos_option_id": "e497bbc3-1127-4490-a51d-93582c40ab40",
    "status": "PENDING_CREATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Internet Gateway¶

Show details for internet_gateway.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/internet_gateways/{internet_gateway_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
internet_gateway_id	URI	string	hyph-uuid	-	Unique ID of the Internet Gateway resource	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
internet_gateway	object	datatype_internet_gateway	-
description	string	-	Description of the Internet Gateway resource
id	string	hyph-uuid	Unique ID of the Internet Gateway resource
internet_service_id	string	hyph-uuid-or-empty	Internet Service instantiated by this Gateway
name	string	-	Name of the Internet Gateway resource
qos_option_id	string	hyph-uuid-or-empty	Quality of Service options selected for this Gateway
status	string	-	The Internet Gateway status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "internet_gateway": {
    "description": "",
    "id": "03a07645-980a-42a4-9e2e-ebfb04391841",
    "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
    "name": "Lab3-Internet-Service-Provider-01",
    "qos_option_id": "e497bbc3-1127-4490-a51d-93582c40ab40",
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Update Internet Gateway¶

Update internet_gateway.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/internet_gateways/{internet_gateway_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
internet_gateway_id	URI	string	hyph-uuid	-	Unique ID of the Internet Gateway resource	yes
internet_gateway	plain	object	datatype_internet_gateway	-	-	yes
description	plain	string	-	-	Description of the Internet Gateway resource	no
name	plain	string	-	-	Name of the Internet Gateway resource	no
qos_option_id	plain	string	hyph-uuid-or-empty	-	Quality of Service options selected for this Gateway	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
internet_gateway	object	datatype_internet_gateway	-
description	string	-	Description of the Internet Gateway resource
id	string	hyph-uuid	Unique ID of the Internet Gateway resource
internet_service_id	string	hyph-uuid-or-empty	Internet Service instantiated by this Gateway
name	string	-	Name of the Internet Gateway resource
qos_option_id	string	hyph-uuid-or-empty	Quality of Service options selected for this Gateway
status	string	-	The Internet Gateway status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples¶

Sample Request Body¶

{
  "internet_gateway": {
    "description": "",
    "name": "Lab3-Internet-Service-Provider-01",
    "qos_option_id": "e497bbc3-1127-4490-a51d-93582c40ab40"
  }
}

Sample Response Body¶

{
  "internet_gateway": {
    "description": "",
    "id": "03a07645-980a-42a4-9e2e-ebfb04391841",
    "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
    "name": "Lab3-Internet-Service-Provider-01",
    "qos_option_id": "e497bbc3-1127-4490-a51d-93582c40ab40",
    "status": "PENDING_UPDATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Delete Internet Gateway¶

Delete internet_gateway.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

DELETE

HTTP Request Path¶

{endpoint}/v2.0/internet_gateways/{internet_gateway_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
internet_gateway_id	URI	string	hyph-uuid	-	Unique ID of the Internet Gateway resource	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.

Internet Service

Public IPs