slb template external-service¶
External service template
external-service Specification¶
Type Collection Object Key(s) name Collection Name external-service-list Collection URI /axapi/v3/slb/template/external-service Element Name external-service Element URI /axapi/v3/slb/template/external-service/{name} Element Attributes external-service_attributes Schema external-service schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/slb/template/external-service | ||
Create List | POST | /axapi/v3/slb/template/external-service | ||
Get Object | GET | /axapi/v3/slb/template/external-service/{name} | ||
Get List | GET | /axapi/v3/slb/template/external-service | ||
Modify Object | POST | /axapi/v3/slb/template/external-service/{name} | ||
Replace Object | PUT | /axapi/v3/slb/template/external-service/{name} | ||
Replace List | PUT | /axapi/v3/slb/template/external-service | ||
Delete Object | DELETE | /axapi/v3/slb/template/external-service/{name} | ||
external-service-list¶
external-service-list is JSON List of external-service attributes
external-service-list : [
]
external-service attributes¶
action
Description ‘continue’: Continue; ‘drop’: Drop; ‘reset’: Reset;
Type: string
Supported Values: continue, drop, reset
Default: continue
bypass-ip-cfg
Type: Listfailure-action
Description ‘continue’: Continue; ‘drop’: Drop; ‘reset’: Reset;
Type: string
Supported Values: continue, drop, reset
Default: continue
name
Description External Service Template Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
service-group
Description Bind a Service Group to the template (Service Group Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/slb/service-group
source-ip
Description Source IP persistence template (Source IP persistence template name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/slb/template/persist/source-ip
tcp-proxy
Description TCP proxy template (TCP proxy template name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/slb/template/tcp-proxy
timeout
Description Timeout value 1 - 200 in units of 200ms, default is 5 (default is 1000ms) (1 - 200 in units of 200ms, default is 5 (1000ms))
Type: number
Range: 1-200
Default: 5
type
Description ‘skyfire-icap’: Skyfire ICAP service; ‘url-filter’: URL filtering service;
Type: string
Supported Values: skyfire-icap, url-filter
Default: url-filter
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
bypass-ip-cfg¶
Specification Type list Block object keys bypass-ip
Description ip address to bypass external service
Type: string
Format: ipv4-address
mask
Description IP prefix mask
Type: string
Format: ipv4-netmask