system geo-location entry¶
Manually configure geo-location entry
entry Specification¶
Parameter Value Type Collection Object Key(s) geo-locn-obj-name Collection Name entry-list Collection URI /axapi/v3/system/geo-location/entry Element Name entry Element URI /axapi/v3/system/geo-location/entry/{geo-locn-obj-name} Element Attributes entry_attributes Partition Visibility shared Schema entry schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/system/geo-location/entry | ||
Create List | POST | /axapi/v3/system/geo-location/entry | ||
Get Object | GET | /axapi/v3/system/geo-location/entry/{geo-locn-obj-name} | ||
Get List | GET | /axapi/v3/system/geo-location/entry | ||
Modify Object | POST | /axapi/v3/system/geo-location/entry/{geo-locn-obj-name} | ||
Replace Object | PUT | /axapi/v3/system/geo-location/entry/{geo-locn-obj-name} | ||
Replace List | PUT | /axapi/v3/system/geo-location/entry | ||
Delete Object | DELETE | /axapi/v3/system/geo-location/entry/{geo-locn-obj-name} | ||
entry-list¶
entry-list is JSON List of entry attributes
entry-list : [
]
entry attributes¶
geo-locn-multiple-addresses
Type: Listgeo-locn-obj-name
Description Specify geo-location name, section range is (1-15)
Type: string
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
geo-locn-multiple-addresses¶
Specification Value Type list Block object keys first-ip-address
Description Specify IP information (Specify IP address)
Type: string
Format: ipv4-address
first-ipv6-address
Description Specify IPv6 address
Type: string
Format: ipv6-address
geol-ipv4-mask
Description Specify IPv4 mask
Type: string
Format: ipv4-netmask
Mutual Exclusion: geol-ipv4-mask and ip-addr2 are mutually exclusive
geol-ipv6-mask
Description Specify IPv6 mask
Type: number
Range: 0-128
Mutual Exclusion: geol-ipv6-mask and ipv6-addr2 are mutually exclusive
ip-addr2
Description Specify IP address range
Type: string
Format: ipv4-address
Mutual Exclusion: ip-addr2 and geol-ipv4-mask are mutually exclusive
ipv6-addr2
Description Specify IPv6 address range
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-addr2 and geol-ipv6-mask are mutually exclusive