slb template http-policy¶

http-policy template

http-policy Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name http-policy-list

Collection URI /axapi/v3/slb/template/http-policy

Element Name http-policy

Element URI /axapi/v3/slb/template/http-policy/{name}

Element Attributes http-policy_attributes

Partition Visibility shared

Schema http-policy schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/slb/template/http-policy	http-policy attributes
POST /axapi/v3/slb/template/http-policy/ Payload: { "http-policy": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/slb/template/http-policy	http-policy attributes
Get Object	GET	/axapi/v3/slb/template/http-policy/{name}	http-policy attributes
GET /axapi/v3/slb/template/http-policy/a Reponse: { "http-policy": { "name": "a", "uuid": "ff99574e-5076-11ee-98ee-fbe362803b33", "user-tag": "a", "a10-url": "/axapi/v3/slb/template/http-policy/a" } }
Get List	GET	/axapi/v3/slb/template/http-policy	http-policy-list
Modify Object	POST	/axapi/v3/slb/template/http-policy/{name}	http-policy attributes
Replace Object	PUT	/axapi/v3/slb/template/http-policy/{name}	http-policy attributes
PUT /axapi/v3/slb/template/http-policy/a Payload: { "http-policy": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/slb/template/http-policy	http-policy-list
Delete Object	DELETE	/axapi/v3/slb/template/http-policy/{name}	http-policy attributes
DELETE /axapi/v3/slb/template/http-policy/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

http-policy-list¶

http-policy-list is JSON List of http-policy attributes

http-policy-list : [

{ http-policy attributes },

{ http-policy attributes },

…

]

http-policy attributes¶

cookie-name

Description name of cookie to match (Cookie Name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

geo-location-match

Type: List

http-policy-match

Type: List

multi-match-rule-list

Type: List

Reference Object: /axapi/v3/slb/template/http-policy/{name}/multi-match-rule/{multi-match}

name

Description http-policy template name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

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

http-policy-match¶

Specification Value

Type list

Block object keys

match-string

Description URL String, use “[no-name]” for empty query-param-name match, use “[no-value]” for empty query-param-value match

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

match-type

Description ‘contains’: Select service group if URL string contains another string; ‘ends-with’: Select service group if URL string ends with another string; ‘equals’: Select service group if URL string equals another string; ‘starts-with’: Select service group if URL string starts with another string;

Type: string

Supported Values: contains, ends-with, equals, starts-with

service-group

Description Service Group to be used (Service Group Name)

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

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

type

Description ‘cookie’: cookie value match; ‘host’: hostname match; ‘url’: URL match; ‘header-name’: header name match; ‘header-value’: header value match; ‘query-param-name’: query parameter name; ‘query-param-value’: query parameter value;

Type: string

Supported Values: cookie, host, url, header-name, header-value, query-param-name, query-param-value

multi-match-rule-list¶

Specification Value

Type list

Block object keys

cookie-name-contains-string

Description Cookie value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-name-contains-type

Description ‘contains’: Cookie name contains string;

Type: string

Supported Values: contains

Mutual Exclusion: cookie-name-contains-type,cookie-name-equals-type, cookie-name-starts-with-type, and cookie-name-ends-with-type are mutually exclusive

cookie-name-ends-with-string

Description Cookie name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-name-ends-with-type

Description ‘ends-with’: Cookie name ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: cookie-name-ends-with-type,cookie-name-equals-type, cookie-name-contains-type, and cookie-name-starts-with-type are mutually exclusive

cookie-name-equals-string

Description Cookie name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-name-equals-type

Description ‘equals’: Cookie name equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: cookie-name-equals-type,cookie-name-contains-type, cookie-name-starts-with-type, and cookie-name-ends-with-type are mutually exclusive

cookie-name-starts-with-string

Description Cookie name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-name-starts-with-type

Description ‘starts-with’: Cookie name starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: cookie-name-starts-with-type,cookie-name-equals-type, cookie-name-contains-type, and cookie-name-ends-with-type are mutually exclusive

cookie-value-contains-string

Description Cookie value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-value-contains-type

Description ‘contains’: Cookie value contains string;

Type: string

Supported Values: contains

Mutual Exclusion: cookie-value-contains-type,cookie-value-equals-type, cookie-value-starts-with-type, and cookie-value-ends-with-type are mutually exclusive

cookie-value-ends-with-string

Description Cookie value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-value-ends-with-type

Description ‘ends-with’: Cookie value ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: cookie-value-ends-with-type,cookie-value-equals-type, cookie-value-contains-type, and cookie-value-starts-with-type are mutually exclusive

cookie-value-equals-string

Description Cookie value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-value-equals-type

Description ‘equals’: Cookie value equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: cookie-value-equals-type,cookie-value-contains-type, cookie-value-starts-with-type, and cookie-value-ends-with-type are mutually exclusive

cookie-value-starts-with-string

Description Cookie value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

cookie-value-starts-with-type

Description ‘starts-with’: Cookie value starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: cookie-value-starts-with-type,cookie-value-equals-type, cookie-value-contains-type, and cookie-value-ends-with-type are mutually exclusive

header-name-contains-string

Description Header name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-name-contains-type

Description ‘contains’: Header name contains string;

Type: string

Supported Values: contains

Mutual Exclusion: header-name-contains-type,header-name-equals-type, header-name-starts-with-type, and header-name-ends-with-type are mutually exclusive

header-name-ends-with-string

Description Header name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-name-ends-with-type

Description ‘ends-with’: Header name ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: header-name-ends-with-type,header-name-equals-type, header-name-contains-type, and header-name-starts-with-type are mutually exclusive

header-name-equals-string

Description Header name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-name-equals-type

Description ‘equals’: Header name equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: header-name-equals-type,header-name-contains-type, header-name-starts-with-type, and header-name-ends-with-type are mutually exclusive

header-name-starts-with-string

Description Header name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-name-starts-with-type

Description ‘starts-with’: Header name starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: header-name-starts-with-type,header-name-equals-type, header-name-contains-type, and header-name-ends-with-type are mutually exclusive

header-value-contains-string

Description Header value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-value-contains-type

Description ‘contains’: Header value contains string;

Type: string

Supported Values: contains

Mutual Exclusion: header-value-contains-type,header-value-equals-type, header-value-starts-with-type, and header-value-ends-with-type are mutually exclusive

header-value-ends-with-string

Description Header value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-value-ends-with-type

Description ‘ends-with’: Header value ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: header-value-ends-with-type,header-value-equals-type, header-value-contains-type, and header-value-starts-with-type are mutually exclusive

header-value-equals-string

Description Header value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-value-equals-type

Description ‘equals’: Header value equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: header-value-equals-type,header-value-contains-type, header-value-starts-with-type, and header-value-ends-with-type are mutually exclusive

header-value-starts-with-string

Description Header value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

header-value-starts-with-type

Description ‘starts-with’: Header value starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: header-value-starts-with-type,header-value-equals-type, header-value-contains-type, and header-value-ends-with-type are mutually exclusive

host-contains-string

Description Host string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

host-contains-type

Description ‘contains’: Host contains string;

Type: string

Supported Values: contains

Mutual Exclusion: host-contains-type,host-equals-type, host-starts-with-type, and host-ends-with-type are mutually exclusive

host-ends-with-string

Description Host string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

host-ends-with-type

Description ‘ends-with’: Host ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: host-ends-with-type,host-equals-type, host-contains-type, and host-starts-with-type are mutually exclusive

host-equals-string

Description Host string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

host-equals-type

Description ‘equals’: Host equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: host-equals-type,host-contains-type, host-starts-with-type, and host-ends-with-type are mutually exclusive

host-starts-with-string

Description Host string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

host-starts-with-type

Description ‘starts-with’: Host starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: host-starts-with-type,host-equals-type, host-contains-type, and host-ends-with-type are mutually exclusive

multi-match

Description Specify a multi-match-rule name

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters

query-param-name-contains-string

Description query parameter name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-name-contains-type

Description ‘contains’: query parameter name contains string;

Type: string

Supported Values: contains

Mutual Exclusion: query-param-name-contains-type,query-param-name-equals-type, query-param-name-starts-with-type, and query-param-name-ends-with-type are mutually exclusive

query-param-name-ends-with-string

Description query parameter name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-name-ends-with-type

Description ‘ends-with’: query parameter name ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: query-param-name-ends-with-type,query-param-name-equals-type, query-param-name-contains-type, and query-param-name-starts-with-type are mutually exclusive

query-param-name-equals-string

Description query parameter name string, use “[no-name]” for empty query-param-name match

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-name-equals-type

Description ‘equals’: query parameter name equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: query-param-name-equals-type,query-param-name-contains-type, query-param-name-starts-with-type, and query-param-name-ends-with-type are mutually exclusive

query-param-name-starts-with-string

Description query parameter name string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-name-starts-with-type

Description ‘starts-with’: query parameter name starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: query-param-name-starts-with-type,query-param-name-equals-type, query-param-name-contains-type, and query-param-name-ends-with-type are mutually exclusive

query-param-value-contains-string

Description query parameter value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-value-contains-type

Description ‘contains’: query parameter value contains string;

Type: string

Supported Values: contains

Mutual Exclusion: query-param-value-contains-type,query-param-value-equals-type, query-param-value-starts-with-type, and query-param-value-ends-with-type are mutually exclusive

query-param-value-ends-with-string

Description query parameter value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-value-ends-with-type

Description ‘ends-with’: query parameter value ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: query-param-value-ends-with-type,query-param-value-equals-type, query-param-value-contains-type, and query-param-value-starts-with-type are mutually exclusive

query-param-value-equals-string

Description query parameter value string, use “[no-value]” for empty query-param-value match

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-value-equals-type

Description ‘equals’: query parameter value equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: query-param-value-equals-type,query-param-value-contains-type, query-param-value-starts-with-type, and query-param-value-ends-with-type are mutually exclusive

query-param-value-starts-with-string

Description query parameter value string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

query-param-value-starts-with-type

Description ‘starts-with’: query parameter value starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: query-param-value-starts-with-type,query-param-value-equals-type, query-param-value-contains-type, and query-param-value-ends-with-type are mutually exclusive

seq-num

Description Specify a sequence number

Type: number

Range: 1-8192

service-group

Description Service Group to be used (Service Group Name)

Type: string

Maximum Length: 127 characters

Maximum Length: 1 characters

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

url-contains-string

Description URL string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

url-contains-type

Description ‘contains’: URL contains string;

Type: string

Supported Values: contains

Mutual Exclusion: url-contains-type,url-equals-type, url-starts-with-type, and url-ends-with-type are mutually exclusive

url-ends-with-string

Description URL string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

url-ends-with-type

Description ‘ends-with’: URL ends-with string;

Type: string

Supported Values: ends-with

Mutual Exclusion: url-ends-with-type,url-equals-type, url-contains-type, and url-starts-with-type are mutually exclusive

url-equals-string

Description URL string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

url-equals-type

Description ‘equals’: URL equals to string;

Type: string

Supported Values: equals

Mutual Exclusion: url-equals-type,url-contains-type, url-starts-with-type, and url-ends-with-type are mutually exclusive

url-starts-with-string

Description URL string

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

url-starts-with-type

Description ‘starts-with’: URL starts-with string;

Type: string

Supported Values: starts-with

Mutual Exclusion: url-starts-with-type,url-equals-type, url-contains-type, and url-ends-with-type are mutually exclusive

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

geo-location-match¶

Specification Value

Type list

Block object keys

geo-location

Description Geolocation name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

geo-location-service-group

Description Service Group to be used (Service Group Name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

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