Waiting for engine...
Skip to main content

Account Cloud Attachment Properties object

Programmatically get or edit the properties of a Runtime cloud's attachments, such as Runtime cloud and the Atom that the owner or accounts attached to the Cloud.

These actions are equivalent to those you can perform from the Attachment quotas tab (Manage > Cloud Management) in the user interface.

Retrieving Account Cloud Attachment Properties is an asynchronous process:

  1. Send a GET request that specifies both the account ID and container ID to the Boomi Enterprise Platform.
  2. The platform returns a token for the specified Runtime cloud .
  3. Send one or more GET requests that include the token. Retrieving property values does not require a request body.
  4. The platform returns list of existing property names and values for the given account and Cloud.

Updating Account Cloud Attachment Properties does not require a request token. Therefore, you only need to make one request when updating one or more properties. When modifying properties, send a POST request including only those property names and values in the request body that you wish to modify.

Structure​

Initial GET response

<bns:AsyncOperationTokenResult responseStatusCode="202">
    <bns:asyncToken token=""/>
</bns:AsyncOperationTokenResult>

Subsequent GET response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:AsyncOperationResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" responseStatusCode="200">
    <bns:result xsi:type="bns:AccountCloudAttachmentProperties" accountDiskUsage="" numberofAtomWorkers="" atomInputSize="" atomOutputOverflowSize="" atomWorkingOverflowSize="" httpRequestRate="" workerMaxExecutionTime="" workerMaxGeneralExecutionTime="" workerMaxRunningExecutions="" workerMaxQueuedExecutions="" workerQueuedExecutionTimeout="" maxConnectorTrackDocs="" httpWorkload="" as2Workload="" cloudAccountExecutionLimit="" cloudAccountExecutionWarningOffset="" enableAtomWorkerWarmup="" minNumberofAtomWorkers="" testModeMaxDocs="" testModeMaxDocBytes="" enableAccountDataArchiving="" listenerMaxConcurrentExecutions="" downloadRunnerlogs=""/>
</bns:AsyncOperationResult>

All properties that are eligible for viewing or updating as part of the Account Cloud Attachment Properties object are representative of those described in the topic Attachment quotas tab.

FieldTypeRepresents UI propertyDescription
accountDiskUsageintegerAccount Disk UsageRepresented in bytes, this property is used to set the size limit for an account that uses the private runtime cloud.
as2WorkloadstringDefault AS2 WorkloadUsed 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.
atomOutputOverflowSizeintegerAtom Output Overflow SizeRepresented in bytes, if specified, this value must be a positive number. For Execution worker processes, this property limits the number of bytes per output datastore maintained in memory before overflowing to disk.
atomWorkingOverflowSizeintegerAtom Working Overflow SizeRepresented in bytes. For Execution worker processes, this property limits the number of bytes per working datastore maintained in memory before overflowing to disk.
atomInputSizeintegerWeb Service Request Input SizeRepresented 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.
cloudAccountExecutionLimitintegerAccount Concurrent Execution LimitThe 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.
cloudAccountExecutionWarningOffsetintegerAccount Concurrent Execution Warning OffsetIf 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 Atom 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 Atom generates a warning in the container log when the account exceeds 15 concurrent runs.
downloadRunnerlogsstringEnable Download of Execution Artifacts and Worker LogsRuntime cloud owners can set this property to give account users or specific tenants the ability to download Execution 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 clusters, and the feature is turned off.
2. False — The feature is not enabled, and users cannot download Execution worker logs or run artifacts.
3. True — (default) The feature is enabled. Users can download Execution worker logs and run artifacts. Note: This property is turned on automatically for public runtime clouds.
enableAtomWorkerWarmupstringExecution Worker Warmup EnabledAccepted values:
1. inherited- indicating that the property inherits what is set in the runtime cloud clusters.
2. true- indicating that when an Execution worker is within 30 minutes of shutting down, the Cloud starts (“warm-up”) another Execution 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 Execution 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.
enableAccountDataArchivingstringEnable Processed Document ArchivingAccepted 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 clusters.
2. true- If true or Inherited (true), the owner of the selected attached Atom can enable processed document archiving.
3. false- indicates that the feature is not enabled.
flowControlParallelProcessTypeOverridestringNONE THREADS PROCESSESOverrides 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.
httpRequestRateintegerHTTP Request RateLimits the number of Web Services Server requests per second. This limitation is per node in the Runtime cloud , and per Cloud or Atom 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.
httpWorkloadstringDefault HTTP WorkloadAccepted 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 clusters.
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.
listenerMaxConcurrentExecutionsintegerMaximum Concurrent Executions per ListenerThe maximum number of concurrent runs allowed per listener — that is, the maximum listener pool size.
maxConnectorTrackDocsintegerMaximum Connector Tracking DocumentsYou 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.
minNumberofAtomWorkersintegerMinimum Execution workersThe 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.
numberofAtomWorkersintegerExecution workersAllocated number of execution workers.
testModeMaxDocsintegerTest Mode Maximum Document CountThe 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.
testModeMaxDocBytesintegerTest Mode Maximum Aggregate Document SizeRepresented 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.
workerMaxExecutionTimeintegerExecution Worker Maximum Run TimeMaximum 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.
workerMaxGeneralExecutionTimeintegerExecution Worker Maximum General Execution TimeMaximum 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.
workerMaxRunningExecutionsintegerExecution Worker Maximum Running ExecutionsThe 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.
workerMaxQueuedExecutionsintegerExecution Worker Maximum Queued ExecutionsMaximum 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.
workerQueuedExecutionTimeouthr:min:sec:msExecution Worker Queued Execution Time-outMaximum 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.
accountDiskUsageintegerAccount Disk UsageRepresented in bytes, this property sets the size limit for an account that uses the private runtime cloud.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedNot SupportedNot SupportedSupportedNot SupportedNot Supported

Using the GET operation​

  • Use the GET operation to return and view a full list of Account Cloud attachment properties and their current values. This action is equivalent to viewing the Attachment quotas tab (Manage > Cloud Management) in the user interface.

  • As detailed earlier in this topic, you must send two GET requests to retrieve Account Cloud attachment properties:

    1. Send a GET request that specifies both the account ID and container ID to the . The platform returns a token for the specified Runtime cloud .
    2. Send a second GET request with the token returned in step 1. The object returns a list of existing property names and values for the given account and Cloud.

  • The Cloud and attachments to which you are calling must be online. Cloud owners and users that own the Cloud attachments can use this operation.

Using the UPDATE operation​

  • Use the UPDATE operation to modify one or more Account Cloud attachment properties. To update property values, include all property names that you want to modify including their new values in the request body; you do not need to provide the full list of properties in the request. This action is equivalent to editing property values on the Attachment quotas tab (Manage > Cloud Management) in the user interface.

    To ensure a successful request, you must provide valid property names and their accepted values in the request body. Otherwise, it returns an error.

  • The response returns a status code of 200 indicating a successful request. To verify updates made to a property, you can make a new GET request or view the Cloud attachment quotas tab (Manage > Cloud Management) in the user interface.

  • To modify properties, you must be the owner of the private runtime cloud, and both the Runtime cloud and its attachments must be online.

SOAP implementation​

Request (first GET request):

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <api:asyncGet>
            <api:objectType>AccountCloudAttachmentProperties</api:objectType>
            <api:objectId>1f23456f-a78f-91cc-012e-3e4dec5b67d8</api:objectId>
            <api:accountId>parent-cloud-account-123 or attachment-accountId-123</api:accountId>
        </api:asyncGet>
    </soapenv:Body>
</soapenv:Envelope>

Response (first GET request):

<?xml version='1.0' encoding='UTF-8'?>
 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:asyncGetResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:result responseStatusCode="202">
                <bns:asyncToken token="AccountCloudAttachmentProperties-1f23456f-a78f-91cc-012e-3e4dec5b67d8"/>
            </bns:result>
        </bns:asyncGetResponse>
    </S:Body>
</S:Envelope>

Request (second GET request):

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <api:asyncResult>
            <api:token>AccountCloudAttachmentProperties-1f23456f-a78f-91cc-012e-3e4dec5b67d8</api:token>
            <api:accountId>parent-cloud-account-123 or attachment-accountId-123</api:accountId>
        </api:asyncResult>
    </soapenv:Body>
</soapenv:Envelope>

Response (second GET request):

<?xml version='1.0' encoding='UTF-8'?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
      <bns:asyncGetResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
          <bns:result responseStatusCode="202">
              <object xsi:type="api:AccountCloudAttachmentProperties" containerId="1b2a345e-6d78-9fa0-bdba-1b2caeaec34d" 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">
              </object>
          </bns:result>
      </bns:asyncGetResponse>
  </S:Body>
</S:Envelope>
On this Page