Boomi Platform API Reference (1.0.0) - AccountCloudAttachmentPropertiesDefault

Toggle Pane

• AccountCloudAttachmentPropertiesDefault
  • postModifies or updates an AccountCloudAttachmentPropertiesDefault object.
  • getRetrieves an AccountCloudAttachmentPropertiesDefault object by identifier
  • getRetrieves an AccountCloudAttachmentPropertiesDefault object by token

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountCloudAttachmentPropertiesDefault

The AccountCloudAttachmentPropertiesDefault object lets the runtime cloud owner retrieve and update the default cloud attachment properties for each runtime cloud cluster. Retrieving the default cloud attachment properties is an asynchronous process:

1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform, where {accountId} is the ID of the authenticating account for the request and {runtimeId} is the ID of the runtime cloud cluster.
2. The platform returns a token.
3. Send one or more GET requests that include the token.
4. The platform returns a list of the cloud attachments associated with the runtime cloud cluster.

Note: The runtime cloud cluster and cloud attachments to which you are calling must be online.

Modifies or updates an AccountCloudAttachmentPropertiesDefault object.

Sets the default cloud attachment properties for runtime cloud clusters.

If you have multiple runtime cloud clusters, you need to set the defaults for each runtime cloud cluster individually. You can use the AccountCloudAttachmentSummary API to see the runtime cloud cluster status.

Note: If a value is not included in the Update call or is explicitly set to null, the value will be reset to its original default value for the runtime cloud cluster.

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

accountDiskUsage	integer <int64> Represented in bytes, this property sets the size limit for an account that uses the private Runtime cloud.
as2Workload	string Enum: "GENERAL" "LOW_LATENCY_DEBUG" Used to select the process run mode for AS2 listener processes.Accepted values: 1. inherited — (Default) The setting is inherited from the Runtime cluster. 2. general — The default process mode for all new processes. 3. low_latency_debug — All AS2 listener processes use an execution worker. Note: After you change this property value you must restart the Runtime cloud cluster or Runtime. If you select Low_Latency_Debug, Trading Partner components that use AS2 listeners also use that run mode.
atomInputSize	integer <int64> Represented in bytes. For Web Services Server listener processes, limits the input size of a web service request. If reaching this limit, it rejects the request.For Flow Services Server listener processes, limits the request size and response size. If reaching this limit, it rejects the request. If reaching this limit, it rejects the request with a 400 error code. If reaching the limit on a response, it rejects the request with a 503 error code.
atomOutputOverflowSize	integer <int64> Represented in bytes, if specified, this value must be a positive number. For Runtime worker processes, this property limits the number of bytes per output datastore maintained in memory before overflowing to disk.
atomWorkingOverflowSize	integer <int64> Represented in bytes. For Runtime worker processes, this property limits the number of bytes per working datastore maintained in memory before overflowing to disk.
cloudAccountExecutionLimit	integer <int32> The total number of concurrent runs allowed. If specified, this value must be a positive number. If this field does not contain a value, there is no limit. On a Cloud, for this limit to take effect, you must also set the Cloud Partition Size property. The Cloud Partition Size property is set in the Properties panel, under Runtime Management.
cloudAccountExecutionWarningOffset	integer <int32> If specified, this value must be a positive number. If this field does not contain a value, it does not generate a warning. This value is subtracted from the Account Concurrent Execution Limit to determine when the Runtime generates a warning that the account is close to exceeding its number of concurrent runs. For example, if this property is set to 5 and the Account Concurrent Execution Limit is set to 20, the Runtime generates a warning in the container log when the account exceeds 15 concurrent runs.
containerId	string
downloadRunnerlogs	boolean Runtime cloud owners can set this property to give account users or specific tenants the ability to download Runtime Worker log files from Runtime Management and run artifacts from Process Reporting.Accepted values: 1. Inherited (false) — The setting is inherited from the Runtime cloud cluster, and the feature is turned off. 2. False — The feature is not enabled, and users cannot download Runtime Worker logs or run artifacts. 3. True — (default) The feature is enabled. Users can download Runtime Worker logs and run artifacts. Note: This property is turned on automatically for public Runtime clouds.
enableAccountDataArchiving	boolean Accepted values: 1. inherited- (plus the value of the setting being inherited. For example, inherited(true) or inherited(false)) indicates that the property inherits what is set in the Runtime cloud cluster. 2. true- If true or Inherited (true), the owner of the selected attached Runtime can enable processed document archiving. 3. false- indicates that the feature is not enabled.
enableAtomWorkerWarmup	boolean Accepted values: 1. inherited- indicating that the property inherits what is set in the Runtime cloud cluster. 2. true- indicating that when an execution worker is within 30 minutes of shutting down, the Cloud starts (“warm-up”) another Runtime worker to replace it. 3. false- indicates that you did not enable the feature. You can use this feature if you provision your account with at least one Runtime worker. If you provision your account with more than one execution worker, and if there are multiple execution workers within 30 minutes of shutting down, then by default it replaces only one execution worker. However, if one of those execution workers has a load greater than “LOW”, then it is replaced even though there is another execution worker running. If you have set the Minimum Execution Workers property, then it replaces the appropriate number of execution workers so that you do not go below the minimum.
flowControlParallelProcessTypeOverride	string Enum: "NONE" "THREADS" "PROCESSES" Overrides the Parallel Process Type setting in Flow Control shapes at a global Runtime cloud or Attachment Quota level. You can set the property only if you are a private Runtime cloud owner.The default value is NONE.
httpRequestRate	integer <int32> Limits the number of Web Services Server requests per second. This limitation is per node in the Runtime cloud, and per Cloud or Runtime attachment (not per account).If it exceeds this value, callers receive a 503 error. After you change this property value you must restart the Runtime cloud cluster or Runtime. Note: If you set an HTTP Request Rate value, API Management uses this limit before the values specified in the API Contract for Rate Limit or Quota Limit.
httpWorkload	string Enum: "GENERAL" "LOW_LATENCY_DEBUG" "LOW_LATENCY" Accepted values: 1. inherited- (plus the value of the setting being inherited. For example, inherited(true) or inherited(false)) indicating that the property inherits what is set in the Runtime cloud cluster. 2. general- The default process mode for all new processes. General mode processes do not use an execution worker, but Low_Latency mode processes do use one. 3. low_latency- All Web Services Server processes use an execution worker and run in Low_Latency mode. 4. low_latency_debug- All Web Services Server processes use an execution worker. Processes configured in Generalmode run in Low_Latency_Debug mode.
listenerMaxConcurrentExecutions	integer <int32> The maximum number of concurrent runs allowed per listener — that is, the maximum listener pool size.
maxConnectorTrackDocs	integer <int32> You must set a positive integer less than or equal to 10,000. For example, in a process run, the maximum number of connector tracking generated documents for a single connector step.After reaching this limit, it does not report more tracking documents to the platform for that step in that run.
minNumberofAtomWorkers	integer <int32> The minimum number of execution workers that run continuously in the Cloud.If this property is set to a number greater than zero, then a few minutes after the Cloud starts and stabilizes, this number of execution workers begin to run. Their starting is not dependent upon receiving incoming process run requests. This behavior is like having multiple runners at the starting line of a race. All runners are ready and start to run as soon as the starter pistol is fired. This property works in conjunction with the Execution Worker Warmup Enabled property. If you set Minimum Execution Workers > 0, then it enables Execution Worker Warmup behavior. As your minimum number of execution workers reach the end of their life span, they are replaced with new execution workers. If the load on active execution workers drop, the Runtime cloud reduces the number of execution workers to the value you set for this property. Note: Setting this property to a number greater than the number of provisioned execution workers in your account does not cause additional execution workers to run. If you would like to have additional execution workers provisioned in your account, contact the Support team.
numberofAtomWorkers	integer <int32> Allocated number of execution workers.
queueCommitBatchLimit	integer <int32>
queueIncomingMessageRateLimit	integer <int32> The maximum number of requests the attachment is allowed to send to the Shared Queue Server per minute. The limit is only enforced if the Incoming Message Rate Limit is set in the underlying cloud Queue Shared Server. If a value is not set or is less than 1, the Shared Queue Server limit is used. The message is rejected if the limit is exceeded and should be retried from within the integration process. The limit is enforced per cloud node.
queueMaxBatchSize	integer <int32>
queueMaxDocSize	integer <int64>
queueMsgThrottleRate	integer <int32>
queueUseFilePersistence	boolean
testModeMaxDocBytes	integer <int64> Represented in bytes, the maximum aggregate data size across the run of a process in test mode. A negative value means there is no maximum.This field is present only if you enable the enhanced test mode feature in the account. If you want to enable this feature, contact your sales representative.
testModeMaxDocs	integer <int32> The maximum number of files (documents) per inbound connector shape during the run of a process in test mode. A negative value means there is no maximum.This field is present only if you enable enhanced test mode feature in the account.
workerElasticScalingThreshold	integer <int32>
workerMaxExecutionTime	integer <int64> Maximum run time in milliseconds for Execution worker processes. For example, an accepted value is 30000. After this amount of time passes, a 522 HTTP status code message is returned to the client saying that the process exceeds the time limit and then cancels the process run. After you change this property value, you must restart the Runtime cloud cluster or Runtime.
workerMaxGeneralExecutionTime	integer <int64> Maximum run time in milliseconds for Execution worker processes that use Low_Latency_Debug mode. For example, an accepted value is 60000. After you change this property value, you must restart the Runtime cloud cluster or Runtime.
workerMaxQueuedExecutions	integer <int32> Maximum number of extra processes that can queue in a single Execution worker, when the maximum number of processes is running. If specified, this value must be a positive number. After you change this property value you must restart the Runtime cloud cluster or Runtime.
workerMaxRunningExecutions	integer <int32> The maximum number of simultaneous processes that can run in a single Execution worker.After you change this property value, you must restart the Runtime cloud cluster or Runtime.
workerQueuedExecutionTimeout	integer <int64> Maximum time that a job in the queue can wait to run. After this amount of time, the job fails with a time-out exception.For example, an accepted value is 0:10:00. After you change this property value you must restart the Runtime cloud cluster or Runtime.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

accountDiskUsage	integer <int64> Represented in bytes, this property sets the size limit for an account that uses the private Runtime cloud.
as2Workload	string Enum: "GENERAL" "LOW_LATENCY_DEBUG" Used to select the process run mode for AS2 listener processes.Accepted values: 1. inherited — (Default) The setting is inherited from the Runtime cluster. 2. general — The default process mode for all new processes. 3. low_latency_debug — All AS2 listener processes use an execution worker. Note: After you change this property value you must restart the Runtime cloud cluster or Runtime. If you select Low_Latency_Debug, Trading Partner components that use AS2 listeners also use that run mode.
atomInputSize	integer <int64> Represented in bytes. For Web Services Server listener processes, limits the input size of a web service request. If reaching this limit, it rejects the request.For Flow Services Server listener processes, limits the request size and response size. If reaching this limit, it rejects the request. If reaching this limit, it rejects the request with a 400 error code. If reaching the limit on a response, it rejects the request with a 503 error code.
atomOutputOverflowSize	integer <int64> Represented in bytes, if specified, this value must be a positive number. For Runtime worker processes, this property limits the number of bytes per output datastore maintained in memory before overflowing to disk.
atomWorkingOverflowSize	integer <int64> Represented in bytes. For Runtime worker processes, this property limits the number of bytes per working datastore maintained in memory before overflowing to disk.
cloudAccountExecutionLimit	integer <int32> The total number of concurrent runs allowed. If specified, this value must be a positive number. If this field does not contain a value, there is no limit. On a Cloud, for this limit to take effect, you must also set the Cloud Partition Size property. The Cloud Partition Size property is set in the Properties panel, under Runtime Management.
cloudAccountExecutionWarningOffset	integer <int32> If specified, this value must be a positive number. If this field does not contain a value, it does not generate a warning. This value is subtracted from the Account Concurrent Execution Limit to determine when the Runtime generates a warning that the account is close to exceeding its number of concurrent runs. For example, if this property is set to 5 and the Account Concurrent Execution Limit is set to 20, the Runtime generates a warning in the container log when the account exceeds 15 concurrent runs.
containerId	string
downloadRunnerlogs	boolean Runtime cloud owners can set this property to give account users or specific tenants the ability to download Runtime Worker log files from Runtime Management and run artifacts from Process Reporting.Accepted values: 1. Inherited (false) — The setting is inherited from the Runtime cloud cluster, and the feature is turned off. 2. False — The feature is not enabled, and users cannot download Runtime Worker logs or run artifacts. 3. True — (default) The feature is enabled. Users can download Runtime Worker logs and run artifacts. Note: This property is turned on automatically for public Runtime clouds.
enableAccountDataArchiving	boolean Accepted values: 1. inherited- (plus the value of the setting being inherited. For example, inherited(true) or inherited(false)) indicates that the property inherits what is set in the Runtime cloud cluster. 2. true- If true or Inherited (true), the owner of the selected attached Runtime can enable processed document archiving. 3. false- indicates that the feature is not enabled.
enableAtomWorkerWarmup	boolean Accepted values: 1. inherited- indicating that the property inherits what is set in the Runtime cloud cluster. 2. true- indicating that when an execution worker is within 30 minutes of shutting down, the Cloud starts (“warm-up”) another Runtime worker to replace it. 3. false- indicates that you did not enable the feature. You can use this feature if you provision your account with at least one Runtime worker. If you provision your account with more than one execution worker, and if there are multiple execution workers within 30 minutes of shutting down, then by default it replaces only one execution worker. However, if one of those execution workers has a load greater than “LOW”, then it is replaced even though there is another execution worker running. If you have set the Minimum Execution Workers property, then it replaces the appropriate number of execution workers so that you do not go below the minimum.
flowControlParallelProcessTypeOverride	string Enum: "NONE" "THREADS" "PROCESSES" Overrides the Parallel Process Type setting in Flow Control shapes at a global Runtime cloud or Attachment Quota level. You can set the property only if you are a private Runtime cloud owner.The default value is NONE.
httpRequestRate	integer <int32> Limits the number of Web Services Server requests per second. This limitation is per node in the Runtime cloud, and per Cloud or Runtime attachment (not per account).If it exceeds this value, callers receive a 503 error. After you change this property value you must restart the Runtime cloud cluster or Runtime. Note: If you set an HTTP Request Rate value, API Management uses this limit before the values specified in the API Contract for Rate Limit or Quota Limit.
httpWorkload	string Enum: "GENERAL" "LOW_LATENCY_DEBUG" "LOW_LATENCY" Accepted values: 1. inherited- (plus the value of the setting being inherited. For example, inherited(true) or inherited(false)) indicating that the property inherits what is set in the Runtime cloud cluster. 2. general- The default process mode for all new processes. General mode processes do not use an execution worker, but Low_Latency mode processes do use one. 3. low_latency- All Web Services Server processes use an execution worker and run in Low_Latency mode. 4. low_latency_debug- All Web Services Server processes use an execution worker. Processes configured in Generalmode run in Low_Latency_Debug mode.
listenerMaxConcurrentExecutions	integer <int32> The maximum number of concurrent runs allowed per listener — that is, the maximum listener pool size.
maxConnectorTrackDocs	integer <int32> You must set a positive integer less than or equal to 10,000. For example, in a process run, the maximum number of connector tracking generated documents for a single connector step.After reaching this limit, it does not report more tracking documents to the platform for that step in that run.
minNumberofAtomWorkers	integer <int32> The minimum number of execution workers that run continuously in the Cloud.If this property is set to a number greater than zero, then a few minutes after the Cloud starts and stabilizes, this number of execution workers begin to run. Their starting is not dependent upon receiving incoming process run requests. This behavior is like having multiple runners at the starting line of a race. All runners are ready and start to run as soon as the starter pistol is fired. This property works in conjunction with the Execution Worker Warmup Enabled property. If you set Minimum Execution Workers > 0, then it enables Execution Worker Warmup behavior. As your minimum number of execution workers reach the end of their life span, they are replaced with new execution workers. If the load on active execution workers drop, the Runtime cloud reduces the number of execution workers to the value you set for this property. Note: Setting this property to a number greater than the number of provisioned execution workers in your account does not cause additional execution workers to run. If you would like to have additional execution workers provisioned in your account, contact the Support team.
numberofAtomWorkers	integer <int32> Allocated number of execution workers.
queueCommitBatchLimit	integer <int32>
queueIncomingMessageRateLimit	integer <int32> The maximum number of requests the attachment is allowed to send to the Shared Queue Server per minute. The limit is only enforced if the Incoming Message Rate Limit is set in the underlying cloud Queue Shared Server. If a value is not set or is less than 1, the Shared Queue Server limit is used. The message is rejected if the limit is exceeded and should be retried from within the integration process. The limit is enforced per cloud node.
queueMaxBatchSize	integer <int32>
queueMaxDocSize	integer <int64>
queueMsgThrottleRate	integer <int32>
queueUseFilePersistence	boolean
testModeMaxDocBytes	integer <int64> Represented in bytes, the maximum aggregate data size across the run of a process in test mode. A negative value means there is no maximum.This field is present only if you enable the enhanced test mode feature in the account. If you want to enable this feature, contact your sales representative.
testModeMaxDocs	integer <int32> The maximum number of files (documents) per inbound connector shape during the run of a process in test mode. A negative value means there is no maximum.This field is present only if you enable enhanced test mode feature in the account.
workerElasticScalingThreshold	integer <int32>
workerMaxExecutionTime	integer <int64> Maximum run time in milliseconds for Execution worker processes. For example, an accepted value is 30000. After this amount of time passes, a 522 HTTP status code message is returned to the client saying that the process exceeds the time limit and then cancels the process run. After you change this property value, you must restart the Runtime cloud cluster or Runtime.
workerMaxGeneralExecutionTime	integer <int64> Maximum run time in milliseconds for Execution worker processes that use Low_Latency_Debug mode. For example, an accepted value is 60000. After you change this property value, you must restart the Runtime cloud cluster or Runtime.
workerMaxQueuedExecutions	integer <int32> Maximum number of extra processes that can queue in a single Execution worker, when the maximum number of processes is running. If specified, this value must be a positive number. After you change this property value you must restart the Runtime cloud cluster or Runtime.
workerMaxRunningExecutions	integer <int32> The maximum number of simultaneous processes that can run in a single Execution worker.After you change this property value, you must restart the Runtime cloud cluster or Runtime.
workerQueuedExecutionTimeout	integer <int64> Maximum time that a job in the queue can wait to run. After this amount of time, the job fails with a time-out exception.For example, an accepted value is 0:10:00. After you change this property value you must restart the Runtime cloud cluster or Runtime.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/AccountCloudAttachmentPropertiesDefault/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AccountCloudAttachmentPropertiesDefault",
• "accountDiskUsage": "429496729600",
• "numberofAtomWorkers": "1",
• "atomInputSize": "413132133313",
• "atomOutputOverflowSize": "421313313",
• "atomWorkingOverflowSize": "31313313",
• "httpRequestRate": "31313313",
• "workerMaxExecutionTime": "30000",
• "workerMaxGeneralExecutionTime": "600000",
• "workerMaxRunningExecutions": "20",
• "workerMaxQueuedExecutions": "10",
• "workerQueuedExecutionTimeout": "10000",
• "maxConnectorTrackDocs": "10000",
• "httpWorkload": "LOW_LATENCY",
• "as2Workload": "GENERAL",
• "cloudAccountExecutionLimit": "2147383646",
• "cloudAccountExecutionWarningOffset": "31313213",
• "enableAtomWorkerWarmup": "false",
• "minNumberofAtomWorkers": "1",
• "testModeMaxDocs": "100",
• "testModeMaxDocBytes": "10485760",
• "enableAccountDataArchiving": "false",
• "listenerMaxConcurrentExecutions": "6",
• "downloadRunnerlogs": "true"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AccountCloudAttachmentPropertiesDefault",
• "statusCode": 200,
• "sessionId": "AccountCloudAttachmentPropertiesDefault-1f23456f-a78f-91cc-012e-3e4dec5b67d8"

}

Retrieves an AccountCloudAttachmentPropertiesDefault object by identifier

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (AsyncToken)
responseStatusCode required	integer <int32>

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/async/AccountCloudAttachmentPropertiesDefault/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AsyncOperationTokenResult",
• "asyncToken": {

  • "@type": "AsyncToken",
  • "token": "AccountCloudAttachmentPropertiesDefault-1f23456f-a78f-91cc-012e-3e4dec5b67d8"

  },
• "responseStatusCode": 200

}

Retrieves an AccountCloudAttachmentPropertiesDefault object by token

Authorizations:

basicAuth

path Parameters

token required

string Takes in the token from a previous call to return a result.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

responseStatusCode required	integer <int32>
numberOfResults	integer <int32>
	Array of objects (AccountCloudAttachmentPropertiesDefault)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/async/AccountCloudAttachmentPropertiesDefault/response/{token}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AsyncOperationResult",
• "result": [

  • {

    • "@type": "AccountCloudAttachmentPropertiesDefault",
    • "accountDiskUsage": 4294,
    • "numberofAtomWorkers": 4,
    • "atomInputSize": 4131,
    • "atomOutputOverflowSize": 4213,
    • "atomWorkingOverflowSize": 413,
    • "httpRequestRate": 43,
    • "workerMaxExecutionTime": 322,
    • "workerMaxGeneralExecutionTime": 322,
    • "workerMaxRunningExecutions": 40,
    • "workerMaxQueuedExecutions": 40,
    • "workerQueuedExecutionTimeout": 401,
    • "maxConnectorTrackDocs": 40,
    • "httpWorkload": "LOW_LATENCY_DEBUG",
    • "as2Workload": "GENERAL",
    • "cloudAccountExecutionLimit": 415,
    • "cloudAccountExecutionWarningOffset": 413,
    • "enableAtomWorkerWarmup": true,
    • "minNumberofAtomWorkers": 4,
    • "testModeMaxDocs": 400,
    • "testModeMaxDocBytes": 304,
    • "enableAccountDataArchiving": true,
    • "listenerMaxConcurrentExecutions": 5,
    • "downloadRunnerlogs": true

    }

  ],
• "responseStatusCode": 200

}