slb service-group member¶
Service Group Member
member Specification¶
Type Collection Object Key(s) name, port Collection Name member-list Collection URI /axapi/v3/slb/service-group/{name}/member Element Name member Element URI /axapi/v3/slb/service-group/{name}/member/{name}+{port} Element Attributes member_attributes Statistics Data URI /axapi/v3/slb/service-group/{name}/member/{name}+{port}/stats Operational Data URI /axapi/v3/slb/service-group/{name}/member/{name}+{port}/oper Schema member schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/service-group/{name}/member | ||
Create List | POST | /axapi/v3/slb/service-group/{name}/member | ||
Get Object | GET | /axapi/v3/slb/service-group/{name}/member/{name}+{port} | ||
Get List | GET | /axapi/v3/slb/service-group/{name}/member | ||
Modify Object | POST | /axapi/v3/slb/service-group/{name}/member/{name}+{port} | ||
Replace Object | PUT | /axapi/v3/slb/service-group/{name}/member/{name}+{port} | ||
Replace List | PUT | /axapi/v3/slb/service-group/{name}/member | ||
Delete Object | DELETE | /axapi/v3/slb/service-group/{name}/member/{name}+{port} |
member-list¶
member-list is JSON List of member attributes
member-list : [
]
member attributes¶
fqdn-name
Description Server hostname - Not applicable if real server is already defined
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
host
Description IP Address - Not applicable if real server is already defined
Type: string
Format: ipv4-address
member-priority
Description Priority of Port in the Group (Priority of Port in the Group, default is 1)
Type: number
Range: 1-16
Default: 1
member-state
Description ‘enable’: Enable member service port; ‘disable’: Disable member service port; ‘disable-with-health-check’: disable member service port, but health check work;
Type: string
Supported Values: enable, disable, disable-with-health-check
Default: enable
member-stats-data-disable
Description Disable statistical data collection
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
member-template
Description Real server port template (Real server port template name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/port
name
Description Member name
Type: string
Format: comp-string
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/server
port
Description Port number
Type: number
Range: 0-65534
Default: 65534
Reference Object: /axapi/v3/slb/server/port
resolve-as
Description ‘resolve-to-ipv4’: Use A Query only to resolve FQDN; ‘resolve-to-ipv6’: Use AAAA Query only to resolve FQDN; ‘resolve-to-ipv4-and-ipv6’: Use A as well as AAAA Query to resolve FQDN;
Type: string
Supported Values: resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6
Default: resolve-to-ipv4
sampling-enable
Type: Listserver-ipv6-addr
Description IPV6 Address - Not applicable if real server is already defined
Type: string
Format: ipv6-address
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘total_fwd_bytes’: Bytes processed in forward direction; ‘total_fwd_pkts’: Packets processed in forward direction; ‘total_rev_bytes’: Bytes processed in reverse direction; ‘total_rev_pkts’: Packets processed in reverse direction; ‘total_conn’: Total established connections; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_status_code_2xx’: Total reverse packets inspected status code 2xx; ‘total_rev_pkts_inspected_status_code_non_5xx’: Total reverse packets inspected status code non 5xx; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total requests successful; ‘peak_conn’: Peak connections; ‘response_time’: Response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time; ‘curr_ssl_conn’: Current SSL connections; ‘total_ssl_conn’: Total SSL connections; ‘curr_conn_overflow’: Current connection counter overflow count; ‘state_flaps’: State flaps count;
Type: string
Supported Values: all, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, total_rev_pkts_inspected, total_rev_pkts_inspected_status_code_2xx, total_rev_pkts_inspected_status_code_non_5xx, curr_req, total_req, total_req_succ, peak_conn, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn, curr_conn_overflow, state_flaps
stats data¶
Counter | Size | Description | |
---|---|---|---|
curr_req | 8 | Current requests | |
total_fwd_bytes | 8 | Bytes processed in forward direction | |
curr_ssl_conn | 8 | Current SSL connections | |
peak_conn | 8 | Peak connections | |
total_req | 8 | Total requests | |
total_conn | 8 | Total established connections | |
total_ssl_conn | 8 | Total SSL connections | |
fastest_rsp_time | 8 | Fastest response time | |
total_fwd_pkts | 8 | Packets processed in forward direction | |
total_rev_pkts_inspected_status_code_non_5xx | 8 | Total reverse packets inspected status code non 5xx | |
total_rev_pkts | 8 | Packets processed in reverse direction | |
total_rev_pkts_inspected_status_code_2xx | 8 | Total reverse packets inspected status code 2xx | |
total_req_succ | 8 | Total requests successful | |
state_flaps | 8 | State flaps count | |
curr_conn | 8 | Current established connections | |
total_rev_pkts_inspected | 8 | Total reverse packets inspected | |
curr_conn_overflow | 8 | Current connection counter overflow count | |
total_rev_bytes | 8 | Bytes processed in reverse direction | |
slowest_rsp_time | 8 | Slowest response time | |
response_time | 8 | Response time |
operational data¶
Counter | Size | Description | |
---|---|---|---|
alt-list | alt-list | ||
hm-key | number | hm-key | |
state | enum | Output contains one of the following values: - UP, DOWN, MAINTENANCE, DIS-UP, DIS-DOWN, DIS-MAINTENANCE, DIS-DAMP | |
drs-list | drs-list | ||
hm-index | number | hm-index |