health monitor method tcp¶

TCP type

tcp Specification¶

Parameter Value

Type Configuration Resource

Element Name tcp

Element URI /axapi/v3/health/monitor/{name}/method/tcp

Element Attributes tcp_attributes

Partition Visibility shared

Schema tcp schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/monitor/{name}/method/tcp	tcp attributes
POST /axapi/v3/health/monitor/a/method/tcp Payload: { "tcp": { "method-tcp": 1, "tcp-port": 1, "port-halfopen": 1 } }
Get Object	GET	/axapi/v3/health/monitor/{name}/method/tcp	tcp attributes
GET /axapi/v3/health/monitor/a/method/tcp Reponse: { "tcp": { "method-tcp": 1, "tcp-port": 1, "port-halfopen": 1, "uuid": "26a42054-4fcc-11ee-8c93-17f0fbeb6d81", "a10-url": "/axapi/v3/health/monitor/a/method/tcp" } }
Modify Object	POST	/axapi/v3/health/monitor/{name}/method/tcp	tcp attributes
Replace Object	PUT	/axapi/v3/health/monitor/{name}/method/tcp	tcp attributes
PUT /axapi/v3/health/monitor/a/method/tcp Payload: { "tcp": { "method-tcp": 1, "tcp-port": 1, "port-send": "abcd", "maintenance": 1, "maintenance-text": "abcd", "port-resp": { "port-contains": "qwe" } } }
Delete Object	DELETE	/axapi/v3/health/monitor/{name}/method/tcp	tcp attributes
DELETE /axapi/v3/health/monitor/a/method/tcp Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

tcp attributes¶

maintenance

Description Specify response text for maintenance

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maintenance-text

Description Specify text for maintenance

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

method-tcp

Description TCP type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port-halfopen

Description Set TCP SYN check

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: port-halfopen and port-send are mutually exclusive

port-resp

Description: port-resp is a JSON Block. Please see below for port-resp

Type: Object

port-send

Description Send a string to server (Specify the string)

Type: string

Format: string-rlx

Maximum Length: 511 characters

Maximum Length: 1 characters

Mutual Exclusion: port-send and port-halfopen are mutually exclusive

tcp-port

Description Specify TCP port (Specify port number)

Type: number

Range: 1-65534

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

port-resp¶

Specification Value

Type object

port-contains

Description Mark server up if response string contains string (Specify the string)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters