Client (List)#
Path: /facilities/http/client
This section defines an Http client. These clients are used by subsystems when accessing web resources, such as Scim server or other services. The important settings are authentication and TLS settings, such as which trust stores to use.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | required | ||
| cache | leafref | optional | The HTTP client cache to use for this client | |
| scheme | enumeration | optional | https | |
| connect-timeout | uint8 | optional | 10 | Http client connect timeout. Determines the timeout in seconds until a connection is established. A timeout value of zero indicates an infinite timeout. The default is 10. The timeout is applicable per connection, i.e. if the client has both IPv4 and IPv6 protocols available, the client will try to start a new connection using IPv6 if the initiated connection using IPv4 timed out and vice-versa, each of which will use the configured connect-timeout. |
| socket-timeout | uint8 | optional | 10 | Http client socket timeout. Determines the timeout in seconds for the maximum period of inactivity while waiting for data or between two consecutive data packets. A timeout value of zero indicates an infinite timeout. The default is 10. |
| include-client-info | boolean | optional | false | Relay information about the upstream client (e.g., IP address, HTTP protocol, etc.) |
| enable-metrics | boolean | optional | false | Whether request metrics for this HTTP client are published by the server. |
Subsections#
| Name | Type | Description |
|---|---|---|
| connection-pool | Section | None |
| http-authentication | OneOf | The authentication method to use |
| tls | Section | None |
| proxy | Section | Settings for the proxy the client should forward its requests through. |
| client-alarms | Section | Toggle what alarms this HTTP client can trigger |
| retry-on-failures | Section | Enables retry after a network error (while connecting, reading, writing on the socket) or a temporary HTTP error: 502 (Bad Gateway), 503 (Service Unavailable), 504 (Gateway Timeout). A configurable delay, (one second by default) is awaited before each retry. By default, a single retry is attempted.Note: When enabling retries, it is advised to reduce the Connect and Socket timeouts to decrease the time the user is waiting for an error in case of long lasting network problem. |