slb template link-probe¶
Link probe template
link-probe Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name link-probe-list Collection URI /axapi/v3/slb/template/link-probe Element Name link-probe Element URI /axapi/v3/slb/template/link-probe/{name} Element Attributes link-probe_attributes Partition Visibility shared Schema link-probe schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/link-probe | ||
Create List | POST | /axapi/v3/slb/template/link-probe | ||
Get Object | GET | /axapi/v3/slb/template/link-probe/{name} | ||
Get List | GET | /axapi/v3/slb/template/link-probe | ||
Modify Object | POST | /axapi/v3/slb/template/link-probe/{name} | ||
Replace Object | PUT | /axapi/v3/slb/template/link-probe/{name} | ||
Replace List | PUT | /axapi/v3/slb/template/link-probe | ||
Delete Object | DELETE | /axapi/v3/slb/template/link-probe/{name} |
link-probe-list¶
link-probe-list is JSON List of link-probe attributes
link-probe-list : [
]
link-probe attributes¶
destination
Description: destination is a JSON Block. Please see below for destination
Type: Object
Reference Object: /axapi/v3/slb/template/link-probe/{name}/destination
disable
Description Disable Probe template
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
expected-status-code
Description Specify response code range (e.g. 200,400-430), default is 200 (Format is xx,xx-xx (xx between [100, 899]), default is 200)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Default: 200
name
Description probe template Name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
probe-interval
Description Time between each probe that needs to be sent out (in seconds, default is 5)
Type: number
Range: 1-7200
Default: 5
probes-per-test
Description Total number of probes to be sent out for each test
Type: number
Range: 1-10
Default: 5
rtt-method
Description ‘http-rtt’: Calculate Round Trip Time between HTTP request and response; ‘tcp-srtt’: Use TCP Smoothed round trip time in the HTTP connection;
Type: string
Supported Values: http-rtt, tcp-srtt
Default: http-rtt
selection-rule
Description ‘threshold’: Use all links below a threshold before selecting the fastest link; ‘fastest-link-always’: Always use the link with the lowest average latency;
Type: string
Supported Values: threshold, fastest-link-always
Default: fastest-link-always
test-interval
Description time interval between subsequent tests (in seconds, default is 60)
Type: number
Range: 1-7200
Default: 60
threshold-value
Description Use all links below a threshold before selecting the fastest link (RTT in milliseconds)
Type: number
Range: 0-65534
Default: 0
url
Description Specify URL to which probes should be sent out. Default is /
Type: string
Format: string-rlx
Maximum Length: 1023 characters
Maximum Length: 1 characters
Default: /
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
destination¶
Specification Value Type object hostname
Description Target Hostname
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
resolve-as
Description ‘resolve-to-ipv4’: Use A Query only to resolve the configured hostname; ‘resolve-to-ipv6’: Use AAAA Query only to resolve the configured hostname;
Type: string
Supported Values: resolve-to-ipv4, resolve-to-ipv6
Mutual Exclusion: resolve-as, static-ipv4-addr, and static-ipv6-addr are mutually exclusive
static-ipv4-addr
Description Target IPv4 Address
Type: string
Format: ipv4-address
Mutual Exclusion: static-ipv4-addr, resolve-as, and static-ipv6-addr are mutually exclusive
static-ipv6-addr
Description Target IPv6 Address
Type: string
Format: ipv6-address
Mutual Exclusion: static-ipv6-addr, resolve-as, and static-ipv4-addr are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters