3.1.5.5.7 probes

The probes resources are used to configure the mechanism of detection of connectivity issues with load balanced IPs.

The URI for the resource is as follows.

 https://<url>/networking/v1/loadBalancers/{parentResourceId}/probes/{resourceId}

url: The address or name of the REST server of the Network Controller.

parentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.3 for more details.

resourceId: the identifier for the specific descendant resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.5.7.1.1

Create a new probes resource or update an existing probes resource.

GET

3.1.5.5.7.1.2

Get one probes resource.

GET ALL

3.1.5.5.7.1.3

List all probes resources in the Network Controller.

DELETE

3.1.5.5.7.1.4

Deletes a probes resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

intervalInSeconds

Optional

Indicates the interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval SHOULD<5> be slightly less than half the allocated timeout period (in seconds), which allows two full probes before taking the instance out of rotation.

loadBalancingRules

Read-only

Indicates an array of references to loadBalancingRule resources that use this probe.

numberOfProbes

Optional

Indicates the timeout period, in seconds, applied to the probe where no response will result in stopping further traffic from being delivered to the endpoint. This value allows endpoints to be taken out of rotation faster or slower than the typical times (which are the defaults). The default value is 31, the minimum value is 11.

protocol

Required

Indicates the protocol of the endpoint. Valid values are HTTP or TCP. If TCP is specified, a received ACK is required for the probe to be successful. If HTTP is specified, a 200 (OK) response from the specified URI is required for the probe to be successful.

port

Required

Indicates the port for communicating the probe. Possible values range from 1 to 65535, inclusive.

requestPath

Required

Indicates the URI used for requesting health status from the VM. path is required if protocol is set to HTTP. Otherwise, it is not allowed. There is no default value.