Common Function Gateway¶

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

List Common Function Gateway¶

List all visible common_function_gateways.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/common_function_gateways

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
common_function_pool_id	query	string	hyph-uuid	-	Common Function Pool instantiated by this Gateway	no
description	query	string	-	-	Description of the Common Function Gateway resource	no
id	query	string	hyph-uuid	-	Unique ID of the Common Function Gateway resource	no
name	query	string	-	-	Name of the Common Function Gateway resource	no
network_id	query	string	hyph-uuid-or-empty	-	Id of automatically created network connected to this Common Function Gateway	no
status	query	string	-	-	The Common Function Gateway status.	no
subnet_id	query	string	hyph-uuid-or-empty	-	Id of automatically created subnet connected to this Common Function Gateway (using link-local addresation)	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
common_function_gateways	array<object>	datatype_common_function_gateway	-
common_function_pool_id	string	hyph-uuid	Common Function Pool instantiated by this Gateway
description	string	-	Description of the Common Function Gateway resource
id	string	hyph-uuid	Unique ID of the Common Function Gateway resource
name	string	-	Name of the Common Function Gateway resource
network_id	string	hyph-uuid-or-empty	Id of automatically created network connected to this Common Function Gateway
status	string	-	The Common Function Gateway status.
subnet_id	string	hyph-uuid-or-empty	Id of automatically created subnet connected to this Common Function Gateway (using link-local addresation)
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¶

{
  "common_function_gateways": [
    {
      "common_function_pool_id": "c57066cc-9553-43a6-90de-c847231bc70b",
      "description": "test",
      "id": "00efeb33-b050-4d2c-912f-d3a21bd744df",
      "name": "test",
      "network_id": "4dbc584d-4e63-40c7-be72-134a5e996efd",
      "status": "ACTIVE",
      "subnet_id": "ec43e4fb-ebdd-49c9-8927-a3dd9d0d9d01",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    },
    {
      "common_function_pool_id": "c57066cc-9553-43a6-90de-c847231bc70b",
      "description": "SougouTest_commonGW_1-1",
      "id": "03837e1a-77cd-4a53-9289-e614b56b3864",
      "name": "TestCommonFunctionGW001-1",
      "network_id": "63ea768c-10b2-4b2c-818c-b0a0f98a11b6",
      "status": "ACTIVE",
      "subnet_id": "44c4e3be-58ad-4498-b0d3-fa7ec3e82d27",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
    }
  ]
}

Create Common Function Gateway¶

Create common_function_gateway.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

POST

HTTP Request Path¶

{endpoint}/v2.0/common_function_gateways

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Default	Description	Required
common_function_gateway	plain	object	datatype_common_function_gateway	-	-	-	yes
common_function_pool_id	plain	string	hyph-uuid	-	-	Common Function Pool instantiated by this Gateway	yes
description	plain	string	-	-	""	Description of the Common Function Gateway resource	no
name	plain	string	-	-	""	Name of the Common Function Gateway resource	no
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
common_function_gateway	object	datatype_common_function_gateway	-
common_function_pool_id	string	hyph-uuid	Common Function Pool instantiated by this Gateway
description	string	-	Description of the Common Function Gateway resource
id	string	hyph-uuid	Unique ID of the Common Function Gateway resource
name	string	-	Name of the Common Function Gateway resource
network_id	string	hyph-uuid-or-empty	Id of automatically created network connected to this Common Function Gateway
status	string	-	The Common Function Gateway status.
subnet_id	string	hyph-uuid-or-empty	Id of automatically created subnet connected to this Common Function Gateway (using link-local addresation)
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples¶

Sample Request Body¶

{
  "common_function_gateway": {
    "common_function_pool_id": "c57066cc-9553-43a6-90de-c847231bc70b",
    "description": "test",
    "name": "test",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Sample Response Body¶

{
  "common_function_gateway": {
    "common_function_pool_id": "c57066cc-9553-43a6-90de-c847231bc70b",
    "description": "test",
    "id": "00efeb33-b050-4d2c-912f-d3a21bd744df",
    "name": "test",
    "network_id": "4dbc584d-4e63-40c7-be72-134a5e996efd",
    "status": "PENDING_CREATE",
    "subnet_id": "ec43e4fb-ebdd-49c9-8927-a3dd9d0d9d01",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Show Common Function Gateway¶

Show details for common_function_gateway.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/common_function_gateways/{common_function_gateway_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
common_function_gateway_id	URI	string	hyph-uuid	-	Unique ID of the Common Function 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
common_function_gateway	object	datatype_common_function_gateway	-
common_function_pool_id	string	hyph-uuid	Common Function Pool instantiated by this Gateway
description	string	-	Description of the Common Function Gateway resource
id	string	hyph-uuid	Unique ID of the Common Function Gateway resource
name	string	-	Name of the Common Function Gateway resource
network_id	string	hyph-uuid-or-empty	Id of automatically created network connected to this Common Function Gateway
status	string	-	The Common Function Gateway status.
subnet_id	string	hyph-uuid-or-empty	Id of automatically created subnet connected to this Common Function Gateway (using link-local addresation)
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¶

{
  "common_function_gateway": {
    "common_function_pool_id": "c57066cc-9553-43a6-90de-c847231bc70b",
    "description": "test",
    "id": "00efeb33-b050-4d2c-912f-d3a21bd744df",
    "name": "test",
    "network_id": "4dbc584d-4e63-40c7-be72-134a5e996efd",
    "status": "ACTIVE",
    "subnet_id": "ec43e4fb-ebdd-49c9-8927-a3dd9d0d9d01",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Update Common Function Gateway¶

Update common_function_gateway.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/common_function_gateways/{common_function_gateway_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
common_function_gateway_id	URI	string	hyph-uuid	-	Unique ID of the Common Function Gateway resource	yes
common_function_gateway	plain	object	datatype_common_function_gateway	-	-	yes
description	plain	string	-	-	Description of the Common Function Gateway resource	no
name	plain	string	-	-	Name of the Common Function Gateway resource	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
common_function_gateway	object	datatype_common_function_gateway	-
common_function_pool_id	string	hyph-uuid	Common Function Pool instantiated by this Gateway
description	string	-	Description of the Common Function Gateway resource
id	string	hyph-uuid	Unique ID of the Common Function Gateway resource
name	string	-	Name of the Common Function Gateway resource
network_id	string	hyph-uuid-or-empty	Id of automatically created network connected to this Common Function Gateway
status	string	-	The Common Function Gateway status.
subnet_id	string	hyph-uuid-or-empty	Id of automatically created subnet connected to this Common Function Gateway (using link-local addresation)
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)

Examples¶

Sample Request Body¶

{
  "common_function_gateway": {
    "description": "test",
    "name": "test"
  }
}

Sample Response Body¶

{
  "common_function_gateway": {
    "common_function_pool_id": "c57066cc-9553-43a6-90de-c847231bc70b",
    "description": "test",
    "id": "00efeb33-b050-4d2c-912f-d3a21bd744df",
    "name": "test",
    "network_id": "4dbc584d-4e63-40c7-be72-134a5e996efd",
    "status": "PENDING_UPDATE",
    "subnet_id": "ec43e4fb-ebdd-49c9-8927-a3dd9d0d9d01",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8"
  }
}

Delete Common Function Gateway¶

Delete common_function_gateway.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

DELETE

HTTP Request Path¶

{endpoint}/v2.0/common_function_gateways/{common_function_gateway_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
common_function_gateway_id	URI	string	hyph-uuid	-	Unique ID of the Common Function 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.

Common Function

Revision History