Atom Disk Space object

As a Cloud owner, you can use the Atom Disk Space object to retrieve information about the current disk space usage for a given Runtime cloud attachment.

For monitoring purposes, the Atom Disk Space object can help you determine how close your account is to the maximum disk space quota set on the Account Disk Usage property (Runtime Management > Cloud Management > Attachment Quotas tab).

Retrieving Atom disk space is an asynchronous process:

• The client sends a GET request that specifies a container ID to the .
• The platform returns a token for the specified Runtime cloud.
• The client sends one or more GET requests that include the token.
• The platform returns one of the following:
  • Status code 202 while the request is in progress.
  • Status code 200 with the custom contents of the token when the request is complete.

Structure

Initial GET response:

<bns:AsyncOperationTokenResult responseStatusCode="">
    <bns:asyncToken token="AtomDiskSpace-..."/>
</bns:AsyncOperationTokenResult>

Subsequent GET response:

<bns:AsyncOperationResult responseStatusCode="">
    <bns:result xsi:type="bns:AtomDiskSpace" rawTotalSize="" totalSize="" rawQuotaLimit="" quotaLimit="">
        <bns:DiskSpaceDirectory file="" rawSize="" size=""/>
    </bns:result>
</bns:AsyncOperationResult>

Field	Type	Description
Filter	Filter	Filter
file	string	A specific directory within the attachment’s directory for which this size pertains.
rawSize	string	The disk space in bytes that is already consumed within the directory.
size	string	The size of disk space consumed within this directory.
rawTotalSize	string	The disk space in bytes that is already consumed by the given attachment.
totalSize	string	The size of disk space already consumed by the given attachment.
rawQuotaLimit	string	The total number of bytes available for consumption by this attachment.
quotaLimit	string	The total amount of disk space available for consumption by this attachment.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Supported	Not Supported	Not Supported	Not Supported	Not Supported	Not Supported

Using the GET operation

• The GET operation returns the current disk usage state of the given Runtime cloud attachment.

• The initial GET operation returns a token for the specified Runtime cloud attachment. Subsequent GET operations return status code 202 (while the request is in progress) based on the returned token.

SOAP implementation

GET operation

Request (token):

<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>AtomDiskSpace</api:objectType>
         <api:objectId>123456eb-7ac8-9e0a-a1a2-3456a789012</api:objectId>
         <api:accountId>parent-cloud-account-123</api:accountId>
      </api:asyncGet>
   </soapenv:Body>
</soapenv:Envelope>

note

objectID is the Runtime ID for the specific Runtime cloud attachment.

Response (token):

<?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="AtomDiskSpace-12b08345-ab6a-7b0f-8a91-2e34dec567a8"/>
            </bns:result>
        </bns:asyncGetResponse>
    </S:Body>
</S:Envelope>

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>AtomDiskSpace-1e10ed91-3f23-42ea-b999-4ab1376e3ec3</api:token>
         <api:accountId>parent-cloud-account-123</api:accountId>
      </api:asyncResult>
   </soapenv:Body>
</soapenv:Envelope> 

Response (pending):

<?xml version='1.0' encoding='UTF-8'?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <bns:asyncResultResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/"> <bns:results responseStatusCode="202"/> </bns:asyncResultResponse> </S:Body> </S:Envelope>

Response:

<?xml version='1.0' encoding='UTF-8'?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:asyncResultResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results responseStatusCode="200">
                <bns:result xsi:type="bns:AtomDiskSpace" rawTotalSize="975152" totalSize="952 KB">
                    <bns:DiskSpaceDirectory file="/mnt/boomi/cloud/accounts/parent-cloud-account-123/work" rawSize="0" size="0"/>
                    <bns:DiskSpaceDirectory file="/mnt/boomi/cloud/accounts/parent-cloud-account-123/execution/history/2020.07.21" rawSize="18693" size="18 KB"/>
                    <bns:DiskSpaceDirectory file="/mnt/boomi/cloud/accounts/parent-cloud-account-123/execution/history/2020.07.22" rawSize="68779" size="67 KB"/>
                </bns:result>
            </bns:results>
        </bns:asyncResultResponse>
    </S:Body>
</S:Envelope>