Application Gateway Global Settings API

URL

Operations

• list: Retrieves a list of values for the global configuration settings for each application gateway type. The only supported type is CUSTOM_GATEWAY.

Parameters

• errorThreshold: Specifies the number of consecutive errors after which the router declares the Application Gateway host unavailable and tries to reconnect.

• heartbeat: Information about the heartbeat, which includes the following parameters:

  • interval: The time in milliseconds the router waits between successful heartbeats.

  • limit: The number of consecutive missed heartbeats after which the router closes the connection and attempts to reconnect.

  • retry: How long in milliseconds the router waits before retrying a heartbeat after a heartbeat has failed.

  • timeout: How long in milliseconds the router waits for a response to a heartbeat before considering it a failure.

• session: Information about the session, which includes the following parameters:

  • openTimeout: How long in milliseconds the router waits for a response to an open or close request. If it receives no response within this time, the router assumes the request failed.

  • retry: How long in milliseconds the router waits before trying to reconnect after a connection terminates or a connection attempts fails.

  • retryLimit: The number of times the router tries to establish the connection before it quits. If this limit is reached, you must restart the connection.

• timeout: Information about the request, which includes the following parameters:

  • abandon: An internal timeout in milliseconds for communication between the router and the Application Gateway interface process. If a request exceeds this limit, the router assumes the Application Gateway interface process is off-line.

  • late: An internal timeout in milliseconds for communication between the router and the Application Gateway interface process. If a request exceeds this limit, the system software considers the request to be late.

  • request: How long in milliseconds the system software waits before timing out a request.

• type: The type of application gateway. The only supported type is CUSTOM_GATEWAY.

Example Get Response

Copy
<applicationGatewayGlobalSettings>
    <applicationGatewayGlobalSetting>
        <connectionParameters>
            <errorThreshold>10</errorThreshold>
            <heartBeat>
                <interval>15000</interval>
                <limit>10</limit>
                <retry>200</retry>
                <timeout>300</timeout>
            </heartBeat>
            <session>
                <openTimeout>15000</openTimeout>
                <retry>60000</retry>
                <retryLimit>10</retryLimit>
            </session>
            <timeout>
                <abandon>5000</abandon>
                <late>300</late>
                <request>300</request>
            </timeout>
        </connectionParameters>
        <type>CUSTOM_GATEWAY</type>
    </applicationGatewayGlobalSetting>
</applicationGatewayGlobalSettings>