Load Balancer Syslog Server¶
This page describes operations you can perform on load_balancer_syslog_server. List, create, get details for, update, and delete.
List Load Balancer Syslog Server¶
List all visible load_balancer_syslog_servers.
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{endpoint}/v2.0/load_balancer_syslog_servers
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required |
|---|---|---|---|---|---|---|
| description | query | string | - | - | Description for syslog | no |
| id | query | string | uuid | - | Unique ID of the syslog resource | no |
| ip_address | query | string | ipv4 | - | Ip address of syslog server | no |
| load_balancer_id | query | string | hyph-uuid | - | The ID of load_balancer this load_balancer_syslog_server belongs to. | no |
| log_facility | query | string | - | ['LOCAL0', 'LOCAL1', 'LOCAL2', 'LOCAL3', 'LOCAL4', 'LOCAL5', 'LOCAL6', 'LOCAL7'] | Log facility for syslog | no |
| log_level | query | string | - | - | Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others. | no |
| name | query | string | - | - | Name of the syslog resource | no |
| port_number | query | integer | - | - | Port number of syslog server | no |
| status | query | string | - | - | Load balancer syslog server status | no |
| transport_type | query | string | - | ['UDP'] | protocol for syslog transport | 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 |
|---|---|---|---|
| load_balancer_syslog_servers | array<object> | datatype_load_balancer_syslog_server | - |
| description | string | - | Description for syslog |
| id | string | uuid | Unique ID of the syslog resource |
| ip_address | string | ipv4 | Ip address of syslog server |
| load_balancer_id | string | hyph-uuid | The ID of load_balancer this load_balancer_syslog_server belongs to. |
| log_facility | string | - | Log facility for syslog |
| log_level | string | - | Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others. |
| name | string | - | Name of the syslog resource |
| port_number | integer | - | Port number of syslog server |
| status | string | - | Load balancer syslog server status |
| transport_type | string | - | protocol for syslog transport |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"load_balancer_syslog_servers": [
{
"description": "test",
"id": "2897f333-3554-4099-a638-64d7022bf9ae",
"ip_address": "120.120.120.30",
"load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
"log_facility": "LOCAL3",
"log_level": "DEBUG",
"name": "first_syslog_server",
"port_number": 514,
"status": "ACTIVE",
"transport_type": "UDP"
},
{
"description": "My second backup server",
"id": "2897f333-3554-4099-a638-64d7022bf9ae",
"ip_address": "120.120.122.30",
"load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
"log_facility": "LOCAL2",
"log_level": "ERROR",
"name": "second_syslog_server",
"port_number": 514,
"status": "ACTIVE",
"transport_type": "UDP"
}
]
}
Create Load Balancer Syslog Server¶
Create load_balancer_syslog_server.
Synchronous / Asynchronous¶
- Asynchronous
Request¶
HTTP Request Method¶
- POST
HTTP Request Path¶
{endpoint}/v2.0/load_balancer_syslog_servers
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Default | Description | Required |
|---|---|---|---|---|---|---|---|
| load_balancer_syslog_server | plain | object | datatype_load_balancer_syslog_server | - | - | - | yes |
| acl_logging | plain | string | - | ['ENABLED', 'DISABLED'] | "DISABLED" | should syslog record acl info | no |
| appflow_logging | plain | string | - | ['ENABLED', 'DISABLED'] | "DISABLED" | should syslog record appflow info | no |
| date_format | plain | string | - | ['DDMMYYYY', 'MMDDYYYY', 'YYYYMMDD'] | "MMDDYYYY" | date format utilized by syslog | no |
| description | plain | string | - | - | null | Description for syslog | no |
| ip_address | plain | string | ipv4 | - | - | Ip address of syslog server | yes |
| load_balancer_id | plain | string | hyph-uuid | - | - | The ID of load_balancer this load_balancer_syslog_server belongs to. | yes |
| log_facility | plain | string | - | ['LOCAL0', 'LOCAL1', 'LOCAL2', 'LOCAL3', 'LOCAL4', 'LOCAL5', 'LOCAL6', 'LOCAL7'] | "LOCAL0" | Log facility for syslog | no |
| log_level | plain | string | - | - | "ALL" | Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others. | no |
| name | plain | string | - | - | - | Name of the syslog resource | yes |
| port_number | plain | integer | - | - | 514 | Port number of syslog server | no |
| priority | plain | integer | - | - | 0 | priority (0-255) | no |
| tcp_logging | plain | string | - | ['NONE', 'ALL'] | "NONE" | should syslog record tcp protocol info | no |
| tenant_id | plain | string | uuid | - | See notes. | Tenant ID of the owner (UUID) | no |
| time_zone | plain | string | - | ['GMT_TIME', 'LOCAL_TIME'] | "GMT_TIME" | time zone utilized by syslog | no |
| transport_type | plain | string | - | ['UDP'] | "UDP" | protocol for syslog transport | no |
| user_configurable_log_messages | plain | string | - | ['YES', 'NO'] | "NO" | can user configure log messages | 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 |
|---|---|---|---|
| load_balancer_syslog_server | object | datatype_load_balancer_syslog_server | - |
| acl_logging | string | - | should syslog record acl info |
| appflow_logging | string | - | should syslog record appflow info |
| date_format | string | - | date format utilized by syslog |
| description | string | - | Description for syslog |
| id | string | uuid | Unique ID of the syslog resource |
| ip_address | string | ipv4 | Ip address of syslog server |
| load_balancer_id | string | hyph-uuid | The ID of load_balancer this load_balancer_syslog_server belongs to. |
| log_facility | string | - | Log facility for syslog |
| log_level | string | - | Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others. |
| name | string | - | Name of the syslog resource |
| port_number | integer | - | Port number of syslog server |
| priority | integer | - | priority (0-255) |
| status | string | - | Load balancer syslog server status |
| tcp_logging | string | - | should syslog record tcp protocol info |
| tenant_id | string | uuid | Tenant ID of the owner (UUID) |
| time_zone | string | - | time zone utilized by syslog |
| transport_type | string | - | protocol for syslog transport |
| user_configurable_log_messages | string | - | can user configure log messages |
Examples¶
Sample Request Body¶
{
"load_balancer_syslog_server": {
"acl_logging": "DISABLED",
"appflow_logging": "DISABLED",
"date_format": "MMDDYYYY",
"description": "test",
"ip_address": "120.120.120.30",
"load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
"log_facility": "LOCAL3",
"log_level": "DEBUG",
"name": "first_syslog_server",
"port_number": 514,
"priority": 20,
"tcp_logging": "ALL",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"time_zone": "LOCAL_TIME",
"transport_type": "UDP",
"user_configurable_log_messages": "NO"
}
}
Sample Response Body¶
{
"load_balancer_syslog_server": {
"acl_logging": "DISABLED",
"appflow_logging": "DISABLED",
"date_format": "MMDDYYYY",
"description": "test",
"id": "2897f333-3554-4099-a638-64d7022bf9ae",
"ip_address": "120.120.120.30",
"load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
"log_facility": "LOCAL3",
"log_level": "DEBUG",
"name": "first_syslog_server",
"port_number": 514,
"priority": 20,
"status": "PENDING_CREATE",
"tcp_logging": "ALL",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"time_zone": "LOCAL_TIME",
"transport_type": "UDP",
"user_configurable_log_messages": "NO"
}
}
Show Load Balancer Syslog Server¶
Show details for load_balancer_syslog_server.
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{endpoint}/v2.0/load_balancer_syslog_servers/{load_balancer_syslog_server_id}
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required |
|---|---|---|---|---|---|---|
| load_balancer_syslog_server_id | URI | string | hyph-uuid | - | Unique ID of the syslog 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 |
|---|---|---|---|
| load_balancer_syslog_server | object | datatype_load_balancer_syslog_server | - |
| acl_logging | string | - | should syslog record acl info |
| appflow_logging | string | - | should syslog record appflow info |
| date_format | string | - | date format utilized by syslog |
| description | string | - | Description for syslog |
| id | string | uuid | Unique ID of the syslog resource |
| ip_address | string | ipv4 | Ip address of syslog server |
| load_balancer_id | string | hyph-uuid | The ID of load_balancer this load_balancer_syslog_server belongs to. |
| log_facility | string | - | Log facility for syslog |
| log_level | string | - | Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others. |
| name | string | - | Name of the syslog resource |
| port_number | integer | - | Port number of syslog server |
| priority | integer | - | priority (0-255) |
| status | string | - | Load balancer syslog server status |
| tcp_logging | string | - | should syslog record tcp protocol info |
| tenant_id | string | uuid | Tenant ID of the owner (UUID) |
| time_zone | string | - | time zone utilized by syslog |
| transport_type | string | - | protocol for syslog transport |
| user_configurable_log_messages | string | - | can user configure log messages |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"load_balancer_syslog_server": {
"acl_logging": "DISABLED",
"appflow_logging": "DISABLED",
"date_format": "MMDDYYYY",
"description": "test",
"id": "2897f333-3554-4099-a638-64d7022bf9ae",
"ip_address": "120.120.120.30",
"load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
"log_facility": "LOCAL3",
"log_level": "DEBUG",
"name": "first_syslog_server",
"port_number": 514,
"priority": 20,
"status": "ACTIVE",
"tcp_logging": "ALL",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"time_zone": "LOCAL_TIME",
"transport_type": "UDP",
"user_configurable_log_messages": "NO"
}
}
Update Load Balancer Syslog Server¶
Update load_balancer_syslog_server.
Synchronous / Asynchronous¶
- Asynchronous
Request¶
HTTP Request Method¶
- PUT
HTTP Request Path¶
{endpoint}/v2.0/load_balancer_syslog_servers/{load_balancer_syslog_server_id}
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required |
|---|---|---|---|---|---|---|
| load_balancer_syslog_server_id | URI | string | hyph-uuid | - | Unique ID of the syslog resource | yes |
| load_balancer_syslog_server | plain | object | datatype_load_balancer_syslog_server | - | - | yes |
| acl_logging | plain | string | - | ['ENABLED', 'DISABLED'] | should syslog record acl info | no |
| appflow_logging | plain | string | - | ['ENABLED', 'DISABLED'] | should syslog record appflow info | no |
| date_format | plain | string | - | ['DDMMYYYY', 'MMDDYYYY', 'YYYYMMDD'] | date format utilized by syslog | no |
| description | plain | string | - | - | Description for syslog | no |
| log_facility | plain | string | - | ['LOCAL0', 'LOCAL1', 'LOCAL2', 'LOCAL3', 'LOCAL4', 'LOCAL5', 'LOCAL6', 'LOCAL7'] | Log facility for syslog | no |
| log_level | plain | string | - | - | Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others. | no |
| priority | plain | integer | - | - | priority (0-255) | no |
| tcp_logging | plain | string | - | ['NONE', 'ALL'] | should syslog record tcp protocol info | no |
| time_zone | plain | string | - | ['GMT_TIME', 'LOCAL_TIME'] | time zone utilized by syslog | no |
| user_configurable_log_messages | plain | string | - | ['YES', 'NO'] | can user configure log messages | 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 |
|---|---|---|---|
| load_balancer_syslog_server | object | datatype_load_balancer_syslog_server | - |
| acl_logging | string | - | should syslog record acl info |
| appflow_logging | string | - | should syslog record appflow info |
| date_format | string | - | date format utilized by syslog |
| description | string | - | Description for syslog |
| id | string | uuid | Unique ID of the syslog resource |
| ip_address | string | ipv4 | Ip address of syslog server |
| load_balancer_id | string | hyph-uuid | The ID of load_balancer this load_balancer_syslog_server belongs to. |
| log_facility | string | - | Log facility for syslog |
| log_level | string | - | Valid elements for log_level are "ALERT","CRITICAL","EMERGENCY", "INFORMATIONAL","NOTICE", "ALL", "DEBUG", "ERROR","NONE", "WARNING". log_level value can be assigned combining multiple elements as "ALERT"|"CRITICAL"|"EMERGENCY". Caution: Can not combine "ALL" or "NONE" with the others. |
| name | string | - | Name of the syslog resource |
| port_number | integer | - | Port number of syslog server |
| priority | integer | - | priority (0-255) |
| status | string | - | Load balancer syslog server status |
| tcp_logging | string | - | should syslog record tcp protocol info |
| tenant_id | string | uuid | Tenant ID of the owner (UUID) |
| time_zone | string | - | time zone utilized by syslog |
| transport_type | string | - | protocol for syslog transport |
| user_configurable_log_messages | string | - | can user configure log messages |
Examples¶
Sample Request Body¶
{
"load_balancer_syslog_server": {
"acl_logging": "DISABLED",
"appflow_logging": "DISABLED",
"date_format": "MMDDYYYY",
"description": "test",
"log_facility": "LOCAL3",
"log_level": "DEBUG",
"priority": 20,
"tcp_logging": "ALL",
"time_zone": "LOCAL_TIME",
"user_configurable_log_messages": "NO"
}
}
Sample Response Body¶
{
"load_balancer_syslog_server": {
"acl_logging": "DISABLED",
"appflow_logging": "DISABLED",
"date_format": "MMDDYYYY",
"description": "test",
"id": "2897f333-3554-4099-a638-64d7022bf9ae",
"ip_address": "120.120.120.30",
"load_balancer_id": "9f872504-36ab-46af-83ce-a4991c669edd",
"log_facility": "LOCAL3",
"log_level": "DEBUG",
"name": "first_syslog_server",
"port_number": 514,
"priority": 20,
"status": "PENDING_UPDATE",
"tcp_logging": "ALL",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"time_zone": "LOCAL_TIME",
"transport_type": "UDP",
"user_configurable_log_messages": "NO"
}
}
Delete Load Balancer Syslog Server¶
Delete load_balancer_syslog_server.
Synchronous / Asynchronous¶
- Asynchronous
Request¶
HTTP Request Method¶
- DELETE
HTTP Request Path¶
{endpoint}/v2.0/load_balancer_syslog_servers/{load_balancer_syslog_server_id}
HTTP Request Parameters¶
| Parameter | Style | Type | Format | Enumeration | Description | Required |
|---|---|---|---|---|---|---|
| load_balancer_syslog_server_id | URI | string | hyph-uuid | - | Unique ID of the syslog resource | yes |