system geoloc-list¶

Configure geolocation list

geoloc-list Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name geoloc-list-list

Collection URI /axapi/v3/system/geoloc-list

Element Name geoloc-list

Element URI /axapi/v3/system/geoloc-list/{name}

Element Attributes geoloc-list_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/system/geoloc-list/{name}/stats

Operational Data URI /axapi/v3/system/geoloc-list/{name}/oper

Schema geoloc-list schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/system/geoloc-list	geoloc-list attributes
POST /axapi/v3/system/geoloc-list/ Payload: { "geoloc-list": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/system/geoloc-list	geoloc-list attributes
Get Object	GET	/axapi/v3/system/geoloc-list/{name}	geoloc-list attributes
GET /axapi/v3/system/geoloc-list/a Reponse: { "geoloc-list": { "name": "a", "shared": 0, "uuid": "c390501a-5128-11ee-9f88-7dde599be8ea", "user-tag": "a", "a10-url": "/axapi/v3/system/geoloc-list/a" } }
Get List	GET	/axapi/v3/system/geoloc-list	geoloc-list-list
Modify Object	POST	/axapi/v3/system/geoloc-list/{name}	geoloc-list attributes
Replace Object	PUT	/axapi/v3/system/geoloc-list/{name}	geoloc-list attributes
Replace List	PUT	/axapi/v3/system/geoloc-list	geoloc-list-list
Delete Object	DELETE	/axapi/v3/system/geoloc-list/{name}	geoloc-list attributes

geoloc-list-list¶

geoloc-list-list is JSON List of geoloc-list attributes

geoloc-list-list : [

{ geoloc-list attributes },

{ geoloc-list attributes },

…

]

geoloc-list attributes¶

exclude-geoloc-name-list

Type: List

include-geoloc-name-list

Type: List

name

Description Specify name of Geolocation list

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

sampling-enable

Type: List

shared

Description Enable sharing with other partitions

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

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘hit-count’: some help string; ‘total-geoloc’: some help string; ‘total-active’: some help string;

Type: string

Supported Values: all, hit-count, total-geoloc, total-active

include-geoloc-name-list¶

Specification Value

Type list

Block object keys

include-geoloc-name-val

Description Geolocation name to add

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

exclude-geoloc-name-list¶

Specification Value

Type list

Block object keys

exclude-geoloc-name-val

Description Geolocation name to exclude

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters