system geoloc-list¶
Configure geolocation list
geoloc-list Specification¶
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 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 | ||
Create List | POST | /axapi/v3/system/geoloc-list | ||
Get Object | GET | /axapi/v3/system/geoloc-list/{name} | ||
Get List | GET | /axapi/v3/system/geoloc-list | ||
Modify Object | POST | /axapi/v3/system/geoloc-list/{name} | ||
Replace Object | PUT | /axapi/v3/system/geoloc-list/{name} | ||
Replace List | PUT | /axapi/v3/system/geoloc-list | ||
Delete Object | DELETE | /axapi/v3/system/geoloc-list/{name} |
geoloc-list-list¶
geoloc-list-list is JSON List of geoloc-list attributes
geoloc-list-list : [
]
geoloc-list attributes¶
exclude-geoloc-name-list
Type: Listinclude-geoloc-name-list
Type: Listname
Description Specify name of Geolocation list
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
sampling-enable
Type: Listshared
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 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 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 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
stats data¶
Counter | Size | Description | |
---|---|---|---|
total-geoloc | 8 | some help string | |
total-active | 8 | some help string | |
hit-count | 8 | some help string |
operational data¶
Counter | Size | Description | |
---|---|---|---|
geoloc-list | geoloc-list |