Internal Console API

InternalCloud

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Provides access to system level information for this installation.

Method Summary
  deleteJob(String jobId)

Deletes the specified job (presumably stuck job) from the job queue.

InternalApiMonitor getApiMonitor()

Returns the API monitor for this cloud

InternalAuthManager getAuthManager()

Returns authentication manager for this cloud.

Data getCodeInfo()

Returns the code distro settings for this cloud.

SystemDataView getDaemonLogs()

Provides access to system daemon logs.

DataList getIssuers()

Returns a list containing the default root level certificate issuers for the cloud.

SystemDataView getJobQueue()

Provides access to system job queue.

SystemDataView getJobsPending()

Provides access to system jobs not yet in the queue.

Data getMainStatusInfo(String node)

Returns primary information on replication status for the given node.

DataList getMemorySummary()

Returns a list containing memory information and operating system for this cloud.

Data getReadStatusInfo(String node)

Returns read information on replication status for the given node.

DataList getSessionSummary()

Returns a list of active sessions summary by worker and location. The information has an accuracy window of approximately 5 minutes.

DataList getSessions(Date startDate, Date endDate, String type, int limit)

Returns a list of sessions that have accessed this cloud in the since the given date.

DataList getStorageList()

Returns a list containing information on storage nodes.

DataList getStorageProcessList(String node)

Returns a list containing information on storage processes.

Data getStorageStatusInfo(String node)

Returns information on storage status for the given node.

DataList getStorageTables(String node)

Returns a list containing information on storage tables.

Data getStorageVariableInfo(String node)

Returns information on storage variables for the given node.

Data getSupportInfo()

Returns the support info for this cloud.

Data getSystemInfo()

Returns the system info for this cloud.

DataList getThreadSummary()

Returns a list containing thread information for this cloud.

DataList getTrafficSummary()

Returns a list containing traffic information for this cloud.

String toString()

Returns a description of this object.

Method Detail


deleteJob(String jobId)

Deletes the specified job (presumably stuck job) from the job queue.

Parameters:

  • String   jobId Required parameter.

Since: 02-25-2014

top

InternalApiMonitor getApiMonitor()

Returns the API monitor for this cloud

Returns:  InternalApiMonitor

Since: 06-30-2016

top

InternalAuthManager getAuthManager()

Returns authentication manager for this cloud.

Returns:  InternalAuthManager

Since: 09-15-2015

top

Data getCodeInfo()

Returns the code distro settings for this cloud.

Returns:  Data

Since: 06-12-2013

top

SystemDataView getDaemonLogs()

Provides access to system daemon logs.

Returns:  SystemDataView


DataList Name: SystemDaemonLogs
Tag Support: No
DataList Keys/Column Name Column Type Read Only
logId Number  
handler String  
worker String  
startDate Date  
endDate Date  
events Number  
summary String  
freeMemory Big unsigned integer  
sessions Medium integer  
palId String  
name String  
txId String  
description String  

Since: 12-31-2013

top

DataList getIssuers()

Returns a list containing the default root level certificate issuers for the cloud.

Returns:  DataList


DataList Name: issuers
DataList Fields: sigalg, issuer, subject, notBefore, notAfter, valid, reason

Since: 07-15-2013

top

SystemDataView getJobQueue()

Provides access to system job queue.

Returns:  SystemDataView


DataList Name: SystemJobQueue
Tag Support: No
DataList Keys/Column Name Column Type Read Only
guid Number  
jobId Number  
handler String  
jobType String  
worker String  
createDate Date  

Since: 01-01-2014

top

SystemDataView getJobsPending()

Provides access to system jobs not yet in the queue.

Returns:  SystemDataView


DataList Name: SystemJobsPending
Tag Support: No
DataList Keys/Column Name Column Type Read Only
jobId String  
name String  
workflow String  
worker String  
errorMessage String  
scheduleDate Date  
runDate Date  
status String  
palName String  
palId String  
enterprise String  

Since: 01-01-2014

top

Data getMainStatusInfo(String node)

Returns primary information on replication status for the given node.

Parameters:

  • String   node Required parameter.

Returns:  Data

Since: 07-12-2013

top

DataList getMemorySummary()

Returns a list containing memory information and operating system for this cloud.

Returns:  DataList


DataList Name: memory
DataList Fields: worker, name, used, committed, init, max, time, os

Since: 08-19-2015

top

Data getReadStatusInfo(String node)

Returns read information on replication status for the given node.

Parameters:

  • String   node Required parameter.

Returns:  Data

Since: 07-12-2013

top

DataList getSessionSummary()

Returns a list of active sessions summary by worker and location. The information has an accuracy window of approximately 5 minutes.

Returns:  DataList


DataList Name: summary
DataList Fields: worker, root, login, landing, builder, wservice, uservice, mservice, total, rejections

Since: 12-06-2013

top

DataList getSessions(Date startDate, Date endDate, String type, int limit)

Returns a list of sessions that have accessed this cloud in the since the given date.

Parameters:

  • Date   startDate Required parameter.
  • Date   endDate Required parameter.
  • String   type Required parameter. Allowed values: *, daemon, session, webservice.
  • int   limit Maximum allowed size of parameter: 10000

Returns:  DataList


DataList Name: sessions
DataList Fields: userId, worker, app, initialAccess, lastAccess, remoteAddress, userAgent, userAgentVersion, sessionId, memory

Since: 08-14-2013

top

DataList getStorageList()

Returns a list containing information on storage nodes.

Returns:  DataList


DataList Name: storageList
DataList Fields: node, host, name, port, type, initialSize, poolSize, maxWait, replication, roundRobin

Since: 05-14-2013

top

DataList getStorageProcessList(String node)

Returns a list containing information on storage processes.

Parameters:

  • String   node Required parameter.

Returns:  DataList


DataList Name: processList
DataList Fields: processId, user, host, db, command, time, info

Since: 05-14-2013

top

Data getStorageStatusInfo(String node)

Returns information on storage status for the given node.

Parameters:

  • String   node Required parameter.

Returns:  Data

Since: 05-14-2013

top

DataList getStorageTables(String node)

Returns a list containing information on storage tables.

Parameters:

  • String   node Required parameter.

Returns:  DataList


DataList Name: tableList
DataList Fields: name, type, engine, version, rowFormat, rows, avgRowLength, dataLength, maxDataLength, indexLength, dataFree, autoIncrement, createDate, updateDate, checkDate, collation, checksum, createOptions, comment

Since: 05-14-2013

top

Data getStorageVariableInfo(String node)

Returns information on storage variables for the given node.

Parameters:

  • String   node Required parameter.

Returns:  Data

Since: 05-14-2013

top

Data getSupportInfo()

Returns the support info for this cloud.

Returns:  Data

Since: 06-12-2013

top

Data getSystemInfo()

Returns the system info for this cloud.

Returns:  Data

Since: 12-06-2013

top

DataList getThreadSummary()

Returns a list containing thread information for this cloud.

Returns:  DataList


DataList Name: threads
DataList Fields: worker, name, line, count, time, threadId, threadName, blockedCount, blockedTime, lockOwnerId, lockName, lockOwnerName, waitedCount, waitedTime

Since: 11-20-2017

top

DataList getTrafficSummary()

Returns a list containing traffic information for this cloud.

Returns:  DataList


DataList Name: traffic
DataList Fields: worker, enabled, timeout, processors

Since: 07-13-2018

top

String toString()

Returns a description of this object.

Returns:  String

Since: 05-14-2013

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM