slb template mqtt¶

MQTT template

mqtt Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name mqtt-list

Collection URI /axapi/v3/slb/template/mqtt

Element Name mqtt

Element URI /axapi/v3/slb/template/mqtt/{name}

Element Attributes mqtt_attributes

Partition Visibility shared

Schema mqtt schema

Operations Allowed:

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

mqtt-list¶

mqtt-list is JSON List of mqtt attributes

mqtt-list : [

{ mqtt attributes },

{ mqtt attributes },

…

]

mqtt attributes¶

clientid-hash-first

Description Use the begining part of client ID to calculate hash value (client ID string length to calculate hash value)

Type: number

Range: 4-128

clientid-hash-last

Description Use the end part of Client ID to calculate hash value (Client ID length to calculate hash value)

Type: number

Range: 4-128

clientid-hash-offset

Description Skip part of Client ID to calculate hash value (Offset of the Client ID)

Type: number

Range: 0-255

clientid-hash-persist

Description Use Client ID’s hash value to select server

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description MQTT 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