health monitor method http¶
HTTP type
http Specification¶
Type Configuration Resource Element Name http Element URI /axapi/v3/health/monitor/{name}/method/http Element Attributes http_attributes Schema http schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/health/monitor/{name}/method/http | ||
Get Object | GET | /axapi/v3/health/monitor/{name}/method/http | ||
Modify Object | POST | /axapi/v3/health/monitor/{name}/method/http | ||
Replace Object | PUT | /axapi/v3/health/monitor/{name}/method/http | ||
Delete Object | DELETE | /axapi/v3/health/monitor/{name}/method/http |
http attributes¶
http
Description HTTP type
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)http-expect
Description Specify what you expect from the response message
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-host
Description Specify “Host:” header used in request (enclose IPv6 address in [])
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
http-kerberos-auth
Description Http Kerberos Auth
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-kerberos-kdc
Description: http-kerberos-kdc is a JSON Block. Please see below for http-kerberos-kdc
Type: Object
http-kerberos-realm
Description Specify realm of Kerberos server
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
http-maintenance-code
Description Specify response code for maintenance (Format is xx,xx-xx (xx between [100, 899]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
http-password
Description Specify the user password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-password-string
Description Specify password, ‘’ means empty password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters
http-port
Description Specify HTTP Port (Specify port number (default 80))
Type: number
Range: 1-65534
Default: 80
http-postdata
Description Specify the HTTP post data (Input post data here)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
http-postfile
Description Specify the HTTP post data (Input post data file name here)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
http-response-code
Description Specify response code range (e.g. 200,400-430) (Format is xx,xx-xx (xx between [100, 899]))
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: http-response-code and http-text are mutually exclusive
http-text
Description Specify text expected
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: http-text http-response-code and text-regex are mutually exclusive
http-url
Description Specify URL string, default is GET /
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
http-username
Description Specify the username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
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
Mutual Exclusion: maintenance-text and maintenance-text-regex are mutually exclusive
maintenance-text-regex
Description Specify Regex text for maintenance
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: maintenance-text-regex and maintenance-text are mutually exclusive
post-path
Description Specify URL path, default is “/”
Type: string
Format: string-rlx
Maximum Length: 500 characters
Maximum Length: 1 characters
post-type
Description ‘postdata’: Specify the HTTP post data; ‘postfile’: Specify the HTTP post data;
Type: string
Supported Values: postdata, postfile
response-code-regex
Description Specify response code range with Regex (code with Regex, such as [2-5][0-9][0-9])
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
text-regex
Description Specify text expected with Regex
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: text-regex and http-text are mutually exclusive
url-path
Description Specify URL path, default is “/”
Type: string
Format: string-rlx
Maximum Length: 500 characters
Maximum Length: 1 characters
url-type
Description ‘GET’: HTTP GET method; ‘POST’: HTTP POST method; ‘HEAD’: HTTP HEAD method;
Type: string
Supported Values: GET, POST, HEAD
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
http-kerberos-kdc¶
Specification Type object http-kerberos-hostip
Description Kdc’s hostname(length:1-31) or IP address
Type: string
Format: host
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: http-kerberos-hostip and http-kerberos-hostipv6 are mutually exclusive
http-kerberos-hostipv6
Description Server’s IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: http-kerberos-hostipv6 and http-kerberos-hostip are mutually exclusive
http-kerberos-port
Description Specify the kdc port
Type: number
Range: 1-65535
http-kerberos-portv6
Description Specify the kdc port
Type: number
Range: 1-65535