cgnv6 template http-alg¶

HTTP-ALG Template

http-alg Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name http-alg-list

Collection URI /axapi/v3/cgnv6/template/http-alg

Element Name http-alg

Element URI /axapi/v3/cgnv6/template/http-alg/{name}

Element Attributes http-alg_attributes

Partition Visibility shared

Schema http-alg schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/cgnv6/template/http-alg	http-alg attributes
POST /axapi/v3/cgnv6/template/http-alg/ Payload: { "http-alg": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/cgnv6/template/http-alg	http-alg attributes
Get Object	GET	/axapi/v3/cgnv6/template/http-alg/{name}	http-alg attributes
GET /axapi/v3/cgnv6/template/http-alg/a Reponse: { "http-alg": { "name": "a", "request-insert-client-ip": 0, "request-insert-msisdn": 0, "uuid": "d4887808-4f88-11ee-9e04-5d5bbc5e5064", "user-tag": "a", "a10-url": "/axapi/v3/cgnv6/template/http-alg/a" } }
Get List	GET	/axapi/v3/cgnv6/template/http-alg	http-alg-list
Modify Object	POST	/axapi/v3/cgnv6/template/http-alg/{name}	http-alg attributes
Replace Object	PUT	/axapi/v3/cgnv6/template/http-alg/{name}	http-alg attributes
PUT /axapi/v3/cgnv6/template/http-alg/a Payload: { "http-alg": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/cgnv6/template/http-alg	http-alg-list
Delete Object	DELETE	/axapi/v3/cgnv6/template/http-alg/{name}	http-alg attributes
DELETE /axapi/v3/cgnv6/template/http-alg/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

http-alg-list¶

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

http-alg-list : [

{ http-alg attributes },

{ http-alg attributes },

…

]

http-alg attributes¶

header-name-client-ip

Description Header name (default: X-Forwarded-For)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: X-Forwarded-For

header-name-msisdn

Description Header name (default: X-MSISDN)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: X-MSISDN

include-tunnel-ip

Description Include the tunnel IP (applies to DS-Lite and 6RD-NAT64 sessions)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

method

Description ‘append’: Append if there is already a header (default); ‘replace’: Replace if there is already a header;

Type: string

Supported Values: append, replace

Default: append

name

Description HTTP-ALG template name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

request-insert-client-ip

Description Insert Client IP into HTTP request

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

request-insert-msisdn

Description Insert MSISDN into HTTP request

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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