slb service-group member

Servers are add as members of a service group so traffic can be load balanced between them.

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/

member Attributes

Create List

POST

/axapi/v3/slb/service-group/{name}/member/

member Attributes

Get Object

GET

/axapi/v3/slb/service-group/{name}/member/{name}+{port}

member Attributes

Get List

GET

/axapi/v3/slb/service-group/{name}/member/

member-list

Modify Object

POST

/axapi/v3/slb/service-group/{name}/member/{name}+{port}

member Attributes

Replace Object

PUT

/axapi/v3/slb/service-group/{name}/member/{name}+{port}

member Attributes

Replace List

PUT

/axapi/v3/slb/service-group/{name}/member/

member-list

Delete Object

DELETE

/axapi/v3/slb/service-group/{name}/member/{name}+{port}

member Attributes

Get Stats

GET

/axapi/v3/slb/service-group/{name}/member/{name}+{port}/stats

stats data

Get Oper

GET

/axapi/v3/slb/service-group/{name}/member/{name}+{port}/oper

operational data

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

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 for the service-group member.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

member-template

Description: Binds a real port template to a member port.

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/template/port

name

Description: Name of service group member.

Type: string

Format: comp-string

Required: Yes

Reference Object: /axapi/v3/slb/server

port

Description: Service group member port number

Type: number

Range: 0-65534

Default: 65534

Required: Yes

Reference Object: /axapi/v3/slb/server/port

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

server-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

uuid

Description: uuid of the object

Type: string

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘total_fwd_bytes’: Total forward bytes; ‘total_fwd_pkts’: Total forward packets; ‘total_rev_bytes’: Total reverse bytes; ‘total_rev_pkts’: Total reverse packets; ‘total_conn’: Total 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_conn; ‘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;

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

stats data

Counter Size Description
curr_req 8 Current requests
total_fwd_bytes 8 Total forward bytes
total_ssl_conn 8 Total SSL connections
curr_ssl_conn 8 Current SSL connections
peak_conn 8 peak_conn
total_req 8 Total requests
total_conn 8 Total connections
fastest_rsp_time 8 Fastest response time
total_fwd_pkts 8 Total forward packets
total_rev_pkts_inspected_status_code_non_5xx 8 Total reverse packets inspected status code non 5xx
total_rev_pkts 8 Total reverse packets
total_rev_pkts_inspected_status_code_2xx 8 Total reverse packets inspected status code 2xx
total_req_succ 8 Total requests successful
curr_conn 8 Current connections
total_rev_pkts_inspected 8 Total reverse packets inspected
total_rev_bytes 8 Total reverse bytes
slowest_rsp_time 8 Slowest response time
response_time 8 Response time

operational data

Name Type Description
state enum Output contains one of the following values: - UP, DOWN, MAINTENANCE, DIS-UP, DIS-DOWN, DIS-MAINTENANCE