health global¶
Define the Health Monitor global default
global Specification¶
Type Configuration Resource Element Name global Element URI /axapi/v3/health/global Element Attributes global_attributes Schema global schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/health/global | ||
Get Object | GET | /axapi/v3/health/global | ||
Modify Object | POST | /axapi/v3/health/global | ||
Replace Object | PUT | /axapi/v3/health/global | ||
Delete Object | DELETE | /axapi/v3/health/global |
global attributes¶
check-rate
Description Health Check Rate per 500ms (default 1000)
Type: number
Range: 1-50000
Default: 1000
disable-auto-adjust
Description Disable the Health Check Rate Auto Adjustment
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
external-rate
Description Define the External Health Check Rate (Number of External Script Programs (default 2))
Type: number
Range: 1-999
Default: 2
interval
Description Specify the Healthcheck Interval (Interval Value, in seconds (default 5))
Type: number
Range: 1-180
Default: 5
multi-process
Description Start Health Monitoring in Multi-Process Mode (Specify the number of multiple processes (default 1))
Type: number
Range: 1-20
Default: 1
per
Description Specify the Unit Time for the rate (Specify the Unit Time, multiple of 100ms)
Type: number
Range: 1-20
Default: 2
retry
Description Specify the Healthcheck Retries (Retry Count (default 3))
Type: number
Range: 1-10
Default: 3
timeout
Description Specify the Healthcheck Timeout (Timeout Value, in seconds (default 5), Timeout should be less than or equal to interval)
Type: number
Range: 1-180
Default: 5
up-retry
Description Specify the Healthcheck Retries before declaring target up (Up-retry count (default 1))
Type: number
Range: 1-10
Default: 1
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters