Waiting for engine...
Skip to main content

DeployedApiExecutionSettings

Configuration settings for API execution including concurrency, timeouts, and retry behavior.

type DeployedApiExecutionSettings {
  concurrency: Int!
  retries: Int!
  retryCases: [DeployedApiRetryCase!]
  connectTimeout: Long!
  executionTimeout: Long!
  subscriptionCacheSize: Long!
}

Fields​

DeployedApiExecutionSettings.concurrency ● Int! non-null scalar miscellaneous

A value between 1 and 10000, with 100 as the default, that specifies the number of concurrent calls that can be made to the deployed API. Number of requests processed by configuring concurrency setting is determined by the concurrency setting and the number of processors. For a single node {conKeyRefs.Runtime}, the maximum number of concurrent requests allowed = number of CPUs/processors * 2 * concurrency value. For example, if a single node {conKeyRefs.Runtime} has 12 CPUs and concurrency is set to 1 on the Deployed API, 24 requests (12 * 2 * 1) will be processed by the back-end {conKeyRefs.Runtime} at any point of time.

DeployedApiExecutionSettings.retries ● Int! non-null scalar miscellaneous

A value between 0 and 10, with 1 used as the default, that specifies the number of retries attempted for a call before ending in an error, as configured in the retryCases value.

DeployedApiExecutionSettings.retryCases ● [DeployedApiRetryCase!] list enum platform

Identifies the retry cases.

DeployedApiExecutionSettings.connectTimeout ● Long! non-null scalar partner-portal

A value between 1 and 600 (10 minutes), with 120 used as the default, that specifies the connection timeout value in seconds.

DeployedApiExecutionSettings.executionTimeout ● Long! non-null scalar partner-portal

A value between 1 and 315360000 (10 years), with 315360000 used as the default, that specifies the run time-out value in seconds.

DeployedApiExecutionSettings.subscriptionCacheSize ● Long! non-null scalar partner-portal

The maximum number of entries in a subscription cache per API. Defaults to 1,000 entries (~32KB). Note that this is the maximum size.

Member Of​

DeployedApi object ●  Gateway object

On this Page