Common Function¶

This page describes operations you can perform on common_functions. List, and get details for.

List Common Function¶

List all visible common_functions.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/common_functions

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Description of the Common Function resource	no
id	query	string	hyph-uuid	-	Unique ID of the Common Function resource	no
link_local_ip_address	query	string	ipv4	-	Link-local IP address of Common Function (after NAT)	no
name	query	string	-	-	Name of the Common Function resource	no
status	query	string	-	-	Common Function status.	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_functions	array<object>	datatype_common_function	-
description	string	-	Description of the Common Function resource
id	string	hyph-uuid	Unique ID of the Common Function resource
link_local_ip_address	string	ipv4	Link-local IP address of Common Function (after NAT)
name	string	-	Name of the Common Function resource
status	string	-	Common Function status.

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "common_functions": [
    {
      "description": "",
      "id": "29c616f9-f92e-47f9-a97f-17cd3fb62467",
      "link_local_ip_address": "169.254.127.2",
      "name": "reserved-01",
      "status": "ACTIVE"
    },
    {
      "description": "",
      "id": "2e7f5b7f-9f17-4829-82fc-d1397729de2b",
      "link_local_ip_address": "169.254.127.3",
      "name": "reserved-02",
      "status": "ACTIVE"
    }
  ]
}

Show Common Function¶

Show details for common_function.