The DTC HTTP monitor object is used to determine the health of a HTTP service by first sending a specific http message to a server and then examining the response received from the server. The validation is successful if the received response matches the expected message.
References to dtc:monitor:http are object references. The name part of a DTC HTTP monitor object reference has the following components:
- Name of DTC HTTP monitor
Example: dtc:monitor:http/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCHttp1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): comment, name.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name |
An optional cipher list for a secure HTTP/S connection.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
An optional client certificate, supplied in a secure HTTP/S mode if present.
Type
String.
This field supports nested return fields as described here.
Create
The default value is empty.
Search
The field is not available for search.
Comment for this DTC monitor; maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
The content check type.
Type
String.
Create
The default value is NONE.
Search
The field is not available for search.
A portion of response to use as input for content check.
Type
String.
Create
The default value is ALL.
Search
The field is not available for search.
A content check success criteria operator.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
A content check regular expression.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
A content extraction sub-expression to extract.
Type
Unsigned integer.
Create
The default value is 0.
Search
The field is not available for search.
A content extraction expected type for the extracted data.
Type
String.
Create
The default value is STRING.
Search
The field is not available for search.
A content extraction value to compare with extracted result.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
Determines whether the Server Name Indication (SNI) for HTTPS monitor is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The interval for TCP health check.
Type
Unsigned integer.
Create
The default value is 5.
Search
The field is not available for search.
The display name for this DTC monitor.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
Port for TCP requests.
Type
Unsigned integer.
Create
The default value is 80.
Search
The field is not available for search.
An HTTP request to send.
Type
String.
Create
The default value is GET /.
Search
The field is not available for search.
The type of an expected result.
Type
String.
Create
The default value is ANY.
Search
The field is not available for search.
The expected return code.
Type
Unsigned integer.
Create
The default value is 200.
Search
The field is not available for search.
The value of how many times the server should appear as down to be treated as dead after it was alive.
Type
Unsigned integer.
Create
The default value is 1.
Search
The field is not available for search.
The value of how many times the server should appear as up to be treated as alive after it was dead.
Type
Unsigned integer.
Create
The default value is 1.
Search
The field is not available for search.
The connection security status.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| ciphers | String | N | N | N | N/A |
| client_cert | String | N | N | N | N/A |
| comment | String | N | N | Y | : = ~ |
| content_check | String | N | N | N | N/A |
| content_check_input | String | N | N | N | N/A |
| content_check_op | String | N | N | N | N/A |
| content_check_regex | String | N | N | N | N/A |
| content_extract_group | Unsigned int | N | N | N | N/A |
| content_extract_type | String | N | N | N | N/A |
| content_extract_value | String | N | N | N | N/A |
| enable_sni | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| interval | Unsigned int | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| port | Unsigned int | N | N | N | N/A |
| request | String | N | N | N | N/A |
| result | String | N | N | N | N/A |
| result_code | Unsigned int | N | N | N | N/A |
| retry_down | Unsigned int | N | N | N | N/A |
| retry_up | Unsigned int | N | N | N | N/A |
| secure | Bool | N | N | N | N/A |
| timeout | Unsigned int | N | N | N | N/A |
| validate_cert | Bool | N | N | N | N/A |
