health monitor method external¶

EXTERNAL type

external Specification¶

Parameter Value

Type Configuration Resource

Element Name external

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

Element Attributes external_attributes

Partition Visibility shared

Schema external schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/monitor/{name}/method/external	external attributes
POST /axapi/v3/health/monitor/a/method/external Payload: { "external": { "external": 1, "ext-program": "a", "ext-port": 1 } }
Get Object	GET	/axapi/v3/health/monitor/{name}/method/external	external attributes
GET /axapi/v3/health/monitor/a/method/external Reponse: { "external": { "external": 1, "ext-program": "a", "ext-port": 1, "ext-preference": 0, "uuid": "d1d6d704-4fc8-11ee-8c93-17f0fbeb6d81", "a10-url": "/axapi/v3/health/monitor/a/method/external" } }
Modify Object	POST	/axapi/v3/health/monitor/{name}/method/external	external attributes
Replace Object	PUT	/axapi/v3/health/monitor/{name}/method/external	external attributes
PUT /axapi/v3/health/monitor/a/method/external Payload: { "external": { "external": 1, "ext-program": "abcd", "ext-port": 2 } }
Delete Object	DELETE	/axapi/v3/health/monitor/{name}/method/external	external attributes
DELETE /axapi/v3/health/monitor/a/method/external Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

external attributes¶

ext-arguments

Description Specify external application’s arguments (Application arguments)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

ext-port

Description Specify the server port (Port Number)

Type: number

Range: 1-65534

ext-preference

Description Get server’s perference

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ext-program

Description Specify external application (Program name)

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

ext-program-shared

Description Specify external application (Program name)

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

external

Description EXTERNAL type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

shared-partition-program

Description external application from shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters