slb template external-service¶

External service template

external-service Specification¶

Parameter Value

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

Partition Visibility shared

Schema external-service schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/slb/template/external-service	external-service attributes
POST /axapi/v3/slb/template/external-service/ Payload: { "external-service": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/slb/template/external-service	external-service attributes
Get Object	GET	/axapi/v3/slb/template/external-service/{name}	external-service attributes
GET /axapi/v3/slb/template/external-service/a Reponse: { "external-service": { "name": "a", "failure-action": "continue", "timeout": 5, "action": "continue", "type": "url-filter", "uuid": "6a9922e2-5075-11ee-98ee-fbe362803b33", "user-tag": "a", "a10-url": "/axapi/v3/slb/template/external-service/a" } }
Get List	GET	/axapi/v3/slb/template/external-service	external-service-list
Modify Object	POST	/axapi/v3/slb/template/external-service/{name}	external-service attributes
Replace Object	PUT	/axapi/v3/slb/template/external-service/{name}	external-service attributes
PUT /axapi/v3/slb/template/external-service/a Payload: { "external-service": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/slb/template/external-service	external-service-list
Delete Object	DELETE	/axapi/v3/slb/template/external-service/{name}	external-service attributes
DELETE /axapi/v3/slb/template/external-service/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

external-service-list¶

external-service-list is JSON List of external-service attributes

external-service-list : [

{ external-service attributes },

{ external-service attributes },

…

]

external-service attributes¶

action

Description ‘continue’: Continue; ‘drop’: Drop; ‘reset’: Reset;

Type: string

Supported Values: continue, drop, reset

Default: continue

bypass-ip-cfg

Type: List

failure-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: 127 characters

Maximum Length: 1 characters

request-header-forward-list

Type: List

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

Reference Object: /axapi/v3/slb/service-group

shared-partition-persist-source-ip-template

Description Reference a persist source ip template from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-persist-source-ip-template and source-ip are mutually exclusive

shared-partition-tcp-proxy-template

Description Reference a TCP Proxy template from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared-partition-tcp-proxy-template and tcp-proxy are mutually exclusive

source-ip

Description Source IP persistence template (Source IP persistence template name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Mutual Exclusion: source-ip and shared-partition-persist-source-ip-template are mutually exclusive

Reference Object: /axapi/v3/slb/template/persist/source-ip

tcp-proxy

Description TCP Proxy Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Mutual Exclusion: tcp-proxy and shared-partition-tcp-proxy-template are mutually exclusive

template-persist-source-ip-shared

Description Source IP Persistence Template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/template/persist/source-ip

template-tcp-proxy-shared

Description TCP Proxy Template name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference 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 Value

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

request-header-forward-list¶

Specification Value

Type list

Block object keys

request-header-forward

Description Request header to be forwarded to external service (Header Name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters