OneDB Explore API

REST API doc for OneDB Explore
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

ServerAndGroupsRelatedAPIs

ServerAndGroupsRelatedAPIs

Up 
post /onedb/{onedbServerId}/privileges/internalUsers
Add internal user which comes in the body of post request (addInternalUser)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body InternalPrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/rlogs/llog
Add logical log (addLogicalLog)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AddLogicalLogInfoRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/cmsm/sla
Add or modify SLA of the given connection unit which comes in the body of post request (addOrModifySLA)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AddOrModifySLARequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/storage/pool
Add a storage pool entry. (addStoragePoolEntry)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StoragePoolRequest (optional)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/vps/{class}
Add virtual processors (addVirtualProcessors)

Path parameters

class (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body VPsClassRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/sql/cancel
Cancel a SQL statement or query on a database (cancelSQL)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SqlRequest (optional)
Body Parameter —

Return type

array[Object]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/aus/configuration/databases
Change databases priority for Auto Update Statistics Evaluation (changeDatabasePriority)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AusConfigurationDatabasesRequest (optional)
Body Parameter —

Return type

AusConfigurationDatabasesRequest

Example data

Content-Type: application/json
{
  "database_priority_disable" : [ { }, { } ],
  "database_priority_high" : [ { }, { } ],
  "database_priority_low" : [ { }, { } ],
  "database_priority_medium" : [ { }, { } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AusConfigurationDatabasesRequest

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}
Close sql session (closeSqlSession)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/aus/jobs/refresh/threads
Increase or decrease threads of AUSR (configureAUSRThread)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AusJobsRefreshThreadsRequest (optional)
Body Parameter —

Return type

AusJobsRefreshThreadsRequest

Example data

Content-Type: application/json
{
  "threadCount" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AusJobsRefreshThreadsRequest

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/storage/chunks
Create a chunk (createChunk)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body NewChunksRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/groups/{groupId}/dashboards
Create one or more Custom Dashboards (createDashboard)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body groupId_dashboards_body (required)
Body Parameter —

Return type

inline_response_200_1

Example data

Content-Type: application/json
{
  "newDashboards" : [ {
    "id" : 0,
    "config" : {
      "new" : true,
      "panels" : [ {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      }, {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      } ],
      "name" : "name",
      "defaultServerIds" : [ 7, 7 ]
    },
    "group" : {
      "permissions" : 5,
      "name" : "name",
      "parentGroupId" : 1,
      "id" : 6
    }
  }, {
    "id" : 0,
    "config" : {
      "new" : true,
      "panels" : [ {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      }, {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      } ],
      "name" : "name",
      "defaultServerIds" : [ 7, 7 ]
    },
    "group" : {
      "permissions" : 5,
      "name" : "name",
      "parentGroupId" : 1,
      "id" : 6
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_1

400

Bad Request

403

Forbidden

404

Not Found
Up 
post /onedb/{onedbServerId}/databases
Create database (createDatabase)
This api will create database, demo database on basis of flag (isDemoDatabase) this flag is not mandatory, if set to true then demo database will be created otherwise regular database.

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DatabasesRequest (optional)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/groups/{groupId}
Add the OneDB server (createGroup)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body GroupIdRequest (optional)
Body Parameter —

Return type

OneDbGroupIdResponse

Example data

Content-Type: application/json
{
  "id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OneDbGroupIdResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/groups/{groupId}/monitoring/batch
Create a batch request to get data from the repository for multiple sensors. (createGroupBatchRequest)
Monitoring batch for GroupId

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body GroupIdSensorDataResponse (optional)
Body Parameter —

Return type

array[GroupIdSensorDataResponse]

Example data

Content-Type: application/json
[ {
  "data" : {
    "dsMax" : 0,
    "from" : "from",
    "to" : "to"
  },
  "id" : "id"
}, {
  "data" : {
    "dsMax" : 0,
    "from" : "from",
    "to" : "to"
  },
  "id" : "id"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/groups/{groupId}/monitoring
Add a sensor (or set of sensors) to the monitoring profile (createGroupSensor)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Sensor (optional)
Body Parameter —

Return type

Sensor

Example data

Content-Type: application/json
{
  "runInterval" : 0,
  "disabled" : true,
  "dataRetentionInterval" : 6,
  "type" : {
    "fromPackage" : true,
    "meta" : {
      "default" : {
        "defaults" : { },
        "subtype" : "subtype",
        "sleepBetweenExecution" : 5,
        "serverTypes" : [ "serverTypes", "serverTypes" ],
        "unique" : [ "unique", "unique" ],
        "delta" : [ "delta", "delta" ],
        "scanDuration" : 1,
        "dataRetentionInterval" : 5,
        "type" : "type",
        "collapse" : {
          "value" : "value",
          "key" : "key"
        },
        "sql" : "sql",
        "primaryKey" : {
          "name" : "name",
          "type" : "type"
        }
      },
      "metrics" : {
        "metric_name" : {
          "unit" : "unit",
          "name" : "name"
        }
      },
      "chart" : {
        "stacked" : true,
        "minY" : 2,
        "maxY" : 7,
        "type" : "type"
      }
    },
    "name" : "name",
    "description" : "description",
    "id" : "id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Sensor

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables/{tableName}/index
Get the REST API resource for an OneDB Indexes (createIndex)
create an index for sql-sessions under {tablename} in schema-manager

Path parameters

tableName (required)
Path Parameter —
sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DatabasesSqlSessionsTablesIndexRequest (optional)
Body Parameter —

Return type

SqlSessionsTablesIndexResponse

Example data

Content-Type: application/json
{
  "createIndexQuery" : "createIndexQuery"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SqlSessionsTablesIndexResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/scheduler/tasks
Create New Task API (createNewTask)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SchedulerTaskRequest (required)
Body Parameter —

Return type

RevokeSchedulerTaskResponse

Example data

Content-Type: application/json
{
  "tk_total_time" : 7.061401241503109,
  "tk_name" : "tk_name",
  "tk_delete" : {
    "IntervalDF" : {
      "seconds" : 5,
      "nanoseconds" : 5
    }
  },
  "tk_monday" : true,
  "tk_thursday" : true,
  "tk_description" : "tk_description",
  "tk_type" : "TASK",
  "tk_sequence" : 6,
  "tk_result_table" : "tk_result_table",
  "tk_execute" : "tk_execute",
  "tk_wednesday" : true,
  "tk_sunday" : true,
  "tk_start_time" : {
    "date" : "2000-01-23"
  },
  "tk_priority" : 9,
  "tk_total_executions" : 2,
  "tk_enable" : true,
  "tk_dbs" : "tk_dbs",
  "tk_create" : "tk_create",
  "tk_friday" : true,
  "tk_attributes" : 1,
  "tk_tuesday" : true,
  "tk_saturday" : true,
  "tk_id" : 0,
  "tk_group" : "tk_group"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RevokeSchedulerTaskResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/databases/{database}/sql-sessions
Execute data with sql-sessions ID related information (createSQLSession)

Path parameters

database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SqlSessionIdTypeRequest (optional)
Body Parameter —

Return type

SqlSessionIdResponse

Example data

Content-Type: application/json
{
  "id" : 0,
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SqlSessionIdResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/monitoring
Add a sensor (or set of sensors) to the monitoring profile (createSensor)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Sensor (required)
Body Parameter —

Return type

Sensor

Example data

Content-Type: application/json
{
  "runInterval" : 0,
  "disabled" : true,
  "dataRetentionInterval" : 6,
  "type" : {
    "fromPackage" : true,
    "meta" : {
      "default" : {
        "defaults" : { },
        "subtype" : "subtype",
        "sleepBetweenExecution" : 5,
        "serverTypes" : [ "serverTypes", "serverTypes" ],
        "unique" : [ "unique", "unique" ],
        "delta" : [ "delta", "delta" ],
        "scanDuration" : 1,
        "dataRetentionInterval" : 5,
        "type" : "type",
        "collapse" : {
          "value" : "value",
          "key" : "key"
        },
        "sql" : "sql",
        "primaryKey" : {
          "name" : "name",
          "type" : "type"
        }
      },
      "metrics" : {
        "metric_name" : {
          "unit" : "unit",
          "name" : "name"
        }
      },
      "chart" : {
        "stacked" : true,
        "minY" : 2,
        "maxY" : 7,
        "type" : "type"
      }
    },
    "name" : "name",
    "description" : "description",
    "id" : "id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Sensor

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb
Create an OneDB Server inside OneDB Explore (createServer)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body NewOneDBServerRequest (required)
Body Parameter — OneDB Server which needs to be created

Return type

OneDBServerResponse

Example data

Content-Type: application/json
{
  "connectionProperties" : { },
  "agent" : {
    "online" : true,
    "isMonitoring" : true,
    "config" : {
      "database" : "database",
      "repositoryServerId" : 5
    }
  },
  "monitorUser" : "monitorUser",
  "parentGroupId" : 6,
  "hasMonitorPassword" : true,
  "hasAdminPassword" : true,
  "serviceName" : "serviceName",
  "hostname" : "hostname",
  "adminUser" : "adminUser",
  "unreadIncidents" : 5,
  "port" : 1,
  "permissions" : { },
  "alias" : "alias",
  "id" : 0,
  "status" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OneDBServerResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
post /onedb/{onedbServerId}/monitoring/batch
Create a batch request to get data from the repository for multiple sensors. (createServerBatchRequest)
Monitoring batch for SensorId

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body GroupIdSensorDataResponse (optional)
Body Parameter —

Return type

array[GroupIdSensorDataResponse]

Example data

Content-Type: application/json
[ {
  "data" : {
    "dsMax" : 0,
    "from" : "from",
    "to" : "to"
  },
  "id" : "id"
}, {
  "data" : {
    "dsMax" : 0,
    "from" : "from",
    "to" : "to"
  },
  "id" : "id"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/storage/spaces
Create a space (createSpace)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body NewSpaceRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/backups/tasks
delete info about backup tasks (deleteBackupTasks)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

DeleteBackupTask

Example data

Content-Type: application/json
{
  "numNonCriticalDbspaces" : 5.962133916683182,
  "backupsEnabled" : true,
  "backupOnconfigs" : {
    "BAR_MAX_BACKUP" : 0,
    "BAR_NB_XPORT_COUNT" : 6,
    "BAR_XFER_BUF_SIZE" : 1
  },
  "level1" : 6,
  "ok" : true,
  "level0" : 0,
  "n" : 5.637376656633329,
  "level2" : 1,
  "backupsConfigured" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DeleteBackupTask

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/groups/{groupId}/dashboards/{dashboardId}
Delete a single dashboard (deleteDashboard)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64
dashboardId (required)
Path Parameter — Id of Custom Dashboard added in the Dashboards page format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
post /onedb/groups/{groupId}/dashboards/drop
Delete one or more Custom Dashboards (deleteDashboards)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body dashboards_drop_body (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
delete /onedb/groups/{groupId}
Delete the OneDB server (deleteGroup)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/groups/{groupId}/monitoring/sensors/{sensorTypeId}
Delete the sensor from the server or group's monitoring profile (deleteGroupMonitoringSensor)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64
sensorTypeId (required)
Path Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/groups/{groupId}/incidents/drop
Delete one or more incidents (deleteIncidentsForGroup)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DeleteIncidentsRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/incidents/drop
Delete one or more incidents (deleteIncidentsForServer)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DeleteIncidentsRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/privileges/internalUsers/drop
Delete the internal user which comes in the body of delete request (deleteInternalUser)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/scheduler/tasks/{id}/parameters/{paramId}
Delete parameter for task (deleteParameterForTask)

Path parameters

id (required)
Path Parameter —
paramId (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[BSONObject]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/cmsm/sla
Delete SLA of the given connection unit which comes in the body of delete request (deleteSLA)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}
Deletes a single OneDB Server (deleteServer)
Delete OneDB Server by id

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden
Up 
delete /onedb/{onedbServerId}/monitoring/sensors/{sensorTypeId}
Delete the sensor from the server or group's monitoring profile (deleteServerMonitoringSensor)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
sensorTypeId (required)
Path Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/storage/pool/{id}
Delete a storage pool entry. (deleteStoragePoolEntry)

Path parameters

id (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/agent/deploy
Create an Agent to deploy OneDB Server (deployAgent)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DeployAgentResponse (optional)
Body Parameter —

Return type

array[SuccessResponseWithResult]

Example data

Content-Type: application/json
[ {
  "result_message" : "result_message",
  "return_code" : 0
}, {
  "result_message" : "result_message",
  "return_code" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/backups/tasks
Create info about backup tasks (deployBackupTasks)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body BackupTaskPayloadRequest (optional)
Body Parameter —

Return type

BackupTaskResponse

Example data

Content-Type: application/json
{
  "numNonCriticalDbspaces" : 5.962133916683182,
  "backupsEnabled" : true,
  "backupOnconfigs" : [ {
    "BAR_MAX_BACKUP" : 0,
    "BAR_NB_XPORT_COUNT" : 6,
    "BAR_XFER_BUF_SIZE" : 1
  }, {
    "BAR_MAX_BACKUP" : 0,
    "BAR_NB_XPORT_COUNT" : 6,
    "BAR_XFER_BUF_SIZE" : 1
  } ],
  "level1" : "level1",
  "level0" : "level0",
  "level2" : "level2",
  "backupsConfigured" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BackupTaskResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables/{tableName}/index/disable
Update the REST API resource for an OneDB Indexes (disableIndex)
Disables the index for a particular table from {tableName}

Path parameters

tableName (required)
Path Parameter —
sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DatabaseSqlSessionIdTablenameIndexDisableRequest (optional)
Body Parameter —

Query parameters

indexName (optional)
Query Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/storage/chunks/{number}
Drop a chunk (dropChunk)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
number (required)
Path Parameter — Chunk number to drop

Query parameters

dropToStoragePool (optional)
Query Parameter — boolean indicating whether the space associated with the chunk should be returned to the storage pool default: false

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/databases/{database}
Drop database (dropDatabase)

Path parameters

database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables/{tableName}/index/drop
Drop indexes from onedb server table (dropIndex)

Path parameters

tableName (required)
Path Parameter — name of the table from which indexes to be dropped
sqlSessionId (required)
Path Parameter — sqlSessionId for database inside OneDB Server
database (required)
Path Parameter — name of the database inside OneDB Server
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/rlogs/llog/{number}
Drop logical log (dropLogicalLog)

Path parameters

number (required)
Path Parameter — format: int32
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/storage/spaces/{name}
Drop a space (dropSpace)

Path parameters

name (required)
Path Parameter — the name of the space to drop
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

dropToStoragePool (optional)
Query Parameter — Indicating whether the space should be returned to the storage pool or not. default: false

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/vps/{class}
Drop virtual processors (dropVirtualProcessors)

Path parameters

class (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

count (optional)
Query Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables/{tableName}/index/enable
Update the REST API resource for an OneDB Indexes (enableIndex)
Enables the index for a particular table from {tableName}

Path parameters

tableName (required)
Path Parameter —
sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DatabaseSqlSessionIdTablenameIndexEnableRequest (optional)
Body Parameter —

Query parameters

indexName (optional)
Query Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/backups
Create backupInfo about the server (executeBackup)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateBackupResponse (optional)
Body Parameter —

Return type

array[BackupResponse1]

Example data

Content-Type: application/json
[ {
  "oldest_level1" : 6.027456183070403,
  "oldest_level0" : 0.8008281904610115,
  "per_space" : [ {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  }, {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  } ],
  "oldest_level2" : 1.4658129805029452,
  "max_interval_any" : 2.027123023002322,
  "backup_in_progress" : true,
  "spaces_not_backed_up" : 5.962133916683182,
  "max_interval_l0" : 3.616076749251911
}, {
  "oldest_level1" : 6.027456183070403,
  "oldest_level0" : 0.8008281904610115,
  "per_space" : [ {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  }, {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  } ],
  "oldest_level2" : 1.4658129805029452,
  "max_interval_any" : 2.027123023002322,
  "backup_in_progress" : true,
  "spaces_not_backed_up" : 5.962133916683182,
  "max_interval_l0" : 3.616076749251911
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/aus/jobs/cleanup
Execute AUS cleanup job (executeCleanUp)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AUSJobsCleanupRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/aus/jobs/evaluation
Execute Auto Update Statistics Evaluation (executeEvaluationTask)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExecuteEvaluationTaskRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/sql
Execute a SQL statement or query on a database (executeSQL)
A document indicating the SQL to run. The document must include a sql field.The document can optionally include a list of 'params' to bind as host variables to the SQL statement

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SqlRequest (optional)
Body Parameter —

Return type

array[Object]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/scheduler/tasks/{tk_id}/runs
Create a task scheduler inside OneDB Explore. (executeTask)

Path parameters

tk_id (required)
Path Parameter — tk_id of scheduled task OneDB Server inside OneDB Explore format: int32
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExecuteTaskRequest (optional)
Body Parameter —

Return type

ExecuteTaskResponse

Example data

Content-Type: application/json
{
  "tk_id" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ExecuteTaskResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/aus/alerts
Get AUS Alerts (getAUSAlert)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[AUSAlertResponse]

Example data

Content-Type: application/json
[ {
  "alert_time" : "2000-01-23",
  "alert_message" : "alert_message",
  "alert_type" : "alert_type",
  "alert_color" : "alert_color"
}, {
  "alert_time" : "2000-01-23",
  "alert_message" : "alert_message",
  "alert_type" : "alert_type",
  "alert_color" : "alert_color"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/aus/configuration
Get AUS Configuration (getAUSConfiguration)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[AUSConfigurationResponse]

Example data

Content-Type: application/json
[ {
  "total_ausr_threads" : 5,
  "tasks" : [ {
    "tk_name" : "tk_name",
    "tk_monday" : true,
    "tk_wednesday" : true,
    "tk_sunday" : true,
    "tk_start_time" : {
      "date" : "2000-01-23"
    },
    "tk_thursday" : true,
    "tk_enable" : true,
    "tk_friday" : true,
    "tk_tuesday" : true,
    "tk_saturday" : true,
    "tk_id" : 0,
    "parameters" : [ {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    }, {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    } ],
    "tk_frequency" : {
      "IntervalDF" : {
        "seconds" : "2000-01-23T04:56:07.000+00:00",
        "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
      }
    }
  }, {
    "tk_name" : "tk_name",
    "tk_monday" : true,
    "tk_wednesday" : true,
    "tk_sunday" : true,
    "tk_start_time" : {
      "date" : "2000-01-23"
    },
    "tk_thursday" : true,
    "tk_enable" : true,
    "tk_friday" : true,
    "tk_tuesday" : true,
    "tk_saturday" : true,
    "tk_id" : 0,
    "parameters" : [ {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    }, {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    } ],
    "tk_frequency" : {
      "IntervalDF" : {
        "seconds" : "2000-01-23T04:56:07.000+00:00",
        "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
      }
    }
  } ]
}, {
  "total_ausr_threads" : 5,
  "tasks" : [ {
    "tk_name" : "tk_name",
    "tk_monday" : true,
    "tk_wednesday" : true,
    "tk_sunday" : true,
    "tk_start_time" : {
      "date" : "2000-01-23"
    },
    "tk_thursday" : true,
    "tk_enable" : true,
    "tk_friday" : true,
    "tk_tuesday" : true,
    "tk_saturday" : true,
    "tk_id" : 0,
    "parameters" : [ {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    }, {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    } ],
    "tk_frequency" : {
      "IntervalDF" : {
        "seconds" : "2000-01-23T04:56:07.000+00:00",
        "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
      }
    }
  }, {
    "tk_name" : "tk_name",
    "tk_monday" : true,
    "tk_wednesday" : true,
    "tk_sunday" : true,
    "tk_start_time" : {
      "date" : "2000-01-23"
    },
    "tk_thursday" : true,
    "tk_enable" : true,
    "tk_friday" : true,
    "tk_tuesday" : true,
    "tk_saturday" : true,
    "tk_id" : 0,
    "parameters" : [ {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    }, {
      "task_name" : "task_name",
      "value_type" : "value_type",
      "name" : "name",
      "description" : "description",
      "id" : 6,
      "value" : 1
    } ],
    "tk_frequency" : {
      "IntervalDF" : {
        "seconds" : "2000-01-23T04:56:07.000+00:00",
        "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
      }
    }
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/aus
Get the REST resource for this OneDB server's auto update statistics (getAUSStatus)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

includeStats (optional)
Query Parameter —

Return type

array[AUSResponse]

Example data

Content-Type: application/json
[ {
  "last_evaluation" : {
    "date" : "2000-01-23"
  },
  "enabled" : true
}, {
  "last_evaluation" : {
    "date" : "2000-01-23"
  },
  "enabled" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/logs/adminapi
Get the log/history of SQL Admin API commands run on the database server (getAdminAPICommandHistory)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

from (optional)
Query Parameter — format: int64
commandFilter (optional)
Query Parameter —

Return type

array[LogsAdminAPIResponse]

Example data

Content-Type: application/json
[ {
  "cmd_user" : "cmd_user",
  "cmd_hostname" : "cmd_hostname",
  "cmd_number" : 0,
  "cmd_executed" : "cmd_executed",
  "cmd_exec_time" : {
    "date" : "2000-01-23"
  },
  "cmd_ret_status" : 6,
  "cmd_ret_msg" : "cmd_ret_msg"
}, {
  "cmd_user" : "cmd_user",
  "cmd_hostname" : "cmd_hostname",
  "cmd_number" : 0,
  "cmd_executed" : "cmd_executed",
  "cmd_exec_time" : {
    "date" : "2000-01-23"
  },
  "cmd_ret_status" : 6,
  "cmd_ret_msg" : "cmd_ret_msg"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/privileges/adminPrivileges
Get all info about admin privileges (getAdminPrivilegesInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

AdminPrivilegedUserResponse

Example data

Content-Type: application/json
{
  "privilegeTypes" : [ "privilegeTypes", "privilegeTypes" ],
  "lastModified" : "lastModified",
  "userName" : "userName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AdminPrivilegedUserResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/agent
Returns the agent info for given OneDB Server (getAgent)
Find agent info by OneDB Server id

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

AgentResponse

Example data

Content-Type: application/json
{
  "online" : true,
  "isMonitoring" : true,
  "config" : {
    "database" : "database",
    "repositoryServerId" : 5
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AgentResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/aggregates
Gets the aggregates list (getAggregatesDetails)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsAggregatesResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "handlesnulls" : true,
  "combine_func" : "combine_func",
  "final_func" : "final_func",
  "name" : "name",
  "iter_func" : "iter_func",
  "init_func" : "init_func"
}, {
  "owner" : "owner",
  "handlesnulls" : true,
  "combine_func" : "combine_func",
  "final_func" : "final_func",
  "name" : "name",
  "iter_func" : "iter_func",
  "init_func" : "init_func"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/permissions/effective
Get the effective users and their permissions for this server or group (getAllEffectivePermissions)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[OneDBServerIDPermissionsEffectiveResponse]

Example data

Content-Type: application/json
[ [ {
  "permissions" : 6,
  "user" : {
    "name" : "name",
    "id" : 0
  }
}, {
  "permissions" : 6,
  "user" : {
    "name" : "name",
    "id" : 0
  }
} ], [ {
  "permissions" : 6,
  "user" : {
    "name" : "name",
    "id" : 0
  }
}, {
  "permissions" : 6,
  "user" : {
    "name" : "name",
    "id" : 0
  }
} ] ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/permissions/effective
Get the effective users and their permissions for this server or group (getAllEffectivePermissions1)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

PermissionsEffectiveResponse

Example data

Content-Type: application/json
[ {
  "permissions" : 6,
  "user" : {
    "name" : "name",
    "id" : 0
  }
}, {
  "permissions" : 6,
  "user" : {
    "name" : "name",
    "id" : 0
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PermissionsEffectiveResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/scheduler/groups
Get all groups (getAllGroups)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

orderField (optional)
Query Parameter —

Return type

array[SchedulerGroupsResponse]

Example data

Content-Type: application/json
[ {
  "group_id" : 0,
  "group_name" : "group_name",
  "group_description" : "group_description"
}, {
  "group_id" : 0,
  "group_name" : "group_name",
  "group_description" : "group_description"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/permissions
Get all users and their permissions for this server or group (getAllPermissions)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[PermissionsResponse]

Example data

Content-Type: application/json
[ {
  "own" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
}, {
  "own" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/permissions
Get all users and their permissions for this server or group (getAllPermissions1)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

PermissionsUserResource

Example data

Content-Type: application/json
{
  "own" : {
    "value" : [ "READ", "READ" ],
    "key" : {
      "settingsBSON" : {
        "key" : { }
      },
      "defaultAlertingProfile" : {
        "settings" : {
          "name" : "name",
          "messengerId" : 2,
          "timeout" : 7,
          "bson" : {
            "key" : { }
          },
          "instant" : true
        },
        "id" : 5,
        "bson" : {
          "key" : { }
        }
      },
      "roleExpiry" : 1,
      "passwordHash" : "passwordHash",
      "messengers" : [ {
        "id" : 9,
        "type" : "type",
        "enabled" : true,
        "bson" : {
          "key" : { }
        },
        "messengerBSON" : {
          "key" : { }
        }
      }, {
        "id" : 9,
        "type" : "type",
        "enabled" : true,
        "bson" : {
          "key" : { }
        },
        "messengerBSON" : {
          "key" : { }
        }
      } ],
      "expired" : true,
      "permissions" : [ "SUPERADMIN", "SUPERADMIN" ],
      "name" : "name",
      "lastPasswordUpdate" : 6,
      "id" : 0,
      "hashingAlgoName" : "hashingAlgoName",
      "locked" : true,
      "passwordSalt" : "passwordSalt",
      "successiveFailedLoginAttempts" : 5,
      "bson" : {
        "key" : { }
      },
      "alertingProfiles" : [ null, null ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PermissionsUserResource

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/scheduler/tasks
Get all scheduler tasks (getAllTasks)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[SchedulerTasksResponse]

Example data

Content-Type: application/json
[ {
  "tk_name" : "tk_name",
  "tk_monday" : true,
  "tk_wednesday" : true,
  "tk_sunday" : true,
  "tk_start_time" : {
    "date" : "2000-01-23"
  },
  "tk_thursday" : true,
  "tk_enable" : true,
  "tk_friday" : true,
  "tk_tuesday" : true,
  "tk_saturday" : true,
  "tk_id" : 0,
  "tk_group" : "tk_group",
  "tk_type" : "tk_type",
  "tk_frequency" : {
    "IntervalDF" : {
      "seconds" : "2000-01-23T04:56:07.000+00:00",
      "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
    }
  }
}, {
  "tk_name" : "tk_name",
  "tk_monday" : true,
  "tk_wednesday" : true,
  "tk_sunday" : true,
  "tk_start_time" : {
    "date" : "2000-01-23"
  },
  "tk_thursday" : true,
  "tk_enable" : true,
  "tk_friday" : true,
  "tk_tuesday" : true,
  "tk_saturday" : true,
  "tk_id" : 0,
  "tk_group" : "tk_group",
  "tk_type" : "tk_type",
  "tk_frequency" : {
    "IntervalDF" : {
      "seconds" : "2000-01-23T04:56:07.000+00:00",
      "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
    }
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/cmsm/availableServers
Get name of available servers (getAvailableServers)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[AvailableServersResponse]

Example data

Content-Type: application/json
[ {
  "name" : "name"
}, {
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/backups/history
Get backup history of full system backups (getBackupHistory)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

from (optional)
Query Parameter — format: int64

Return type

array[BackupsHistoryResponse]

Example data

Content-Type: application/json
[ {
  "level1" : [ { }, { } ],
  "level0" : [ { }, { } ],
  "level2" : [ { }, { } ]
}, {
  "level1" : [ { }, { } ],
  "level0" : [ { }, { } ],
  "level2" : [ { }, { } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/backups
Get backupInfo about the server (getBackupInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[BackupResponse1]

Example data

Content-Type: application/json
[ {
  "oldest_level1" : 6.027456183070403,
  "oldest_level0" : 0.8008281904610115,
  "per_space" : [ {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  }, {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  } ],
  "oldest_level2" : 1.4658129805029452,
  "max_interval_any" : 2.027123023002322,
  "backup_in_progress" : true,
  "spaces_not_backed_up" : 5.962133916683182,
  "max_interval_l0" : 3.616076749251911
}, {
  "oldest_level1" : 6.027456183070403,
  "oldest_level0" : 0.8008281904610115,
  "per_space" : [ {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  }, {
    "name" : "name",
    "level1" : 7,
    "level0" : 2,
    "dbsnum" : 5,
    "level2" : 9
  } ],
  "oldest_level2" : 1.4658129805029452,
  "max_interval_any" : 2.027123023002322,
  "backup_in_progress" : true,
  "spaces_not_backed_up" : 5.962133916683182,
  "max_interval_l0" : 3.616076749251911
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/backups
Get information about each storage space backups (getBackupInfo1)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[BackupResponse]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "level1" : 1,
  "level0" : 6,
  "dbsnum" : 0,
  "level2" : 5
}, {
  "name" : "name",
  "level1" : 1,
  "level0" : 6,
  "dbsnum" : 0,
  "level2" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/backups/tasks
Get info about backup tasks (getBackupTasks)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[BackupTaskResponse]

Example data

Content-Type: application/json
[ {
  "numNonCriticalDbspaces" : 5.962133916683182,
  "backupsEnabled" : true,
  "backupOnconfigs" : [ {
    "BAR_MAX_BACKUP" : 0,
    "BAR_NB_XPORT_COUNT" : 6,
    "BAR_XFER_BUF_SIZE" : 1
  }, {
    "BAR_MAX_BACKUP" : 0,
    "BAR_NB_XPORT_COUNT" : 6,
    "BAR_XFER_BUF_SIZE" : 1
  } ],
  "level1" : "level1",
  "level0" : "level0",
  "level2" : "level2",
  "backupsConfigured" : true
}, {
  "numNonCriticalDbspaces" : 5.962133916683182,
  "backupsEnabled" : true,
  "backupOnconfigs" : [ {
    "BAR_MAX_BACKUP" : 0,
    "BAR_NB_XPORT_COUNT" : 6,
    "BAR_XFER_BUF_SIZE" : 1
  }, {
    "BAR_MAX_BACKUP" : 0,
    "BAR_NB_XPORT_COUNT" : 6,
    "BAR_XFER_BUF_SIZE" : 1
  } ],
  "level1" : "level1",
  "level0" : "level0",
  "level2" : "level2",
  "backupsConfigured" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/logs/baractlog
Get OneDB bar activity log (getBarActivityLog)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

offset (optional)
Query Parameter — format: int32
offset2 (optional)
Query Parameter — format: int32

Return type

array[LogsBaractlogResponse]

Example data

Content-Type: application/json
[ {
  "offset" : 0,
  "message" : "message"
}, {
  "offset" : 0,
  "message" : "message"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/casts
Gets the casts list (getCastsDetails)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsCastsResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "from_type" : "from_type",
  "to_type" : "to_type",
  "cast_type" : "cast_type",
  "routine_name" : "routine_name"
}, {
  "owner" : "owner",
  "from_type" : "from_type",
  "to_type" : "to_type",
  "cast_type" : "cast_type",
  "routine_name" : "routine_name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/checkpoints
Get OneDB server checkpoints (getCheckpoints)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

from (optional)
Query Parameter — Include only checkpoints that occurred after the 'from' timestamp format: int64
to (optional)
Query Parameter — Include only checkpoints that occurred before the 'to' timestamp format: int64

Return type

array[CheckPointResponse]

Example data

Content-Type: application/json
[ {
  "tot_crit_wait" : 7.386282,
  "cp_time" : 5.637377,
  "ckpt_logpos" : 9,
  "flush_time" : 5.962134,
  "logused" : 2,
  "block_time" : 1.0246457,
  "caller" : "caller",
  "n_crit_waits" : 4,
  "ckpt_logid" : 7,
  "n_dirty_buffs" : 2,
  "longest_crit_wait" : 1.2315135,
  "crit_time" : 1.4658129,
  "intvl" : 0,
  "physused" : 3,
  "timestamp" : 6
}, {
  "tot_crit_wait" : 7.386282,
  "cp_time" : 5.637377,
  "ckpt_logpos" : 9,
  "flush_time" : 5.962134,
  "logused" : 2,
  "block_time" : 1.0246457,
  "caller" : "caller",
  "n_crit_waits" : 4,
  "ckpt_logid" : 7,
  "n_dirty_buffs" : 2,
  "longest_crit_wait" : 1.2315135,
  "crit_time" : 1.4658129,
  "intvl" : 0,
  "physused" : 3,
  "timestamp" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/chunks
Get information about all chunks (getChunks)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[ChunksResponse]

Example data

Content-Type: application/json
[ {
  "offset" : 5,
  "reads" : 3,
  "type" : "type",
  "dbsnum" : 6,
  "path" : "path",
  "percent_used" : 9.301444,
  "space_name" : "space_name",
  "size" : 5,
  "read_time" : 4.145608,
  "write_time" : 7.386282,
  "chknum" : 0,
  "extendable" : 2,
  "writes" : 2,
  "free_size" : 7,
  "page_size" : 1,
  "status" : "status"
}, {
  "offset" : 5,
  "reads" : 3,
  "type" : "type",
  "dbsnum" : 6,
  "path" : "path",
  "percent_used" : 9.301444,
  "space_name" : "space_name",
  "size" : 5,
  "read_time" : 4.145608,
  "write_time" : 7.386282,
  "chknum" : 0,
  "extendable" : 2,
  "writes" : 2,
  "free_size" : 7,
  "page_size" : 1,
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/aus/commands
Get all update statistics commands (getCommands)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

commandState (optional)
Query Parameter —

Return type

array[AUSCommandsResponse]

Example data

Content-Type: application/json
[ {
  "state" : "state",
  "command" : "command"
}, {
  "state" : "state",
  "command" : "command"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/onconfig
Get OneDB onconfig settings (getConfiguration)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

filter (optional)
Query Parameter — Specify a filter query parameter with a comma separated list of onconfig parameter names to only return information about the specified onconfig parameters. No filter will return all config paramater's info

Return type

array[OnConfigResponse]

Example data

Content-Type: application/json
[ {
  "effective" : "effective",
  "name" : "name",
  "flags" : 6,
  "dynamic" : 1,
  "id" : 0,
  "type" : "type"
}, {
  "effective" : "effective",
  "name" : "name",
  "flags" : 6,
  "dynamic" : 1,
  "id" : 0,
  "type" : "type"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/cmsm
Get info about all connection managers (getConnectionManagers)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

includeDetailedInfo (optional)
Query Parameter — API will return detailed info for all Connection Managers if it is true, otherwise only CM name and arbitrator will be returned default: false

Return type

array[ConnectionManagerInfoResponse]

Example data

Content-Type: application/json
[ {
  "cmName" : "cmName",
  "cmUnitList" : [ {
    "servers" : "servers",
    "cmUnitName" : "cmUnitName",
    "foc" : "foc",
    "type" : "type"
  }, {
    "servers" : "servers",
    "cmUnitName" : "cmUnitName",
    "foc" : "foc",
    "type" : "type"
  } ],
  "cmArbitrator" : 0
}, {
  "cmName" : "cmName",
  "cmUnitList" : [ {
    "servers" : "servers",
    "cmUnitName" : "cmUnitName",
    "foc" : "foc",
    "type" : "type"
  }, {
    "servers" : "servers",
    "cmUnitName" : "cmUnitName",
    "foc" : "foc",
    "type" : "type"
  } ],
  "cmArbitrator" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/cmsm/cmUnits
Get connection unit info for a single connection manager (getConnectionUnits)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

cmName (required)
Query Parameter — Name of associated connection manager
cmUnitName (required)
Query Parameter — Name of connection unit

Return type

ConnectionUnitResponse

Example data

Content-Type: application/json
{
  "servers" : "servers",
  "slaInfoList" : [ {
    "slaName" : "slaName",
    "mode" : "mode",
    "port" : "port",
    "dbServers" : "dbServers",
    "useAliases" : "useAliases",
    "workers" : "workers",
    "policy" : "policy"
  }, {
    "slaName" : "slaName",
    "mode" : "mode",
    "port" : "port",
    "dbServers" : "dbServers",
    "useAliases" : "useAliases",
    "workers" : "workers",
    "policy" : "policy"
  } ],
  "foc" : "foc",
  "type" : "type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ConnectionUnitResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/dashboards/{dashboardId}
Get info about single custom dashboard (getDashboard)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64
dashboardId (required)
Path Parameter — Id of Custom Dashboard added in the Dashboards page format: int64

Return type

DashboardResponse

Example data

Content-Type: application/json
{
  "id" : 0,
  "config" : {
    "new" : true,
    "panels" : [ {
      "x" : 5,
      "width" : 7,
      "y" : 2,
      "title" : "title",
      "type" : "type",
      "config" : {
        "isCustomQuery" : true,
        "databaseName" : "databaseName",
        "yAxes" : [ {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        }, {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        } ],
        "dataSeries" : [ {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        }, {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        } ],
        "chartType" : "chartType",
        "queryString" : "queryString",
        "dataSources" : [ {
          "sensorType" : "sensorType"
        }, {
          "sensorType" : "sensorType"
        } ]
      },
      "height" : 9
    }, {
      "x" : 5,
      "width" : 7,
      "y" : 2,
      "title" : "title",
      "type" : "type",
      "config" : {
        "isCustomQuery" : true,
        "databaseName" : "databaseName",
        "yAxes" : [ {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        }, {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        } ],
        "dataSeries" : [ {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        }, {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        } ],
        "chartType" : "chartType",
        "queryString" : "queryString",
        "dataSources" : [ {
          "sensorType" : "sensorType"
        }, {
          "sensorType" : "sensorType"
        } ]
      },
      "height" : 9
    } ],
    "name" : "name",
    "defaultServerIds" : [ 7, 7 ]
  },
  "group" : {
    "permissions" : 5,
    "name" : "name",
    "parentGroupId" : 1,
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DashboardResponse

403

Forbidden

404

Not Found
Up 
get /onedb/{onedbServerId}/dashboard/info
Get server info for the dashboard (getDashboardServerInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DashboardInfoResponse]

Example data

Content-Type: application/json
[ {
  "iwa" : {
    "hasIWA" : true
  },
  "host" : {
    "os_nodename" : "os_nodename",
    "os_num_procs" : 0,
    "os_num_olprocs" : 6,
    "os_open_file_lim" : 2,
    "os_version" : "os_version",
    "os_mem_total" : 5,
    "os_name" : "os_name",
    "os_release" : "os_release",
    "os_machine" : "os_machine",
    "os_mem_free" : 5,
    "os_pagesize" : 1
  },
  "vps" : [ {
    "totalcpu" : 2.027123,
    "usercpu" : 9.301444,
    "syscpu" : 3.6160767,
    "count" : 7,
    "class" : "class"
  }, {
    "totalcpu" : 2.027123,
    "usercpu" : 9.301444,
    "syscpu" : 3.6160767,
    "count" : 7,
    "class" : "class"
  } ]
}, {
  "iwa" : {
    "hasIWA" : true
  },
  "host" : {
    "os_nodename" : "os_nodename",
    "os_num_procs" : 0,
    "os_num_olprocs" : 6,
    "os_open_file_lim" : 2,
    "os_version" : "os_version",
    "os_mem_total" : 5,
    "os_name" : "os_name",
    "os_release" : "os_release",
    "os_machine" : "os_machine",
    "os_mem_free" : 5,
    "os_pagesize" : 1
  },
  "vps" : [ {
    "totalcpu" : 2.027123,
    "usercpu" : 9.301444,
    "syscpu" : 3.6160767,
    "count" : 7,
    "class" : "class"
  }, {
    "totalcpu" : 2.027123,
    "usercpu" : 9.301444,
    "syscpu" : 3.6160767,
    "count" : 7,
    "class" : "class"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/dashboard/storage_perf
Get storage performance info for the dashboard (getDashboardStoragePerformanceInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DashboardStoragePerformanceResponse]

Example data

Content-Type: application/json
[ {
  "pf_iswrites" : 3,
  "pf_isrewrites" : 2,
  "pf_pagwrites" : 8,
  "pf_fgwrites" : 3,
  "pf_isopens" : 2,
  "pf_lockwts" : 1,
  "pf_ovlock" : 1,
  "pf_seqscans" : 6,
  "last_checkpoint" : {
    "tot_crit_wait" : 6.519181,
    "cp_time" : 5.9448957,
    "ckpt_logpos" : 3,
    "flush_time" : 6.878052,
    "logused" : 0,
    "block_time" : 4.652396,
    "caller" : "caller",
    "n_crit_waits" : 7,
    "ckpt_logid" : 3,
    "n_dirty_buffs" : 6,
    "longest_crit_wait" : 0.10263654,
    "crit_time" : 6.778325,
    "intvl" : 1,
    "physused" : 7,
    "timestamp" : 2
  },
  "pf_flushes" : 9,
  "pf_isdeletes" : 4,
  "pf_isamtot" : 5,
  "pf_isrollbacks" : 1,
  "pf_bufreads" : 6,
  "pf_dskwrites" : 1,
  "pf_iscommits" : 7,
  "pf_pagreads" : 6,
  "pf_ovuser" : 1,
  "pf_deadlks" : 5,
  "pf_bufwrites" : 5,
  "pf_isstarts" : 7,
  "pf_dskreads" : 0,
  "pf_lktouts" : 9,
  "pf_ckptwts" : 4,
  "pf_compress" : 6,
  "pf_buffwts" : 6,
  "pf_lockreqs" : 7,
  "pf_isreads" : 9,
  "pf_numckpts" : 9
}, {
  "pf_iswrites" : 3,
  "pf_isrewrites" : 2,
  "pf_pagwrites" : 8,
  "pf_fgwrites" : 3,
  "pf_isopens" : 2,
  "pf_lockwts" : 1,
  "pf_ovlock" : 1,
  "pf_seqscans" : 6,
  "last_checkpoint" : {
    "tot_crit_wait" : 6.519181,
    "cp_time" : 5.9448957,
    "ckpt_logpos" : 3,
    "flush_time" : 6.878052,
    "logused" : 0,
    "block_time" : 4.652396,
    "caller" : "caller",
    "n_crit_waits" : 7,
    "ckpt_logid" : 3,
    "n_dirty_buffs" : 6,
    "longest_crit_wait" : 0.10263654,
    "crit_time" : 6.778325,
    "intvl" : 1,
    "physused" : 7,
    "timestamp" : 2
  },
  "pf_flushes" : 9,
  "pf_isdeletes" : 4,
  "pf_isamtot" : 5,
  "pf_isrollbacks" : 1,
  "pf_bufreads" : 6,
  "pf_dskwrites" : 1,
  "pf_iscommits" : 7,
  "pf_pagreads" : 6,
  "pf_ovuser" : 1,
  "pf_deadlks" : 5,
  "pf_bufwrites" : 5,
  "pf_isstarts" : 7,
  "pf_dskreads" : 0,
  "pf_lktouts" : 9,
  "pf_ckptwts" : 4,
  "pf_compress" : 6,
  "pf_buffwts" : 6,
  "pf_lockreqs" : 7,
  "pf_isreads" : 9,
  "pf_numckpts" : 9
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/dashboards
Get info about all custom dashboards (getDashboards)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "dashboards" : [ {
    "id" : 0,
    "config" : {
      "new" : true,
      "panels" : [ {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      }, {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      } ],
      "name" : "name",
      "defaultServerIds" : [ 7, 7 ]
    },
    "group" : {
      "permissions" : 5,
      "name" : "name",
      "parentGroupId" : 1,
      "id" : 6
    }
  }, {
    "id" : 0,
    "config" : {
      "new" : true,
      "panels" : [ {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      }, {
        "x" : 5,
        "width" : 7,
        "y" : 2,
        "title" : "title",
        "type" : "type",
        "config" : {
          "isCustomQuery" : true,
          "databaseName" : "databaseName",
          "yAxes" : [ {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          }, {
            "min" : 2,
            "max" : 4,
            "label" : "label",
            "type" : "type"
          } ],
          "dataSeries" : [ {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          }, {
            "yAxis" : 3,
            "color" : "color",
            "id" : "id",
            "label" : "label"
          } ],
          "chartType" : "chartType",
          "queryString" : "queryString",
          "dataSources" : [ {
            "sensorType" : "sensorType"
          }, {
            "sensorType" : "sensorType"
          } ]
        },
        "height" : 9
      } ],
      "name" : "name",
      "defaultServerIds" : [ 7, 7 ]
    },
    "group" : {
      "permissions" : 5,
      "name" : "name",
      "parentGroupId" : 1,
      "id" : 6
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200

400

Bad Request

403

Forbidden

404

Not Found
Up 
get /onedb/groups/{groupId}/monitoring/sensors/{sensorTypeId}/data
Create a batch request to get data from the repository for multiple sensors. (getData1)

Path parameters

sensorTypeId (required)
Path Parameter —
groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Query parameters

from (optional)
Query Parameter — format: int64
to (optional)
Query Parameter — format: int64
primaryKeys (optional)
Query Parameter —
dsMax (optional)
Query Parameter — format: int32

Return type

GroupIdSensorDataResponse

Example data

Content-Type: application/json
{
  "data" : {
    "dsMax" : 0,
    "from" : "from",
    "to" : "to"
  },
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK GroupIdSensorDataResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}
Get the list of information for specific databases on the server (getDatabase)

Path parameters

database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesObjectResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "load_tasks" : 7.061401241503109,
  "space_occupied" : 2.3021358869347655,
  "unload_tasks" : 9.301444243932576,
  "created" : "2000-01-23",
  "locale" : "locale",
  "ansi" : 1.4658129805029452,
  "gls" : 5.962133916683182,
  "name" : "name",
  "logging" : 0.8008281904610115,
  "caseInsensitive" : 5.637376656633329,
  "bufferedLogging" : 6.027456183070403,
  "dbspace" : "dbspace"
}, {
  "owner" : "owner",
  "load_tasks" : 7.061401241503109,
  "space_occupied" : 2.3021358869347655,
  "unload_tasks" : 9.301444243932576,
  "created" : "2000-01-23",
  "locale" : "locale",
  "ansi" : 1.4658129805029452,
  "gls" : 5.962133916683182,
  "name" : "name",
  "logging" : 0.8008281904610115,
  "caseInsensitive" : 5.637376656633329,
  "bufferedLogging" : 6.027456183070403,
  "dbspace" : "dbspace"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases
Get the list of databases on the server (getDatabases)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "created" : "2000-01-23",
  "name" : "name",
  "logging" : 0.8008281904610115,
  "caseInsensitive" : 5.637376656633329,
  "bufferedLogging" : 6.027456183070403,
  "dbspace" : "dbspace",
  "locale" : "locale",
  "ansi" : 1.4658129805029452,
  "gls" : 5.962133916683182
}, {
  "owner" : "owner",
  "created" : "2000-01-23",
  "name" : "name",
  "logging" : 0.8008281904610115,
  "caseInsensitive" : 5.637376656633329,
  "bufferedLogging" : 6.027456183070403,
  "dbspace" : "dbspace",
  "locale" : "locale",
  "ansi" : 1.4658129805029452,
  "gls" : 5.962133916683182
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/aus/configuration/databases
Get databases configuration (getDatabasesPriority)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[ConfigurationDatabasesResponse]

Example data

Content-Type: application/json
[ {
  "database_priority_disable" : [ { }, { } ],
  "database_priority_high" : [ { }, { } ],
  "database_priority_low" : [ { }, { } ],
  "database_priority_medium" : [ { }, { } ]
}, {
  "database_priority_disable" : [ { }, { } ],
  "database_priority_high" : [ { }, { } ],
  "database_priority_low" : [ { }, { } ],
  "database_priority_medium" : [ { }, { } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/datablades
Gets the datablades list (getDatablades)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsDatabladesResponse]

Example data

Content-Type: application/json
[ {
  "bld_id" : "bld_id"
}, {
  "bld_id" : "bld_id"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/locales
Get list of dblocales available in database (getDbLocales)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DBLocaleResponse]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "language" : "language"
}, {
  "name" : "name",
  "language" : "language"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/spaces/dbspaces
Get the list of dbspaces only (no blobspaces, no sbspaces, no temp spaces) (getDbSpaces)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DBSpacesResponse]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "dbsnum" : 0
}, {
  "name" : "name",
  "dbsnum" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/er/domain/profile
Get ER domain profile statistics (getDomainProfile)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[ERDomainProfileResponse]

Example data

Content-Type: application/json
[ {
  "disk" : {
    "total" : 6,
    "metadataFree" : 1,
    "userdataFree" : 5
  },
  "ddr" : {
    "current" : "current",
    "pagesFromDDRBLOCK" : 0,
    "state" : "state",
    "snoopy" : "snoopy",
    "replay" : "replay"
  },
  "receiveQ" : {
    "txnInPendingList" : 1,
    "txnInQueue" : 1
  },
  "apply" : {
    "totalFailures" : 5,
    "risFileCount" : 8,
    "avgLatency" : 9.965781217890562,
    "txnProcessed" : 6,
    "commitRate" : 7.457744773683766,
    "failRate" : 4.965218492984954,
    "maxLatency" : 9.369310271410669,
    "avgActiveApply" : 1.1730742509559433,
    "state" : "state",
    "atsFileCount" : 6
  },
  "ERState" : "ERState",
  "name" : "name",
  "supportsCommand" : "supportsCommand",
  "ableToConnect" : "ableToConnect",
  "time" : "time",
  "version" : "version",
  "sendQ" : {
    "txnSpooled" : 2,
    "acksPending" : 7,
    "txnInQueue" : 5
  },
  "network" : {
    "expectedConnections" : 3,
    "pendingMsg" : 1,
    "numberOfConnections" : 9,
    "state" : "state",
    "throughput" : 7.386281948385884,
    "msgSent" : 2,
    "msgReceived" : 4
  }
}, {
  "disk" : {
    "total" : 6,
    "metadataFree" : 1,
    "userdataFree" : 5
  },
  "ddr" : {
    "current" : "current",
    "pagesFromDDRBLOCK" : 0,
    "state" : "state",
    "snoopy" : "snoopy",
    "replay" : "replay"
  },
  "receiveQ" : {
    "txnInPendingList" : 1,
    "txnInQueue" : 1
  },
  "apply" : {
    "totalFailures" : 5,
    "risFileCount" : 8,
    "avgLatency" : 9.965781217890562,
    "txnProcessed" : 6,
    "commitRate" : 7.457744773683766,
    "failRate" : 4.965218492984954,
    "maxLatency" : 9.369310271410669,
    "avgActiveApply" : 1.1730742509559433,
    "state" : "state",
    "atsFileCount" : 6
  },
  "ERState" : "ERState",
  "name" : "name",
  "supportsCommand" : "supportsCommand",
  "ableToConnect" : "ableToConnect",
  "time" : "time",
  "version" : "version",
  "sendQ" : {
    "txnSpooled" : 2,
    "acksPending" : 7,
    "txnInQueue" : 5
  },
  "network" : {
    "expectedConnections" : 3,
    "pendingMsg" : 1,
    "numberOfConnections" : 9,
    "state" : "state",
    "throughput" : 7.386281948385884,
    "msgSent" : 2,
    "msgReceived" : 4
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/er/domain
Get ER domain topology (getDomainTopology)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

ERDomainResponse

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "serverState" : "serverState",
    "rootId" : 6,
    "isHub" : true,
    "members" : [ {
      "dbServerName" : "dbServerName"
    }, {
      "dbServerName" : "dbServerName"
    } ],
    "name" : "name",
    "id" : 0,
    "isLeaf" : true
  }, {
    "serverState" : "serverState",
    "rootId" : 6,
    "isHub" : true,
    "members" : [ {
      "dbServerName" : "dbServerName"
    }, {
      "dbServerName" : "dbServerName"
    } ],
    "name" : "name",
    "id" : 0,
    "isLeaf" : true
  } ],
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ERDomainResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/er
Get high level ER status (getERStatus)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

EnterpriseReplicationResource

Example data

Content-Type: application/json
{
  "erstatus" : { },
  "domainTopology" : {
    "key" : { }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK EnterpriseReplicationResource

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/monitoring/effective
Get the effective monitoring profile (getEffectiveProfile)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[MonitoringEffectiveResponse]

Example data

Content-Type: application/json
[ {
  "sensors" : [ {
    "runInterval" : 0,
    "disabled" : true,
    "dataRetentionInterval" : 6,
    "type" : {
      "fromPackage" : true,
      "meta" : {
        "default" : {
          "defaults" : { },
          "subtype" : "subtype",
          "sleepBetweenExecution" : 5,
          "serverTypes" : [ "serverTypes", "serverTypes" ],
          "unique" : [ "unique", "unique" ],
          "delta" : [ "delta", "delta" ],
          "scanDuration" : 1,
          "dataRetentionInterval" : 5,
          "type" : "type",
          "collapse" : {
            "value" : "value",
            "key" : "key"
          },
          "sql" : "sql",
          "primaryKey" : {
            "name" : "name",
            "type" : "type"
          }
        },
        "metrics" : {
          "metric_name" : {
            "unit" : "unit",
            "name" : "name"
          }
        },
        "chart" : {
          "stacked" : true,
          "minY" : 2,
          "maxY" : 7,
          "type" : "type"
        }
      },
      "name" : "name",
      "description" : "description",
      "id" : "id"
    }
  }, {
    "runInterval" : 0,
    "disabled" : true,
    "dataRetentionInterval" : 6,
    "type" : {
      "fromPackage" : true,
      "meta" : {
        "default" : {
          "defaults" : { },
          "subtype" : "subtype",
          "sleepBetweenExecution" : 5,
          "serverTypes" : [ "serverTypes", "serverTypes" ],
          "unique" : [ "unique", "unique" ],
          "delta" : [ "delta", "delta" ],
          "scanDuration" : 1,
          "dataRetentionInterval" : 5,
          "type" : "type",
          "collapse" : {
            "value" : "value",
            "key" : "key"
          },
          "sql" : "sql",
          "primaryKey" : {
            "name" : "name",
            "type" : "type"
          }
        },
        "metrics" : {
          "metric_name" : {
            "unit" : "unit",
            "name" : "name"
          }
        },
        "chart" : {
          "stacked" : true,
          "minY" : 2,
          "maxY" : 7,
          "type" : "type"
        }
      },
      "name" : "name",
      "description" : "description",
      "id" : "id"
    }
  } ]
}, {
  "sensors" : [ {
    "runInterval" : 0,
    "disabled" : true,
    "dataRetentionInterval" : 6,
    "type" : {
      "fromPackage" : true,
      "meta" : {
        "default" : {
          "defaults" : { },
          "subtype" : "subtype",
          "sleepBetweenExecution" : 5,
          "serverTypes" : [ "serverTypes", "serverTypes" ],
          "unique" : [ "unique", "unique" ],
          "delta" : [ "delta", "delta" ],
          "scanDuration" : 1,
          "dataRetentionInterval" : 5,
          "type" : "type",
          "collapse" : {
            "value" : "value",
            "key" : "key"
          },
          "sql" : "sql",
          "primaryKey" : {
            "name" : "name",
            "type" : "type"
          }
        },
        "metrics" : {
          "metric_name" : {
            "unit" : "unit",
            "name" : "name"
          }
        },
        "chart" : {
          "stacked" : true,
          "minY" : 2,
          "maxY" : 7,
          "type" : "type"
        }
      },
      "name" : "name",
      "description" : "description",
      "id" : "id"
    }
  }, {
    "runInterval" : 0,
    "disabled" : true,
    "dataRetentionInterval" : 6,
    "type" : {
      "fromPackage" : true,
      "meta" : {
        "default" : {
          "defaults" : { },
          "subtype" : "subtype",
          "sleepBetweenExecution" : 5,
          "serverTypes" : [ "serverTypes", "serverTypes" ],
          "unique" : [ "unique", "unique" ],
          "delta" : [ "delta", "delta" ],
          "scanDuration" : 1,
          "dataRetentionInterval" : 5,
          "type" : "type",
          "collapse" : {
            "value" : "value",
            "key" : "key"
          },
          "sql" : "sql",
          "primaryKey" : {
            "name" : "name",
            "type" : "type"
          }
        },
        "metrics" : {
          "metric_name" : {
            "unit" : "unit",
            "name" : "name"
          }
        },
        "chart" : {
          "stacked" : true,
          "minY" : 2,
          "maxY" : 7,
          "type" : "type"
        }
      },
      "name" : "name",
      "description" : "description",
      "id" : "id"
    }
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/alerting/effective
Get the REST resource for OneDB server's alerting effective profile (getEffectiveProfile1)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[AlertingEffectiveResponse]

Example data

Content-Type: application/json
[ {
  "condition" : {
    "op" : "op",
    "b" : {
      "type" : "type",
      "value" : 6
    }
  },
  "name" : "name",
  "id" : 0,
  "trigger" : {
    "type" : "type"
  }
}, {
  "condition" : {
    "op" : "op",
    "b" : {
      "type" : "type",
      "value" : 6
    }
  },
  "name" : "name",
  "id" : 0,
  "trigger" : {
    "type" : "type"
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/monitoring/effective
Get the effective monitoring profile (getEffectiveProfile2)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

MonitoringEffectiveProfile

Example data

Content-Type: application/json
{
  "sensors" : [ {
    "runInterval" : 0,
    "disabled" : true,
    "dataRetentionInterval" : 6,
    "type" : {
      "fromPackage" : true,
      "meta" : {
        "default" : {
          "defaults" : { },
          "subtype" : "subtype",
          "sleepBetweenExecution" : 5,
          "serverTypes" : [ "serverTypes", "serverTypes" ],
          "unique" : [ "unique", "unique" ],
          "delta" : [ "delta", "delta" ],
          "scanDuration" : 1,
          "dataRetentionInterval" : 5,
          "type" : "type",
          "collapse" : {
            "value" : "value",
            "key" : "key"
          },
          "sql" : "sql",
          "primaryKey" : {
            "name" : "name",
            "type" : "type"
          }
        },
        "metrics" : {
          "metric_name" : {
            "unit" : "unit",
            "name" : "name"
          }
        },
        "chart" : {
          "stacked" : true,
          "minY" : 2,
          "maxY" : 7,
          "type" : "type"
        }
      },
      "name" : "name",
      "description" : "description",
      "id" : "id"
    }
  }, {
    "runInterval" : 0,
    "disabled" : true,
    "dataRetentionInterval" : 6,
    "type" : {
      "fromPackage" : true,
      "meta" : {
        "default" : {
          "defaults" : { },
          "subtype" : "subtype",
          "sleepBetweenExecution" : 5,
          "serverTypes" : [ "serverTypes", "serverTypes" ],
          "unique" : [ "unique", "unique" ],
          "delta" : [ "delta", "delta" ],
          "scanDuration" : 1,
          "dataRetentionInterval" : 5,
          "type" : "type",
          "collapse" : {
            "value" : "value",
            "key" : "key"
          },
          "sql" : "sql",
          "primaryKey" : {
            "name" : "name",
            "type" : "type"
          }
        },
        "metrics" : {
          "metric_name" : {
            "unit" : "unit",
            "name" : "name"
          }
        },
        "chart" : {
          "stacked" : true,
          "minY" : 2,
          "maxY" : 7,
          "type" : "type"
        }
      },
      "name" : "name",
      "description" : "description",
      "id" : "id"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation MonitoringEffectiveProfile

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/alerting/effective
Get the REST resource for OneDB server's alerting effective profile (getEffectiveProfile3)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

array[AlertingEffectiveGroupIdResponse]

Example data

Content-Type: application/json
[ {
  "condition" : {
    "op" : "op",
    "b" : {
      "type" : "type",
      "value" : 6
    }
  },
  "name" : "name",
  "disabled" : true,
  "id" : 0,
  "trigger" : {
    "type" : "type"
  }
}, {
  "condition" : {
    "op" : "op",
    "b" : {
      "type" : "type",
      "value" : 6
    }
  },
  "name" : "name",
  "disabled" : true,
  "id" : 0,
  "trigger" : {
    "type" : "type"
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}
Get objects (getGroup)
Get object api

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Query parameters

nested (optional)
Query Parameter — default: 1
groups (optional)
Query Parameter — default: 1 format: int32
servers (optional)
Query Parameter — default: 1 format: int32
aggregate (optional)
Query Parameter — default: 1 format: int32

Return type

BSONObject

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation BSONObject
Up 
get /onedb/groups/{groupId}/monitoring
Get the monitoring profile (getGroupMonitoringProfile)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

MonitoringResponse

Example data

Content-Type: application/json
{
  "own" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MonitoringResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/monitoring/sensors/{sensorTypeId}
Get the REST API resource representing a specific sensor (getGroupMonitoringSensor)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64
sensorTypeId (required)
Path Parameter —

Return type

array[Object]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/ha
Get all high availability info of the server (getHighAvailabilityInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

includeDetailedInfo (optional)
Query Parameter — True when detailed information is required default: false

Return type

HighAvailabilityInfoResponse

Example data

Content-Type: application/json
{
  "haName" : "haName",
  "primaryNotPresent" : "primaryNotPresent",
  "exceptionMessage" : "exceptionMessage",
  "clusterNodeList" : [ {
    "lagtime" : 1.4658129805029452,
    "name" : "name",
    "connectionStatus" : "connectionStatus",
    "updatable" : "updatable",
    "workload" : 6.027456183070403,
    "id" : 0,
    "idException" : "idException",
    "approxLogBacklog" : "approxLogBacklog",
    "type" : "type",
    "status" : "status"
  }, {
    "lagtime" : 1.4658129805029452,
    "name" : "name",
    "connectionStatus" : "connectionStatus",
    "updatable" : "updatable",
    "workload" : 6.027456183070403,
    "id" : 0,
    "idException" : "idException",
    "approxLogBacklog" : "approxLogBacklog",
    "type" : "type",
    "status" : "status"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HighAvailabilityInfoResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/ha/smx
Get high availability SMX info of the server (getHighAvailabilitySMXInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

HighAvailabilitySMXInfoResponse

Example data

Content-Type: application/json
{
  "primaryNotPresent" : "primaryNotPresent",
  "smxInfoList" : [ {
    "bytesReceived" : 1,
    "retriesForWriteCall" : 5,
    "encryptionStatus" : "encryptionStatus",
    "name" : "name",
    "numberOfNetworkPipes" : 0,
    "compressionStatus" : "compressionStatus",
    "bytesSent" : 6,
    "type" : "type"
  }, {
    "bytesReceived" : 1,
    "retriesForWriteCall" : 5,
    "encryptionStatus" : "encryptionStatus",
    "name" : "name",
    "numberOfNetworkPipes" : 0,
    "compressionStatus" : "compressionStatus",
    "bytesSent" : 6,
    "type" : "type"
  } ],
  "exceptionMessage" : "exceptionMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HighAvailabilitySMXInfoResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/host
Get information on about the OneDB server host machine (getHostOSInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

ServerHostInfoResponse

Example data

Content-Type: application/json
{
  "os_nodename" : "os_nodename",
  "os_num_procs" : 0,
  "os_num_olprocs" : 6,
  "os_open_file_lim" : 2,
  "os_version" : "os_version",
  "os_mem_total" : 5,
  "os_name" : "os_name",
  "os_release" : "os_release",
  "os_machine" : "os_machine",
  "os_mem_free" : 5,
  "os_pagesize" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ServerHostInfoResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/iwa
Get info about OneDB Warehouse Accelerators (getIWAInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[IWAResponse]

Example data

Content-Type: application/json
[ {
  "hasIWA" : true
}, {
  "hasIWA" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/incidents
Get incidents for a server (getIncidents)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

after (optional)
Query Parameter — Get incidents that occurred after a specific timestamp format: int64
limit (optional)
Query Parameter — Limit the number of incidents returned default: 50 format: int32

Return type

array[IncidentsResponse]

Example data

Content-Type: application/json
[ {
  "server_name" : "server_name",
  "meta" : {
    "msg" : "msg"
  },
  "when_created" : 6,
  "id" : 0,
  "state" : 1,
  "server_id" : 5
}, {
  "server_name" : "server_name",
  "meta" : {
    "msg" : "msg"
  },
  "when_created" : 6,
  "id" : 0,
  "state" : 1,
  "server_id" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/incidents
Get incidents for a group (getIncidents1)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Query parameters

after (optional)
Query Parameter — Get incidents that occurred after a specific timestamp format: int64
limit (optional)
Query Parameter — Limit the number of incidents returned default: 50 format: int32

Return type

array[IncidentsResponse]

Example data

Content-Type: application/json
[ {
  "server_name" : "server_name",
  "meta" : {
    "msg" : "msg"
  },
  "when_created" : 6,
  "id" : 0,
  "state" : 1,
  "server_id" : 5
}, {
  "server_name" : "server_name",
  "meta" : {
    "msg" : "msg"
  },
  "when_created" : 6,
  "id" : 0,
  "state" : 1,
  "server_id" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables/{tableName}/index
Get the REST API resource for an OneDB Indexes (getIndexOnBasisOfName)

Path parameters

tableName (required)
Path Parameter —
sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

indexName (optional)
Query Parameter —

Return type

array[DatabasesSqlSessionsTablesIndexResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "tabid" : 0,
  "tabname" : "tabname",
  "idxtype" : "idxtype",
  "idxname" : "idxname"
}, {
  "owner" : "owner",
  "tabid" : 0,
  "tabname" : "tabname",
  "idxtype" : "idxtype",
  "idxname" : "idxname"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/privileges/internalUsers
Get all internal users (getInternalUsers)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

InternalPrivilegedUserResponse

Example data

Content-Type: application/json
{
  "osUserName" : "osUserName",
  "uid" : 0,
  "gid" : 6,
  "homeDirectory" : "homeDirectory",
  "isLocked" : true,
  "privilegeTypes" : [ "privilegeTypes", "privilegeTypes" ],
  "authenticationType" : "authenticationType",
  "userName" : "userName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK InternalPrivilegedUserResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/jobs
Get the list of pending and completed jobs for compression (getJobList)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

StorageJobsResponse

Example data

Content-Type: application/json
[ {
  "msg" : "msg",
  "running" : 1,
  "elapsed" : 5,
  "processed" : 5,
  "js_comment" : "js_comment",
  "numrows" : 2,
  "start" : {
    "date" : "date"
  },
  "js_task" : 6,
  "js_id" : 0,
  "end" : {
    "date" : "date"
  },
  "command" : "command"
}, {
  "msg" : "msg",
  "running" : 1,
  "elapsed" : 5,
  "processed" : 5,
  "js_comment" : "js_comment",
  "numrows" : 2,
  "start" : {
    "date" : "date"
  },
  "js_task" : 6,
  "js_id" : 0,
  "end" : {
    "date" : "date"
  },
  "command" : "command"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StorageJobsResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/monitoring/sensors/{sensorTypeId}/data/latest
Get the REST resource for the latest data associated with this sensor (getLatestData)

Path parameters

sensorTypeId (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

n (optional)
Query Parameter — default: 1 format: int32
fromTimestamp (optional)
Query Parameter — format: int64

Return type

array[MonitoringOnedbSensorIdDataLatestResponse]

Example data

Content-Type: application/json
[ {
  "data" : {
    "count" : 6,
    "files" : [ { }, { } ]
  },
  "timestamp" : 0
}, {
  "data" : {
    "count" : 6,
    "files" : [ { }, { } ]
  },
  "timestamp" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/monitoring/sensors/{sensorTypeId}/data/latest
Get the REST resource for the latest data associated with this sensor (getLatestData1)

Path parameters

sensorTypeId (required)
Path Parameter —
groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Query parameters

n (optional)
Query Parameter — default: 1 format: int32
fromTimestamp (optional)
Query Parameter — format: int64

Return type

array[MonitoringGroupIdSensorIdDataLatestResponse]

Example data

Content-Type: application/json
[ {
  "data" : {
    "count" : 6,
    "files" : [ { }, { } ]
  },
  "timestamp" : 0
}, {
  "data" : {
    "count" : 6,
    "files" : [ { }, { } ]
  },
  "timestamp" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/rlogs/llog
Get logical log info (getLogicalLogInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

LogicalLogInfoResponse

Example data

Content-Type: application/json
{
  "number" : 0,
  "percent_used" : 5,
  "pps" : 3,
  "flags" : 9,
  "total_size" : 2.027123023002322,
  "filltime" : 7,
  "used_pages" : 5,
  "location" : 2,
  "total_pages" : 1,
  "used_size" : 4,
  "uniqueid" : 6,
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK LogicalLogInfoResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/memory
Get OneDB server memory information (getMemoryInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

MemoryResponse

Example data

Content-Type: application/json
{
  "os_mem_used" : 5,
  "max_ses_mem" : 7,
  "total_mem" : 0,
  "os_mem_total" : 5,
  "session_count" : 2,
  "avg_ses_mem" : 9,
  "os_mem_free" : 1,
  "used_mem" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MemoryResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/sql/more
Get more rows from the last query executed (getMore)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsMoreResponse]

Example data

Content-Type: application/json
[ {
  "data" : [ {
    "tabname" : {
      "value" : "value"
    },
    "flags" : {
      "value" : 0
    }
  }, {
    "tabname" : {
      "value" : "value"
    },
    "flags" : {
      "value" : 0
    }
  } ],
  "hasMore" : true
}, {
  "data" : [ {
    "tabname" : {
      "value" : "value"
    },
    "flags" : {
      "value" : 0
    }
  }, {
    "tabname" : {
      "value" : "value"
    },
    "flags" : {
      "value" : 0
    }
  } ],
  "hasMore" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/logs/baractlog/config
Get OnBar Logs Rotation Current Configurations (getOnBarLogsRotationConfigurations)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[OnBarConfigResponse]

Example data

Content-Type: application/json
[ {
  "rotationEnabled" : true,
  "rotationFrequency" : 6.027456183070403,
  "maxFiles" : 0
}, {
  "rotationEnabled" : true,
  "rotationFrequency" : 6.027456183070403,
  "maxFiles" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/onconfig/{name}
Get information about a specific onconfig parameter (getOnconfigParameter)

Path parameters

name (required)
Path Parameter — Name of the onconfig parameter
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

OnConfigResponse

Example data

Content-Type: application/json
{
  "effective" : "effective",
  "name" : "name",
  "flags" : 6,
  "dynamic" : 1,
  "id" : 0,
  "type" : "type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OnConfigResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/logs/onlinelog
Get OneDB online log (getOnlineLog)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

offset (optional)
Query Parameter — format: int32
offset2 (optional)
Query Parameter — format: int32

Return type

array[OnlineLogResponse]

Example data

Content-Type: application/json
[ {
  "offset" : 0,
  "message" : "message"
}, {
  "offset" : 0,
  "message" : "message"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/logs/onlinelog/config
Get Online Logs Rotation Current Configurations (getOnlineLogsRotationConfigurations)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[OnLineLogRotationResponse]

Example data

Content-Type: application/json
[ {
  "rotationEnabled" : true,
  "rotationFrequency" : 6.027456183070403,
  "maxFiles" : 0
}, {
  "rotationEnabled" : true,
  "rotationFrequency" : 6.027456183070403,
  "maxFiles" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/opclasses
Gets the operator classes details (getOperatorClassesDetails)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsOPClassesResponse]

Example data

Content-Type: application/json
[ {
  "opclassname" : "opclassname",
  "owner" : "owner",
  "access_method" : "access_method",
  "operators" : "operators",
  "support_func" : "support_func"
}, {
  "opclassname" : "opclassname",
  "owner" : "owner",
  "access_method" : "access_method",
  "operators" : "operators",
  "support_func" : "support_func"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/policies
Get info related to the automatic storage optimization policies (getOptimizePolicies)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

PoliciesResponse

Example data

Content-Type: application/json
{
  "task_parameters" : [ {
    "task_name" : "task_name",
    "value_type" : "value_type",
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "value" : "value"
  }, {
    "task_name" : "task_name",
    "value_type" : "value_type",
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "value" : "value"
  } ],
  "task_info" : {
    "tk_total_time" : "tk_total_time",
    "tk_name" : "tk_name",
    "tk_delete" : {
      "IntervalDF" : {
        "seconds" : "seconds",
        "nanoseconds" : "nanoseconds"
      }
    },
    "tk_monday" : true,
    "tk_thursday" : true,
    "tk_description" : "tk_description",
    "tk_type" : "tk_type",
    "tk_sequence" : 6,
    "tk_stop_time" : "tk_stop_time",
    "tk_result_table" : "tk_result_table",
    "tk_execute" : "tk_execute",
    "tk_wednesday" : true,
    "tk_sunday" : true,
    "tk_start_time" : {
      "date" : "date"
    },
    "tk_priority" : 5,
    "tk_total_executions" : "2000-01-23",
    "tk_enable" : true,
    "tk_dbs" : "tk_dbs",
    "tk_next_execution" : "2000-01-23",
    "tk_create" : "tk_create",
    "tk_friday" : true,
    "tk_attributes" : 1,
    "tk_tuesday" : true,
    "tk_saturday" : true,
    "tk_id" : 0,
    "tk_group" : "tk_group"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PoliciesResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/scheduler/tasks/{id}/parameters
Get parameters for task (getParametersForTask)

Path parameters

id (required)
Path Parameter — format: int32
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[SchedulerTasksParametersResponse]

Example data

Content-Type: application/json
[ {
  "task_name" : "task_name",
  "value_type" : "value_type",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "value" : "value"
}, {
  "task_name" : "task_name",
  "value_type" : "value_type",
  "name" : "name",
  "description" : "description",
  "id" : 0,
  "value" : "value"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/rlogs/plog
Get physical log info (getPhysicalLogInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[PhysicalLogResponse]

Example data

Content-Type: application/json
[ {
  "buffer_size" : 9,
  "total_size" : 2.3021358869347655,
  "location" : 0,
  "used_pages" : 1,
  "buffer_pages" : 5,
  "total_pages" : 6,
  "dbspace" : "dbspace",
  "used_size" : 7,
  "start_offset" : 3,
  "start_position_pages" : 5
}, {
  "buffer_size" : 9,
  "total_size" : 2.3021358869347655,
  "location" : 0,
  "used_pages" : 1,
  "buffer_pages" : 5,
  "total_pages" : 6,
  "dbspace" : "dbspace",
  "used_size" : 7,
  "start_offset" : 3,
  "start_position_pages" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/privileges/{database}/privilegedUsers
Get all privileged users for the given database (getPrivilegedUsers)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
database (required)
Path Parameter — The database name to get privileged users on

Return type

array[DatabasePrivilegedUserResponse]

Example data

Content-Type: application/json
[ {
  "defaultRole" : "defaultRole",
  "userName" : "userName",
  "privilegeType" : "privilegeType"
}, {
  "defaultRole" : "defaultRole",
  "userName" : "userName",
  "privilegeType" : "privilegeType"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/procedures/{procid}
Gets procedure or function details on basis of procid (getProcedureAndFunctionDetails)

Path parameters

procid (required)
Path Parameter — format: int32
sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsProceduresIDResponse]

Example data

Content-Type: application/json
[ {
  "sql_create" : "sql_create",
  "sql_alter" : "sql_alter"
}, {
  "sql_create" : "sql_create",
  "sql_alter" : "sql_alter"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/procedures
Get procedures and function details (getProceduresDetails)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsProceduresResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "mode" : "mode",
  "numargs" : 6,
  "paramtypes" : "paramtypes",
  "procid" : 0,
  "retsize" : 1,
  "procname" : "procname",
  "type" : "type",
  "lang" : "lang"
}, {
  "owner" : "owner",
  "mode" : "mode",
  "numargs" : 6,
  "paramtypes" : "paramtypes",
  "procid" : 0,
  "retsize" : 1,
  "procname" : "procname",
  "type" : "type",
  "lang" : "lang"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/monitoring
Get the monitoring profile (getProfile)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

MonitoringProfileResponse

Example data

Content-Type: application/json
{
  "own" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK MonitoringProfileResponse

403

Forbidden

404

Not Found
Up 
get /onedb/{onedbServerId}/alerting
Get the REST resource for this OneDB server's alerting profile (getProfile1)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[AlertingResponse]

Example data

Content-Type: application/json
[ {
  "alerts" : [ {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  }, {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  } ],
  "inherited" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
}, {
  "alerts" : [ {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  }, {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  } ],
  "inherited" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/profile
Get OneDB profile information (getProfile2)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[OneDBProfileResponse]

Example data

Content-Type: application/json
[ {
  "pf_iswrites" : 3,
  "pf_isrewrites" : 2,
  "pf_pagwrites" : 8,
  "pf_fgwrites" : 3,
  "pf_isopens" : 2,
  "pf_lockwts" : 1,
  "pf_ovlock" : 1,
  "pf_seqscans" : 6,
  "pf_flushes" : 9,
  "pf_isdeletes" : 4,
  "pf_isamtot" : 5,
  "pf_isrollbacks" : 1,
  "pf_bufreads" : 6,
  "pf_dskwrites" : 1,
  "pf_iscommits" : 7,
  "pf_pagreads" : 6,
  "pf_ovuser" : 1,
  "pf_deadlks" : 5,
  "pf_bufwrites" : 5,
  "pf_isstarts" : 7,
  "pf_dskreads" : 0,
  "pf_lktouts" : 9,
  "pf_ckptwts" : 4,
  "pf_compress" : 6,
  "pf_buffwts" : 6,
  "pf_lockreqs" : 7,
  "pf_isreads" : 9,
  "pf_numckpts" : 9
}, {
  "pf_iswrites" : 3,
  "pf_isrewrites" : 2,
  "pf_pagwrites" : 8,
  "pf_fgwrites" : 3,
  "pf_isopens" : 2,
  "pf_lockwts" : 1,
  "pf_ovlock" : 1,
  "pf_seqscans" : 6,
  "pf_flushes" : 9,
  "pf_isdeletes" : 4,
  "pf_isamtot" : 5,
  "pf_isrollbacks" : 1,
  "pf_bufreads" : 6,
  "pf_dskwrites" : 1,
  "pf_iscommits" : 7,
  "pf_pagreads" : 6,
  "pf_ovuser" : 1,
  "pf_deadlks" : 5,
  "pf_bufwrites" : 5,
  "pf_isstarts" : 7,
  "pf_dskreads" : 0,
  "pf_lktouts" : 9,
  "pf_ckptwts" : 4,
  "pf_compress" : 6,
  "pf_buffwts" : 6,
  "pf_lockreqs" : 7,
  "pf_isreads" : 9,
  "pf_numckpts" : 9
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/alerting
Get the REST resource for the group's alerting profile (getProfile4)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

AlertingResponse1

Example data

Content-Type: application/json
{
  "alerts" : [ {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  }, {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  } ],
  "inherited" : [ "inherited", "inherited" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AlertingResponse1

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/rlogs
Get OneDB recovery log info (getRecoveryLogInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[RLogsResponse]

Example data

Content-Type: application/json
[ {
  "plog" : {
    "buffer_size" : 9,
    "total_size" : 2.3021358869347655,
    "location" : 0,
    "used_pages" : 1,
    "buffer_pages" : 5,
    "total_pages" : 6,
    "dbspace" : "dbspace",
    "used_size" : 7,
    "start_offset" : 3,
    "start_position_pages" : 5
  },
  "llog" : [ {
    "number" : 2,
    "percent_used" : 1,
    "pps" : 1,
    "flags" : 7,
    "total_size" : 4.965218492984954,
    "filltime" : 6,
    "used_pages" : 1,
    "location" : 1,
    "total_pages" : 7,
    "used_size" : 5,
    "uniqueid" : 4,
    "status" : "status"
  }, {
    "number" : 2,
    "percent_used" : 1,
    "pps" : 1,
    "flags" : 7,
    "total_size" : 4.965218492984954,
    "filltime" : 6,
    "used_pages" : 1,
    "location" : 1,
    "total_pages" : 7,
    "used_size" : 5,
    "uniqueid" : 4,
    "status" : "status"
  } ]
}, {
  "plog" : {
    "buffer_size" : 9,
    "total_size" : 2.3021358869347655,
    "location" : 0,
    "used_pages" : 1,
    "buffer_pages" : 5,
    "total_pages" : 6,
    "dbspace" : "dbspace",
    "used_size" : 7,
    "start_offset" : 3,
    "start_position_pages" : 5
  },
  "llog" : [ {
    "number" : 2,
    "percent_used" : 1,
    "pps" : 1,
    "flags" : 7,
    "total_size" : 4.965218492984954,
    "filltime" : 6,
    "used_pages" : 1,
    "location" : 1,
    "total_pages" : 7,
    "used_size" : 5,
    "uniqueid" : 4,
    "status" : "status"
  }, {
    "number" : 2,
    "percent_used" : 1,
    "pps" : 1,
    "flags" : 7,
    "total_size" : 4.965218492984954,
    "filltime" : 6,
    "used_pages" : 1,
    "location" : 1,
    "total_pages" : 7,
    "used_size" : 5,
    "uniqueid" : 4,
    "status" : "status"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/scheduler/tasks/runs/history
Get task run history (getRunHistory)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SchedulerTasksRunsHistoryResponse

Example data

Content-Type: application/json
[ {
  "tk_total_time" : 5.962133916683182,
  "tk_run_retcode" : 5,
  "tk_run_time" : {
    "date" : "date"
  },
  "tk_name" : "tk_name",
  "tk_id" : 0,
  "tk_average_time" : 1.4658129805029452,
  "tk_total_executions" : 6
}, {
  "tk_total_time" : 5.962133916683182,
  "tk_run_retcode" : 5,
  "tk_run_time" : {
    "date" : "date"
  },
  "tk_name" : "tk_name",
  "tk_id" : 0,
  "tk_average_time" : 1.4658129805029452,
  "tk_total_executions" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SchedulerTasksRunsHistoryResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/config
Get the SQL tracing configuration (getSQLTraceConfig)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SqlTraceConfigResponse

Example data

Content-Type: application/json
{
  "mode" : {
    "type" : "global"
  },
  "databases" : {
    "tracedDatabases" : [ "sysadmin", "sysadmin" ],
    "untracedDatabases" : [ "untracedDatabases", "untracedDatabases" ]
  },
  "level" : {
    "type" : "low"
  },
  "flags" : 1.4658129805029452,
  "state" : {
    "type" : "on"
  },
  "tracedUsers" : [ 5, 5 ],
  "ntraces" : 0.8008281904610115,
  "tracesize" : 6.027456183070403
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation SqlTraceConfigResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/info
Get information about the live SQL tracing data, including the tracing starttime, duration, number of SQL statements seen, etc (getSQLTraceInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SqltraceInfoResponse

Example data

Content-Type: application/json
{
  "duration" : 0,
  "trc_tabnames" : 2,
  "sqlpersec" : 1.4658129805029452,
  "trc_dbsname" : 7,
  "trc_hostvars" : 9,
  "starttime" : {
    "date" : "date"
  },
  "trc_procedures" : 5,
  "sqlseen" : 6,
  "memoryused" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SqltraceInfoResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/statements/{sqlid}/executions
Get a list of all executions of a SQL statement based on a sql statement id (getSQLTraceStatementExecution)

Path parameters

sqlid (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

fromTimestamp (optional)
Query Parameter — format: int64
toTimestamp (optional)
Query Parameter — format: int64

Return type

ExecutionsSqlResponse

Example data

Content-Type: application/json
[ {
  "sql_uid" : 1,
  "sql_runtime" : 5.637377,
  "sql_sid" : 6,
  "sql_id" : 0,
  "sql_totaliowaits" : 3.616076749251911,
  "sql_finishtime" : 5,
  "sql_actualrows" : 7,
  "sql_rowspersec" : 2.302136,
  "sql_lockwttime" : 9.301444
}, {
  "sql_uid" : 1,
  "sql_runtime" : 5.637377,
  "sql_sid" : 6,
  "sql_id" : 0,
  "sql_totaliowaits" : 3.616076749251911,
  "sql_finishtime" : 5,
  "sql_actualrows" : 7,
  "sql_rowspersec" : 2.302136,
  "sql_lockwttime" : 9.301444
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ExecutionsSqlResponse
Up 
get /onedb/{onedbServerId}/sqltrace/statements/{sqlid}/iterators
Get SQL trace iterator info for a particular sql statement id (getSQLTraceStatementIterators)

Path parameters

sqlid (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

IterationSqlResponse

Example data

Content-Type: application/json
[ {
  "sql_itr_sender" : 5,
  "sql_itr_id" : 6,
  "sql_id" : 0,
  "sql_itr_estrows" : 9,
  "sql_itr_right" : 5,
  "sql_itr_numrows" : 3,
  "sql_itr_type" : 2,
  "sql_itr_table" : "sql_itr_table",
  "sql_itr_partnum" : 1,
  "sql_itr_misc" : 4,
  "sql_itr_info" : "sql_itr_info",
  "sql_itr_left" : 1,
  "sql_itr_cost" : 7,
  "sql_itr_nxtsender" : 2,
  "sql_itr_time" : 7.386282
}, {
  "sql_itr_sender" : 5,
  "sql_itr_id" : 6,
  "sql_id" : 0,
  "sql_itr_estrows" : 9,
  "sql_itr_right" : 5,
  "sql_itr_numrows" : 3,
  "sql_itr_type" : 2,
  "sql_itr_table" : "sql_itr_table",
  "sql_itr_partnum" : 1,
  "sql_itr_misc" : 4,
  "sql_itr_info" : "sql_itr_info",
  "sql_itr_left" : 1,
  "sql_itr_cost" : 7,
  "sql_itr_nxtsender" : 2,
  "sql_itr_time" : 7.386282
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK IterationSqlResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/statements/{sqlid}
Get SQL trace profile statistics for a particular sql statement id (getSQLTraceStatementProfile)

Path parameters

sqlid (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SqlIdResponse

Example data

Content-Type: application/json
{
  "sql_uid" : 1,
  "sql_sid" : 6,
  "sql_executions" : 9,
  "sql_id" : 0,
  "sql_totaliowaits" : 3.5571952270680973,
  "sql_database" : "sql_database",
  "sql_sorttotal" : 7,
  "sql_statement" : "sql_statement",
  "sql_totaltime" : 6.683562403749608,
  "sql_finishtime" : 5,
  "sql_numiowaits" : 6,
  "sql_num_hvars" : 0,
  "sql_lockwttime" : 1.4894159,
  "sql_bfwrites" : 3,
  "sql_wrcache" : 7.386282,
  "sql_pdq" : 7,
  "sql_bfreads" : 9,
  "sql_stmtname" : "sql_stmtname",
  "sql_sqlmemory" : 3,
  "sql_isollevel" : 3,
  "sql_rowspersec" : 1.284659,
  "sql_estcost" : 2,
  "sql_pgreads" : 7,
  "sql_runtime" : 2.302136,
  "sql_avgtime" : 8.762042012749001,
  "sql_lockreq" : 1,
  "hvars" : [ {
    "sql_hvar_data" : "sql_hvar_data",
    "sql_hvar_type" : "sql_hvar_type",
    "sql_hvar_id" : 7
  }, {
    "sql_hvar_data" : "sql_hvar_data",
    "sql_hvar_type" : "sql_hvar_type",
    "sql_hvar_id" : 7
  } ],
  "sql_numiterators" : 9,
  "sql_avgiowaits" : 6.965117697638846,
  "sql_stmttype" : 5,
  "sql_numtables" : 5,
  "sql_logspace" : 6,
  "sql_estrows" : 6,
  "sql_sortmem" : 4,
  "sql_pgwrites" : 2,
  "sql_sqlerror" : 5,
  "sql_maxtime" : 9.018348,
  "sql_actualrows" : 6,
  "sql_sortdisk" : 1,
  "sql_isamerror" : 6,
  "sql_rdcache" : 4.145608,
  "sql_lockwaits" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SqlIdResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/statements
Get traced statements (getSQLTraceStatements)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

type (optional)
Query Parameter —
fromTimestamp (optional)
Query Parameter — format: int64
toTimestamp (optional)
Query Parameter — format: int64

Return type

SqlTraceStatementsResponse

Example data

Content-Type: application/json
[ {
  "sql_id" : 0,
  "sql_statement" : "sql_statement",
  "count" : 6,
  "runtime" : 1.4658129,
  "iowait" : 5.637377,
  "lockwait" : 5.962134
}, {
  "sql_id" : 0,
  "sql_statement" : "sql_statement",
  "count" : 6,
  "runtime" : 1.4658129,
  "iowait" : 5.637377,
  "lockwait" : 5.962134
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SqlTraceStatementsResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/stmttypes
Get the traced statements by type (getSQLTraceStatementsByType)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

StmttypesResponse

Example data

Content-Type: application/json
[ {
  "avg_runtime" : 6.027456183070403,
  "stmt_type" : "stmt_type",
  "max_runtime" : 1.4658129805029452,
  "count" : 0,
  "avg_mem" : 5.962133916683182,
  "rows_processed" : 5
}, {
  "avg_runtime" : 6.027456183070403,
  "stmt_type" : "stmt_type",
  "max_runtime" : 1.4658129805029452,
  "count" : 0,
  "avg_mem" : 5.962133916683182,
  "rows_processed" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StmttypesResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace
Get SQL trace summary info (getSQLTraceSummary)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SqlTraceResponse

Example data

Content-Type: application/json
{
  "config" : {
    "mode" : "mode",
    "databases" : {
      "tracedDatabases" : [ "sysadmin", "sysadmin" ],
      "untracedDatabases" : [ "untracedDatabases", "untracedDatabases" ]
    },
    "level" : "level",
    "flags" : 1,
    "state" : "state",
    "tracedUsers" : [ 5, 5 ],
    "ntraces" : 0.8008281904610115,
    "tracesize" : 6.027456183070403
  },
  "info" : {
    "duration" : 5,
    "trc_tabnames" : 2,
    "sqlpersec" : 7.0614014,
    "trc_dbsname" : 4,
    "trc_hostvars" : 7,
    "starttime" : {
      "date" : "2000-01-23"
    },
    "trc_procedures" : 3,
    "sqlseen" : 2,
    "memoryused" : 9
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SqlTraceResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/statements/{sqlid}/transaction
Get transaction info for a particular SQL statement (getSQLTraceTransactionSummary)

Path parameters

sqlid (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

TransactionSqlIdResponse

Example data

Content-Type: application/json
{
  "sql_sid" : 6,
  "sql_totaliowaits" : 1.4894159098541704,
  "sql_sorttotal" : 4,
  "statements" : [ {
    "sql_runtime" : 3.5571952270680973,
    "sql_id" : 9,
    "sql_totaliowaits" : 6.778324963048013,
    "sql_statement" : "sql_statement",
    "sql_finishtime" : 6,
    "sql_actualrows" : 1,
    "sql_rowspersec" : 6.965117697638846,
    "sql_lockwttime" : 2.8841621266687802
  }, {
    "sql_runtime" : 3.5571952270680973,
    "sql_id" : 9,
    "sql_totaliowaits" : 6.778324963048013,
    "sql_statement" : "sql_statement",
    "sql_finishtime" : 6,
    "sql_actualrows" : 1,
    "sql_rowspersec" : 6.965117697638846,
    "sql_lockwttime" : 2.8841621266687802
  } ],
  "sql_numiowaits" : 1,
  "sql_begintxtime" : 8,
  "sql_lockwttime" : 3.616076749251911,
  "sql_bfwrites" : 2,
  "sql_wrcache" : 9.369310271410669,
  "sql_bfreads" : 5,
  "sql_sqlmemory" : 5,
  "sql_estcost" : 7,
  "sql_pgreads" : 1,
  "sql_runtime" : 6.027456183070403,
  "sql_lockreq" : 7,
  "sql_avgiowaits" : 6.84685269835264,
  "sql_logspace" : 2,
  "sql_estrows" : 1,
  "sql_sortmem" : 1,
  "sql_pgwrites" : 5,
  "sql_actualrows" : 4,
  "sql_sortdisk" : 7,
  "sql_numstmt" : 0,
  "sql_rdcache" : 9.965781217890562,
  "sql_lockwaits" : 9
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK TransactionSqlIdResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sqltrace/transactions
Get a list of all transactions in the SQL trace buffer (getSQLTraceTransactions)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

TransactionResponse

Example data

Content-Type: application/json
[ {
  "avg_runtime" : 5.637376656633329,
  "sql_sid" : 0,
  "sql_id" : 1,
  "max_runtime" : 2,
  "count" : 5,
  "avg_mem" : 7.061401241503109,
  "rows" : 9,
  "sql_begintxtime" : 6
}, {
  "avg_runtime" : 5.637376656633329,
  "sql_sid" : 0,
  "sql_id" : 1,
  "max_runtime" : 2,
  "count" : 5,
  "avg_mem" : 7.061401241503109,
  "rows" : 9,
  "sql_begintxtime" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation TransactionResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/monitoring/sensors/{sensorTypeId}/data/meta
Get the REST resource for the data associated with this sensor (getSensorDataMeta1)

Path parameters

sensorTypeId (required)
Path Parameter —
groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

GroupIdSensorDataMetaResponse

Example data

Content-Type: application/json
[ {
  "meta" : {
    "msg" : "msg",
    "server_name" : "server_name",
    "server_id" : 1
  },
  "when_created" : "when_created",
  "id" : 0,
  "state" : 6
}, {
  "meta" : {
    "msg" : "msg",
    "server_name" : "server_name",
    "server_id" : 1
  },
  "when_created" : "when_created",
  "id" : 0,
  "state" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK GroupIdSensorDataMetaResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/sequences
Gets the list of sequences (getSequencesDetails)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsSequencesResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "cache" : 2,
  "inc_val" : 0,
  "max_val" : 5,
  "tabauth" : "tabauth",
  "grantee" : "grantee",
  "restart_val" : 5,
  "seqname" : "seqname",
  "min_val" : 1,
  "grantor" : "grantor",
  "cycle" : "cycle",
  "start_val" : 6
}, {
  "owner" : "owner",
  "cache" : 2,
  "inc_val" : 0,
  "max_val" : 5,
  "tabauth" : "tabauth",
  "grantee" : "grantee",
  "restart_val" : 5,
  "seqname" : "seqname",
  "min_val" : 1,
  "grantor" : "grantor",
  "cycle" : "cycle",
  "start_val" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}
Returns a single OneDB Server info (getServerInfo)
Find OneDB Server by id

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

OneDBServerResponse

Example data

Content-Type: application/json
{
  "connectionProperties" : { },
  "agent" : {
    "online" : true,
    "isMonitoring" : true,
    "config" : {
      "database" : "database",
      "repositoryServerId" : 5
    }
  },
  "monitorUser" : "monitorUser",
  "parentGroupId" : 6,
  "hasMonitorPassword" : true,
  "hasAdminPassword" : true,
  "serviceName" : "serviceName",
  "hostname" : "hostname",
  "adminUser" : "adminUser",
  "unreadIncidents" : 5,
  "port" : 1,
  "permissions" : { },
  "alias" : "alias",
  "id" : 0,
  "status" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OneDBServerResponse

403

Forbidden

404

Not Found
Up 
get /onedb/{onedbServerId}/monitoring/sensors/{sensorTypeId}
Get the REST API resource representing a specific sensor (getServerMonitoringSensor)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
sensorTypeId (required)
Path Parameter —

Return type

array[Object]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/monitoring/sensors/{sensorTypeId}/data
Create a batch request to get data from the repository for multiple sensors. (getServerMonitoringSensorData)

Path parameters

sensorTypeId (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

from (optional)
Query Parameter — format: int64
to (optional)
Query Parameter — format: int64
primaryKeys (optional)
Query Parameter —
dsMax (optional)
Query Parameter — format: int32

Return type

SensorTypeIdDataResponse

Example data

Content-Type: application/json
{
  "data" : {
    "dsMax" : 0,
    "from" : "from",
    "to" : "to"
  },
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SensorTypeIdDataResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/monitoring/sensors/{sensorTypeId}/data/meta
Create a batch request to get data from the repository for multiple sensors (getServerMonitoringSensorDataMeta)

Path parameters

sensorTypeId (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SensorDataMetaResponse

Example data

Content-Type: application/json
[ {
  "meta" : {
    "msg" : "msg",
    "server_name" : "server_name",
    "server_id" : 1
  },
  "when_created" : "when_created",
  "id" : 0,
  "state" : 6
}, {
  "meta" : {
    "msg" : "msg",
    "server_name" : "server_name",
    "server_id" : 1
  },
  "when_created" : "when_created",
  "id" : 0,
  "state" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SensorDataMetaResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/status
Get objects (getServerStatus)
Get object api

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

BSONObject

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation BSONObject
Up 
get /onedb/{onedbServerId}/sessions/{id}
Get information about a particular session (getSessionInfo)

Path parameters

id (required)
Path Parameter — format: int32
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SessionsIdResponse

Example data

Content-Type: application/json
{
  "mem_used" : 7,
  "gid" : 1,
  "memory" : [ {
    "name" : "name",
    "used" : 7,
    "free" : 1
  }, {
    "name" : "name",
    "used" : 7,
    "free" : 1
  } ],
  "profile" : {
    "log_space" : 6,
    "seqscans" : 5,
    "lock_waits" : 1,
    "bufwrites" : 2,
    "total_sorts" : 3.0937452,
    "nfiles" : 6,
    "max_sort" : 7,
    "rows_processed" : 9,
    "log_space_max" : 6,
    "rows_deleted" : 9,
    "rollbacks" : 3,
    "lock_timeouts" : 5,
    "memory_sorts" : 0,
    "deadlocks" : 4,
    "nlocks" : 1,
    "rows_inserted" : 6,
    "fg_writes" : 3,
    "rows_updated" : 8,
    "fg_reads" : 6,
    "log_records" : 9,
    "commits" : 6,
    "longtxs" : 6,
    "bufreads" : 1,
    "disk_sorts" : 7,
    "lock_requests" : 7
  },
  "threads" : [ {
    "time_slice" : 8.969578798196912,
    "thread_id" : 6,
    "vpid" : 7,
    "thread_priority" : 3,
    "name" : "name",
    "wait_reason" : "wait_reason",
    "total_time" : 4.652396432933246,
    "num_scheduled" : 0
  }, {
    "time_slice" : 8.969578798196912,
    "thread_id" : 6,
    "vpid" : 7,
    "thread_priority" : 3,
    "name" : "name",
    "wait_reason" : "wait_reason",
    "total_time" : 4.652396432933246,
    "num_scheduled" : 0
  } ],
  "pid" : 5,
  "nfiles" : 9,
  "userid" : 6,
  "locks" : [ {
    "index_number" : 4,
    "lock_duration" : {
      "IntervalDF" : {
        "seconds" : 3,
        "nanoseconds" : 2.027123
      }
    },
    "waiter" : "waiter",
    "lock_type" : "lock_type",
    "table_name" : "table_name",
    "key_item_locked" : "key_item_locked",
    "rowid" : "rowid"
  }, {
    "index_number" : 4,
    "lock_duration" : {
      "IntervalDF" : {
        "seconds" : 3,
        "nanoseconds" : 2.027123
      }
    },
    "waiter" : "waiter",
    "lock_type" : "lock_type",
    "table_name" : "table_name",
    "key_item_locked" : "key_item_locked",
    "rowid" : "rowid"
  } ],
  "mem_total" : 2,
  "sid" : 0,
  "network" : [ 1, 1 ],
  "sql" : [ "sql", "sql" ],
  "connected" : 5,
  "hostname" : "hostname",
  "environment" : [ {
    "name" : "name",
    "source" : "source",
    "value" : "value"
  }, {
    "name" : "name",
    "source" : "source",
    "value" : "value"
  } ],
  "progname" : "progname",
  "current_statement" : "current_statement",
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionsIdResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sessions
Get the list of all sessions (getSessionList)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SessionsResponse

Example data

Content-Type: application/json
{
  "connected" : 1,
  "hostname" : "hostname",
  "cpu_time" : 2.302136,
  "io_wait_time" : 5.637377,
  "pid" : 6,
  "is_killable" : 7,
  "mem_total" : 5,
  "sid" : 0,
  "username" : "username"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionsResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/sessions/summary
Get summary information about all sessions. (getSessionSummary)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SessionsSummaryResponse

Example data

Content-Type: application/json
{
  "max_session_memory" : 6,
  "average_session_memory" : 1.4658129805029452,
  "total_sessions" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SessionsSummaryResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/spaces
Get information about all storage spaces (getSpaces)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[SpaceResponse]

Example data

Content-Type: application/json
[ {
  "extend_size" : 9.301444,
  "expandable" : 2,
  "flags" : 6,
  "type" : "type",
  "dbsnum" : 0,
  "last_backup" : "last_backup",
  "create_size" : 3.6160767,
  "percent_used" : 5.637377,
  "size" : 1,
  "name" : "name",
  "nchunks" : 2,
  "free_size" : 5,
  "status" : "recovering",
  "page_size" : 7
}, {
  "extend_size" : 9.301444,
  "expandable" : 2,
  "flags" : 6,
  "type" : "type",
  "dbsnum" : 0,
  "last_backup" : "last_backup",
  "create_size" : 3.6160767,
  "percent_used" : 5.637377,
  "size" : 1,
  "name" : "name",
  "nchunks" : 2,
  "free_size" : 5,
  "status" : "recovering",
  "page_size" : 7
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/ha/statusInfo
Get specific server info of high availability cluster (getSpecificServerInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

name (required)
Query Parameter — Name of server for which information is required
type (required)
Query Parameter — Type of server for which information is required

Return type

HASpecificServerInfoResponse

Example data

Content-Type: application/json
{
  "transactionLatency" : "transactionLatency",
  "sumOfWorkReplay" : 0.8008282,
  "catchupBacklog" : "catchupBacklog",
  "stopApplyStatistics" : "stopApplyStatistics",
  "activeConnectionManagers" : "activeConnectionManagers",
  "failoverArbitration" : "failoverArbitration",
  "lastLogPageFlushed" : "lastLogPageFlushed",
  "flowControl" : "flowControl",
  "backlog" : "backlog",
  "lastLogPageApplied" : "lastLogPageApplied",
  "lastLogPageAcked" : "lastLogPageAcked",
  "lastLogPageSent" : "lastLogPageSent",
  "delayApplyStatistics" : "delayApplyStatistics",
  "nextLogPageToSend" : "nextLogPageToSend",
  "logTransmissionStatus" : "logTransmissionStatus"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HASpecificServerInfoResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/pool
Get information about storage pool entries (getStoragePoolInfo)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

status (optional)
Query Parameter —

Return type

StoragePoolResponse

Example data

Content-Type: application/json
[ {
  "path" : "path",
  "chunk_size" : 5,
  "device_size" : 1,
  "last_accessed" : {
    "date" : "date"
  },
  "offset" : 6,
  "space_remaining" : 2,
  "priority" : 5,
  "entry_id" : 0,
  "status" : "status"
}, {
  "path" : "path",
  "chunk_size" : 5,
  "device_size" : 1,
  "last_accessed" : {
    "date" : "date"
  },
  "offset" : 6,
  "space_remaining" : 2,
  "priority" : 5,
  "entry_id" : 0,
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StoragePoolResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage
Get high level info about space used and free (getStorageSummary)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

StorageResponse

Example data

Content-Type: application/json
{
  "dbspace_used" : 0,
  "blobspace_used" : 5,
  "tempspace_free" : 5,
  "tempspace_used" : 1,
  "blobspace_free" : 2,
  "dbspace_free" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StorageResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables/{tableName}/details
Get the details for table (getTableDetails)

Path parameters

tableName (required)
Path Parameter —
sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsTablesDetailsResponse]

Example data

Content-Type: application/json
[ {
  "privileges" : [ {
    "tabauth" : "tabauth",
    "grantee" : "grantee",
    "grantor" : "grantor"
  }, {
    "tabauth" : "tabauth",
    "grantee" : "grantee",
    "grantor" : "grantor"
  } ],
  "indexes" : [ {
    "owner" : "owner",
    "leaves" : 5,
    "columns" : [ {
      "id" : 7,
      "descending" : true
    }, {
      "id" : 7,
      "descending" : true
    } ],
    "unique" : true,
    "clustered" : true,
    "name" : "name",
    "uniqueKeys" : 5,
    "filterErrorsEnabled" : true,
    "filtering" : true,
    "enabled" : true,
    "levels" : 1,
    "clusters" : 2
  }, {
    "owner" : "owner",
    "leaves" : 5,
    "columns" : [ {
      "id" : 7,
      "descending" : true
    }, {
      "id" : 7,
      "descending" : true
    } ],
    "unique" : true,
    "clustered" : true,
    "name" : "name",
    "uniqueKeys" : 5,
    "filterErrorsEnabled" : true,
    "filtering" : true,
    "enabled" : true,
    "levels" : 1,
    "clusters" : 2
  } ],
  "references" : [ { }, { } ],
  "columns" : [ {
    "hidden" : true,
    "notNull" : true,
    "name" : "name",
    "length" : 6,
    "id" : 0,
    "type" : "type"
  }, {
    "hidden" : true,
    "notNull" : true,
    "name" : "name",
    "length" : 6,
    "id" : 0,
    "type" : "type"
  } ],
  "fragments" : [ {
    "partn" : "partn",
    "partition" : "partition",
    "indexname" : "indexname",
    "colno" : 9,
    "udi_counter" : 3,
    "fragtype" : "fragtype",
    "dbspace" : "dbspace",
    "type" : "type",
    "exprtext" : true
  }, {
    "partn" : "partn",
    "partition" : "partition",
    "indexname" : "indexname",
    "colno" : 9,
    "udi_counter" : 3,
    "fragtype" : "fragtype",
    "dbspace" : "dbspace",
    "type" : "type",
    "exprtext" : true
  } ],
  "type" : "type",
  "triggers" : [ { }, { } ],
  "constraints" : [ { }, { } ],
  "statistics" : [ {
    "statLevel" : "statLevel",
    "statChange" : "statChange",
    "fragmentStatistics" : [ { }, { } ],
    "is_fragmented" : true,
    "tableStatistics" : [ {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    }, {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    } ]
  }, {
    "statLevel" : "statLevel",
    "statChange" : "statChange",
    "fragmentStatistics" : [ { }, { } ],
    "is_fragmented" : true,
    "tableStatistics" : [ {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    }, {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    } ]
  } ]
}, {
  "privileges" : [ {
    "tabauth" : "tabauth",
    "grantee" : "grantee",
    "grantor" : "grantor"
  }, {
    "tabauth" : "tabauth",
    "grantee" : "grantee",
    "grantor" : "grantor"
  } ],
  "indexes" : [ {
    "owner" : "owner",
    "leaves" : 5,
    "columns" : [ {
      "id" : 7,
      "descending" : true
    }, {
      "id" : 7,
      "descending" : true
    } ],
    "unique" : true,
    "clustered" : true,
    "name" : "name",
    "uniqueKeys" : 5,
    "filterErrorsEnabled" : true,
    "filtering" : true,
    "enabled" : true,
    "levels" : 1,
    "clusters" : 2
  }, {
    "owner" : "owner",
    "leaves" : 5,
    "columns" : [ {
      "id" : 7,
      "descending" : true
    }, {
      "id" : 7,
      "descending" : true
    } ],
    "unique" : true,
    "clustered" : true,
    "name" : "name",
    "uniqueKeys" : 5,
    "filterErrorsEnabled" : true,
    "filtering" : true,
    "enabled" : true,
    "levels" : 1,
    "clusters" : 2
  } ],
  "references" : [ { }, { } ],
  "columns" : [ {
    "hidden" : true,
    "notNull" : true,
    "name" : "name",
    "length" : 6,
    "id" : 0,
    "type" : "type"
  }, {
    "hidden" : true,
    "notNull" : true,
    "name" : "name",
    "length" : 6,
    "id" : 0,
    "type" : "type"
  } ],
  "fragments" : [ {
    "partn" : "partn",
    "partition" : "partition",
    "indexname" : "indexname",
    "colno" : 9,
    "udi_counter" : 3,
    "fragtype" : "fragtype",
    "dbspace" : "dbspace",
    "type" : "type",
    "exprtext" : true
  }, {
    "partn" : "partn",
    "partition" : "partition",
    "indexname" : "indexname",
    "colno" : 9,
    "udi_counter" : 3,
    "fragtype" : "fragtype",
    "dbspace" : "dbspace",
    "type" : "type",
    "exprtext" : true
  } ],
  "type" : "type",
  "triggers" : [ { }, { } ],
  "constraints" : [ { }, { } ],
  "statistics" : [ {
    "statLevel" : "statLevel",
    "statChange" : "statChange",
    "fragmentStatistics" : [ { }, { } ],
    "is_fragmented" : true,
    "tableStatistics" : [ {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    }, {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    } ]
  }, {
    "statLevel" : "statLevel",
    "statChange" : "statChange",
    "fragmentStatistics" : [ { }, { } ],
    "is_fragmented" : true,
    "tableStatistics" : [ {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    }, {
      "mode" : "mode",
      "build_date" : {
        "date" : "2000-01-23"
      },
      "nrows" : 4,
      "confidence" : 1.2315135,
      "change" : 1,
      "name" : "name",
      "udi_counter" : 1,
      "type" : "type",
      "sample" : 2,
      "resolution" : 7,
      "build_duration" : {
        "IntervalDF" : {
          "seconds" : "2000-01-23T04:56:07.000+00:00",
          "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
        }
      }
    } ]
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/privileges/{database}/tablePrivileges
Get all info about table-level privileges for the given database (getTablePrivilegesInfo)

Path parameters

database (required)
Path Parameter — The database name to get table-level privileges on
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

TablePrivilegedUserResponse

Example data

Content-Type: application/json
{
  "tabAuth" : [ "tabAuth", "tabAuth" ],
  "grantee" : "grantee",
  "grantor" : "grantor",
  "tableName" : "tableName"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK TablePrivilegedUserResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables
Get the list of table (getTables)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsTablesResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "statisticsLevel" : true,
  "isRaw" : true,
  "isExternal" : true,
  "lockLevel" : "lockLevel",
  "isAqt" : true,
  "synonyms" : { },
  "isRemote" : true,
  "isCollection" : true,
  "pageSize" : 5,
  "type" : "type",
  "lastStatisticsUpdate" : 2,
  "hasRowId" : true,
  "isAuditEnabled" : true,
  "name" : "name",
  "isSubTable" : true,
  "id" : 0,
  "lastModified" : 6,
  "isCdr" : true,
  "firstExtentSize" : 1,
  "isVirtualAqt" : true,
  "nextExtentSize" : 5
}, {
  "owner" : "owner",
  "statisticsLevel" : true,
  "isRaw" : true,
  "isExternal" : true,
  "lockLevel" : "lockLevel",
  "isAqt" : true,
  "synonyms" : { },
  "isRemote" : true,
  "isCollection" : true,
  "pageSize" : 5,
  "type" : "type",
  "lastStatisticsUpdate" : 2,
  "hasRowId" : true,
  "isAuditEnabled" : true,
  "name" : "name",
  "isSubTable" : true,
  "id" : 0,
  "lastModified" : 6,
  "isCdr" : true,
  "firstExtentSize" : 1,
  "isVirtualAqt" : true,
  "nextExtentSize" : 5
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/storage/databases/{dbname}
Get storage characteristics for all tables and indexes in a particular database (getTablesAndIndexesInfo)

Path parameters

dbname (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

dbsnum (optional)
Query Parameter — format: int32
include_catalogs (optional)
Query Parameter —

Return type

array[Object]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/scheduler/tasks/{id}
Get task by id (getTask)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
id (required)
Path Parameter — format: int32

Return type

array[SchedulerTasksIDResponse]

Example data

Content-Type: application/json
[ {
  "tk_total_time" : 5,
  "tk_name" : "tk_name",
  "tk_delete" : {
    "IntervalDF" : {
      "seconds" : "2000-01-23T04:56:07.000+00:00",
      "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "tk_monday" : true,
  "tk_thursday" : true,
  "tk_description" : "tk_description",
  "tk_type" : "tk_type",
  "tk_sequence" : 6,
  "tk_result_table" : "tk_result_table",
  "tk_execute" : "tk_execute",
  "tk_wednesday" : true,
  "tk_sunday" : true,
  "tk_start_time" : {
    "date" : "2000-01-23"
  },
  "tk_priority" : 2,
  "tk_total_executions" : 1,
  "tk_enable" : true,
  "tk_dbs" : "tk_dbs",
  "tk_create" : "tk_create",
  "tk_friday" : true,
  "tk_attributes" : 5,
  "tk_tuesday" : true,
  "tk_saturday" : true,
  "tk_id" : 0,
  "tk_group" : "tk_group"
}, {
  "tk_total_time" : 5,
  "tk_name" : "tk_name",
  "tk_delete" : {
    "IntervalDF" : {
      "seconds" : "2000-01-23T04:56:07.000+00:00",
      "nanoseconds" : "2000-01-23T04:56:07.000+00:00"
    }
  },
  "tk_monday" : true,
  "tk_thursday" : true,
  "tk_description" : "tk_description",
  "tk_type" : "tk_type",
  "tk_sequence" : 6,
  "tk_result_table" : "tk_result_table",
  "tk_execute" : "tk_execute",
  "tk_wednesday" : true,
  "tk_sunday" : true,
  "tk_start_time" : {
    "date" : "2000-01-23"
  },
  "tk_priority" : 2,
  "tk_total_executions" : 1,
  "tk_enable" : true,
  "tk_dbs" : "tk_dbs",
  "tk_create" : "tk_create",
  "tk_friday" : true,
  "tk_attributes" : 5,
  "tk_tuesday" : true,
  "tk_saturday" : true,
  "tk_id" : 0,
  "tk_group" : "tk_group"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/profile/threads
Get OneDB threads information (getThreads)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

ProfileThreadResponse

Example data

Content-Type: application/json
{
  "statedesc" : "statedesc",
  "vpid" : 2,
  "cpu_time" : 9.301444,
  "address" : 6,
  "name" : "name",
  "num_sched" : 3,
  "state" : 1,
  "statedetail" : "statedetail",
  "priority" : 5,
  "vpclass" : 5,
  "tid" : 0,
  "last_run_time" : 7
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ProfileThreadResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/udts
Gets the user defined datatypes list (getUdtsDetails)

Path parameters

sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[DatabasesSqlSessionsUDTsResponse]

Example data

Content-Type: application/json
[ {
  "owner" : "owner",
  "mode" : "mode",
  "cannothash" : true,
  "byvalue" : true,
  "maxlength" : 6,
  "type_id" : 0,
  "length" : 1,
  "align" : 5,
  "typename" : "typename",
  "desc" : "desc"
}, {
  "owner" : "owner",
  "mode" : "mode",
  "cannothash" : true,
  "byvalue" : true,
  "maxlength" : 6,
  "type_id" : 0,
  "length" : 1,
  "align" : 5,
  "typename" : "typename",
  "desc" : "desc"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/permissions/{userId}
Get the REST resource for the permissions of a specific user (getUserPermissions)

Path parameters

userId (required)
Path Parameter — format: int64
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[PermissionsUserIDResponse]

Example data

Content-Type: application/json
[ {
  "effective" : 6,
  "permissions" : 0
}, {
  "effective" : 6,
  "permissions" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/groups/{groupId}/permissions/{userId}
Get the REST resource for the permissions of a specific user (getUserPermissions1)

Path parameters

userId (required)
Path Parameter — format: int64
groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

UserIdResponse

Example data

Content-Type: application/json
{
  "effective" : 6,
  "permissions" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK UserIdResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/vps
Get list of virtual processor classes (getVirtualProcessorClasses)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[VPsResponse]

Example data

Content-Type: application/json
[ {
  "totalcpu" : 5.962133916683182,
  "usercpu" : 6.0274563,
  "syscpu" : 1.4658129,
  "count" : 0,
  "class" : "class"
}, {
  "totalcpu" : 5.962133916683182,
  "usercpu" : 6.0274563,
  "syscpu" : 1.4658129,
  "count" : 0,
  "class" : "class"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/vps/{class}
Get info about virtual processors in a specific class (getVirtualProcessorsInClass)

Path parameters

class (required)
Path Parameter — The virtual processor class name
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

array[VPsClassResponse]

Example data

Content-Type: application/json
[ {
  "vpid" : 0,
  "totalcpu" : 5.962133916683182,
  "usercpu" : 6.0274563,
  "syscpu" : 1.4658129,
  "class" : "class"
}, {
  "vpid" : 0,
  "totalcpu" : 5.962133916683182,
  "usercpu" : 6.0274563,
  "syscpu" : 1.4658129,
  "class" : "class"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/privileges/{database}/privilegedUsers
Grant privilege on the given database to the user which comes in the body of post request (grantDatabasePrivilege)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
database (required)
Path Parameter — The database name to grant privilege on

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DatabasePrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/privileges/adminPrivileges
Grant or Modify admin privileges to the user which comes in the body of post request (grantOrModifyAdminPrivileges)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AdminPrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/privileges/{database}/tablePrivileges
Grant privileges on the given table to the user which comes in the body of post request (grantTablePrivileges)

Path parameters

database (required)
Path Parameter — The database name to grant privileges on
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body TablePrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
delete /onedb/{onedbServerId}/sessions/{id}
Kill a session (killSession)

Path parameters

id (required)
Path Parameter — format: int32
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/storage/chunks/{number}
Modify a chunk by changing its extendable property or by extending it. (modifyChunk)

Path parameters

number (required)
Path Parameter — Chunk number for the chunk to modify
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ModifyChunkRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/cmsm/foc
Modify FOC of the given connection unit which comes in the body of put request (modifyFOC)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body FOCRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/privileges/internalUsers
Modify internal user which comes in the body of put request (modifyInternalUser)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExistingInternalPrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/storage/spaces/{name}
Modify a space changing its create size and extend size properties or by expanding by the space. (modifySpace)

Path parameters

name (required)
Path Parameter — Name of the space to modify
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ModifySpaceRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/storage/pool/{id}
Modify a storage pool entry. (modifyStoragePoolEntry)

Path parameters

id (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StoragePoolIdRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/privileges/{database}/tablePrivileges
Modify existing privileges on the given table to the user which comes in the body of put request (modifyTablePrivileges)

Path parameters

database (required)
Path Parameter — The database name to update privileges on
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body TablePrivilegedUserRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/rlogs/plog
Move physical log (movePhysicalLog)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MovePhysicalLogRequest (optional)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found
Up 
delete /onedb/{onedbServerId}/scheduler/tasks/{id}
Delete task and its parameters (removeTask)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
id (required)
Path Parameter — format: int32

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
delete /onedb/{onedbServerId}/permissions/{userId}
Remove the user's permissions on this server or group (removeUserPermissions)

Path parameters

userId (required)
Path Parameter — format: int64
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
delete /onedb/groups/{groupId}/permissions/{userId}
Remove the user's permissions on this server or group (removeUserPermissions1)

Path parameters

userId (required)
Path Parameter — userId of given permissions on this server or group format: int64
groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/privileges/adminPrivileges/drop
Revoke privileges from the user which comes in the body of delete request (revokeAdminPrivileges)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RevokeAdminPrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/privileges/{database}/privilegedUsers/drop
Revoke privilege on the given database from the user which comes in the body of delete request (revokeDatabasePrivilege)

Path parameters

database (required)
Path Parameter — The database name to revoke privilege from
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RevokeDbPrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/privileges/{database}/tablePrivileges/drop
Revoke privileges of the given table from the user which comes in the body of delete request (revokeTablePrivileges)

Path parameters

database (required)
Path Parameter — The database name to update privileges on
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RevokeTablePrivilegedUserRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
post /onedb/{onedbServerId}/checkpoints
Run a checkpoint (runCheckpoint)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CheckPointRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
get /onedb/{onedbServerId}/reports
Get the REST resource for this OneDB server's system reports (runOneDBSystemReport)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Query parameters

id (required)
Query Parameter —
fromTimestamp (optional)
Query Parameter — format: int64
toTimestamp (optional)
Query Parameter — format: int64
database (optional)
Query Parameter —

Return type

array[Object]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/storage/databases/{dbname}
Run a storage optimization access on objects in a specific database (runStorageActionOnDatabase)

Path parameters

dbname (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/storage/policies
Configure the policies and schedule the task to optimize data storage (setOptimizePolicies)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SetOptimizePoliciesRequest (optional)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/sqltrace/config
Update SQL tracing configuration (setSQLTraceConfiguration)
sqltraceConfiguration is a document indicating the new configuration

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SqlTraceConfigRequest (optional)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found
Up 
put /onedb/{onedbServerId}/rlogs/llog
Switch logical log (switchLogicalLog)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SwitchLogicalLogRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/agent
Update agent info for given OneDB Server (updateAgent)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AgentRequest (required)
Body Parameter —

Return type

map[String, Object]

Example data

Content-Type: application/json
{
  "key" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation
Up 
put /onedb/{onedbServerId}/backups/tasks
Update backup tasks (updateBackupTasks)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter —

Return type

array[Object]

Example data

Content-Type: application/json
[ { }, { } ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/onconfig
Update one or more onconfig parameters. (updateConfiguration)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MultipleOnConfigRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/groups/{groupId}/dashboards/{dashboardId}
Update an existing dashboard (updateDashboard)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64
dashboardId (required)
Path Parameter — Id of Custom Dashboard added in the Dashboards page format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DashboardConfig (required)
Body Parameter —

Return type

DashboardResponse

Example data

Content-Type: application/json
{
  "id" : 0,
  "config" : {
    "new" : true,
    "panels" : [ {
      "x" : 5,
      "width" : 7,
      "y" : 2,
      "title" : "title",
      "type" : "type",
      "config" : {
        "isCustomQuery" : true,
        "databaseName" : "databaseName",
        "yAxes" : [ {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        }, {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        } ],
        "dataSeries" : [ {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        }, {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        } ],
        "chartType" : "chartType",
        "queryString" : "queryString",
        "dataSources" : [ {
          "sensorType" : "sensorType"
        }, {
          "sensorType" : "sensorType"
        } ]
      },
      "height" : 9
    }, {
      "x" : 5,
      "width" : 7,
      "y" : 2,
      "title" : "title",
      "type" : "type",
      "config" : {
        "isCustomQuery" : true,
        "databaseName" : "databaseName",
        "yAxes" : [ {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        }, {
          "min" : 2,
          "max" : 4,
          "label" : "label",
          "type" : "type"
        } ],
        "dataSeries" : [ {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        }, {
          "yAxis" : 3,
          "color" : "color",
          "id" : "id",
          "label" : "label"
        } ],
        "chartType" : "chartType",
        "queryString" : "queryString",
        "dataSources" : [ {
          "sensorType" : "sensorType"
        }, {
          "sensorType" : "sensorType"
        } ]
      },
      "height" : 9
    } ],
    "name" : "name",
    "defaultServerIds" : [ 7, 7 ]
  },
  "group" : {
    "permissions" : 5,
    "name" : "name",
    "parentGroupId" : 1,
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK DashboardResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
put /onedb/groups/{groupId}
Update the server's information. (updateGroup)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body GroupIdRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/groups/{groupId}/monitoring
Update the monitoring profile (updateGroupMonitoringProfile)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateSensorRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/groups/{groupId}/monitoring/sensors/{sensorTypeId}
Update the sensor in the monitoring profile (updateGroupMonitoringSensor)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64
sensorTypeId (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SensorTypeIdRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/groups
Update a set of groups (updateGroups)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body GroupIdRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/incidents
Update the state of one or more incidents (updateIncidents)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body IncidentsRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/groups/{groupId}/incidents
Update the state of one or more incidents (updateIncidents1)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body IncidentsRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/memory
Update OneDB server Low Memory Manager configuration (updateLowMemoryManagerConfiguration)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body MemoryRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/logs/baractlog/config
Update Current Configurations for OnBar rotation logs (updateOnBarLogsRotationConfigurations)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body OnBarConfigResponse (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/onconfig/{name}
Update an onconfig parameter (updateOnconfigParameter)

Path parameters

name (required)
Path Parameter — Name of the onconfig parameter to update
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SingleOnConfigRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/logs/onlinelog/config
Update Current Configurations for Online rotation logs (updateOnlineLogsRotationConfigurations)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateOnlineLogsRotationConfigurationsRequest (required)
Body Parameter —

Return type

SuccessResponseWithResult

Example data

Content-Type: application/json
{
  "result_message" : "result_message",
  "return_code" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation SuccessResponseWithResult

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/scheduler/tasks/{id}/parameters
Get parameters for task (updateParametersForTask)

Path parameters

id (required)
Path Parameter — format: int32
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SchedulerTaskIDParametersRequest (required)
Body Parameter —

Return type

array[RevokeTaskIDParametersResponse]

Example data

Content-Type: application/json
[ [ {
  "task_name" : "task_name",
  "value_type" : "value_type",
  "current_state" : 0,
  "name" : "name",
  "description" : "description",
  "id" : 6,
  "value" : 1
}, {
  "task_name" : "task_name",
  "value_type" : "value_type",
  "current_state" : 0,
  "name" : "name",
  "description" : "description",
  "id" : 6,
  "value" : 1
} ], [ {
  "task_name" : "task_name",
  "value_type" : "value_type",
  "current_state" : 0,
  "name" : "name",
  "description" : "description",
  "id" : 6,
  "value" : 1
}, {
  "task_name" : "task_name",
  "value_type" : "value_type",
  "current_state" : 0,
  "name" : "name",
  "description" : "description",
  "id" : 6,
  "value" : 1
} ] ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/monitoring
Update the monitoring profile (updateProfile)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateSensorRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/alerting
Update the REST resource for this OneDB server's alerting profile (updateProfile1)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AlertingResponse (optional)
Body Parameter —

Return type

array[AlertingResponse]

Example data

Content-Type: application/json
[ {
  "alerts" : [ {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  }, {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  } ],
  "inherited" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
}, {
  "alerts" : [ {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  }, {
    "owner" : {
      "owner" : { },
      "alerts" : [ null, null ],
      "eventNeededSensors" : [ "eventNeededSensors", "eventNeededSensors" ],
      "disabledAlertIds" : [ 6, 6 ],
      "effectiveAlerts" : [ null, null ]
    },
    "violationToIncidentsMappingPolicy" : "ONE_TO_ONE",
    "neededSensors" : [ "neededSensors", "neededSensors" ],
    "whenToCheckNext" : 1,
    "frequencyPolicy" : "AT_FIXED_RATE",
    "name" : "name",
    "id" : 0,
    "trigger" : {
      "type" : "INTERVAL"
    },
    "alertEventTypes" : [ "AGENT_STATUS", "AGENT_STATUS" ],
    "criticalAlert" : true
  } ],
  "inherited" : {
    "sensors" : [ {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    }, {
      "runInterval" : 0,
      "disabled" : true,
      "dataRetentionInterval" : 6,
      "type" : {
        "fromPackage" : true,
        "meta" : {
          "default" : {
            "defaults" : { },
            "subtype" : "subtype",
            "sleepBetweenExecution" : 5,
            "serverTypes" : [ "serverTypes", "serverTypes" ],
            "unique" : [ "unique", "unique" ],
            "delta" : [ "delta", "delta" ],
            "scanDuration" : 1,
            "dataRetentionInterval" : 5,
            "type" : "type",
            "collapse" : {
              "value" : "value",
              "key" : "key"
            },
            "sql" : "sql",
            "primaryKey" : {
              "name" : "name",
              "type" : "type"
            }
          },
          "metrics" : {
            "metric_name" : {
              "unit" : "unit",
              "name" : "name"
            }
          },
          "chart" : {
            "stacked" : true,
            "minY" : 2,
            "maxY" : 7,
            "type" : "type"
          }
        },
        "name" : "name",
        "description" : "description",
        "id" : "id"
      }
    } ]
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/groups/{groupId}/alerting
Get the REST resource for this GroupID server's for updating alerting profile (updateProfile3)

Path parameters

groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AlertingGroupIdRequest (optional)
Body Parameter —

Return type

AlertingGroupIdResponse

Example data

Content-Type: application/json
{
  "alerts" : [ {
    "condition" : {
      "op" : "op",
      "b" : {
        "type" : "type",
        "value" : 6
      }
    },
    "name" : "name",
    "disabled" : true,
    "id" : 0,
    "trigger" : {
      "type" : "type"
    }
  }, {
    "condition" : {
      "op" : "op",
      "b" : {
        "type" : "type",
        "value" : 6
      }
    },
    "name" : "name",
    "disabled" : true,
    "id" : 0,
    "trigger" : {
      "type" : "type"
    }
  } ],
  "inherited" : [ {
    "server_name" : "server_name",
    "meta" : {
      "msg" : "msg"
    },
    "when_created" : 6,
    "id" : 0,
    "state" : 1,
    "server_id" : 5
  }, {
    "server_name" : "server_name",
    "meta" : {
      "msg" : "msg"
    },
    "when_created" : 6,
    "id" : 0,
    "state" : 1,
    "server_id" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AlertingGroupIdResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}
Update a single OneDB server's information inside OneDB Explore. (updateServerInfo)
Update OneDB Server by id

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExistingOneDBServerRequest (optional)
Body Parameter —

Return type

OneDBServerResponse

Example data

Content-Type: application/json
{
  "connectionProperties" : { },
  "agent" : {
    "online" : true,
    "isMonitoring" : true,
    "config" : {
      "database" : "database",
      "repositoryServerId" : 5
    }
  },
  "monitorUser" : "monitorUser",
  "parentGroupId" : 6,
  "hasMonitorPassword" : true,
  "hasAdminPassword" : true,
  "serviceName" : "serviceName",
  "hostname" : "hostname",
  "adminUser" : "adminUser",
  "unreadIncidents" : 5,
  "port" : 1,
  "permissions" : { },
  "alias" : "alias",
  "id" : 0,
  "status" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OneDBServerResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
put /onedb/{onedbServerId}/monitoring/sensors/{sensorTypeId}
Update the sensor in the monitoring profile (updateServerMonitoringSensor)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
sensorTypeId (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SensorTypeIdRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb
Update a set of OneDB Servers inside OneDB Explore (updateServers)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ExistingOneDBServerRequest (required)
Body Parameter — OneDB Servers which needs to be updated

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
put /onedb/{onedbServerId}/databases/{database}/sql-sessions/{sqlSessionId}/tables/{tableName}/statistics
Update the statistics level of a table (updateTableStatisticsConfiguration)
'statLevel' key means the statistics level user wants to change, if this key is not present or key value is null or key value is empty means user don't want to change the statistics level. If 'statChange' key is present in JSON with integer value then api will update thresholdValue. If both keys are present then api will update statistics level as well as statChange

Path parameters

tableName (required)
Path Parameter —
sqlSessionId (required)
Path Parameter —
database (required)
Path Parameter —
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DatabasesSqlSessionsTablesStatisticsRequest (optional)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error
Up 
put /onedb/{onedbServerId}/scheduler/tasks/{id}
Update Task API (updateTask)

Path parameters

onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64
id (required)
Path Parameter — format: int32

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SchedulerTaskRequest (required)
Body Parameter —

Return type

RevokeSchedulerTaskResponse

Example data

Content-Type: application/json
{
  "tk_total_time" : 7.061401241503109,
  "tk_name" : "tk_name",
  "tk_delete" : {
    "IntervalDF" : {
      "seconds" : 5,
      "nanoseconds" : 5
    }
  },
  "tk_monday" : true,
  "tk_thursday" : true,
  "tk_description" : "tk_description",
  "tk_type" : "TASK",
  "tk_sequence" : 6,
  "tk_result_table" : "tk_result_table",
  "tk_execute" : "tk_execute",
  "tk_wednesday" : true,
  "tk_sunday" : true,
  "tk_start_time" : {
    "date" : "2000-01-23"
  },
  "tk_priority" : 9,
  "tk_total_executions" : 2,
  "tk_enable" : true,
  "tk_dbs" : "tk_dbs",
  "tk_create" : "tk_create",
  "tk_friday" : true,
  "tk_attributes" : 1,
  "tk_tuesday" : true,
  "tk_saturday" : true,
  "tk_id" : 0,
  "tk_group" : "tk_group"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RevokeSchedulerTaskResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
put /onedb/{onedbServerId}/permissions/{userId}
Update a user's permissions on this server or group. (updateUserPermissions)
Permission for server ID

Path parameters

userId (required)
Path Parameter — format: int64
onedbServerId (required)
Path Parameter — Id of OneDB Server inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PermissionsUserIdRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found
Up 
put /onedb/groups/{groupId}/permissions/{userId}
Update a user's permissions on this server or group. (updateUserPermissions1)
Permission for group ID

Path parameters

userId (required)
Path Parameter — format: int64
groupId (required)
Path Parameter — Id of Group inside OneDB Explore format: int64

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body PermissionsUserIdRequest (required)
Body Parameter —

Return type

SuccessResponse

Example data

Content-Type: application/json
{
  "ok" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SuccessResponse

400

Bad Request

403

Forbidden

404

Not Found

Models

[ Jump to Methods ]

Table of Contents

  1. AUSAlertResponse
  2. AUSCommandsResponse
  3. AUSConfigurationResponse
  4. AUSConfigurationResponse_parameters
  5. AUSConfigurationResponse_tasks
  6. AUSJobsCleanupRequest
  7. AUSJobsCleanupRequest_server
  8. AUSJobsCleanupRequest_server_permissions
  9. AUSResponse
  10. AddLogicalLogInfoRequest
  11. AddOrModifySLARequest
  12. AdminPrivilegedUserRequest
  13. AdminPrivilegedUserResponse
  14. AfFilesResponse
  15. AfFilesResponse_type
  16. AfFilesResponse_type_meta
  17. AfFilesResponse_type_meta_default
  18. AfFilesResponse_type_meta_metrics
  19. AfFilesServerIDResponse
  20. AgentConfiguration
  21. AgentPostRequest
  22. AgentRequest
  23. AgentResource
  24. AgentResponse
  25. AggregatesResource
  26. AlertTrigger
  27. AlertingCriteria
  28. AlertingCriteriaProfile
  29. AlertingCriteriaProfileOwner
  30. AlertingCriteriaProfileResource
  31. AlertingEffectiveGroupIdResponse
  32. AlertingEffectiveGroupIdResponse_condition
  33. AlertingEffectiveGroupIdResponse_condition_b
  34. AlertingEffectiveGroupIdResponse_trigger
  35. AlertingEffectiveResponse
  36. AlertingGroupIdRequest
  37. AlertingGroupIdRequest_alerts
  38. AlertingGroupIdRequest_inherited
  39. AlertingGroupIdResponse
  40. AlertingIncidentsResource
  41. AlertingMessenger
  42. AlertingProfile
  43. AlertingProfileSettings
  44. AlertingResponse
  45. AlertingResponse1
  46. AusConfigurationDatabasesRequest
  47. AusJobsRefreshThreadsRequest
  48. Aus_cmd_compSqlResponse
  49. Aus_cmd_compSqlResponse_aus_cmd_id
  50. Aus_cmd_compSqlResponse_aus_cmd_time
  51. Aus_cmd_compSqlResponse_data
  52. Aus_cmd_infoSqlResponse
  53. Aus_cmd_infoSqlResponse_data
  54. Aus_commandSqlResponse
  55. Aus_commandSqlResponse_data
  56. AutoUpdateStatsResource
  57. Autoreg_migrateSqlResponse
  58. Autoreg_migrateSqlResponse_data
  59. AvailableServersResponse
  60. BSONObject
  61. BackupResource
  62. BackupResponse
  63. BackupResponse1
  64. BackupResponse1_per_space
  65. BackupTaskPayloadRequest
  66. BackupTaskResponse
  67. BackupTaskResponse_backupOnconfigs
  68. BackupsDbspaceResponse
  69. BackupsDbspaceResponse_type
  70. BackupsDbspaceResponse_type_meta
  71. BackupsDbspaceResponse_type_meta_default
  72. BackupsDbspaceResponse_type_meta_default_primaryKey
  73. BackupsDbspaceResponse_type_meta_metrics
  74. BackupsDbspaceServerIDResponse
  75. BackupsHistoryResponse
  76. BakupsTasksLevel0Response
  77. BakupsTasksLevel0Response_backupParams
  78. BakupsTasksLevel0Response_level0
  79. BakupsTasksLevel0Response_level0_tk_frequency
  80. BakupsTasksLevel0Response_level0_tk_frequency_IntervalDF
  81. BakupsTasksLevel0Response_level0_tk_next_execution
  82. BakupsTasksLevel1Response
  83. BakupsTasksLevel2Response
  84. BakupsTasks_OnBarRequest
  85. BakupsTasks_OnTapeRequest
  86. BakupsTasks_OnTapeRequest_schedule
  87. BufferandDiskIoResponse
  88. BufferandDiskIoServerIDResponse
  89. CastsResource
  90. CheckPointRequest
  91. CheckPointResponse
  92. CheckpointSensorResponse
  93. CheckpointSensorResponse_type
  94. CheckpointSensorResponse_type_meta
  95. CheckpointSensorResponse_type_meta_default
  96. CheckpointSensorResponse_type_meta_metrics
  97. CheckpointSensorResponse_type_meta_metrics_cp_time
  98. CheckpointSensorServerIDResponse
  99. CheckpointsResource
  100. ChunksResponse
  101. ChunkwritesResponse
  102. ChunkwritesResponse_type
  103. ChunkwritesResponse_type_meta
  104. ChunkwritesResponse_type_meta_default
  105. ChunkwritesResponse_type_meta_default_collapse
  106. ChunkwritesResponse_type_meta_metrics
  107. ChunkwritesServerIDResponse
  108. Command_historySqlResponse
  109. Command_historySqlResponse_data
  110. ConfigurationDatabasesResponse
  111. Connection
  112. ConnectionManagerInfoResponse
  113. ConnectionManagerResource
  114. ConnectionUnit
  115. ConnectionUnitResponse
  116. CreateBackupResponse
  117. DBLocaleResponse
  118. DBSpaceUsageResponse
  119. DBSpaceUsageResponse_type
  120. DBSpaceUsageResponse_type_meta
  121. DBSpaceUsageResponse_type_meta_default
  122. DBSpaceUsageResponse_type_meta_metrics
  123. DBSpaceUsageServerIDResponse
  124. DBSpacesResponse
  125. Dashboard
  126. DashboardConfig
  127. DashboardIdRequest
  128. DashboardInfoResponse
  129. DashboardInfoResponse_host
  130. DashboardInfoResponse_iwa
  131. DashboardInfoResponse_vps
  132. DashboardManager
  133. DashboardResponse
  134. DashboardResponse_group
  135. DashboardStoragePerformanceResponse
  136. DashboardStoragePerformanceResponse_last_checkpoint
  137. Dashboard_group
  138. DataSeries
  139. DatabaseMetaData
  140. DatabasePrivilegedUserRequest
  141. DatabasePrivilegedUserResponse
  142. DatabaseResource
  143. DatabaseSqlSessionIdTablenameIndexDisableRequest
  144. DatabaseSqlSessionIdTablenameIndexEnableRequest
  145. DatabasesObjectResponse
  146. DatabasesRequest
  147. DatabasesResource
  148. DatabasesResponse
  149. DatabasesSqlSessionsAggregatesResponse
  150. DatabasesSqlSessionsCastsResponse
  151. DatabasesSqlSessionsDatabladesResponse
  152. DatabasesSqlSessionsMoreResponse
  153. DatabasesSqlSessionsMoreResponse_data
  154. DatabasesSqlSessionsMoreResponse_flags
  155. DatabasesSqlSessionsMoreResponse_tabname
  156. DatabasesSqlSessionsOPClassesResponse
  157. DatabasesSqlSessionsProceduresIDResponse
  158. DatabasesSqlSessionsProceduresResponse
  159. DatabasesSqlSessionsSequencesResponse
  160. DatabasesSqlSessionsSqlResponse
  161. DatabasesSqlSessionsTablesDetailsResponse
  162. DatabasesSqlSessionsTablesDetailsResponse_columns
  163. DatabasesSqlSessionsTablesDetailsResponse_columns_1
  164. DatabasesSqlSessionsTablesDetailsResponse_fragments
  165. DatabasesSqlSessionsTablesDetailsResponse_indexes
  166. DatabasesSqlSessionsTablesDetailsResponse_privileges
  167. DatabasesSqlSessionsTablesDetailsResponse_statistics
  168. DatabasesSqlSessionsTablesDetailsResponse_tableStatistics
  169. DatabasesSqlSessionsTablesIndexRequest
  170. DatabasesSqlSessionsTablesIndexRequest_columnsList
  171. DatabasesSqlSessionsTablesIndexResponse
  172. DatabasesSqlSessionsTablesResponse
  173. DatabasesSqlSessionsTablesStatisticsRequest
  174. DatabasesSqlSessionsUDTsResponse
  175. DatabladesResource
  176. DbNameIsFalseResponse
  177. DbNameIsFalseResponse_inner
  178. DbNameIsTrueResponse
  179. DbNameIsTrueResponse_fragments
  180. DeleteBackupTask
  181. DeleteIncidentRequest
  182. DeleteIncidentsRequest
  183. DeleteLogicalLogRequest
  184. DeleteSLARequest
  185. DeployAgentResponse
  186. DropVirtualProcessorRequest
  187. ERDomainProfileResponse
  188. ERDomainProfileResponse_apply
  189. ERDomainProfileResponse_ddr
  190. ERDomainProfileResponse_disk
  191. ERDomainProfileResponse_network
  192. ERDomainProfileResponse_receiveQ
  193. ERDomainProfileResponse_sendQ
  194. ERDomainResponse
  195. ERNodeResponse
  196. ERNodeResponse_members
  197. EnterpriseReplicationResource
  198. Entry
  199. EntryUserEnumSetOneDBServerPermission
  200. ExecuteEvaluationTaskRequest
  201. ExecuteEvaluationTaskRequest_agent
  202. ExecuteEvaluationTaskRequest_agent_config
  203. ExecuteEvaluationTaskRequest_permissions
  204. ExecuteTaskRequest
  205. ExecuteTaskResponse
  206. ExecutionsSqlResponse
  207. ExecutionsSqlResponse_inner
  208. ExistingInternalPrivilegedUserRequest
  209. ExistingOneDBServerRequest
  210. FOCRequest
  211. ForegroundWritesResponse
  212. ForegroundWritesResponse_type
  213. ForegroundWritesResponse_type_meta
  214. ForegroundWritesResponse_type_meta_default
  215. ForegroundWritesResponse_type_meta_metrics
  216. ForegroundWritesServerIDResponse
  217. GroupIdRequest
  218. GroupIdSensorDataMetaResponse
  219. GroupIdSensorDataMetaResponse_inner
  220. GroupIdSensorDataResponse
  221. GroupIdSensorDataResponse_data
  222. HASpecificServerInfoResponse
  223. HighAvailabilityApplyRateResponse
  224. HighAvailabilityApplyRateResponse_type
  225. HighAvailabilityApplyRateResponse_type_meta
  226. HighAvailabilityApplyRateResponse_type_meta_default
  227. HighAvailabilityApplyRateResponse_type_meta_metrics
  228. HighAvailabilityApplyRateServerIDResponse
  229. HighAvailabilityApproximateLogBacklogResponse
  230. HighAvailabilityApproximateLogBacklogResponse_type
  231. HighAvailabilityApproximateLogBacklogResponse_type_meta
  232. HighAvailabilityApproximateLogBacklogResponse_type_meta_default
  233. HighAvailabilityApproximateLogBacklogResponse_type_meta_metrics
  234. HighAvailabilityApproximateLogBacklogServerIDResponse
  235. HighAvailabilityConnectionStatusResponse
  236. HighAvailabilityConnectionStatusResponse_type
  237. HighAvailabilityConnectionStatusResponse_type_meta
  238. HighAvailabilityConnectionStatusResponse_type_meta_default
  239. HighAvailabilityConnectionStatusResponse_type_meta_metrics
  240. HighAvailabilityConnectionStatusResponse_type_meta_metrics_connection_status
  241. HighAvailabilityConnectionStatusServerIDResponse
  242. HighAvailabilityInfoResponse
  243. HighAvailabilityLagtimeResponse
  244. HighAvailabilityLagtimeResponse_type
  245. HighAvailabilityLagtimeResponse_type_meta
  246. HighAvailabilityLagtimeResponse_type_meta_default
  247. HighAvailabilityLagtimeResponse_type_meta_metrics
  248. HighAvailabilityLagtimeServerIDResponse
  249. HighAvailabilityLogicalLogRateResponse
  250. HighAvailabilityLogicalLogRateResponse_type
  251. HighAvailabilityLogicalLogRateResponse_type_meta
  252. HighAvailabilityLogicalLogRateResponse_type_meta_default
  253. HighAvailabilityLogicalLogRateResponse_type_meta_metrics
  254. HighAvailabilityLogicalLogRateServerIDResponse
  255. HighAvailabilityResource
  256. HighAvailabilitySMXInfoResponse
  257. HighAvailabilityTransactionLatencyResponse
  258. HighAvailabilityTransactionLatencyResponse_type
  259. HighAvailabilityTransactionLatencyResponse_type_meta
  260. HighAvailabilityTransactionLatencyResponse_type_meta_default
  261. HighAvailabilityTransactionLatencyResponse_type_meta_metrics
  262. HighAvailabilityTransactionLatencyServerIDResponse
  263. HighAvailabilityWorkloadResponse
  264. HighAvailabilityWorkloadResponse_type
  265. HighAvailabilityWorkloadResponse_type_meta
  266. HighAvailabilityWorkloadResponse_type_meta_metrics
  267. HighAvailabilityWorkloadServerIDResponse
  268. IWAResponse
  269. IncidentRequest
  270. IncidentsRequest
  271. IncidentsResponse
  272. IncidentsResponse_meta
  273. InternalPrivilegedUserRequest
  274. InternalPrivilegedUserResponse
  275. IterationSqlResponse
  276. IterationSqlResponse_inner
  277. Job_statusSqlResponse
  278. Job_statusSqlResponse_data
  279. LRUWritesResponse
  280. LRUWritesResponse_type
  281. LRUWritesResponse_type_meta
  282. LRUWritesResponse_type_meta_default
  283. LRUWritesResponse_type_meta_metrics
  284. LRUWritesServerIDResponse
  285. LocalesResource
  286. LockListResponse
  287. LockPerSessionResponse
  288. LockPerTableResponse
  289. LogicalLogInfoResponse
  290. LogsAdminAPIResponse
  291. LogsBaractlogResponse
  292. LogsResource
  293. MemoryRequest
  294. MemoryResource
  295. MemoryResponse
  296. MemorySegmentsResponse
  297. MemorySegmentsResponse_type
  298. MemorySegmentsResponse_type_meta
  299. MemorySegmentsResponse_type_meta_metrics
  300. MemorySegmentsServerIDResponse
  301. MemorySensorResponse
  302. MemorySensorResponse_type
  303. MemorySensorResponse_type_meta
  304. MemorySensorResponse_type_meta_default
  305. MemorySensorResponse_type_meta_metrics
  306. MemorySensorServerIDResponse
  307. ModifyChunkRequest
  308. ModifySpaceRequest
  309. Mon_checkpointSqlResponse
  310. Mon_checkpointSqlResponse_cp_time
  311. Mon_checkpointSqlResponse_data
  312. Mon_checkpointSqlResponse_tot_crit_wait
  313. Mon_checkpointSqlSessionIdResponse
  314. Mon_checkpointSqlSessionIdResponse_data
  315. Mon_compression_estimatesSqlResponse
  316. Mon_compression_estimatesSqlResponse_data
  317. Mon_configSqlResponse
  318. Mon_configSqlResponse_data
  319. Mon_iohistSqlResponse
  320. Mon_iohistSqlResponse_data
  321. Mon_memory_systemSqlResponse
  322. Mon_memory_systemSqlResponse_data
  323. Mon_onconfigSqlResponse
  324. Mon_onconfigSqlResponse_data
  325. Mon_page_usageSqlResponse
  326. Mon_page_usageSqlResponse_data
  327. Mon_sysSqltrace_infoSqlResponse
  328. Mon_sysSqltrace_infoSqlResponse_data
  329. Mon_sysenvSqlResponse
  330. Mon_sysenvSqlResponse_data
  331. Mon_table_namesSqlResponse
  332. Mon_table_namesSqlResponse_data
  333. Mon_table_profileSqlResponse
  334. Mon_table_profileSqlResponse_data
  335. Mon_usersSqlResponse
  336. Mon_usersSqlResponse_data
  337. Mon_vpsSqlResponse
  338. Mon_vpsSqlResponse_data
  339. MonitoringEffectiveProfile
  340. MonitoringEffectiveResponse
  341. MonitoringGroupIdSensorIdDataLatestResponse
  342. MonitoringOnedbSensorIdDataLatestResponse
  343. MonitoringOnedbSensorIdDataLatestResponse_data
  344. MonitoringProfile
  345. MonitoringProfileResource
  346. MonitoringProfileResponse
  347. MonitoringProfileResponse_own
  348. MonitoringResponse
  349. MovePhysicalLogRequest
  350. MultipleOnConfigRequest
  351. NewChunksRequest
  352. NewOneDBServerRequest
  353. NewSpaceRequest
  354. OnBarConfigResponse
  355. OnConfigResponse
  356. OnLineLogRotationResponse
  357. OnconfigResource
  358. OneDBDashboardResource
  359. OneDBIndexesResource
  360. OneDBProfileResponse
  361. OneDBReportsResource
  362. OneDBServerGroup
  363. OneDBServerGroupChild
  364. OneDBServerIDPermissionsEffectiveResponse
  365. OneDBServerResponse
  366. OneDBServerStatusResponse
  367. OneDBServerStatusResponse_type
  368. OneDBServerStatusResponse_type_meta
  369. OneDBServerStatusResponse_type_meta_default
  370. OneDBServerStatusResponse_type_meta_metrics
  371. OneDBServerStatusServerIDResponse
  372. OneDbGroupIdResponse
  373. OnlineLogResponse
  374. OnlineLogSensorResponse
  375. OnlineLogSensorResponse_type
  376. OnlineLogSensorResponse_type_meta
  377. OnlineLogSensorResponse_type_meta_default
  378. OnlineLogSensorResponse_type_meta_metrics
  379. OnlineLogSensorServerIDResponse
  380. OperatingSystemCPUResponse
  381. OperatingSystemCPUResponse_type
  382. OperatingSystemCPUResponse_type_meta
  383. OperatingSystemCPUResponse_type_meta_default
  384. OperatingSystemCPUResponse_type_meta_metrics
  385. OperatingSystemCPUResponse_type_meta_metrics_idle
  386. OperatingSystemCPUResponse_type_meta_metrics_user
  387. OperatingSystemCPUServerIDResponse
  388. OperatingSystemCPUperCoreResponse
  389. OperatingSystemCPUperCoreResponse_type
  390. OperatingSystemCPUperCoreResponse_type_meta
  391. OperatingSystemCPUperCoreResponse_type_meta_default
  392. OperatingSystemCPUperCoreServerIDResponse
  393. OperatingSystemDiskIOResponse
  394. OperatingSystemDiskIOResponse_type
  395. OperatingSystemDiskIOResponse_type_meta
  396. OperatingSystemDiskIOResponse_type_meta_metrics
  397. OperatingSystemDiskIOServerIDResponse
  398. OperatingSystemDiskUtilizationResponse
  399. OperatingSystemDiskUtilizationResponse_type
  400. OperatingSystemDiskUtilizationResponse_type_meta
  401. OperatingSystemDiskUtilizationResponse_type_meta_default
  402. OperatingSystemDiskUtilizationResponse_type_meta_metrics
  403. OperatingSystemDiskUtilizationServerIDResponse
  404. OperatingSystemMemoryResponse
  405. OperatingSystemMemoryResponse_type
  406. OperatingSystemMemoryResponse_type_meta
  407. OperatingSystemMemoryResponse_type_meta_metrics
  408. OperatingSystemMemoryServerIDResponse
  409. OperatingSystemNetworkIOResponse
  410. OperatingSystemNetworkIOResponse_type
  411. OperatingSystemNetworkIOResponse_type_meta
  412. OperatingSystemNetworkIOResponse_type_meta_default
  413. OperatingSystemNetworkIOResponse_type_meta_metrics
  414. OperatingSystemNetworkIOServerIDResponse
  415. OperatorClassesResource
  416. Panel
  417. Panel_config
  418. Panel_config_dataSources
  419. Panel_config_yAxes
  420. PermissionsEffectiveResponse
  421. PermissionsEffectiveResponse_inner
  422. PermissionsResource
  423. PermissionsResponse
  424. PermissionsUserIDResponse
  425. PermissionsUserIdRequest
  426. PermissionsUserResource
  427. Ph_alertSqlResponse
  428. Ph_alertSqlResponse_data
  429. Ph_alerts_SqlResponse
  430. Ph_alerts_SqlResponse_data
  431. Ph_bg_jobs_SqlResponse
  432. Ph_bg_jobs_SqlResponse_data
  433. Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
  434. Ph_bg_jobs_resultsSqlResponse
  435. Ph_bg_jobs_resultsSqlResponse_data
  436. Ph_configSqlResponse
  437. Ph_configSqlResponse_data
  438. Ph_groupSqlResponse
  439. Ph_groupSqlResponse_data
  440. Ph_runSqlResponse
  441. Ph_runSqlResponse_data
  442. Ph_taskSqlResponse
  443. Ph_taskSqlResponse_data
  444. Ph_threshold_SqlResponse
  445. Ph_threshold_SqlResponse_data
  446. Ph_version_SqlResponse
  447. Ph_version_SqlResponse_data
  448. PhysicalLogResponse
  449. PoliciesResponse
  450. PoliciesResponse_task_info
  451. PoliciesResponse_task_info_tk_delete
  452. PoliciesResponse_task_info_tk_delete_IntervalDF
  453. PoliciesResponse_task_info_tk_start_time
  454. PoliciesResponse_task_parameters
  455. PrivilegesResource
  456. ProceduresResource
  457. ProfileStatisticsResource
  458. ProfileThreadResponse
  459. RLogsResponse
  460. RLogsResponse_llog
  461. RLogsResponse_plog
  462. RecoveryLogsResource
  463. ResourceContext
  464. ResultSet
  465. ResultSetMetaData
  466. RevokeAdminPrivilegedUserRequest
  467. RevokeDbPrivilegedUserRequest
  468. RevokeInternalPrivilegedUserRequest
  469. RevokeSchedulerTaskResponse
  470. RevokeTablePrivilegedUserRequest
  471. RevokeTaskIDParametersResponse
  472. RevokeTaskIDParametersResponse_inner
  473. SLAConnectionsResponse
  474. SLAConnectionsResponse_type
  475. SLAConnectionsResponse_type_meta
  476. SLAConnectionsResponse_type_meta_metrics
  477. SLAConnectionsServerIDResponse
  478. SLAInfo
  479. SMXInfoResponse
  480. SQLException
  481. SQLResource
  482. SQLSessionManager
  483. SQLSessionResource
  484. SQLSessionsResource
  485. SQLWarning
  486. SchedulerGroupsResponse
  487. SchedulerResource
  488. SchedulerTaskIDParametersRequest
  489. SchedulerTaskIDParametersRequest_inner
  490. SchedulerTaskRequest
  491. SchedulerTasksIDResponse
  492. SchedulerTasksParametersResponse
  493. SchedulerTasksResponse
  494. SchedulerTasksResponse_tk_frequency
  495. SchedulerTasksResponse_tk_frequency_IntervalDF
  496. SchedulerTasksRunsHistoryResponse
  497. SchedulerTasksRunsHistoryResponse_inner
  498. Sensor
  499. SensorDataMetaResponse
  500. SensorDataResource
  501. SensorResource
  502. SensorType
  503. SensorTypeIdDataResponse
  504. SensorTypeIdRequest
  505. SensorTypeMeta
  506. SensorTypeMeta_chart
  507. SensorTypeMeta_default
  508. SensorTypeMeta_default_collapse
  509. SensorTypeMeta_default_primaryKey
  510. SensorTypeMeta_metrics
  511. SensorTypeMeta_metrics_metric_name
  512. SensorTypeMetricMeta
  513. SequencesResource
  514. SequentialScansResponse
  515. SequentialScansResponse_type
  516. SequentialScansResponse_type_meta
  517. SequentialScansResponse_type_meta_default
  518. SequentialScansResponse_type_meta_metrics
  519. SequentialScansServerIDResponse
  520. ServerHostInfoResponse
  521. ServerHostResource
  522. ServerInfoResource
  523. ServerInfoResponse
  524. SessionActivityResponse
  525. SessionStatisticsResponse
  526. SessionStatisticsResponse_type
  527. SessionStatisticsResponse_type_meta
  528. SessionStatisticsResponse_type_meta_metrics
  529. SessionStatisticsServerIDResponse
  530. SessionsIdResponse
  531. SessionsIdResponse_environment
  532. SessionsIdResponse_lock_duration
  533. SessionsIdResponse_lock_duration_IntervalDF
  534. SessionsIdResponse_locks
  535. SessionsIdResponse_memory
  536. SessionsIdResponse_profile
  537. SessionsIdResponse_threads
  538. SessionsResource
  539. SessionsResponse
  540. SessionsSummaryResponse
  541. SetOptimizePoliciesRequest
  542. SingleOnConfigRequest
  543. SlowestSqlResponse
  544. SlowestSqlResponse_query_plan
  545. SpaceResponse
  546. SqlHighestEstimatedCostResponse
  547. SqlIdResponse
  548. SqlIdResponse_hvars
  549. SqlMostBufferActivityResponse
  550. SqlMostIOTimeResponse
  551. SqlMostMemoryResponse
  552. SqlRequest
  553. SqlSessionIdResponse
  554. SqlSessionIdTypeRequest
  555. SqlSessionsTablesIndexResponse
  556. SqlTraceConfigRequest
  557. SqlTraceConfigResponse
  558. SqlTraceConfigResponse_level
  559. SqlTraceConfigResponse_mode
  560. SqlTraceConfigResponse_state
  561. SqlTraceResponse
  562. SqlTraceResponse_config
  563. SqlTraceResponse_config_databases
  564. SqlTraceResponse_info
  565. SqlTraceResponse_info_starttime
  566. SqlTraceStatementsResponse
  567. SqlTraceStatementsResponse_inner
  568. SqltraceInfoResponse
  569. SqltraceResource
  570. StackTraceElement
  571. Statement
  572. StmttypesResponse
  573. StmttypesResponse_inner
  574. StorageDatabaseDbnameRequest
  575. StorageDatabaseDbnameRequest_objects
  576. StorageDatabaseDbnameTrueRequest
  577. StorageDatabaseDbnameTrueRequest_fragments
  578. StorageDatabaseDbnameTrueRequest_objects
  579. StorageJobsResponse
  580. StorageJobsResponse_inner
  581. StoragePoolIdRequest
  582. StoragePoolRequest
  583. StoragePoolResponse
  584. StoragePoolResponse_inner
  585. StorageResource
  586. StorageResponse
  587. StoragepoolSessionIdResponse
  588. StoragepoolSessionIdResponse_data
  589. SuccessResponse
  590. SuccessResponseWithResult
  591. SwitchLogicalLogRequest
  592. SwitchLogicalLogRequest_Option_for_switch
  593. TableBufferPoolActivityResponse
  594. TableExtentsResponse
  595. TablePrivilegedUserRequest
  596. TablePrivilegedUserResponse
  597. TablesResource
  598. ThreadCountsResponse
  599. ThreadCountsResponse_type
  600. ThreadCountsResponse_type_meta
  601. ThreadCountsResponse_type_meta_default
  602. ThreadCountsResponse_type_meta_default_defaults
  603. ThreadCountsServerIDResponse
  604. Throwable
  605. TransactionResponse
  606. TransactionResponse_inner
  607. TransactionSqlIdResponse
  608. TransactionSqlIdResponse_statements
  609. UpdateOnlineLogsRotationConfigurationsRequest
  610. UpdateSensorRequest
  611. UpdateSensorRequest_sensors
  612. UpdateStatsResponse
  613. User
  614. UserDefinedTypesResource
  615. UserIdResponse
  616. UserPermissionsResource
  617. VPsClassRequest
  618. VPsClassResponse
  619. VPsResponse
  620. VirtualProcessorResource
  621. VirtualProcessorsSensorResponse
  622. VirtualProcessorsSensorResponse_type
  623. VirtualProcessorsSensorResponse_type_meta
  624. VirtualProcessorsSensorResponse_type_meta_metrics
  625. VirtualProcessorsSensorServerIDResponse
  626. WarehouseResource
  627. dashboards_drop_body
  628. groupId_dashboards_body
  629. inline_response_200
  630. inline_response_200_1
  631. onedbgroupsgroupIddashboards_newDashboards

AUSAlertResponse Up

alert_time (optional)
date format: date
alert_type (optional)
String
alert_color (optional)
String
alert_message (optional)
String

AUSCommandsResponse Up

command (optional)
String
state (optional)
String

AUSConfigurationResponse Up

tasks (optional)
array[AUSConfigurationResponse_tasks]
total_ausr_threads (optional)
Integer format: int32

AUSConfigurationResponse_parameters Up

id (optional)
Integer format: int32
name (optional)
String
task_name (optional)
String
value (optional)
Integer format: int32
value_type (optional)
String
description (optional)
String

AUSConfigurationResponse_tasks Up

tk_id (optional)
Integer format: int32
tk_name (optional)
String
tk_start_time (optional)
SqlTraceResponse_info_starttime
tk_stop_time (optional)
SqlTraceResponse_info_starttime
tk_frequency (optional)
SchedulerTasksResponse_tk_frequency
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean
tk_enable (optional)
Boolean
parameters (optional)
array[AUSConfigurationResponse_parameters]

AUSJobsCleanupRequest Up

server (optional)
AUSJobsCleanupRequest_server

AUSJobsCleanupRequest_server Up

id (optional)
Integer format: int32
parentGroupId (optional)
Long format: int64
name (optional)
String
parent (optional)
String
permissions (optional)
AUSJobsCleanupRequest_server_permissions

AUSJobsCleanupRequest_server_permissions Up

read (optional)
Boolean
admin (optional)
Boolean
sql (optional)
Boolean
agent (optional)
AgentPostRequest
alias (optional)
String
hostname (optional)
String
serviceName (optional)
String
port (optional)
Integer format: int32
monitorUser (optional)
String
hasMonitorPassword (optional)
Boolean
adminUser (optional)
String
hasAdminPassword (optional)
Boolean
unreadIncidents (optional)
Long format: int64
connectionProperties (optional)
Object

AUSResponse Up

enabled (optional)
Boolean
last_evaluation (optional)
SqlTraceResponse_info_starttime
next_execution (optional)
SqlTraceResponse_info_starttime

AddLogicalLogInfoRequest Up

task (optional)
String
dbspace (optional)
String Required dbspace file
size (optional)
Integer size of log file
count (optional)
Integer
afterCurrent (optional)
Boolean

AddOrModifySLARequest Up

cmName (optional)
String
cmUnitName (optional)
String
slaName (optional)
String
type (optional)
String
dbServers (optional)
String
port (optional)
String
policy (optional)
String
mode (optional)
String
workers (optional)
String
useAliases (optional)
String

AdminPrivilegedUserRequest Up

userName (optional)
String
privilegeTypes (optional)
array[String] List of admin-level privileges which needs to be granted
removedPrivileges (optional)
array[String] List of table-level privileges which needs to get revoked

AdminPrivilegedUserResponse Up

userName (optional)
String
lastModified (optional)
String
privilegeTypes (optional)
array[String] List of admin-level privileges

AfFilesResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
AfFilesResponse_type

AfFilesResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
AfFilesResponse_type_meta
fromPackage (optional)
Boolean

AfFilesResponse_type_meta Up

type (optional)
Object
default (optional)
AfFilesResponse_type_meta_default
metrics (optional)
AfFilesResponse_type_meta_metrics
chart (optional)
AlertingEffectiveGroupIdResponse_trigger

AfFilesResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
unique (optional)
array[String]

AfFilesResponse_type_meta_metrics Up

type (optional)
Object
count (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

AfFilesServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
AfFilesResponse_type

AgentConfiguration Up

repositoryServerId (optional)
Long Id of Repository OneDB Server inside OneDB Explore format: int64
database (optional)
String name of repsitory database selected for this agent

AgentPostRequest Up

online (optional)
Boolean
isMonitoring (optional)
Boolean
config (optional)
AgentConfiguration
isConfigured (optional)
Boolean

AgentRequest Up

online (optional)
Boolean
config (optional)
AgentConfiguration

AgentResource Up

agent (optional)
map[String, Object]

AgentResponse Up

online (optional)
Boolean
isMonitoring (optional)
Boolean
config (optional)
AgentConfiguration

AggregatesResource Up

aggregatesDetails (optional)
BSONObject

AlertTrigger Up

type (optional)
String
Enum:
INTERVAL
EVENT

AlertingCriteria Up

id (optional)
Long format: int64
owner (optional)
AlertingCriteriaProfile
name (optional)
String
frequencyPolicy (optional)
String
Enum:
AT_FIXED_RATE
WITH_FIXED_DELAY
violationToIncidentsMappingPolicy (optional)
String
Enum:
ONE_TO_ONE
whenToCheckNext (optional)
Long format: int64
trigger (optional)
AlertTrigger
alertEventTypes (optional)
array[String]
Enum:
neededSensors (optional)
array[String]
criticalAlert (optional)
Boolean

AlertingCriteriaProfile Up

owner (optional)
AlertingCriteriaProfileOwner
alerts (optional)
array[AlertingCriteria]
disabledAlertIds (optional)
array[Long] format: int64
effectiveAlerts (optional)
array[AlertingCriteria]
eventNeededSensors (optional)
array[String]

AlertingCriteriaProfileOwner Up

alertingProfile (optional)
AlertingCriteriaProfile
parentAlertingProfile (optional)
AlertingCriteriaProfile

AlertingCriteriaProfileResource Up

profile (optional)
BSONObject
effectiveProfile (optional)
BSONObject

AlertingEffectiveGroupIdResponse Up

id (optional)
Integer format: int32
name (optional)
String
trigger (optional)
AlertingEffectiveGroupIdResponse_trigger
condition (optional)
AlertingEffectiveGroupIdResponse_condition
disabled (optional)
Boolean

AlertingEffectiveGroupIdResponse_condition Up

a (optional)
AlertingEffectiveGroupIdResponse_trigger
b (optional)
AlertingEffectiveGroupIdResponse_condition_b
op (optional)
String

AlertingEffectiveGroupIdResponse_condition_b Up

value (optional)
Integer format: int32
type (optional)
String

AlertingEffectiveGroupIdResponse_trigger Up

type (optional)
String

AlertingEffectiveResponse Up

id (optional)
Integer format: int32
name (optional)
String
trigger (optional)
AlertingEffectiveGroupIdResponse_trigger
condition (optional)
AlertingEffectiveGroupIdResponse_condition

AlertingGroupIdRequest Up

alerts (optional)
array[AlertingGroupIdRequest_alerts]
inherited (optional)
array[AlertingGroupIdRequest_inherited]

AlertingGroupIdRequest_alerts Up

id (optional)
Integer format: int32
name (optional)
String
trigger (optional)
AlertingEffectiveGroupIdResponse_trigger
condition (optional)
AlertingEffectiveGroupIdResponse_condition
disabled (optional)
Boolean

AlertingGroupIdRequest_inherited Up

id (optional)
Integer format: int32
disabled (optional)
Boolean

AlertingGroupIdResponse Up

alerts (optional)
array[AlertingGroupIdRequest_alerts]
inherited (optional)
array[IncidentsResponse]

AlertingIncidentsResource Up

AlertingMessenger Up

id (optional)
Long format: int64
type (optional)
String
enabled (optional)
Boolean
bson (optional)
map[String, Object]
messengerBSON (optional)
map[String, Object]

AlertingProfile Up

id (optional)
Long format: int64
user (optional)
User
settings (optional)
AlertingProfileSettings
bson (optional)
map[String, Object]

AlertingProfileSettings Up

messengerId (optional)
Long format: int64
name (optional)
String
instant (optional)
Boolean
timeout (optional)
Long format: int64
bson (optional)
map[String, Object]

AlertingResponse Up

alerts (optional)
array[AlertingCriteria]
inherited (optional)
MonitoringProfileResponse_own

AlertingResponse1 Up

alerts (optional)
array[AlertingCriteria]
inherited (optional)
array[String]

AusConfigurationDatabasesRequest Up

database_priority_high (optional)
array[Object]
database_priority_medium (optional)
array[Object]
database_priority_low (optional)
array[Object]
database_priority_disable (optional)
array[Object]

AusJobsRefreshThreadsRequest Up

threadCount (optional)
Integer format: int32

Aus_cmd_compSqlResponse Up

data (optional)
array[Aus_cmd_compSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Aus_cmd_compSqlResponse_aus_cmd_id Up

value (optional)
Long format: int64

Aus_cmd_compSqlResponse_aus_cmd_time Up

value (optional)
Date format: date-time

Aus_cmd_compSqlResponse_data Up

aus_cmd_dbs_partnum (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_cmd_exe (optional)
DatabasesSqlSessionsMoreResponse_tabname
aus_cmd_id (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
aus_cmd_partnum (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_cmd_priority (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
aus_cmd_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
aus_cmd_type (optional)
DatabasesSqlSessionsMoreResponse_tabname

Aus_cmd_infoSqlResponse Up

data (optional)
array[Aus_cmd_infoSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Aus_cmd_infoSqlResponse_data Up

aus_ci_database (optional)
DatabasesSqlSessionsMoreResponse_tabname
aus_ci_dbs_partnum (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
aus_ci_done_tables (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_ci_etime (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
aus_ci_locale (optional)
DatabasesSqlSessionsMoreResponse_tabname
aus_ci_logmode (optional)
DatabasesSqlSessionsMoreResponse_tabname
aus_ci_missed_tables (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_ci_need_tables (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_ci_stime (optional)
Aus_cmd_compSqlResponse_aus_cmd_time

Aus_commandSqlResponse Up

data (optional)
array[Aus_commandSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Aus_commandSqlResponse_data Up

aus_cmd_dbs_partnum (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
aus_cmd_dbs_priority (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_cmd_err_isam (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_cmd_err_sql (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_cmd_exe (optional)
DatabasesSqlSessionsMoreResponse_tabname
aus_cmd_id (optional)
DatabasesSqlSessionsMoreResponse_flags
aus_cmd_partnum (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
aus_cmd_priority (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
aus_cmd_runtime (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
aus_cmd_state (optional)
DatabasesSqlSessionsMoreResponse_tabname
aus_cmd_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
aus_cmd_type (optional)
DatabasesSqlSessionsMoreResponse_tabname

AutoUpdateStatsResource Up

databasesPriority (optional)
BSONObject
ausconfiguration (optional)
BSONObject
ausalert (optional)
BSONObject

Autoreg_migrateSqlResponse Up

data (optional)
array[Autoreg_migrateSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Autoreg_migrateSqlResponse_data Up

kind (optional)
DatabasesSqlSessionsMoreResponse_tabname
name (optional)
DatabasesSqlSessionsMoreResponse_tabname

AvailableServersResponse Up

name (optional)
String

BSONObject Up

BackupResource Up

backupInfo (optional)
BSONObject
backupTasks (optional)
map[String, Object]

BackupResponse Up

dbsnum (optional)
Integer format: int32
name (optional)
String Name of storage space
level0 (optional)
Integer format: int32
level1 (optional)
Integer format: int32
level2 (optional)
Integer format: int32

BackupResponse1 Up

oldest_level0 (optional)
BigDecimal format: int32
oldest_level1 (optional)
BigDecimal format: int32
oldest_level2 (optional)
BigDecimal format: int32
spaces_not_backed_up (optional)
BigDecimal format: int32
backup_in_progress (optional)
Boolean
per_space (optional)
array[BackupResponse1_per_space]
max_interval_l0 (optional)
BigDecimal format: int32
max_interval_any (optional)
BigDecimal format: int32

BackupResponse1_per_space Up

dbsnum (optional)
Long format: int64
name (optional)
String Name of storage space
level0 (optional)
Long format: int64
level1 (optional)
Long format: int64
level2 (optional)
Long format: int64

BackupTaskPayloadRequest Up

startTimes (optional)
array[Object]
backupType (optional)
String
backupGenerationRetain (optional)
Long format: int64
schedule (optional)
array[BakupsTasks_OnTapeRequest_schedule]

BackupTaskResponse Up

level0 (optional)
String
level1 (optional)
String
level2 (optional)
String
backupsConfigured (optional)
Boolean
backupsEnabled (optional)
Boolean
backupOnconfigs (optional)
array[BackupTaskResponse_backupOnconfigs]
numNonCriticalDbspaces (optional)
BigDecimal format: int32

BackupTaskResponse_backupOnconfigs Up

BAR_MAX_BACKUP (optional)
Long format: int64
BAR_NB_XPORT_COUNT (optional)
Long format: int64
BAR_XFER_BUF_SIZE (optional)
Long format: int64

BackupsDbspaceResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
BackupsDbspaceResponse_type

BackupsDbspaceResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
BackupsDbspaceResponse_type_meta
fromPackage (optional)
Boolean

BackupsDbspaceResponse_type_meta Up

type (optional)
Object
default (optional)
BackupsDbspaceResponse_type_meta_default
metrics (optional)
BackupsDbspaceResponse_type_meta_metrics

BackupsDbspaceResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
primaryKey (optional)
BackupsDbspaceResponse_type_meta_default_primaryKey

BackupsDbspaceResponse_type_meta_default_primaryKey Up

name (optional)
String
type (optional)
String
unique (optional)
array[String]
Enum:

BackupsDbspaceResponse_type_meta_metrics Up

type (optional)
Object
level0 (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
level1 (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
level2 (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

BackupsDbspaceServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
BackupsDbspaceResponse_type

BackupsHistoryResponse Up

level0 (optional)
array[Object]
level1 (optional)
array[Object]
level2 (optional)
array[Object]

BakupsTasksLevel0Response Up

level0 (optional)
BakupsTasksLevel0Response_level0
backupsConfigured (optional)
Boolean
backupsEnabled (optional)
Boolean
backupType (optional)
String
backupParams (optional)
BakupsTasksLevel0Response_backupParams
backupOnconfigs (optional)
BackupTaskResponse_backupOnconfigs
numNonCriticalDbspaces (optional)
BigDecimal format: int32

BakupsTasksLevel0Response_backupParams Up

ONTAPE_TAPEBLK (optional)
String
ONTAPE_TAPEDEV (optional)
String
ONTAPE_DEVICE_TYPE (optional)
String

BakupsTasksLevel0Response_level0 Up

tk_id (optional)
Integer format: int32
tk_name (optional)
String
tk_execute (optional)
String
tk_enable (optional)
Boolean
tk_next_execution (optional)
BakupsTasksLevel0Response_level0_tk_next_execution
tk_start_time (optional)
date format: date
tk_stop_time (optional)
BakupsTasksLevel0Response_level0_tk_next_execution
tk_frequency (optional)
BakupsTasksLevel0Response_level0_tk_frequency
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean
level (optional)
Long format: int64

BakupsTasksLevel0Response_level0_tk_frequency Up

IntervalDF (optional)
BakupsTasksLevel0Response_level0_tk_frequency_IntervalDF

BakupsTasksLevel0Response_level0_tk_frequency_IntervalDF Up

seconds (optional)
Long format: int64
nanoseconds (optional)
Long format: int64

BakupsTasksLevel0Response_level0_tk_next_execution Up

date (optional)
Date format: date-time

BakupsTasksLevel1Response Up

level1 (optional)
BakupsTasksLevel0Response_level0
backupsConfigured (optional)
Boolean
backupsEnabled (optional)
Boolean
backupType (optional)
String
backupParams (optional)
BakupsTasksLevel0Response_backupParams
backupOnconfigs (optional)
BackupTaskResponse_backupOnconfigs
numNonCriticalDbspaces (optional)
BigDecimal format: int32

BakupsTasksLevel2Response Up

level2 (optional)
BakupsTasksLevel0Response_level0
backupsConfigured (optional)
Boolean
backupsEnabled (optional)
Boolean
backupType (optional)
String
backupParams (optional)
BakupsTasksLevel0Response_backupParams
backupOnconfigs (optional)
BackupTaskResponse_backupOnconfigs
numNonCriticalDbspaces (optional)
BigDecimal format: int32

BakupsTasks_OnBarRequest Up

backupGenerationRetain (optional)
Long format: int64
parallelBackupStreams (optional)
Long format: int64
startTimes (optional)
array[Object]
backupType (optional)
String
schedule (optional)
array[BakupsTasks_OnTapeRequest_schedule]

BakupsTasks_OnTapeRequest Up

deviceType (optional)
String
path (optional)
String
blockSize (optional)
Integer format: int32
startTimes (optional)
array[Object]
backupType (optional)
String
schedule (optional)
array[BakupsTasks_OnTapeRequest_schedule]

BakupsTasks_OnTapeRequest_schedule Up

level (optional)
Integer format: int32
startTime (optional)
Date format: date-time
monday (optional)
Boolean
tuesday (optional)
Boolean
wednesday (optional)
Boolean
thursday (optional)
Boolean
friday (optional)
Boolean
saturday (optional)
Boolean
sunday (optional)
Boolean

BufferandDiskIoResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
CheckpointSensorResponse_type

BufferandDiskIoServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
CheckpointSensorResponse_type

CastsResource Up

castsDetails (optional)
BSONObject

CheckPointRequest Up

type (optional)
String

CheckPointResponse Up

intvl (optional)
Integer format: int32
caller (optional)
String
timestamp (optional)
Long format: int64
crit_time (optional)
Float format: float
flush_time (optional)
Float format: float
cp_time (optional)
Float format: float
n_dirty_buffs (optional)
Integer format: int32
ckpt_logid (optional)
Integer format: int32
ckpt_logpos (optional)
Integer format: int32
physused (optional)
Integer format: int32
logused (optional)
Integer format: int32
n_crit_waits (optional)
Integer format: int32
tot_crit_wait (optional)
Float format: float
longest_crit_wait (optional)
Float format: float
block_time (optional)
Float format: float

CheckpointSensorResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
CheckpointSensorResponse_type

CheckpointSensorResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
CheckpointSensorResponse_type_meta
fromPackage (optional)
Boolean

CheckpointSensorResponse_type_meta Up

type (optional)
Object
default (optional)
CheckpointSensorResponse_type_meta_default
metrics (optional)
CheckpointSensorResponse_type_meta_metrics
chart (optional)
AlertingEffectiveGroupIdResponse_trigger

CheckpointSensorResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
unique (optional)
array[String]

CheckpointSensorResponse_type_meta_metrics Up

type (optional)
Object
cp_time (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

CheckpointSensorResponse_type_meta_metrics_cp_time Up

name (optional)
String

CheckpointSensorServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
CheckpointSensorResponse_type

CheckpointsResource Up

ChunksResponse Up

chknum (optional)
Integer format: int32
dbsnum (optional)
Integer format: int32
space_name (optional)
String Name of storage space
type (optional)
String
path (optional)
String
page_size (optional)
Long format: int64
offset (optional)
Integer format: int32
size (optional)
Long format: int64
extendable (optional)
Integer Value can be 0 or 1. If value is 1 means this chunk is extendable and if 0 then it is not. format: int32
Enum:
0
1
free_size (optional)
Long format: int64
percent_used (optional)
Float format: float
status (optional)
String
reads (optional)
Integer format: int32
writes (optional)
Integer format: int32
read_time (optional)
Float format: float
write_time (optional)
Float format: float

ChunkwritesResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
ChunkwritesResponse_type

ChunkwritesResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
ChunkwritesResponse_type_meta
fromPackage (optional)
Boolean

ChunkwritesResponse_type_meta Up

type (optional)
Object
default (optional)
ChunkwritesResponse_type_meta_default
metrics (optional)
ChunkwritesResponse_type_meta_metrics

ChunkwritesResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
collapse (optional)
ChunkwritesResponse_type_meta_default_collapse
delta (optional)
array[String]
Enum:

ChunkwritesResponse_type_meta_default_collapse Up

key (optional)
String
value (optional)
BigDecimal format: int 64

ChunkwritesResponse_type_meta_metrics Up

type (optional)
Object
chunkwrites_total (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_2K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_4K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_6K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_8K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_10K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_12K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_14K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chunkwrites_16K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

ChunkwritesServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
ChunkwritesResponse_type

Command_historySqlResponse Up

data (optional)
array[Command_historySqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Command_historySqlResponse_data Up

cmd_exec_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
cmd_executed (optional)
DatabasesSqlSessionsMoreResponse_tabname
cmd_hostname (optional)
DatabasesSqlSessionsMoreResponse_tabname
cmd_number (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
cmd_ret_msg (optional)
DatabasesSqlSessionsMoreResponse_tabname
cmd_ret_status (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
cmd_user (optional)
DatabasesSqlSessionsMoreResponse_tabname

ConfigurationDatabasesResponse Up

database_priority_high (optional)
array[Object]
database_priority_medium (optional)
array[Object]
database_priority_low (optional)
array[Object]
database_priority_disable (optional)
array[Object]

Connection Up

readOnly (optional)
Boolean
closed (optional)
Boolean
autoCommit (optional)
Boolean
catalog (optional)
String
clientInfo (optional)
map[String, String]
holdability (optional)
Integer format: int32
metaData (optional)
DatabaseMetaData
networkTimeout (optional)
Integer format: int32
schema (optional)
String
transactionIsolation (optional)
Integer format: int32
typeMap (optional)
Object
warnings (optional)
SQLWarning

ConnectionManagerInfoResponse Up

cmName (optional)
String
cmArbitrator (optional)
Integer format: int32
cmUnitList (optional)
array[ConnectionUnit]

ConnectionManagerResource Up

availableServers (optional)
BSONObject

ConnectionUnit Up

cmUnitName (optional)
String
foc (optional)
String
type (optional)
String
servers (optional)
String

ConnectionUnitResponse Up

foc (optional)
String
type (optional)
String
servers (optional)
String
slaInfoList (optional)
array[SLAInfo]

CreateBackupResponse Up

level (optional)
BigDecimal format: int32

DBLocaleResponse Up

language (optional)
String
name (optional)
String

DBSpaceUsageResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
DBSpaceUsageResponse_type

DBSpaceUsageResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
DBSpaceUsageResponse_type_meta
fromPackage (optional)
Boolean

DBSpaceUsageResponse_type_meta Up

type (optional)
Object
default (optional)
DBSpaceUsageResponse_type_meta_default
metrics (optional)
DBSpaceUsageResponse_type_meta_metrics

DBSpaceUsageResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
primaryKey (optional)
SensorTypeMeta_default_primaryKey

DBSpaceUsageResponse_type_meta_metrics Up

type (optional)
Object
percent_free (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
percent_used (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
free_size (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
size (optional)
OperatingSystemCPUResponse_type_meta_metrics_user

DBSpaceUsageServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
DBSpaceUsageResponse_type

DBSpacesResponse Up

dbsnum (optional)
Integer format: int32
name (optional)
String Name of dbspace

Dashboard Up

id (optional)
Long format: int64
group (optional)
Dashboard_group
configJson (optional)
map[String, Object]

DashboardConfig Up

name (optional)
String
panels (optional)
array[Panel]
defaultServerIds (optional)
array[Long] format: int64
new (optional)
Boolean

DashboardIdRequest Up

dashboardIds (optional)
array[Long] format: int64

DashboardInfoResponse Up

host (optional)
DashboardInfoResponse_host
iwa (optional)
DashboardInfoResponse_iwa
vps (optional)
array[DashboardInfoResponse_vps]

DashboardInfoResponse_host Up

os_name (optional)
String
os_release (optional)
String
os_nodename (optional)
String
os_version (optional)
String
os_machine (optional)
String
os_num_procs (optional)
Integer format: int32
os_num_olprocs (optional)
Integer format: int32
os_pagesize (optional)
Integer format: int32
os_mem_total (optional)
Integer format: int32
os_mem_free (optional)
Integer format: int32
os_open_file_lim (optional)
Integer format: int32

DashboardInfoResponse_iwa Up

hasIWA (optional)
Boolean

DashboardInfoResponse_vps Up

class (optional)
String
count (optional)
Integer format: int32
usercpu (optional)
Float format: float
syscpu (optional)
Float format: float
totalcpu (optional)
Float format: float

DashboardManager Up

all (optional)
array[Dashboard]

DashboardResponse Up

id (optional)
Long format: int64
group (optional)
DashboardResponse_group
config (optional)
DashboardConfig

DashboardResponse_group Up

id (optional)
Long format: int64
parentGroupId (optional)
Long format: int64
name (optional)
String
permissions (optional)
Integer format: int32

DashboardStoragePerformanceResponse Up

pf_dskreads (optional)
Integer format: int32
pf_bufreads (optional)
Integer format: int32
pf_dskwrites (optional)
Integer format: int32
pf_bufwrites (optional)
Integer format: int32
pf_isamtot (optional)
Integer format: int32
pf_isopens (optional)
Integer format: int32
pf_isstarts (optional)
Integer format: int32
pf_isreads (optional)
Integer format: int32
pf_iswrites (optional)
Integer format: int32
pf_isrewrites (optional)
Integer format: int32
pf_isdeletes (optional)
Integer format: int32
pf_iscommits (optional)
Integer format: int32
pf_isrollbacks (optional)
Integer format: int32
pf_ovlock (optional)
Integer format: int32
pf_ovuser (optional)
Integer format: int32
pf_buffwts (optional)
Integer format: int32
pf_lockreqs (optional)
Integer format: int32
pf_lockwts (optional)
Integer format: int32
pf_ckptwts (optional)
Integer format: int32
pf_deadlks (optional)
Integer format: int32
pf_lktouts (optional)
Integer format: int32
pf_numckpts (optional)
Integer format: int32
pf_pagreads (optional)
Integer format: int32
pf_pagwrites (optional)
Integer format: int32
pf_flushes (optional)
Integer format: int32
pf_compress (optional)
Integer format: int32
pf_fgwrites (optional)
Integer format: int32
pf_seqscans (optional)
Integer format: int32
last_checkpoint (optional)
DashboardStoragePerformanceResponse_last_checkpoint

DashboardStoragePerformanceResponse_last_checkpoint Up

intvl (optional)
Integer format: int32
caller (optional)
String
timestamp (optional)
Long format: int64
crit_time (optional)
Float format: float
flush_time (optional)
Float format: float
cp_time (optional)
Float format: float
n_dirty_buffs (optional)
Integer format: int32
ckpt_logid (optional)
Integer format: int32
ckpt_logpos (optional)
Integer format: int32
physused (optional)
Integer format: int32
logused (optional)
Integer format: int32
n_crit_waits (optional)
Integer format: int32
tot_crit_wait (optional)
Float format: float
longest_crit_wait (optional)
Float format: float
block_time (optional)
Float format: float

Dashboard_group Up

id (optional)
Long format: int64
name (optional)
String
permissions (optional)
Integer format: int32

DataSeries Up

id (optional)
String
label (optional)
String
color (optional)
String
yAxis (optional)
Integer format: int32

DatabaseMetaData Up

url (optional)
String
readOnly (optional)
Boolean
resultSetHoldability (optional)
Integer format: int32
catalogSeparator (optional)
String
catalogTerm (optional)
String
catalogs (optional)
ResultSet
clientInfoProperties (optional)
ResultSet
databaseMajorVersion (optional)
Integer format: int32
databaseMinorVersion (optional)
Integer format: int32
databaseProductName (optional)
String
databaseProductVersion (optional)
String
defaultTransactionIsolation (optional)
Integer format: int32
driverMajorVersion (optional)
Integer format: int32
driverMinorVersion (optional)
Integer format: int32
driverName (optional)
String
driverVersion (optional)
String
extraNameCharacters (optional)
String
identifierQuoteString (optional)
String
maxBinaryLiteralLength (optional)
Integer format: int32
maxCatalogNameLength (optional)
Integer format: int32
maxCharLiteralLength (optional)
Integer format: int32
maxColumnNameLength (optional)
Integer format: int32
maxColumnsInGroupBy (optional)
Integer format: int32
maxColumnsInIndex (optional)
Integer format: int32
maxColumnsInOrderBy (optional)
Integer format: int32
maxColumnsInSelect (optional)
Integer format: int32
maxColumnsInTable (optional)
Integer format: int32
maxConnections (optional)
Integer format: int32
maxCursorNameLength (optional)
Integer format: int32
maxIndexLength (optional)
Integer format: int32
maxLogicalLobSize (optional)
Long format: int64
maxProcedureNameLength (optional)
Integer format: int32
maxRowSize (optional)
Integer format: int32
maxSchemaNameLength (optional)
Integer format: int32
maxStatementLength (optional)
Integer format: int32
maxStatements (optional)
Integer format: int32
maxTableNameLength (optional)
Integer format: int32
maxTablesInSelect (optional)
Integer format: int32
maxUserNameLength (optional)
Integer format: int32
numericFunctions (optional)
String
procedureTerm (optional)
String
rowIdLifetime (optional)
String
Enum:
ROWID_UNSUPPORTED
ROWID_VALID_OTHER
ROWID_VALID_SESSION
ROWID_VALID_TRANSACTION
ROWID_VALID_FOREVER
sqlkeywords (optional)
String
sqlstateType (optional)
Integer format: int32
schemaTerm (optional)
String
schemas (optional)
ResultSet
searchStringEscape (optional)
String
stringFunctions (optional)
String
systemFunctions (optional)
String
tableTypes (optional)
ResultSet
timeDateFunctions (optional)
String
typeInfo (optional)
ResultSet
catalogAtStart (optional)
Boolean
connection (optional)
Connection
jdbcmajorVersion (optional)
Integer format: int32
jdbcminorVersion (optional)
Integer format: int32
userName (optional)
String

DatabasePrivilegedUserRequest Up

userName (optional)
String
privilegeType (optional)
String

DatabasePrivilegedUserResponse Up

userName (optional)
String
privilegeType (optional)
String
defaultRole (optional)
String

DatabaseResource Up

resourceContext (optional)
ResourceContext
sqlSessionManager (optional)
SQLSessionManager
database (optional)
map[String, Object]
sqlsessionsResource (optional)
SQLSessionsResource

DatabaseSqlSessionIdTablenameIndexDisableRequest Up

indexName (optional)
String

DatabaseSqlSessionIdTablenameIndexEnableRequest Up

indexName (optional)
String

DatabasesObjectResponse Up

name (optional)
String
owner (optional)
String
created (optional)
date format: date
logging (optional)
BigDecimal format: int32
bufferedLogging (optional)
BigDecimal format: int32
ansi (optional)
BigDecimal format: int32
gls (optional)
BigDecimal format: int32
caseInsensitive (optional)
BigDecimal format: int32
dbspace (optional)
String
locale (optional)
String
space_occupied (optional)
BigDecimal format: int32
load_tasks (optional)
BigDecimal format: int32
unload_tasks (optional)
BigDecimal format: int32

DatabasesRequest Up

name (optional)
String
dbspace (optional)
String
locale (optional)
String
loggingMode (optional)
String
isCharacterCase (optional)
Boolean
isDemoDatabase (optional)
Boolean

DatabasesResource Up

resourceContext (optional)
ResourceContext
databases (optional)
array[Object]

DatabasesResponse Up

name (optional)
String
owner (optional)
String
created (optional)
date format: date
logging (optional)
BigDecimal format: int32
bufferedLogging (optional)
BigDecimal format: int32
ansi (optional)
BigDecimal format: int32
gls (optional)
BigDecimal format: int32
caseInsensitive (optional)
BigDecimal format: int32
dbspace (optional)
String
locale (optional)
String

DatabasesSqlSessionsAggregatesResponse Up

name (optional)
String
owner (optional)
String
init_func (optional)
String
iter_func (optional)
String
combine_func (optional)
String
final_func (optional)
String
handlesnulls (optional)
Boolean

DatabasesSqlSessionsCastsResponse Up

owner (optional)
String
from_type (optional)
String
to_type (optional)
String
routine_name (optional)
String
cast_type (optional)
String

DatabasesSqlSessionsDatabladesResponse Up

bld_id (optional)
String

DatabasesSqlSessionsMoreResponse Up

data (optional)
array[DatabasesSqlSessionsMoreResponse_data]
hasMore (optional)
Boolean

DatabasesSqlSessionsMoreResponse_data Up

tabname (optional)
DatabasesSqlSessionsMoreResponse_tabname
flags (optional)
DatabasesSqlSessionsMoreResponse_flags
txt (optional)
DatabasesSqlSessionsMoreResponse_tabname

DatabasesSqlSessionsMoreResponse_flags Up

value (optional)
Integer format: int32

DatabasesSqlSessionsMoreResponse_tabname Up

value (optional)
String

DatabasesSqlSessionsOPClassesResponse Up

opclassname (optional)
String
owner (optional)
String
access_method (optional)
String
operators (optional)
String
support_func (optional)
String

DatabasesSqlSessionsProceduresIDResponse Up

sql_create (optional)
String
sql_alter (optional)
String

DatabasesSqlSessionsProceduresResponse Up

procid (optional)
Integer format: int32
procname (optional)
String
owner (optional)
String
type (optional)
String
mode (optional)
String
lang (optional)
String
numargs (optional)
Integer format: int32
paramtypes (optional)
String
retsize (optional)
Integer format: int32

DatabasesSqlSessionsSequencesResponse Up

seqname (optional)
String
owner (optional)
String
inc_val (optional)
Integer format: int32
start_val (optional)
Integer format: int32
min_val (optional)
Integer format: int32
max_val (optional)
Long format: int64
restart_val (optional)
Integer format: int32
cycle (optional)
String
cache (optional)
Integer format: int32
grantor (optional)
String
grantee (optional)
String
tabauth (optional)
String

DatabasesSqlSessionsSqlResponse Up

data (optional)
array[DatabasesSqlSessionsMoreResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

DatabasesSqlSessionsTablesDetailsResponse Up

type (optional)
String
columns (optional)
array[DatabasesSqlSessionsTablesDetailsResponse_columns]
constraints (optional)
array[Object]
indexes (optional)
array[DatabasesSqlSessionsTablesDetailsResponse_indexes]
references (optional)
array[Object]
fragments (optional)
array[DatabasesSqlSessionsTablesDetailsResponse_fragments]
privileges (optional)
array[DatabasesSqlSessionsTablesDetailsResponse_privileges]
triggers (optional)
array[Object]
statistics (optional)
array[DatabasesSqlSessionsTablesDetailsResponse_statistics]

DatabasesSqlSessionsTablesDetailsResponse_columns Up

id (optional)
Integer format: int32
name (optional)
String
type (optional)
String
notNull (optional)
Boolean
hidden (optional)
Boolean
length (optional)
Integer format: int32

DatabasesSqlSessionsTablesDetailsResponse_columns_1 Up

id (optional)
Integer format: int32
descending (optional)
Boolean

DatabasesSqlSessionsTablesDetailsResponse_fragments Up

fragtype (optional)
String
type (optional)
String
indexname (optional)
String
colno (optional)
Integer format: int32
partn (optional)
String
dbspace (optional)
String
partition (optional)
String
exprtext (optional)
Boolean
udi_counter (optional)
Integer format: int32

DatabasesSqlSessionsTablesDetailsResponse_indexes Up

enabled (optional)
Boolean
filtering (optional)
Boolean
filterErrorsEnabled (optional)
Boolean
name (optional)
String
owner (optional)
String
unique (optional)
Boolean
clustered (optional)
Boolean
levels (optional)
Integer format: int32
leaves (optional)
Integer format: int32
uniqueKeys (optional)
Integer format: int32
clusters (optional)
Integer format: int32
columns (optional)
array[DatabasesSqlSessionsTablesDetailsResponse_columns_1]

DatabasesSqlSessionsTablesDetailsResponse_privileges Up

grantor (optional)
String
grantee (optional)
String
tabauth (optional)
String

DatabasesSqlSessionsTablesDetailsResponse_statistics Up

is_fragmented (optional)
Boolean
statLevel (optional)
String
statChange (optional)
String
tableStatistics (optional)
array[DatabasesSqlSessionsTablesDetailsResponse_tableStatistics]
fragmentStatistics (optional)
array[Object]

DatabasesSqlSessionsTablesDetailsResponse_tableStatistics Up

name (optional)
String
type (optional)
String
build_date (optional)
SqlTraceResponse_info_starttime
sample (optional)
Integer format: int32
nrows (optional)
Integer format: int32
mode (optional)
String
resolution (optional)
Integer format: int32
confidence (optional)
Float format: float
build_duration (optional)
SchedulerTasksResponse_tk_frequency
udi_counter (optional)
Integer format: int32
change (optional)
Integer format: int32

DatabasesSqlSessionsTablesIndexRequest Up

indexName (optional)
String
columnsList (optional)
array[DatabasesSqlSessionsTablesIndexRequest_columnsList]
indexType (optional)
String
fillFactor (optional)
Long format: int64
isExecute (optional)
Boolean
isOnline (optional)
Boolean
isCompressed (optional)
Boolean
storageScheme (optional)
String

DatabasesSqlSessionsTablesIndexRequest_columnsList Up

id (optional)
Integer format: int32
indexedColumnName (optional)
String
order (optional)
String
hash (optional)
Boolean

DatabasesSqlSessionsTablesIndexResponse Up

idxname (optional)
String
tabname (optional)
String
owner (optional)
String
tabid (optional)
Integer format: int32
idxtype (optional)
String

DatabasesSqlSessionsTablesResponse Up

id (optional)
Integer format: int32
name (optional)
String
owner (optional)
String
lastModified (optional)
Integer format: int32
type (optional)
String
lockLevel (optional)
String
firstExtentSize (optional)
Integer format: int32
nextExtentSize (optional)
Integer format: int32
pageSize (optional)
Integer format: int32
lastStatisticsUpdate (optional)
Integer format: int32
statisticsLevel (optional)
Boolean
hasRowId (optional)
Boolean
isSubTable (optional)
Boolean
isRemote (optional)
Boolean
isCdr (optional)
Boolean
isRaw (optional)
Boolean
isExternal (optional)
Boolean
isAuditEnabled (optional)
Boolean
isAqt (optional)
Boolean
isVirtualAqt (optional)
Boolean
isCollection (optional)
Boolean
synonyms (optional)
Object

DatabasesSqlSessionsTablesStatisticsRequest Up

statLevel (optional)
String Update statitics level as AUTO, TABLE, FRAGMENTS
Enum:
A
T
F
statChange (optional)
Long format: int64

DatabasesSqlSessionsUDTsResponse Up

typename (optional)
String
owner (optional)
String
type_id (optional)
Integer format: int32
mode (optional)
String
desc (optional)
String
maxlength (optional)
Integer format: int32
length (optional)
Integer format: int32
byvalue (optional)
Boolean
cannothash (optional)
Boolean
align (optional)
Integer format: int32

DatabladesResource Up

datablades (optional)
BSONObject

DbNameIsFalseResponse Up

DbNameIsFalseResponse_inner Up

owner (optional)
String
tabname (optional)
String
type (optional)
String
run_time (optional)
Object
created (optional)
Object
extents (optional)
Long format: int64
nrows (optional)
Long format: int64
nptotal (optional)
Long format: int64
npused (optional)
Long format: int64
used_size (optional)
Double format: double
free (optional)
Long format: int64
partly_used (optional)
Long format: int64
mostly_used (optional)
Long format: int64
very_full (optional)
Long format: int64
is_fragment (optional)
Double format: double
compressed (optional)
String
auto_compressed (optional)
String
uncompressed (optional)
String
has_blob_column (optional)
Boolean
running (optional)
Boolean
estimate (optional)
String
fragments (optional)
array[Object] when dbname is sysadmin and condition is false

DbNameIsTrueResponse Up

owner (optional)
String
tabname (optional)
String
type (optional)
String
run_time (optional)
PoliciesResponse_task_info_tk_start_time
created (optional)
SqlTraceResponse_info_starttime
extents (optional)
Long format: int64
nrows (optional)
Long format: int64
nptotal (optional)
Long format: int64
npused (optional)
Long format: int64
used_size (optional)
Double format: double
free (optional)
Long format: int64
partly_used (optional)
Long format: int64
mostly_used (optional)
Long format: int64
very_full (optional)
Long format: int64
is_fragment (optional)
Double format: double
compressed (optional)
String
auto_compressed (optional)
String
uncompressed (optional)
String
has_blob_column (optional)
Boolean
running (optional)
Boolean
estimate (optional)
String
fragments (optional)
array[DbNameIsTrueResponse_fragments]

DbNameIsTrueResponse_fragments Up

nptotal (optional)
Long format: int64
is_fragment (optional)
Long format: int64
type (optional)
String
npused (optional)
Long format: int64
used_size (optional)
Long format: int64
nrows (optional)
Long format: int64
nextents (optional)
Long format: int64
compressed (optional)
String
partnum (optional)
String
dbspace (optional)
String
tabname (optional)
String
owner (optional)
String
auto_compressed (optional)
String
uncompressed (optional)
String
running (optional)
Boolean
estimate (optional)
date format: date

DeleteBackupTask Up

level0 (optional)
Integer format: int32
level1 (optional)
Integer format: int32
level2 (optional)
Integer format: int32
backupsConfigured (optional)
Boolean
backupsEnabled (optional)
Boolean
backupOnconfigs (optional)
BackupTaskResponse_backupOnconfigs
numNonCriticalDbspaces (optional)
BigDecimal format: int32
ok (optional)
Boolean
n (optional)
BigDecimal format: int32

DeleteIncidentRequest Up

id (optional)
Long format: int64
server_id (optional)
Long format: int64

DeleteIncidentsRequest Up

incidents (optional)
array[DeleteIncidentRequest]

DeleteLogicalLogRequest Up

Number (optional)
String

DeleteSLARequest Up

cmName (optional)
String
cmUnitName (optional)
String
slaName (optional)
String
type (optional)
String

DeployAgentResponse Up

overwrite (optional)
Boolean

DropVirtualProcessorRequest Up

class (optional)
String
Count (optional)
Integer format: int32

ERDomainProfileResponse Up

name (optional)
String
time (optional)
String
ableToConnect (optional)
String
version (optional)
String
supportsCommand (optional)
String
ERState (optional)
String
ddr (optional)
ERDomainProfileResponse_ddr
disk (optional)
ERDomainProfileResponse_disk
sendQ (optional)
ERDomainProfileResponse_sendQ
network (optional)
ERDomainProfileResponse_network
receiveQ (optional)
ERDomainProfileResponse_receiveQ
apply (optional)
ERDomainProfileResponse_apply

ERDomainProfileResponse_apply Up

state (optional)
String
txnProcessed (optional)
Long format: int64
commitRate (optional)
Double format: double
avgActiveApply (optional)
Double format: double
failRate (optional)
Double format: double
totalFailures (optional)
Long format: int64
avgLatency (optional)
Double format: double
maxLatency (optional)
Double format: double
atsFileCount (optional)
Long format: int64
risFileCount (optional)
Long format: int64

ERDomainProfileResponse_ddr Up

state (optional)
String
current (optional)
String
snoopy (optional)
String
replay (optional)
String
pagesFromDDRBLOCK (optional)
Long format: int64

ERDomainProfileResponse_disk Up

total (optional)
Long format: int64
metadataFree (optional)
Long format: int64
userdataFree (optional)
Long format: int64

ERDomainProfileResponse_network Up

state (optional)
String
numberOfConnections (optional)
Integer format: int32
expectedConnections (optional)
Integer format: int32
msgSent (optional)
Long format: int64
msgReceived (optional)
Long format: int64
throughput (optional)
Double format: double
pendingMsg (optional)
Long format: int64

ERDomainProfileResponse_receiveQ Up

txnInQueue (optional)
Long format: int64
txnInPendingList (optional)
Long format: int64

ERDomainProfileResponse_sendQ Up

txnInQueue (optional)
Long format: int64
txnSpooled (optional)
Long format: int64
acksPending (optional)
Long format: int64

ERDomainResponse Up

name (optional)
String
nodes (optional)
array[ERNodeResponse]

ERNodeResponse Up

id (optional)
Integer format: int32
name (optional)
String
rootId (optional)
Integer format: int32
isHub (optional)
Boolean
isLeaf (optional)
Boolean
serverState (optional)
String
members (optional)
array[ERNodeResponse_members]

ERNodeResponse_members Up

dbServerName (optional)
String

EnterpriseReplicationResource Up

domainTopology (optional)
map[String, Object]
erstatus (optional)
BSONObject
domainProfile (optional)
BSONObject

Entry Up

value (optional)
Object
key (optional)
Object

EntryUserEnumSetOneDBServerPermission Up

value (optional)
array[String]
Enum:
key (optional)
User

ExecuteEvaluationTaskRequest Up

id (optional)
Long format: int64
parentGroupId (optional)
Long format: int64
name (optional)
String
parent (optional)
String
permissions (optional)
ExecuteEvaluationTaskRequest_permissions
agent (optional)
ExecuteEvaluationTaskRequest_agent
alias (optional)
String
hostname (optional)
String
serviceName (optional)
String
port (optional)
Long format: int64
monitorUser (optional)
String
hasMonitorPassword (optional)
Boolean
adminUser (optional)
String
hasAdminPassword (optional)
Boolean
unreadIncidents (optional)
Long format: int64
connectionProperties (optional)
String

ExecuteEvaluationTaskRequest_agent Up

online (optional)
Boolean
isMonitoring (optional)
Boolean
config (optional)
ExecuteEvaluationTaskRequest_agent_config

ExecuteEvaluationTaskRequest_agent_config Up

repositoryServerId (optional)
Long format: int64
database (optional)
String

ExecuteEvaluationTaskRequest_permissions Up

read (optional)
Boolean
admin (optional)
Boolean
sql (optional)
Boolean

ExecuteTaskRequest Up

tk_name (optional)
String
tk_description (optional)
String
tk_type (optional)
String
tk_result_table (optional)
String
tk_create (optional)
String
tk_delete (optional)
String
tk_execute (optional)
String
tk_start_time (optional)
SqlTraceResponse_info_starttime
tk_stop_time (optional)
SqlTraceResponse_info_starttime
tk_frequency (optional)
BakupsTasksLevel0Response_level0_tk_next_execution
tk_group (optional)
String
tk_enable (optional)
Boolean
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean

ExecuteTaskResponse Up

tk_id (optional)
Integer format: int32

ExecutionsSqlResponse Up

ExecutionsSqlResponse_inner Up

sql_id (optional)
Integer format: int32
sql_sid (optional)
Integer format: int32
sql_uid (optional)
Integer format: int32
sql_finishtime (optional)
Long format: int64
sql_runtime (optional)
Float format: float
sql_rowspersec (optional)
Float format: float
sql_actualrows (optional)
Long format: int64
sql_lockwttime (optional)
Float format: float
sql_totaliowaits (optional)
Double format: double

ExistingInternalPrivilegedUserRequest Up

userName (optional)
String
osUserName (optional)
String
uid (optional)
Integer format: int32
gid (optional)
Integer format: int32
homeDirectory (optional)
String
password (optional)
String
lockType (optional)
String
mapUserBy (optional)
String
previousPrivilegeTypes (optional)
array[String] List of privous privileges
privilegeTypes (optional)
array[String] List of new privileges

ExistingOneDBServerRequest Up

id (optional)
Long format: int64
groupId (optional)
Long format: int64
alias (optional)
String
hostname (optional)
String
serviceName (optional)
String
port (optional)
Integer format: int32
monitorUser (optional)
String
monitorPassword (optional)
String
adminUser (optional)
String
adminPassword (optional)
String
connectionProperties (optional)
Object

FOCRequest Up

cmName (optional)
String
cmUnitName (optional)
String
timeout (optional)
String
order (optional)
String
type (optional)
String

ForegroundWritesResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
ForegroundWritesResponse_type

ForegroundWritesResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
ForegroundWritesResponse_type_meta
fromPackage (optional)
Boolean

ForegroundWritesResponse_type_meta Up

type (optional)
Object
default (optional)
ForegroundWritesResponse_type_meta_default
metrics (optional)
ForegroundWritesResponse_type_meta_metrics

ForegroundWritesResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
collapse (optional)
ChunkwritesResponse_type_meta_default_collapse
delta (optional)
array[String]
Enum:

ForegroundWritesResponse_type_meta_metrics Up

type (optional)
Object
fgwrites_total (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_2K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_4K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_6K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_8K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_10K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_12K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_14K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
fgwrites_16K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

ForegroundWritesServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
ForegroundWritesResponse_type

GroupIdRequest Up

name (optional)
String

GroupIdSensorDataMetaResponse Up

GroupIdSensorDataMetaResponse_inner Up

id (optional)
Long format: int64
when_created (optional)
String format: dateTime
state (optional)
Long format: int64
meta (optional)
Object

GroupIdSensorDataResponse Up

id (optional)
String
data (optional)
GroupIdSensorDataResponse_data

GroupIdSensorDataResponse_data Up

from (optional)
String format: dateTime
to (optional)
String format: dateTime
dsMax (optional)
Long format: int64

HASpecificServerInfoResponse Up

activeConnectionManagers (optional)
String
failoverArbitration (optional)
String
lastLogPageApplied (optional)
String
lastLogPageAcked (optional)
String
lastLogPageSent (optional)
String
lastLogPageFlushed (optional)
String
nextLogPageToSend (optional)
String
flowControl (optional)
String
logTransmissionStatus (optional)
String
delayApplyStatistics (optional)
String
stopApplyStatistics (optional)
String
transactionLatency (optional)
String
sumOfWorkReplay (optional)
Float format: float
backlog (optional)
String
catchupBacklog (optional)
String

HighAvailabilityApplyRateResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityApplyRateResponse_type

HighAvailabilityApplyRateResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
HighAvailabilityApplyRateResponse_type_meta
fromPackage (optional)
Boolean

HighAvailabilityApplyRateResponse_type_meta Up

type (optional)
Object
default (optional)
HighAvailabilityApplyRateResponse_type_meta_default
metrics (optional)
HighAvailabilityApplyRateResponse_type_meta_metrics

HighAvailabilityApplyRateResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
serverTypes (optional)
array[String]
Enum:
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
delta (optional)
array[String]
Enum:

HighAvailabilityApplyRateResponse_type_meta_metrics Up

type (optional)
Object
applyRate (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

HighAvailabilityApplyRateServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityApplyRateResponse_type

HighAvailabilityApproximateLogBacklogResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityApproximateLogBacklogResponse_type

HighAvailabilityApproximateLogBacklogResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
HighAvailabilityApproximateLogBacklogResponse_type_meta
fromPackage (optional)
Boolean

HighAvailabilityApproximateLogBacklogResponse_type_meta Up

type (optional)
Object
default (optional)
HighAvailabilityApproximateLogBacklogResponse_type_meta_default
metrics (optional)
HighAvailabilityApproximateLogBacklogResponse_type_meta_metrics

HighAvailabilityApproximateLogBacklogResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
serverTypes (optional)
array[String]
Enum:
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
primaryKey (optional)
SensorTypeMeta_default_primaryKey

HighAvailabilityApproximateLogBacklogResponse_type_meta_metrics Up

type (optional)
Object
name (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
approxLogBacklog (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

HighAvailabilityApproximateLogBacklogServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityApproximateLogBacklogResponse_type

HighAvailabilityConnectionStatusResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityConnectionStatusResponse_type

HighAvailabilityConnectionStatusResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
HighAvailabilityConnectionStatusResponse_type_meta
fromPackage (optional)
Boolean

HighAvailabilityConnectionStatusResponse_type_meta Up

type (optional)
Object
default (optional)
HighAvailabilityConnectionStatusResponse_type_meta_default
metrics (optional)
HighAvailabilityConnectionStatusResponse_type_meta_metrics

HighAvailabilityConnectionStatusResponse_type_meta_default Up

type (optional)
String
serverTypes (optional)
array[String]
Enum:
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
primaryKey (optional)
SensorTypeMeta_default_primaryKey

HighAvailabilityConnectionStatusResponse_type_meta_metrics Up

type (optional)
Object
connection_status (optional)
HighAvailabilityConnectionStatusResponse_type_meta_metrics_connection_status

HighAvailabilityConnectionStatusResponse_type_meta_metrics_connection_status Up

name (optional)
String
dataType (optional)
String

HighAvailabilityConnectionStatusServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityConnectionStatusResponse_type

HighAvailabilityInfoResponse Up

haName (optional)
String
primaryNotPresent (optional)
String
exceptionMessage (optional)
String
clusterNodeList (optional)
array[ServerInfoResponse]

HighAvailabilityLagtimeResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityLagtimeResponse_type

HighAvailabilityLagtimeResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
HighAvailabilityLagtimeResponse_type_meta
fromPackage (optional)
Boolean

HighAvailabilityLagtimeResponse_type_meta Up

type (optional)
Object
default (optional)
HighAvailabilityLagtimeResponse_type_meta_default
metrics (optional)
HighAvailabilityLagtimeResponse_type_meta_metrics

HighAvailabilityLagtimeResponse_type_meta_default Up

type (optional)
String
serverTypes (optional)
array[String]
Enum:
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
primaryKey (optional)
SensorTypeMeta_default_primaryKey

HighAvailabilityLagtimeResponse_type_meta_metrics Up

server (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
type (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lag_time (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

HighAvailabilityLagtimeServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityLagtimeResponse_type

HighAvailabilityLogicalLogRateResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityLogicalLogRateResponse_type

HighAvailabilityLogicalLogRateResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
HighAvailabilityLogicalLogRateResponse_type_meta
fromPackage (optional)
Boolean

HighAvailabilityLogicalLogRateResponse_type_meta Up

type (optional)
Object
default (optional)
HighAvailabilityLogicalLogRateResponse_type_meta_default
metrics (optional)
HighAvailabilityLogicalLogRateResponse_type_meta_metrics

HighAvailabilityLogicalLogRateResponse_type_meta_default Up

type (optional)
String
serverTypes (optional)
array[String]
Enum:
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
collapse (optional)
ChunkwritesResponse_type_meta_default_collapse
delta (optional)
array[String]
Enum:

HighAvailabilityLogicalLogRateResponse_type_meta_metrics Up

type (optional)
Object
llgrecs (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

HighAvailabilityLogicalLogRateServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityLogicalLogRateResponse_type

HighAvailabilityResource Up

highAvailabilitySMXInfo (optional)
BSONObject

HighAvailabilitySMXInfoResponse Up

primaryNotPresent (optional)
String
exceptionMessage (optional)
String
smxInfoList (optional)
array[SMXInfoResponse]

HighAvailabilityTransactionLatencyResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityTransactionLatencyResponse_type

HighAvailabilityTransactionLatencyResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
HighAvailabilityTransactionLatencyResponse_type_meta
fromPackage (optional)
Boolean

HighAvailabilityTransactionLatencyResponse_type_meta Up

type (optional)
Object
default (optional)
HighAvailabilityTransactionLatencyResponse_type_meta_default
metrics (optional)
HighAvailabilityTransactionLatencyResponse_type_meta_metrics

HighAvailabilityTransactionLatencyResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
serverTypes (optional)
array[String]
Enum:
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32

HighAvailabilityTransactionLatencyResponse_type_meta_metrics Up

type (optional)
Object
transactionLatency (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

HighAvailabilityTransactionLatencyServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityTransactionLatencyResponse_type

HighAvailabilityWorkloadResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityWorkloadResponse_type

HighAvailabilityWorkloadResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
HighAvailabilityWorkloadResponse_type_meta
fromPackage (optional)
Boolean

HighAvailabilityWorkloadResponse_type_meta Up

type (optional)
Object
default (optional)
HighAvailabilityLagtimeResponse_type_meta_default
metrics (optional)
HighAvailabilityWorkloadResponse_type_meta_metrics

HighAvailabilityWorkloadResponse_type_meta_metrics Up

server (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
type (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
cpu_workload (optional)
OperatingSystemCPUResponse_type_meta_metrics_user

HighAvailabilityWorkloadServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
HighAvailabilityWorkloadResponse_type

IWAResponse Up

hasIWA (optional)
Boolean

IncidentRequest Up

id (optional)
Long format: int64
state (optional)
Integer If state is less than 3 then incident is an unread incident format: int32
server_id (optional)
Long format: int64

IncidentsRequest Up

incidents (optional)
array[IncidentRequest]

IncidentsResponse Up

id (optional)
Long format: int64
when_created (optional)
Long format: int64
state (optional)
Integer If state is less than 3 then incident is an unread incident format: int32
meta (optional)
IncidentsResponse_meta
server_id (optional)
Long format: int64
server_name (optional)
String

IncidentsResponse_meta Up

msg (optional)
String

InternalPrivilegedUserRequest Up

userName (optional)
String
osUserName (optional)
String
uid (optional)
Integer format: int32
gid (optional)
Integer format: int32
homeDirectory (optional)
String
password (optional)
String
lockType (optional)
String
isDefault (optional)
Boolean
mapUserBy (optional)
String
privilegeTypes (optional)
array[String] List of privileges

InternalPrivilegedUserResponse Up

userName (optional)
String
authenticationType (optional)
String
isLocked (optional)
Boolean
osUserName (optional)
String
uid (optional)
Integer format: int32
gid (optional)
Integer format: int32
homeDirectory (optional)
String
privilegeTypes (optional)
array[String] List of privileges

IterationSqlResponse Up

IterationSqlResponse_inner Up

sql_id (optional)
Long format: int64
sql_itr_id (optional)
Integer format: int32
sql_itr_left (optional)
Long format: int64
sql_itr_right (optional)
Long format: int64
sql_itr_sender (optional)
Long format: int64
sql_itr_nxtsender (optional)
Long format: int64
sql_itr_cost (optional)
Long format: int64
sql_itr_estrows (optional)
Long format: int64
sql_itr_numrows (optional)
Long format: int64
sql_itr_type (optional)
Long format: int64
sql_itr_misc (optional)
Integer format: int32
sql_itr_info (optional)
String
sql_itr_time (optional)
Float format: float
sql_itr_partnum (optional)
Long format: int64
sql_itr_table (optional)
String

Job_statusSqlResponse Up

data (optional)
array[Job_statusSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Job_statusSqlResponse_data Up

js_command (optional)
DatabasesSqlSessionsMoreResponse_tabname
js_comment (optional)
DatabasesSqlSessionsMoreResponse_tabname
js_done (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
js_id (optional)
DatabasesSqlSessionsMoreResponse_flags
js_result (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
js_seq (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
js_start (optional)
DatabasesSqlSessionsMoreResponse_tabname
js_task (optional)
DatabasesSqlSessionsMoreResponse_flags

LRUWritesResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
LRUWritesResponse_type

LRUWritesResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
LRUWritesResponse_type_meta
fromPackage (optional)
Boolean

LRUWritesResponse_type_meta Up

default (optional)
LRUWritesResponse_type_meta_default
metrics (optional)
LRUWritesResponse_type_meta_metrics

LRUWritesResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
collapse (optional)
ChunkwritesResponse_type_meta_default_collapse
delta (optional)
array[String]
Enum:

LRUWritesResponse_type_meta_metrics Up

type (optional)
Object
lruwrites_total (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_2K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_4K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_6K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_8K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_10K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_12K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_14K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
lruwrites_16K (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

LRUWritesServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
LRUWritesResponse_type

LocalesResource Up

dbLocales (optional)
array[Object]

LockListResponse Up

owner_user (optional)
String
owner_sid (optional)
Integer format: int32
wait_user (optional)
String
wait_sid (optional)
String
lock_type (optional)
String
locked_object (optional)
String
lk_rowid (optional)
Integer format: int32
lk_partnum (optional)
Integer format: int32
lk_start_time (optional)
SqlTraceResponse_info_starttime

LockPerSessionResponse Up

sid (optional)
Integer format: int32
user (optional)
String
hostname (optional)
String
ses_num_locks (optional)
Integer format: int32
ses_req_locks (optional)
Integer format: int32
ses_wai_locks (optional)
Integer format: int32
ses_dead_locks (optional)
Integer format: int32
ses_lock_tout (optional)
Integer format: int32
odb_dbname (optional)
String
txt (optional)
String
ses_connected (optional)
SqlTraceResponse_info_starttime

LockPerTableResponse Up

dbsname (optional)
String
tabname (optional)
String
lockcnt (optional)
Integer format: int32
lockreq (optional)
Long format: int64
lockwaits (optional)
Integer format: int32
deadlocks (optional)
Integer format: int32
locktimeouts (optional)
Integer format: int32

LogicalLogInfoResponse Up

number (optional)
Integer format: int32
uniqueid (optional)
Integer format: int32
total_pages (optional)
Integer format: int32
used_pages (optional)
Integer format: int32
percent_used (optional)
Integer format: int32
location (optional)
Integer format: int32
filltime (optional)
Integer format: int32
status (optional)
String
flags (optional)
Integer format: int32
pps (optional)
Integer format: int32
total_size (optional)
BigDecimal format: int32
used_size (optional)
Integer format: int32

LogsAdminAPIResponse Up

cmd_number (optional)
Integer format: int32
cmd_exec_time (optional)
SqlTraceResponse_info_starttime
cmd_user (optional)
String
cmd_hostname (optional)
String
cmd_executed (optional)
String
cmd_ret_status (optional)
Integer format: int32
cmd_ret_msg (optional)
String

LogsBaractlogResponse Up

message (optional)
String
offset (optional)
Integer format: int32

LogsResource Up

onBarLogsRotationConfigurations (optional)
BSONObject
onlineLogsRotationConfigurations (optional)
BSONObject

MemoryRequest Up

lmm_enable (optional)
Integer Value can be 0 or 1. If value is 1 means low memory manager is enabled and if 0 then low memory manager is disabled. format: int32
Enum:
0
1
lmm_idle_time (optional)
Integer format: int32
lmm_restart (optional)
Boolean
lmm_start_threshold (optional)
String
lmm_stop_threshold (optional)
String

MemoryResource Up

bufferPoolInfo (optional)
BSONObject
memoryInfo (optional)
BSONObject

MemoryResponse Up

total_mem (optional)
Long format: int64
used_mem (optional)
Long format: int64
os_mem_free (optional)
Long format: int64
os_mem_total (optional)
Long format: int64
os_mem_used (optional)
Long format: int64
session_count (optional)
Integer format: int32
max_ses_mem (optional)
Long format: int64
avg_ses_mem (optional)
Long format: int64

MemorySegmentsResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
MemorySegmentsResponse_type

MemorySegmentsResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
MemorySegmentsResponse_type_meta
fromPackage (optional)
Boolean

MemorySegmentsResponse_type_meta Up

default (optional)
MemorySensorResponse_type_meta_default
metrics (optional)
MemorySegmentsResponse_type_meta_metrics

MemorySegmentsResponse_type_meta_metrics Up

seg_class (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
seg_size (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
seg_used (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
seg_free (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

MemorySegmentsServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
MemorySegmentsResponse_type

MemorySensorResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
MemorySensorResponse_type

MemorySensorResponse_type Up

id (optional)
String
description (optional)
String
name (optional)
String
meta (optional)
MemorySensorResponse_type_meta
fromPackage (optional)
Boolean

MemorySensorResponse_type_meta Up

default (optional)
MemorySensorResponse_type_meta_default
metrics (optional)
MemorySensorResponse_type_meta_metrics

MemorySensorResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String

MemorySensorResponse_type_meta_metrics Up

type (optional)
Object
allocated_mem (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
used_mem (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
free_mem (optional)
OperatingSystemCPUResponse_type_meta_metrics_user

MemorySensorServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
MemorySensorResponse_type

ModifyChunkRequest Up

action (optional)
String Name of storage space
Enum:
modify
extend
extendable (optional)
Integer Required if action is modify. Value can be 0 or 1. If value is 1 means this chunk is extendable and if 0 then it is not. format: int32
Enum:
0
1
extend_size (optional)
String Required if action is extend.
offset (optional)
Integer format: int32

ModifySpaceRequest Up

action (optional)
String Name of storage space
Enum:
modify
expand
expand_size (optional)
String Required if action is expand.
create_size (optional)
Long Required if action is modify. format: int64
extend_size (optional)
Long Required if action is modify. format: int64

Mon_checkpointSqlResponse Up

data (optional)
array[Mon_checkpointSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_checkpointSqlResponse_cp_time Up

value (optional)
Float format: float

Mon_checkpointSqlResponse_data Up

block_time (optional)
DatabasesSqlSessionsMoreResponse_flags
caller (optional)
DatabasesSqlSessionsMoreResponse_tabname
ckpt_logid (optional)
DatabasesSqlSessionsMoreResponse_flags
ckpt_logpos (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
clock_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
cp_time (optional)
Mon_checkpointSqlResponse_cp_time
crit_time (optional)
Mon_checkpointSqlResponse_cp_time
dskflush_per_sec (optional)
DatabasesSqlSessionsMoreResponse_flags
flush_time (optional)
Mon_checkpointSqlResponse_cp_time
id (optional)
DatabasesSqlSessionsMoreResponse_flags
intvl (optional)
DatabasesSqlSessionsMoreResponse_flags
llogs_per_sec (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
logused (optional)
DatabasesSqlSessionsMoreResponse_flags
longest_crit_wait (optional)
DatabasesSqlSessionsMoreResponse_flags
n_crit_waits (optional)
DatabasesSqlSessionsMoreResponse_flags
n_dirty_buffs (optional)
DatabasesSqlSessionsMoreResponse_flags
physused (optional)
DatabasesSqlSessionsMoreResponse_flags
plogs_per_sec (optional)
DatabasesSqlSessionsMoreResponse_flags
tot_crit_wait (optional)
Mon_checkpointSqlResponse_tot_crit_wait
type (optional)
DatabasesSqlSessionsMoreResponse_tabname

Mon_checkpointSqlResponse_tot_crit_wait Up

value (optional)
Double format: double

Mon_checkpointSqlSessionIdResponse Up

data (optional)
array[Mon_checkpointSqlSessionIdResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_checkpointSqlSessionIdResponse_data Up

dbsnum (optional)
DatabasesSqlSessionsMoreResponse_flags
id (optional)
DatabasesSqlSessionsMoreResponse_flags
nfree (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
number (optional)
DatabasesSqlSessionsMoreResponse_flags
pagesread (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
pageswritten (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
reads (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
readtime (optional)
Mon_checkpointSqlResponse_cp_time
udfree (optional)
DatabasesSqlSessionsMoreResponse_flags
writes (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
writetime (optional)
Mon_checkpointSqlResponse_cp_time

Mon_compression_estimatesSqlResponse Up

data (optional)
array[Mon_compression_estimatesSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_compression_estimatesSqlResponse_data Up

est_date (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
est_dbname (optional)
DatabasesSqlSessionsMoreResponse_tabname
est_estimate (optional)
DatabasesSqlSessionsMoreResponse_tabname
est_owner (optional)
DatabasesSqlSessionsMoreResponse_tabname
est_partnum (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
est_tabname (optional)
DatabasesSqlSessionsMoreResponse_tabname
id (optional)
Aus_cmd_compSqlResponse_aus_cmd_id

Mon_configSqlResponse Up

data (optional)
array[Mon_configSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_configSqlResponse_data Up

config_id (optional)
DatabasesSqlSessionsMoreResponse_flags
config_value (optional)
DatabasesSqlSessionsMoreResponse_tabname
id (optional)
Aus_cmd_compSqlResponse_aus_cmd_id

Mon_iohistSqlResponse Up

data (optional)
array[Mon_iohistSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_iohistSqlResponse_data Up

gfd (optional)
DatabasesSqlSessionsMoreResponse_flags
id (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
read_ops_minute (optional)
DatabasesSqlSessionsMoreResponse_flags
read_time_minute (optional)
DatabasesSqlSessionsMoreResponse_flags
time (optional)
DatabasesSqlSessionsMoreResponse_flags
write_ops_minute (optional)
DatabasesSqlSessionsMoreResponse_flags
write_time_minute (optional)
DatabasesSqlSessionsMoreResponse_flags

Mon_memory_systemSqlResponse Up

data (optional)
array[Mon_memory_systemSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_memory_systemSqlResponse_data Up

class (optional)
DatabasesSqlSessionsMoreResponse_flags
free (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
id (optional)
DatabasesSqlSessionsMoreResponse_flags
used (optional)
DatabasesSqlSessionsMoreResponse_flags

Mon_onconfigSqlResponse Up

data (optional)
array[Mon_onconfigSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_onconfigSqlResponse_data Up

id (optional)
DatabasesSqlSessionsMoreResponse_flags
name (optional)
DatabasesSqlSessionsMoreResponse_tabname
value (optional)
Aus_cmd_compSqlResponse_aus_cmd_id

Mon_page_usageSqlResponse Up

data (optional)
array[Mon_page_usageSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_page_usageSqlResponse_data Up

dbsnum (optional)
DatabasesSqlSessionsMoreResponse_flags
free (optional)
DatabasesSqlSessionsMoreResponse_flags
id (optional)
DatabasesSqlSessionsMoreResponse_flags
lockid (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
mostly_used (optional)
DatabasesSqlSessionsMoreResponse_flags
nextns (optional)
DatabasesSqlSessionsMoreResponse_flags
nptotal (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
npused (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
nrows (optional)
DatabasesSqlSessionsMoreResponse_flags
partly_used (optional)
DatabasesSqlSessionsMoreResponse_flags
partnum (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
run_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
type (optional)
DatabasesSqlSessionsMoreResponse_tabname
very_full (optional)
DatabasesSqlSessionsMoreResponse_flags

Mon_sysSqltrace_infoSqlResponse Up

data (optional)
array[Mon_sysSqltrace_infoSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_sysSqltrace_infoSqlResponse_data Up

id (optional)
DatabasesSqlSessionsMoreResponse_flags
orig_sql_id (optional)
DatabasesSqlSessionsMoreResponse_flags
serial_id (optional)
DatabasesSqlSessionsMoreResponse_flags
task_id (optional)
DatabasesSqlSessionsMoreResponse_flags

Mon_sysenvSqlResponse Up

data (optional)
array[Mon_sysenvSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_sysenvSqlResponse_data Up

id (optional)
DatabasesSqlSessionsMoreResponse_flags
name (optional)
DatabasesSqlSessionsMoreResponse_tabname
value (optional)
DatabasesSqlSessionsMoreResponse_tabname

Mon_table_namesSqlResponse Up

data (optional)
array[Mon_table_namesSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_table_namesSqlResponse_data Up

created (optional)
Long format: int64
dbsname (optional)
DatabasesSqlSessionsMoreResponse_tabname
id (optional)
DatabasesSqlSessionsMoreResponse_flags
lockid (optional)
DatabasesSqlSessionsMoreResponse_flags
owner (optional)
DatabasesSqlSessionsMoreResponse_tabname
partnum (optional)
DatabasesSqlSessionsMoreResponse_flags
tabname (optional)
DatabasesSqlSessionsMoreResponse_tabname

Mon_table_profileSqlResponse Up

data (optional)
array[Mon_table_profileSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_table_profileSqlResponse_data Up

id (optional)
DatabasesSqlSessionsMoreResponse_flags
lockid (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
nextns (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
npdata (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
nptotal (optional)
DatabasesSqlSessionsMoreResponse_flags
npused (optional)
DatabasesSqlSessionsMoreResponse_tabname
nrows (optional)
DatabasesSqlSessionsMoreResponse_flags
ocount (optional)
DatabasesSqlSessionsMoreResponse_tabname
partnum (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
pf_bfcread (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_bfcwrite (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_dskreads (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_dskwrites (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_isdelete (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_isread (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_isrwrite (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_iswrite (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_lockwait (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_rqlock (optional)
DatabasesSqlSessionsMoreResponse_flags
pf_seqscans (optional)
DatabasesSqlSessionsMoreResponse_flags
serialval (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
ucount (optional)
DatabasesSqlSessionsMoreResponse_flags

Mon_usersSqlResponse Up

data (optional)
array[Mon_usersSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_usersSqlResponse_data Up

hostname (optional)
DatabasesSqlSessionsMoreResponse_tabname
id (optional)
DatabasesSqlSessionsMoreResponse_flags
iowaittime (optional)
Mon_checkpointSqlResponse_cp_time
lkwaittime (optional)
DatabasesSqlSessionsMoreResponse_flags
memtotal (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
memused (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
net_last_read (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
net_last_write (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
net_open_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
net_read_bytes (optional)
DatabasesSqlSessionsMoreResponse_flags
net_read_cnt (optional)
DatabasesSqlSessionsMoreResponse_flags
net_write_bytes (optional)
DatabasesSqlSessionsMoreResponse_flags
net_write_cnt (optional)
DatabasesSqlSessionsMoreResponse_flags
nlocks (optional)
DatabasesSqlSessionsMoreResponse_flags
pid (optional)
DatabasesSqlSessionsMoreResponse_flags
progname (optional)
DatabasesSqlSessionsMoreResponse_tabname
sid (optional)
DatabasesSqlSessionsMoreResponse_flags
uid (optional)
DatabasesSqlSessionsMoreResponse_flags
upf_bufreads (optional)
DatabasesSqlSessionsMoreResponse_flags
upf_bufwrites (optional)
DatabasesSqlSessionsMoreResponse_flags
upf_deadlk (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_diskreads (optional)
DatabasesSqlSessionsMoreResponse_flags
upf_diskwrites (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_dsksorts (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_idxbufreads (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_iscommit (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_isdelete (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_isread (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_isrollback (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_isrwrite (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_lgrecs (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_lktouts (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_logspmax (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_logspuse (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_longtxs (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_niowaits (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_rqlock (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_seqscans (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_srtspmax (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_totsorts (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
upf_wtlock (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
username (optional)
DatabasesSqlSessionsMoreResponse_tabname
wreason (optional)
DatabasesSqlSessionsMoreResponse_flags

Mon_vpsSqlResponse Up

data (optional)
array[Mon_vpsSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Mon_vpsSqlResponse_data Up

class (optional)
DatabasesSqlSessionsMoreResponse_flags
id (optional)
DatabasesSqlSessionsMoreResponse_flags
num_ready (optional)
DatabasesSqlSessionsMoreResponse_flags
usecs_sys (optional)
DatabasesSqlSessionsMoreResponse_flags
usecs_user (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
vpid (optional)
DatabasesSqlSessionsMoreResponse_flags

MonitoringEffectiveProfile Up

sensors (optional)
array[Sensor]

MonitoringEffectiveResponse Up

sensors (optional)
array[Sensor]

MonitoringGroupIdSensorIdDataLatestResponse Up

timestamp (optional)
Long format: int64
data (optional)
MonitoringOnedbSensorIdDataLatestResponse_data

MonitoringOnedbSensorIdDataLatestResponse Up

timestamp (optional)
Long format: int64
data (optional)
MonitoringOnedbSensorIdDataLatestResponse_data

MonitoringOnedbSensorIdDataLatestResponse_data Up

count (optional)
Integer format: int32
files (optional)
array[Object]

MonitoringProfile Up

owner (optional)
OneDBServerGroupChild
sensors (optional)
array[Sensor]

MonitoringProfileResource Up

profile (optional)
BSONObject
effectiveProfile (optional)
BSONObject

MonitoringProfileResponse Up

own (optional)
MonitoringProfileResponse_own
inherited (optional)
MonitoringProfileResponse_own

MonitoringProfileResponse_own Up

sensors (optional)
array[Sensor]

MonitoringResponse Up

own (optional)
MonitoringProfileResponse_own
inherited (optional)
MonitoringProfileResponse_own

MovePhysicalLogRequest Up

dbspace (optional)
String
size (optional)
Long format: int64

MultipleOnConfigRequest Up

name (optional)
String Name of Config Parameter
value (optional)
String Value of Config Parameter

NewChunksRequest Up

create_from_storage_pool (optional)
Boolean
space_name (optional)
String Name of storage space
path (optional)
String
size (optional)
Long format: int64
offset (optional)
Integer format: int32

NewOneDBServerRequest Up

groupId (optional)
Long format: int64
alias (optional)
String
hostname (optional)
String
serviceName (optional)
String
port (optional)
Integer format: int32
monitorUser (optional)
String
monitorPassword (optional)
String
adminUser (optional)
String
adminPassword (optional)
String
connectionProperties (optional)
Object

NewSpaceRequest Up

create_from_storage_pool (optional)
Boolean
extend_size (optional)
Double format: double
create_size (optional)
Double format: double
name (optional)
String Name of storage space
offset (optional)
Integer format: int32
path (optional)
String
size (optional)
String
page_size (optional)
String
type (optional)
String

OnBarConfigResponse Up

maxFiles (optional)
Integer format: int32
rotationEnabled (optional)
Boolean
rotationFrequency (optional)
BigDecimal format: int32

OnConfigResponse Up

id (optional)
Integer format: int32
name (optional)
String Name of Config Parameter
effective (optional)
String Value of Config Parameter
flags (optional)
Integer format: int32
type (optional)
String
dynamic (optional)
Integer If 1 then this parameter is editable at run time otherwise cannot edit at run time. format: int32

OnLineLogRotationResponse Up

maxFiles (optional)
Integer format: int32
rotationEnabled (optional)
Boolean
rotationFrequency (optional)
BigDecimal format: int32

OnconfigResource Up

OneDBDashboardResource Up

dashboardServerInfo (optional)
BSONObject
dashboardStoragePerformanceInfo (optional)
BSONObject

OneDBIndexesResource Up

OneDBProfileResponse Up

pf_dskreads (optional)
Integer format: int32
pf_bufreads (optional)
Integer format: int32
pf_dskwrites (optional)
Integer format: int32
pf_bufwrites (optional)
Integer format: int32
pf_isamtot (optional)
Integer format: int32
pf_isopens (optional)
Integer format: int32
pf_isstarts (optional)
Integer format: int32
pf_isreads (optional)
Integer format: int32
pf_iswrites (optional)
Integer format: int32
pf_isrewrites (optional)
Integer format: int32
pf_isdeletes (optional)
Integer format: int32
pf_iscommits (optional)
Integer format: int32
pf_isrollbacks (optional)
Integer format: int32
pf_ovlock (optional)
Integer format: int32
pf_ovuser (optional)
Integer format: int32
pf_buffwts (optional)
Integer format: int32
pf_lockreqs (optional)
Integer format: int32
pf_lockwts (optional)
Integer format: int32
pf_ckptwts (optional)
Integer format: int32
pf_deadlks (optional)
Integer format: int32
pf_lktouts (optional)
Integer format: int32
pf_numckpts (optional)
Integer format: int32
pf_pagreads (optional)
Integer format: int32
pf_pagwrites (optional)
Integer format: int32
pf_flushes (optional)
Integer format: int32
pf_compress (optional)
Integer format: int32
pf_fgwrites (optional)
Integer format: int32
pf_seqscans (optional)
Integer format: int32

OneDBReportsResource Up

OneDBServerGroup Up

id (optional)
Long format: int64
monitoringProfile (optional)
MonitoringProfile
effectiveMonitoringProfile (optional)
MonitoringProfile
alertingProfile (optional)
AlertingCriteriaProfile
parentGroup (optional)
OneDBServerGroup
name (optional)
String
dashboards (optional)
array[Dashboard]
root (optional)
Boolean
childServersRecursive (optional)
array[OneDBServerResponse]
childServers (optional)
array[OneDBServerResponse]
childGroups (optional)
array[OneDBServerGroup]
allEffectiveUserPermissions (optional)
array[EntryUserEnumSetOneDBServerPermission]
parentAlertingProfile (optional)
AlertingCriteriaProfile
allUserPermissions (optional)
array[EntryUserEnumSetOneDBServerPermission]

OneDBServerGroupChild Up

id (optional)
Long format: int64
monitoringProfile (optional)
MonitoringProfile
effectiveMonitoringProfile (optional)
MonitoringProfile
alertingProfile (optional)
AlertingCriteriaProfile
parentGroup (optional)
OneDBServerGroup
allEffectiveUserPermissions (optional)
array[EntryUserEnumSetOneDBServerPermission]
parentAlertingProfile (optional)
AlertingCriteriaProfile
allUserPermissions (optional)
array[EntryUserEnumSetOneDBServerPermission]

OneDBServerIDPermissionsEffectiveResponse Up

OneDBServerResponse Up

id (optional)
Long format: int64
parentGroupId (optional)
Long format: int64
alias (optional)
String
hostname (optional)
String
serviceName (optional)
String
port (optional)
Integer format: int32
monitorUser (optional)
String
hasMonitorPassword (optional)
Boolean
adminUser (optional)
String
hasAdminPassword (optional)
Boolean
agent (optional)
AgentResponse
status (optional)
Object
unreadIncidents (optional)
Long format: int64
permissions (optional)
Object
connectionProperties (optional)
Object

OneDBServerStatusResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OneDBServerStatusResponse_type

OneDBServerStatusResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OneDBServerStatusResponse_type_meta
fromPackage (optional)
Boolean

OneDBServerStatusResponse_type_meta Up

default (optional)
OneDBServerStatusResponse_type_meta_default
metrics (optional)
OneDBServerStatusResponse_type_meta_metrics

OneDBServerStatusResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32

OneDBServerStatusResponse_type_meta_metrics Up

status (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

OneDBServerStatusServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OneDBServerStatusResponse_type

OneDbGroupIdResponse Up

id (optional)
Integer format: int32

OnlineLogResponse Up

message (optional)
String
offset (optional)
Integer format: int32

OnlineLogSensorResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OnlineLogSensorResponse_type

OnlineLogSensorResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OnlineLogSensorResponse_type_meta
fromPackage (optional)
Boolean

OnlineLogSensorResponse_type_meta Up

default (optional)
OnlineLogSensorResponse_type_meta_default
metrics (optional)
OnlineLogSensorResponse_type_meta_metrics

OnlineLogSensorResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32

OnlineLogSensorResponse_type_meta_metrics Up

message (optional)
HighAvailabilityConnectionStatusResponse_type_meta_metrics_connection_status

OnlineLogSensorServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OnlineLogSensorResponse_type

OperatingSystemCPUResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemCPUResponse_type

OperatingSystemCPUResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OperatingSystemCPUResponse_type_meta
fromPackage (optional)
Boolean

OperatingSystemCPUResponse_type_meta Up

type (optional)
Object
default (optional)
OperatingSystemCPUResponse_type_meta_default
metrics (optional)
OperatingSystemCPUResponse_type_meta_metrics
chart (optional)
SensorTypeMeta_chart

OperatingSystemCPUResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
scanDuration (optional)
Integer format: int32
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32

OperatingSystemCPUResponse_type_meta_metrics Up

type (optional)
Object
user (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
system (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
idle (optional)
OperatingSystemCPUResponse_type_meta_metrics_idle
wait (optional)
OperatingSystemCPUResponse_type_meta_metrics_user

OperatingSystemCPUResponse_type_meta_metrics_idle Up

name (optional)
String
unit (optional)
String
showChart (optional)
Boolean

OperatingSystemCPUResponse_type_meta_metrics_user Up

name (optional)
String
unit (optional)
String

OperatingSystemCPUServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemCPUResponse_type

OperatingSystemCPUperCoreResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemCPUperCoreResponse_type

OperatingSystemCPUperCoreResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OperatingSystemCPUperCoreResponse_type_meta
fromPackage (optional)
Boolean

OperatingSystemCPUperCoreResponse_type_meta Up

default (optional)
OperatingSystemCPUperCoreResponse_type_meta_default
metrics (optional)
OperatingSystemCPUResponse_type_meta_metrics
chart (optional)
SensorTypeMeta_chart

OperatingSystemCPUperCoreResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
scanDuration (optional)
Integer format: int32
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
primaryKey (optional)
SensorTypeMeta_default_primaryKey

OperatingSystemCPUperCoreServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemCPUperCoreResponse_type

OperatingSystemDiskIOResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemDiskIOResponse_type

OperatingSystemDiskIOResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OperatingSystemDiskIOResponse_type_meta
fromPackage (optional)
Boolean

OperatingSystemDiskIOResponse_type_meta Up

default (optional)
OperatingSystemCPUperCoreResponse_type_meta_default
metrics (optional)
OperatingSystemDiskIOResponse_type_meta_metrics

OperatingSystemDiskIOResponse_type_meta_metrics Up

dk_reads (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
dk_rkb (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
dk_writes (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
dk_wkb (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
dk_busy (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
dk_busy_read (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
dk_busy_write (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
chart (optional)
AlertingEffectiveGroupIdResponse_trigger

OperatingSystemDiskIOServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemDiskIOResponse_type

OperatingSystemDiskUtilizationResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemDiskUtilizationResponse_type

OperatingSystemDiskUtilizationResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OperatingSystemDiskUtilizationResponse_type_meta
fromPackage (optional)
Boolean

OperatingSystemDiskUtilizationResponse_type_meta Up

default (optional)
OperatingSystemDiskUtilizationResponse_type_meta_default
metrics (optional)
OperatingSystemDiskUtilizationResponse_type_meta_metrics

OperatingSystemDiskUtilizationResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
primaryKey (optional)
SensorTypeMeta_default_primaryKey

OperatingSystemDiskUtilizationResponse_type_meta_metrics Up

size (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
used (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
free (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
percent_used (optional)
OperatingSystemCPUResponse_type_meta_metrics_user

OperatingSystemDiskUtilizationServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemDiskUtilizationResponse_type

OperatingSystemMemoryResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemMemoryResponse_type

OperatingSystemMemoryResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OperatingSystemMemoryResponse_type_meta
fromPackage (optional)
Boolean

OperatingSystemMemoryResponse_type_meta Up

default (optional)
OnlineLogSensorResponse_type_meta_default
metrics (optional)
OperatingSystemMemoryResponse_type_meta_metrics

OperatingSystemMemoryResponse_type_meta_metrics Up

type (optional)
Object
mem_used (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
mem_free (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
mem_total (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
swap_used (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
swap_free (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
swap_total (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
chart (optional)
AlertingEffectiveGroupIdResponse_trigger

OperatingSystemMemoryServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemMemoryResponse_type

OperatingSystemNetworkIOResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemNetworkIOResponse_type

OperatingSystemNetworkIOResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
OperatingSystemNetworkIOResponse_type_meta
fromPackage (optional)
Boolean

OperatingSystemNetworkIOResponse_type_meta Up

default (optional)
OperatingSystemNetworkIOResponse_type_meta_default
metrics (optional)
OperatingSystemNetworkIOResponse_type_meta_metrics

OperatingSystemNetworkIOResponse_type_meta_default Up

type (optional)
String
subtype (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
primaryKey (optional)
SensorTypeMeta_default_primaryKey
delta (optional)
array[String]
Enum:

OperatingSystemNetworkIOResponse_type_meta_metrics Up

receive_bytes (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
receive_packets (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
transmit_bytes (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
transmit_packets (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
chart (optional)
AlertingEffectiveGroupIdResponse_trigger

OperatingSystemNetworkIOServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
OperatingSystemNetworkIOResponse_type

OperatorClassesResource Up

operatorClassesDetails (optional)
BSONObject

Panel Up

x (optional)
Integer format: int32
y (optional)
Integer format: int32
width (optional)
Integer format: int32
height (optional)
Integer format: int32
title (optional)
String
type (optional)
String
config (optional)
Panel_config

Panel_config Up

dataSources (optional)
array[Panel_config_dataSources]
dataSeries (optional)
array[DataSeries]
yAxes (optional)
array[Panel_config_yAxes]
chartType (optional)
String
databaseName (optional)
String Required if isCustomQuery is true
queryString (optional)
String Required if isCustomQuery is true
isCustomQuery (optional)
Boolean

Panel_config_dataSources Up

sensorType (optional)
String

Panel_config_yAxes Up

type (optional)
String
min (optional)
Integer format: int32
max (optional)
Integer format: int32
label (optional)
String

PermissionsEffectiveResponse Up

PermissionsEffectiveResponse_inner Up

user (optional)
Object
permissions (optional)
Integer format: int32

PermissionsResource Up

allEffectivePermissions (optional)
BSONObject
allPermissions (optional)
BSONObject

PermissionsResponse Up

own (optional)
MonitoringProfileResponse_own
inherited (optional)
MonitoringProfileResponse_own

PermissionsUserIDResponse Up

permissions (optional)
Integer format: int32
effective (optional)
Long format: int64

PermissionsUserIdRequest Up

permissions (optional)
Integer format: int32

PermissionsUserResource Up

own (optional)
EntryUserEnumSetOneDBServerPermission
inherited (optional)
EntryUserEnumSetOneDBServerPermission

Ph_alertSqlResponse Up

data (optional)
array[Ph_alertSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_alertSqlResponse_data Up

alert_action (optional)
DatabasesSqlSessionsMoreResponse_flags
alert_action_dbs (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_color (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_message (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_object_info (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
alert_object_name (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_object_type (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_state (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_state_changed (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
alert_task_id (optional)
DatabasesSqlSessionsMoreResponse_flags
alert_task_seq (optional)
DatabasesSqlSessionsMoreResponse_flags
alert_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
alert_type (optional)
DatabasesSqlSessionsMoreResponse_tabname
id (optional)
DatabasesSqlSessionsMoreResponse_flags

Ph_alerts_SqlResponse Up

data (optional)
array[Ph_alerts_SqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_alerts_SqlResponse_data Up

alert_action (optional)
DatabasesSqlSessionsMoreResponse_flags
alert_action_dbs (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_color (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_id (optional)
DatabasesSqlSessionsMoreResponse_flags
alert_message (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_object_info (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
alert_object_name (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_object_type (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_state (optional)
DatabasesSqlSessionsMoreResponse_tabname
alert_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
alert_type (optional)
DatabasesSqlSessionsMoreResponse_tabname
run_id (optional)
DatabasesSqlSessionsMoreResponse_flags
task_description (optional)
DatabasesSqlSessionsMoreResponse_tabname
task_id (optional)
DatabasesSqlSessionsMoreResponse_flags
task_name (optional)
DatabasesSqlSessionsMoreResponse_tabname

Ph_bg_jobs_SqlResponse Up

data (optional)
array[Ph_bg_jobs_SqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_bg_jobs_SqlResponse_data Up

ph_bg_cmd (optional)
DatabasesSqlSessionsMoreResponse_tabname
ph_bg_database (optional)
DatabasesSqlSessionsMoreResponse_tabname
ph_bg_desc (optional)
DatabasesSqlSessionsMoreResponse_tabname
ph_bg_flags (optional)
DatabasesSqlSessionsMoreResponse_flags
ph_bg_id (optional)
DatabasesSqlSessionsMoreResponse_flags
ph_bg_job_id (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
ph_bg_name (optional)
DatabasesSqlSessionsMoreResponse_tabname
ph_bg_sequence (optional)
Aus_cmd_compSqlResponse_aus_cmd_id
ph_bg_stop_on_error (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
ph_bg_type (optional)
DatabasesSqlSessionsMoreResponse_tabname

Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error Up

value (optional)
Boolean

Ph_bg_jobs_resultsSqlResponse Up

data (optional)
array[Ph_bg_jobs_resultsSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_bg_jobs_resultsSqlResponse_data Up

ph_bgr_bg_id (optional)
DatabasesSqlSessionsMoreResponse_flags
ph_bgr_id (optional)
DatabasesSqlSessionsMoreResponse_flags
ph_bgr_retcode (optional)
DatabasesSqlSessionsMoreResponse_flags
ph_bgr_retcode2 (optional)
DatabasesSqlSessionsMoreResponse_flags
ph_bgr_retmsg (optional)
DatabasesSqlSessionsMoreResponse_tabname
ph_bgr_starttime (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
ph_bgr_stoptime (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
ph_bgr_tk_id (optional)
DatabasesSqlSessionsMoreResponse_flags
ph_bgr_tk_sequence (optional)
Aus_cmd_compSqlResponse_aus_cmd_id

Ph_configSqlResponse Up

data (optional)
array[Ph_configSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_configSqlResponse_data Up

id (optional)
DatabasesSqlSessionsMoreResponse_flags
name (optional)
DatabasesSqlSessionsMoreResponse_tabname
task_name (optional)
DatabasesSqlSessionsMoreResponse_tabname
value (optional)
DatabasesSqlSessionsMoreResponse_tabname
value_type (optional)
DatabasesSqlSessionsMoreResponse_tabname

Ph_groupSqlResponse Up

data (optional)
array[Ph_groupSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_groupSqlResponse_data Up

group_description (optional)
DatabasesSqlSessionsMoreResponse_tabname
group_id (optional)
DatabasesSqlSessionsMoreResponse_flags
group_name (optional)
DatabasesSqlSessionsMoreResponse_tabname

Ph_runSqlResponse Up

data (optional)
array[Ph_runSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_runSqlResponse_data Up

run_btime (optional)
DatabasesSqlSessionsMoreResponse_flags
run_duration (optional)
Mon_checkpointSqlResponse_cp_time
run_id (optional)
DatabasesSqlSessionsMoreResponse_flags
run_mttime (optional)
DatabasesSqlSessionsMoreResponse_flags
run_retcode (optional)
DatabasesSqlSessionsMoreResponse_flags
run_task_id (optional)
DatabasesSqlSessionsMoreResponse_flags
run_task_seq (optional)
DatabasesSqlSessionsMoreResponse_flags
run_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
run_ztime (optional)
Aus_cmd_compSqlResponse_aus_cmd_id

Ph_taskSqlResponse Up

data (optional)
array[Ph_taskSqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_taskSqlResponse_data Up

tk_attributes (optional)
DatabasesSqlSessionsMoreResponse_flags
tk_create (optional)
DatabasesSqlSessionsMoreResponse_flags
tk_dbs (optional)
DatabasesSqlSessionsMoreResponse_tabname
tk_delete (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
tk_description (optional)
DatabasesSqlSessionsMoreResponse_tabname
tk_enable (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
tk_execute (optional)
DatabasesSqlSessionsMoreResponse_tabname
tk_frequency (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
tk_friday (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
tk_group (optional)
DatabasesSqlSessionsMoreResponse_tabname
tk_id (optional)
DatabasesSqlSessionsMoreResponse_flags
tk_monday (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
tk_name (optional)
DatabasesSqlSessionsMoreResponse_tabname
tk_next_execution (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
tk_priority (optional)
DatabasesSqlSessionsMoreResponse_flags
tk_result_table (optional)
DatabasesSqlSessionsMoreResponse_tabname
tk_saturday (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
tk_sequence (optional)
DatabasesSqlSessionsMoreResponse_flags
tk_start_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
tk_stop_time (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
tk_sunday (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
tk_thursday (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
tk_total_executions (optional)
DatabasesSqlSessionsMoreResponse_flags
tk_total_time (optional)
Mon_checkpointSqlResponse_tot_crit_wait
tk_tuesday (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error
tk_type (optional)
DatabasesSqlSessionsMoreResponse_tabname
tk_wednesday (optional)
Ph_bg_jobs_SqlResponse_ph_bg_stop_on_error

Ph_threshold_SqlResponse Up

data (optional)
array[Ph_threshold_SqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_threshold_SqlResponse_data Up

description (optional)
DatabasesSqlSessionsMoreResponse_tabname
id (optional)
DatabasesSqlSessionsMoreResponse_flags
name (optional)
DatabasesSqlSessionsMoreResponse_tabname
task_name (optional)
DatabasesSqlSessionsMoreResponse_tabname
value (optional)
DatabasesSqlSessionsMoreResponse_tabname
value_type (optional)
DatabasesSqlSessionsMoreResponse_tabname

Ph_version_SqlResponse Up

data (optional)
array[Ph_version_SqlResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

Ph_version_SqlResponse_data Up

object (optional)
DatabasesSqlSessionsMoreResponse_tabname
type (optional)
DatabasesSqlSessionsMoreResponse_tabname
value (optional)
DatabasesSqlSessionsMoreResponse_flags

PhysicalLogResponse Up

location (optional)
Integer format: int32
total_pages (optional)
Integer format: int32
used_pages (optional)
Integer format: int32
buffer_pages (optional)
Integer format: int32
start_position_pages (optional)
Integer format: int32
dbspace (optional)
String
total_size (optional)
BigDecimal format: int32
used_size (optional)
Integer format: int32
buffer_size (optional)
Integer format: int32
start_offset (optional)
Integer format: int32

PoliciesResponse Up

task_info (optional)
PoliciesResponse_task_info
task_parameters (optional)
array[PoliciesResponse_task_parameters]

PoliciesResponse_task_info Up

tk_id (optional)
Integer format: int32
tk_name (optional)
String
tk_description (optional)
String
tk_type (optional)
String
tk_sequence (optional)
Long format: int64
tk_result_table (optional)
String
tk_create (optional)
String
tk_dbs (optional)
String
tk_execute (optional)
String
tk_delete (optional)
PoliciesResponse_task_info_tk_delete
tk_start_time (optional)
PoliciesResponse_task_info_tk_start_time
tk_stop_time (optional)
String format: dateTime
tk_frequency (optional)
PoliciesResponse_task_info_tk_delete
tk_next_execution (optional)
date format: date
tk_total_executions (optional)
date format: date
tk_total_time (optional)
String format: dateTime
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean
tk_attributes (optional)
Long format: int64
tk_group (optional)
String
tk_enable (optional)
Boolean
tk_priority (optional)
Long format: int64

PoliciesResponse_task_info_tk_delete Up

IntervalDF (optional)
PoliciesResponse_task_info_tk_delete_IntervalDF

PoliciesResponse_task_info_tk_delete_IntervalDF Up

seconds (optional)
String format: dateTime
nanoseconds (optional)
String format: dateTime

PoliciesResponse_task_info_tk_start_time Up

date (optional)
String format: dateTime

PoliciesResponse_task_parameters Up

id (optional)
Integer format: int32
name (optional)
String
task_name (optional)
String
value (optional)
String
value_type (optional)
String
description (optional)
String

PrivilegesResource Up

adminPrivilegesInfo (optional)
BSONObject
internalUsers (optional)
BSONObject

ProceduresResource Up

proceduresDetails (optional)
BSONObject

ProfileStatisticsResource Up

threads (optional)
BSONObject
profile (optional)
BSONObject

ProfileThreadResponse Up

tid (optional)
Integer format: int32
name (optional)
String
address (optional)
Integer format: int32
state (optional)
Integer format: int32
statedesc (optional)
String
statedetail (optional)
String
priority (optional)
Integer format: int32
vpclass (optional)
Integer format: int32
vpid (optional)
Integer format: int32
last_run_time (optional)
Integer format: int32
cpu_time (optional)
Float format: float
num_sched (optional)
Integer format: int32

RLogsResponse Up

plog (optional)
RLogsResponse_plog
llog (optional)
array[RLogsResponse_llog]

RLogsResponse_llog Up

number (optional)
Integer format: int32
uniqueid (optional)
Integer format: int32
total_pages (optional)
Integer format: int32
used_pages (optional)
Integer format: int32
percent_used (optional)
Integer format: int32
location (optional)
Integer format: int32
filltime (optional)
Integer format: int32
status (optional)
String
flags (optional)
Integer format: int32
pps (optional)
Integer format: int32
total_size (optional)
BigDecimal format: int32
used_size (optional)
Integer format: int32

RLogsResponse_plog Up

location (optional)
Integer format: int32
total_pages (optional)
Integer format: int32
used_pages (optional)
Integer format: int32
buffer_pages (optional)
Integer format: int32
start_position_pages (optional)
Integer format: int32
dbspace (optional)
String
total_size (optional)
BigDecimal format: int32
used_size (optional)
Integer format: int32
buffer_size (optional)
Integer format: int32
start_offset (optional)
Integer format: int32

RecoveryLogsResource Up

recoveryLogInfo (optional)
BSONObject
logicalLogInfo (optional)
BSONObject
physicalLogInfo (optional)
BSONObject

ResourceContext Up

ResultSet Up

type (optional)
Integer format: int32
closed (optional)
Boolean
fetchDirection (optional)
Integer format: int32
fetchSize (optional)
Integer format: int32
concurrency (optional)
Integer format: int32
cursorName (optional)
String
row (optional)
Integer format: int32
statement (optional)
Statement
afterLast (optional)
Boolean
beforeFirst (optional)
Boolean
first (optional)
Boolean
last (optional)
Boolean
holdability (optional)
Integer format: int32
metaData (optional)
ResultSetMetaData
warnings (optional)
SQLWarning

ResultSetMetaData Up

columnCount (optional)
Integer format: int32

RevokeAdminPrivilegedUserRequest Up

userName (optional)
String
lastModified (optional)
date format: date
privilegeTypes (optional)
array[String] List of privileges

RevokeDbPrivilegedUserRequest Up

userName (optional)
String
privilegeType (optional)
String
defaultRole (optional)
String

RevokeInternalPrivilegedUserRequest Up

userName (optional)
String

RevokeSchedulerTaskResponse Up

tk_id (optional)
Integer format: int32
tk_name (optional)
String
tk_description (optional)
String
tk_type (optional)
String
Enum:
TASK
SENSOR
STARTUP TASK
STARTUP SENSOR
tk_sequence (optional)
Long format: int64
tk_result_table (optional)
String
tk_attributes (optional)
Long format: int64
tk_create (optional)
String
tk_dbs (optional)
String
tk_execute (optional)
String
tk_delete (optional)
BakupsTasksLevel0Response_level0_tk_frequency
tk_start_time (optional)
SqlTraceResponse_info_starttime
tk_stop_time (optional)
SqlTraceResponse_info_starttime
tk_frequency (optional)
BakupsTasksLevel0Response_level0_tk_frequency
tk_next_execution (optional)
SqlTraceResponse_info_starttime
tk_total_executions (optional)
Long format: int64
tk_total_time (optional)
Double format: double
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean
tk_group (optional)
String
tk_enable (optional)
Boolean
tk_priority (optional)
Integer format: int32

RevokeTablePrivilegedUserRequest Up

tableName (optional)
String
grantee (optional)
String
grantor (optional)
String
tabAuth (optional)
array[String] List of table authentication
Enum:

RevokeTaskIDParametersResponse Up

RevokeTaskIDParametersResponse_inner Up

current_state (optional)
Integer format: int32
description (optional)
String
id (optional)
Integer format: int32
name (optional)
String
task_name (optional)
String
value (optional)
Integer format: int32
value_type (optional)
String

SLAConnectionsResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
SLAConnectionsResponse_type

SLAConnectionsResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
SLAConnectionsResponse_type_meta
fromPackage (optional)
Boolean

SLAConnectionsResponse_type_meta Up

default (optional)
DBSpaceUsageResponse_type_meta_default
metrics (optional)
SLAConnectionsResponse_type_meta_metrics

SLAConnectionsResponse_type_meta_metrics Up

connections (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

SLAConnectionsServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
SLAConnectionsResponse_type

SLAInfo Up

slaName (optional)
String
dbServers (optional)
String
port (optional)
String
policy (optional)
String
mode (optional)
String
workers (optional)
String
useAliases (optional)
String

SMXInfoResponse Up

name (optional)
String
numberOfNetworkPipes (optional)
Integer format: int32
type (optional)
String
encryptionStatus (optional)
String
bytesSent (optional)
Long format: int64
bytesReceived (optional)
Long format: int64
retriesForWriteCall (optional)
Long format: int64
compressionStatus (optional)
String

SQLException Up

cause (optional)
Throwable
stackTrace (optional)
array[StackTraceElement]
errorCode (optional)
Integer format: int32
nextException (optional)
SQLException
sqlstate (optional)
String
localizedMessage (optional)
String
message (optional)
String
suppressed (optional)
array[Throwable]

SQLResource Up

more (optional)
map[String, Object]

SQLSessionManager Up

SQLSessionResource Up

resourceContext (optional)
ResourceContext
databladesResource (optional)
DatabladesResource
aggregatesResource (optional)
AggregatesResource
operatorClassesResource (optional)
OperatorClassesResource
proceduresResource (optional)
ProceduresResource
sequenceInfoResource (optional)
SequencesResource
tablesResource (optional)
TablesResource
userDefinedTypesResource (optional)
UserDefinedTypesResource
sqlresource (optional)
SQLResource
castsResource (optional)
CastsResource

SQLSessionsResource Up

resourceContext (optional)
ResourceContext

SQLWarning Up

cause (optional)
Throwable
stackTrace (optional)
array[StackTraceElement]
nextWarning (optional)
SQLWarning
errorCode (optional)
Integer format: int32
nextException (optional)
SQLException
sqlstate (optional)
String
localizedMessage (optional)
String
message (optional)
String
suppressed (optional)
array[Throwable]

SchedulerGroupsResponse Up

group_id (optional)
Integer format: int32
group_name (optional)
String
group_description (optional)
String

SchedulerResource Up

allTasks (optional)
BSONObject
runHistory (optional)
array[Object]

SchedulerTaskIDParametersRequest Up

SchedulerTaskIDParametersRequest_inner Up

current_state (optional)
Integer format: int32
description (optional)
String
name (optional)
String
task_name (optional)
String
value (optional)
Integer format: int32
value_type (optional)
String

SchedulerTaskRequest Up

tk_name (optional)
String
tk_description (optional)
String
tk_type (optional)
String
Enum:
TASK
SENSOR
STARTUP TASK
STARTUP SENSOR
tk_result_table (optional)
String
tk_create (optional)
String
tk_delete (optional)
Date format: date-time
tk_execute (optional)
String
tk_start_time (optional)
SqlTraceResponse_info_starttime
tk_stop_time (optional)
SqlTraceResponse_info_starttime
tk_frequency (optional)
BakupsTasksLevel0Response_level0_tk_next_execution
tk_group (optional)
String
tk_enable (optional)
Boolean
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean

SchedulerTasksIDResponse Up

tk_id (optional)
Integer format: int32
tk_name (optional)
String
tk_description (optional)
String
tk_type (optional)
String
tk_sequence (optional)
Integer format: int32
tk_result_table (optional)
String
tk_create (optional)
String
tk_dbs (optional)
String
tk_execute (optional)
String
tk_delete (optional)
SchedulerTasksResponse_tk_frequency
tk_start_time (optional)
SqlTraceResponse_info_starttime
tk_stop_time (optional)
SqlTraceResponse_info_starttime
tk_frequency (optional)
SchedulerTasksResponse_tk_frequency
tk_next_execution (optional)
SqlTraceResponse_info_starttime
tk_total_executions (optional)
Integer format: int32
tk_total_time (optional)
Integer format: int32
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean
tk_attributes (optional)
Integer format: int32
tk_group (optional)
String
tk_enable (optional)
Boolean
tk_priority (optional)
Integer format: int32

SchedulerTasksParametersResponse Up

id (optional)
Integer format: int32
name (optional)
String
task_name (optional)
String
value (optional)
String
value_type (optional)
String
description (optional)
String

SchedulerTasksResponse Up

tk_id (optional)
Integer format: int32
tk_type (optional)
String
tk_name (optional)
String
tk_group (optional)
String
tk_start_time (optional)
SqlTraceResponse_info_starttime
tk_frequency (optional)
SchedulerTasksResponse_tk_frequency
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean
tk_enable (optional)
Boolean
tk_next_execution (optional)
SqlTraceResponse_info_starttime

SchedulerTasksResponse_tk_frequency Up

IntervalDF (optional)
SchedulerTasksResponse_tk_frequency_IntervalDF

SchedulerTasksResponse_tk_frequency_IntervalDF Up

seconds (optional)
Date format: date-time
nanoseconds (optional)
Date format: date-time

SchedulerTasksRunsHistoryResponse Up

SchedulerTasksRunsHistoryResponse_inner Up

tk_id (optional)
Integer format: int32
tk_total_executions (optional)
Long format: int64
tk_average_time (optional)
Double format: double
tk_total_time (optional)
Double format: double
tk_run_time (optional)
Object
tk_run_retcode (optional)
Integer format: int32
tk_name (optional)
String

Sensor Up

runInterval (optional)
Long Interval in seconds on which sensor will execute. format: int64
dataRetentionInterval (optional)
Long Retention interval in days by when explore will cleanup the agent repository data. format: int64
disabled (optional)
Boolean
type (optional)
SensorType

SensorDataMetaResponse Up

SensorDataResource Up

sensorDataMeta (optional)
BSONObject

SensorResource Up

sensor (optional)
BSONObject
sensorDataResource (optional)
SensorDataResource

SensorType Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
SensorTypeMeta
fromPackage (optional)
Boolean

SensorTypeIdDataResponse Up

id (optional)
String
data (optional)
GroupIdSensorDataResponse_data

SensorTypeIdRequest Up

type (optional)
String
runInterval (optional)
Long Interval in seconds on which sensor will execute. format: int64
dataRetentionInterval (optional)
Long Retention interval in days by when explore will cleanup the agent repository data. format: int64
disabled (optional)
Boolean

SensorTypeMeta Up

default (optional)
SensorTypeMeta_default
metrics (optional)
SensorTypeMeta_metrics
chart (optional)
SensorTypeMeta_chart

SensorTypeMeta_chart Up

type (optional)
String
stacked (optional)
Boolean
minY (optional)
Long format: int64
maxY (optional)
Long format: int64

SensorTypeMeta_default Up

type (optional)
String
subtype (optional)
String
scanDuration (optional)
Long format: int64
serverTypes (optional)
array[String]
delta (optional)
array[String]
collapse (optional)
SensorTypeMeta_default_collapse
sleepBetweenExecution (optional)
Long format: int64
dataRetentionInterval (optional)
Long Retention interval in days by when explore will cleanup the agent repository data. format: int64
sql (optional)
String
primaryKey (optional)
SensorTypeMeta_default_primaryKey
unique (optional)
array[String]
defaults (optional)
Object Can contain multiple metric_name with the associated default value

SensorTypeMeta_default_collapse Up

key (optional)
String
value (optional)
String

SensorTypeMeta_default_primaryKey Up

name (optional)
String
type (optional)
String

SensorTypeMeta_metrics Up

metric_name (optional)
SensorTypeMeta_metrics_metric_name

SensorTypeMeta_metrics_metric_name Up

metric_name will be different for each sensors
name (optional)
String
unit (optional)
String

SensorTypeMetricMeta Up

id (optional)
String
name (optional)
String
dataType (optional)
String
unit (optional)
String

SequencesResource Up

sequencesDetails (optional)
BSONObject

SequentialScansResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
SequentialScansResponse_type

SequentialScansResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
SequentialScansResponse_type_meta
fromPackage (optional)
Boolean

SequentialScansResponse_type_meta Up

default (optional)
SequentialScansResponse_type_meta_default
metrics (optional)
SequentialScansResponse_type_meta_metrics

SequentialScansResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
collapse (optional)
ChunkwritesResponse_type_meta_default_collapse
delta (optional)
array[String]
Enum:

SequentialScansResponse_type_meta_metrics Up

type (optional)
Object
seqscans (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

SequentialScansServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
SequentialScansResponse_type

ServerHostInfoResponse Up

os_name (optional)
String
os_release (optional)
String
os_nodename (optional)
String
os_version (optional)
String
os_machine (optional)
String
os_num_procs (optional)
Integer format: int32
os_num_olprocs (optional)
Integer format: int32
os_pagesize (optional)
Integer format: int32
os_mem_total (optional)
Integer format: int32
os_mem_free (optional)
Integer format: int32
os_open_file_lim (optional)
Integer format: int32

ServerHostResource Up

hostOSInfo (optional)
BSONObject

ServerInfoResource Up

serverInfo (optional)
BSONObject
systemReportResource (optional)
OneDBReportsResource
serverHighAvailabilityResource (optional)
HighAvailabilityResource
monitoringProfileResource (optional)
MonitoringProfileResource
alertingResource (optional)
AlertingCriteriaProfileResource
configurationResource (optional)
OnconfigResource
recoveryLogsResource (optional)
RecoveryLogsResource
oneDBDashboardResource (optional)
OneDBDashboardResource
serverHostResource (optional)
ServerHostResource
privilegesResource (optional)
PrivilegesResource
localesResource (optional)
LocalesResource
autoUpdateStatsResource (optional)
AutoUpdateStatsResource
sessionsResource (optional)
SessionsResource
virtualProcessorResource (optional)
VirtualProcessorResource
backupResource (optional)
BackupResource
memoryResource (optional)
MemoryResource
profileResource (optional)
ProfileStatisticsResource
enterpriseReplicationResource (optional)
EnterpriseReplicationResource
storageResource (optional)
StorageResource
connectionManagerResource (optional)
ConnectionManagerResource
databasesResource (optional)
DatabasesResource
checkpointsResource (optional)
CheckpointsResource
alertingIncidentsResource (optional)
AlertingIncidentsResource
permissionsResource (optional)
PermissionsResource
schedulerResource (optional)
SchedulerResource
iwaresource (optional)
WarehouseResource
agentResource (optional)
AgentResource
serverStatus (optional)
BSONObject
logsResource (optional)
LogsResource

ServerInfoResponse Up

name (optional)
String
id (optional)
Long format: int64
idException (optional)
String
type (optional)
String
status (optional)
String
connectionStatus (optional)
String
updatable (optional)
String
workload (optional)
Double format: double
lagtime (optional)
Double format: double
approxLogBacklog (optional)
String

SessionActivityResponse Up

user (optional)
String
hostname (optional)
String
progname (optional)
String
sid (optional)
Integer format: int32
pid (optional)
Integer format: int32
cpu_time (optional)
Float format: float
io_wait_time (optional)
Float format: float
isreads (optional)
Integer format: int32
iswrites (optional)
Integer format: int32
isrewrites (optional)
Integer format: int32
isdeletes (optional)
Integer format: int32
iscommits (optional)
Integer format: int32
isrollbacks (optional)
Integer format: int32
pf_seqscans (optional)
Integer format: int32
pagereads (optional)
Integer format: int32
pagewrites (optional)
Integer format: int32
max_sortdiskspace (optional)
Integer format: int32
waitingfor (optional)
String

SessionStatisticsResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
SessionStatisticsResponse_type

SessionStatisticsResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
SessionStatisticsResponse_type_meta
fromPackage (optional)
Boolean

SessionStatisticsResponse_type_meta Up

default (optional)
MemorySensorResponse_type_meta_default
metrics (optional)
SessionStatisticsResponse_type_meta_metrics

SessionStatisticsResponse_type_meta_metrics Up

session_count (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
max_session_memory (optional)
OperatingSystemCPUResponse_type_meta_metrics_user
average_session_memory (optional)
OperatingSystemCPUResponse_type_meta_metrics_user

SessionStatisticsServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
SessionStatisticsResponse_type

SessionsIdResponse Up

sid (optional)
Integer format: int32
username (optional)
String
hostname (optional)
String
userid (optional)
Integer format: int32
gid (optional)
Integer format: int32
pid (optional)
Integer format: int32
progname (optional)
String
connected (optional)
Long format: int64
mem_total (optional)
Long format: int64
mem_used (optional)
Long format: int64
nfiles (optional)
Integer format: int32
current_statement (optional)
String
environment (optional)
array[SessionsIdResponse_environment]
locks (optional)
array[SessionsIdResponse_locks]
memory (optional)
array[SessionsIdResponse_memory]
network (optional)
array[Integer]
profile (optional)
SessionsIdResponse_profile
sql (optional)
array[String]
threads (optional)
array[SessionsIdResponse_threads]

SessionsIdResponse_environment Up

name (optional)
String
value (optional)
String
source (optional)
String

SessionsIdResponse_lock_duration Up

IntervalDF (optional)
SessionsIdResponse_lock_duration_IntervalDF

SessionsIdResponse_lock_duration_IntervalDF Up

seconds (optional)
Long format: int64
nanoseconds (optional)
Float format: float

SessionsIdResponse_locks Up

table_name (optional)
String
lock_type (optional)
String
lock_duration (optional)
SessionsIdResponse_lock_duration
waiter (optional)
String
rowid (optional)
String
index_number (optional)
Integer format: int32
key_item_locked (optional)
String

SessionsIdResponse_memory Up

name (optional)
String
used (optional)
Long format: int64
free (optional)
Long format: int64

SessionsIdResponse_profile Up

nlocks (optional)
Integer format: int32
nfiles (optional)
Integer format: int32
lock_requests (optional)
Long format: int64
lock_waits (optional)
Integer format: int32
deadlocks (optional)
Integer format: int32
lock_timeouts (optional)
Integer format: int32
log_records (optional)
Long format: int64
rows_processed (optional)
Long format: int64
rows_inserted (optional)
Long format: int64
rows_updated (optional)
Long format: int64
rows_deleted (optional)
Long format: int64
commits (optional)
Integer format: int32
rollbacks (optional)
Integer format: int32
longtxs (optional)
Integer format: int32
bufreads (optional)
Integer format: int32
bufwrites (optional)
Integer format: int32
log_space (optional)
Integer format: int32
log_space_max (optional)
Integer format: int32
seqscans (optional)
Integer format: int32
fg_reads (optional)
Integer format: int32
fg_writes (optional)
Integer format: int32
total_sorts (optional)
Float format: float
disk_sorts (optional)
Integer format: int32
memory_sorts (optional)
Integer format: int32
max_sort (optional)
Integer format: int32

SessionsIdResponse_threads Up

name (optional)
String
thread_id (optional)
Long format: int64
wait_reason (optional)
String
num_scheduled (optional)
Long format: int64
total_time (optional)
Double format: double
time_slice (optional)
Double format: double
vpid (optional)
Integer format: int32
thread_priority (optional)
Long format: int64

SessionsResource Up

sessionSummary (optional)
BSONObject
sessionList (optional)
BSONObject

SessionsResponse Up

sid (optional)
Integer format: int32
username (optional)
String
pid (optional)
Integer format: int32
hostname (optional)
String
connected (optional)
Long format: int64
mem_total (optional)
Long format: int64
io_wait_time (optional)
Float format: float
cpu_time (optional)
Float format: float
is_killable (optional)
Integer format: int32

SessionsSummaryResponse Up

total_sessions (optional)
Integer format: int32
max_session_memory (optional)
Long format: int64
average_session_memory (optional)
Double format: double

SetOptimizePoliciesRequest Up

tk_start_time (optional)
SqlTraceResponse_info_starttime
tk_stop_time (optional)
SqlTraceResponse_info_starttime
tk_frequency (optional)
BakupsTasksLevel0Response_level0_tk_next_execution
tk_monday (optional)
Boolean
tk_tuesday (optional)
Boolean
tk_wednesday (optional)
Boolean
tk_thursday (optional)
Boolean
tk_friday (optional)
Boolean
tk_saturday (optional)
Boolean
tk_sunday (optional)
Boolean
tk_enable (optional)
Boolean
compress (optional)
String
compress_threshold (optional)
String
repack (optional)
String
removeIPA (optional)
String
repack_threshold (optional)
String
shrink (optional)
String
shrink_threshold (optional)
String
defragment (optional)
String
defragment_threshold (optional)
String

SingleOnConfigRequest Up

option (optional)
String 'wm' indicates save the value memory only, 'wf' indicates save to memory and the onconfig file.
Enum:
wf
wm
value (optional)
String Value of Config Parameter

SlowestSqlResponse Up

sql_sid (optional)
Long format: int64
sql_id (optional)
Long format: int64
sql_uid (optional)
Long format: int64
sql_stmttype (optional)
Long format: int64
sql_stmtname (optional)
String
finishtime (optional)
Long format: int64
runtime (optional)
Double format: double
sql_pgreads (optional)
Long format: int64
sql_bfreads (optional)
Long format: int64
sql_bfidxreads (optional)
Long format: int64
sql_bfwrites (optional)
Long format: int64
sql_pgwrites (optional)
Long format: int64
rdcache (optional)
Double format: double
wrcache (optional)
Double format: double
databufreads (optional)
Integer format: int32
sql_lockreq (optional)
Long format: int64
lockwait (optional)
Long format: int64
logspace (optional)
Long format: int64
sql_sorttotal (optional)
Long format: int64
sql_sortdisk (optional)
Long format: int64
sql_sortmem (optional)
Long format: int64
sql_numtables (optional)
Long format: int64
sql_numiterators (optional)
Long format: int64
sql_executions (optional)
Long format: int64
sql_totaltime (optional)
Double format: double
sql_avgtime (optional)
Double format: double
totaltime (optional)
Float format: float
avgtime (optional)
Float format: float
maxtime (optional)
Float format: float
sql_numiowaits (optional)
Long format: int64
iowait (optional)
Integer format: float
avgiowaits (optional)
Double format: double
rowspersec (optional)
Float format: float
sql_estcost (optional)
Long format: int64
sql_estrows (optional)
Long format: int64
sql_actualrows (optional)
Long format: int64
sql_sqlerror (optional)
Long format: int64
sql_isamerror (optional)
Long format: int64
sql_isollevel (optional)
Long format: int64
sql_statement (optional)
String
sql_database (optional)
String
sqlmemory (optional)
Long format: int64
sql_pdq (optional)
String
sql_num_hvars (optional)
Integer format: int32
query_plan (optional)
array[SlowestSqlResponse_query_plan]

SlowestSqlResponse_query_plan Up

sql_id (optional)
Long format: int64
sql_itr_id (optional)
Integer format: int32
sql_itr_left (optional)
Long format: int64
sql_itr_right (optional)
Long format: int64
sql_itr_sender (optional)
Long format: int64
sql_itr_nxtsender (optional)
Long format: int64
sql_itr_cost (optional)
Long format: int64
sql_itr_estrows (optional)
Long format: int64
sql_itr_numrows (optional)
Long format: int64
sql_itr_type (optional)
Long format: int64
sql_itr_misc (optional)
Integer format: int32
sql_itr_info (optional)
String
sql_itr_time (optional)
Float format: float
sql_itr_partnum (optional)
Long format: int64

SpaceResponse Up

dbsnum (optional)
Integer format: int32
name (optional)
String Name of storage space
type (optional)
String
status (optional)
String
Enum:
recovering
operational
flags (optional)
Integer format: int32
last_backup (optional)
String
size (optional)
Long format: int64
free_size (optional)
Long format: int64
percent_used (optional)
Float format: float
nchunks (optional)
Integer Number of chunks in this space format: int32
page_size (optional)
Long format: int64
extend_size (optional)
Float format: float
create_size (optional)
Float format: float
expandable (optional)
Integer Required if action is modify. Value can be 0 or 1. If value is 1 means this chunk is expandable and if 0 then it is not. format: int32
Enum:
0
1

SqlHighestEstimatedCostResponse Up

sql_sid (optional)
Long format: int64
sql_id (optional)
Long format: int64
sql_uid (optional)
Long format: int64
sql_stmttype (optional)
Long format: int64
sql_stmtname (optional)
String
finishtime (optional)
Long format: int64
runtime (optional)
Double format: double
sql_pgreads (optional)
Long format: int64
sql_bfreads (optional)
Long format: int64
sql_bfidxreads (optional)
Long format: int64
sql_bfwrites (optional)
Long format: int64
sql_pgwrites (optional)
Long format: int64
rdcache (optional)
Double format: double
wrcache (optional)
Double format: double
databufreads (optional)
Integer format: int32
sql_lockreq (optional)
Long format: int64
lockwait (optional)
Long format: int64
logspace (optional)
Long format: int64
sql_sorttotal (optional)
Long format: int64
sql_sortdisk (optional)
Long format: int64
sql_sortmem (optional)
Long format: int64
sql_numtables (optional)
Long format: int64
sql_numiterators (optional)
Long format: int64
sql_executions (optional)
Long format: int64
sql_totaltime (optional)
Double format: double
sql_avgtime (optional)
Double format: double
totaltime (optional)
Float format: float
avgtime (optional)
Float format: float
maxtime (optional)
Float format: float
sql_numiowaits (optional)
Long format: int64
iowait (optional)
Integer format: float
avgiowaits (optional)
Double format: double
rowspersec (optional)
Float format: float
sql_estcost (optional)
Long format: int64
sql_estrows (optional)
Long format: int64
sql_actualrows (optional)
Long format: int64
sql_sqlerror (optional)
Long format: int64
sql_isamerror (optional)
Long format: int64
sql_isollevel (optional)
Long format: int64
sql_statement (optional)
String
sql_database (optional)
String
sqlmemory (optional)
Long format: int64
sql_pdq (optional)
String
sql_num_hvars (optional)
Integer format: int32
query_plan (optional)
array[SlowestSqlResponse_query_plan]

SqlIdResponse Up

sql_id (optional)
Integer format: int32
sql_sid (optional)
Integer format: int32
sql_uid (optional)
Integer format: int32
sql_stmttype (optional)
Long format: int64
sql_stmtname (optional)
String
sql_finishtime (optional)
Long format: int64
sql_runtime (optional)
Float format: float
sql_pgreads (optional)
Long format: int64
sql_bfreads (optional)
Long format: int64
sql_bfwrites (optional)
Long format: int64
sql_pgwrites (optional)
Long format: int64
sql_rdcache (optional)
Float format: float
sql_wrcache (optional)
Float format: float
sql_lockreq (optional)
Long format: int64
sql_lockwaits (optional)
Long format: int64
sql_lockwttime (optional)
Float format: float
sql_logspace (optional)
Long format: int64
sql_sorttotal (optional)
Long format: int64
sql_sortdisk (optional)
Long format: int64
sql_sortmem (optional)
Long format: int64
sql_numtables (optional)
Long format: int64
sql_numiterators (optional)
Long format: int64
sql_executions (optional)
Long format: int64
sql_totaltime (optional)
Double format: double
sql_avgtime (optional)
Double format: double
sql_maxtime (optional)
Float format: float
sql_numiowaits (optional)
Long format: int64
sql_totaliowaits (optional)
Double format: double
sql_avgiowaits (optional)
Double format: double
sql_rowspersec (optional)
Float format: float
sql_estcost (optional)
Long format: int64
sql_estrows (optional)
Long format: int64
sql_actualrows (optional)
Long format: int64
sql_sqlerror (optional)
Long format: int64
sql_isamerror (optional)
Long format: int64
sql_isollevel (optional)
Long format: int64
sql_statement (optional)
String
sql_database (optional)
String
sql_sqlmemory (optional)
Long format: int64
sql_pdq (optional)
Integer format: int32
sql_num_hvars (optional)
Integer format: int32
hvars (optional)
array[SqlIdResponse_hvars]

SqlIdResponse_hvars Up

sql_hvar_id (optional)
Integer format: int32
sql_hvar_type (optional)
String
sql_hvar_data (optional)
String

SqlMostBufferActivityResponse Up

sql_sid (optional)
Long format: int64
sql_id (optional)
Long format: int64
sql_uid (optional)
Long format: int64
sql_stmttype (optional)
Long format: int64
sql_stmtname (optional)
String
finishtime (optional)
Long format: int64
runtime (optional)
Double format: double
sql_pgreads (optional)
Long format: int64
sql_bfreads (optional)
Long format: int64
sql_bfidxreads (optional)
Long format: int64
sql_bfwrites (optional)
Long format: int64
sql_pgwrites (optional)
Long format: int64
rdcache (optional)
Double format: double
wrcache (optional)
Double format: double
databufreads (optional)
Integer format: int32
sql_lockreq (optional)
Long format: int64
lockwait (optional)
Long format: int64
logspace (optional)
Long format: int64
sql_sorttotal (optional)
Long format: int64
sql_sortdisk (optional)
Long format: int64
sql_sortmem (optional)
Long format: int64
sql_numtables (optional)
Long format: int64
sql_numiterators (optional)
Long format: int64
sql_executions (optional)
Long format: int64
sql_totaltime (optional)
Double format: double
sql_avgtime (optional)
Double format: double
totaltime (optional)
Float format: float
avgtime (optional)
Float format: float
maxtime (optional)
Float format: float
sql_numiowaits (optional)
Long format: int64
iowait (optional)
Integer format: float
avgiowaits (optional)
Double format: double
rowspersec (optional)
Float format: float
sql_estcost (optional)
Long format: int64
sql_estrows (optional)
Long format: int64
sql_actualrows (optional)
Long format: int64
sql_sqlerror (optional)
Long format: int64
sql_isamerror (optional)
Long format: int64
sql_isollevel (optional)
Long format: int64
sql_statement (optional)
String
sql_database (optional)
String
sqlmemory (optional)
Long format: int64
sql_pdq (optional)
String
sql_num_hvars (optional)
Integer format: int32
query_plan (optional)
array[SlowestSqlResponse_query_plan]

SqlMostIOTimeResponse Up

sql_sid (optional)
Long format: int64
sql_id (optional)
Long format: int64
sql_uid (optional)
Long format: int64
sql_stmttype (optional)
Long format: int64
sql_stmtname (optional)
String
finishtime (optional)
Long format: int64
runtime (optional)
Double format: double
sql_pgreads (optional)
Long format: int64
sql_bfreads (optional)
Long format: int64
sql_bfidxreads (optional)
Long format: int64
sql_bfwrites (optional)
Long format: int64
sql_pgwrites (optional)
Long format: int64
rdcache (optional)
Double format: double
wrcache (optional)
Double format: double
databufreads (optional)
Integer format: int32
sql_lockreq (optional)
Long format: int64
lockwait (optional)
Long format: int64
logspace (optional)
Long format: int64
sql_sorttotal (optional)
Long format: int64
sql_sortdisk (optional)
Long format: int64
sql_sortmem (optional)
Long format: int64
sql_numtables (optional)
Long format: int64
sql_numiterators (optional)
Long format: int64
sql_executions (optional)
Long format: int64
sql_totaltime (optional)
Double format: double
sql_avgtime (optional)
Double format: double
totaltime (optional)
Float format: float
avgtime (optional)
Float format: float
maxtime (optional)
Float format: float
sql_numiowaits (optional)
Long format: int64
iowait (optional)
Integer format: float
avgiowaits (optional)
Double format: double
rowspersec (optional)
Float format: float
sql_estcost (optional)
Long format: int64
sql_estrows (optional)
Long format: int64
sql_actualrows (optional)
Long format: int64
sql_sqlerror (optional)
Long format: int64
sql_isamerror (optional)
Long format: int64
sql_isollevel (optional)
Long format: int64
sql_statement (optional)
String
sql_database (optional)
String
sqlmemory (optional)
Long format: int64
sql_pdq (optional)
String
sql_num_hvars (optional)
Integer format: int32
query_plan (optional)
array[SlowestSqlResponse_query_plan]

SqlMostMemoryResponse Up

sql_sid (optional)
Long format: int64
sql_id (optional)
Long format: int64
sql_uid (optional)
Long format: int64
sql_stmttype (optional)
Long format: int64
sql_stmtname (optional)
String
finishtime (optional)
Long format: int64
runtime (optional)
Double format: double
sql_pgreads (optional)
Long format: int64
sql_bfreads (optional)
Long format: int64
sql_bfidxreads (optional)
Long format: int64
sql_bfwrites (optional)
Long format: int64
sql_pgwrites (optional)
Long format: int64
rdcache (optional)
Double format: double
wrcache (optional)
Double format: double
databufreads (optional)
Integer format: int32
sql_lockreq (optional)
Long format: int64
lockwait (optional)
Long format: int64
logspace (optional)
Long format: int64
sql_sorttotal (optional)
Long format: int64
sql_sortdisk (optional)
Long format: int64
sql_sortmem (optional)
Long format: int64
sql_numtables (optional)
Long format: int64
sql_numiterators (optional)
Long format: int64
sql_executions (optional)
Long format: int64
sql_totaltime (optional)
Double format: double
sql_avgtime (optional)
Double format: double
totaltime (optional)
Float format: float
avgtime (optional)
Float format: float
maxtime (optional)
Float format: float
sql_numiowaits (optional)
Long format: int64
iowait (optional)
Integer format: float
avgiowaits (optional)
Double format: double
rowspersec (optional)
Float format: float
sql_estcost (optional)
Long format: int64
sql_estrows (optional)
Long format: int64
sql_actualrows (optional)
Long format: int64
sql_sqlerror (optional)
Long format: int64
sql_isamerror (optional)
Long format: int64
sql_isollevel (optional)
Long format: int64
sql_statement (optional)
String
sql_database (optional)
String
sqlmemory (optional)
Long format: int64
sql_pdq (optional)
String
sql_num_hvars (optional)
Integer format: int32
query_plan (optional)
array[SlowestSqlResponse_query_plan]

SqlRequest Up

sql (optional)
String

SqlSessionIdResponse Up

id (optional)
Integer format: int32
username (optional)
String

SqlSessionIdTypeRequest Up

type (optional)
String

SqlSessionsTablesIndexResponse Up

createIndexQuery (optional)
String

SqlTraceConfigRequest Up

clear_buffer (optional)
Boolean
databases (optional)
array[String] list of databases to trace
ntraces (optional)
Long format: int64
state (optional)
String
trace_level (optional)
String
trace_mode (optional)
String
trace_size (optional)
Integer format: int32
users (optional)
array[String] list of databases to trace

SqlTraceConfigResponse Up

state (optional)
SqlTraceConfigResponse_state
level (optional)
SqlTraceConfigResponse_level
mode (optional)
SqlTraceConfigResponse_mode
ntraces (optional)
Double format: double
tracesize (optional)
Double format: double
flags (optional)
Double format: double
databases (optional)
SqlTraceResponse_config_databases
tracedUsers (optional)
array[Integer]

SqlTraceConfigResponse_level Up

type (optional)
String
Enum:
low
med
high

SqlTraceConfigResponse_mode Up

type (optional)
String
Enum:
global
User

SqlTraceConfigResponse_state Up

type (optional)
String
Enum:
on
off
suspend
resume

SqlTraceResponse Up

config (optional)
SqlTraceResponse_config
info (optional)
SqlTraceResponse_info

SqlTraceResponse_config Up

state (optional)
String
level (optional)
String
mode (optional)
String
ntraces (optional)
Double format: double
tracesize (optional)
Double format: double
flags (optional)
Long format: int64
databases (optional)
SqlTraceResponse_config_databases
tracedUsers (optional)
array[Integer]

SqlTraceResponse_config_databases Up

tracedDatabases (optional)
array[String]
Enum:
untracedDatabases (optional)
array[String]

SqlTraceResponse_info Up

starttime (optional)
SqlTraceResponse_info_starttime
starttrace (optional)
SqlTraceResponse_info_starttime
duration (optional)
Long format: int64
sqlseen (optional)
Long format: int64
sqlpersec (optional)
Float format: float
memoryused (optional)
Long format: int64
trc_procedures (optional)
Long format: int64
trc_tabnames (optional)
Long format: int64
trc_dbsname (optional)
Long format: int64
trc_hostvars (optional)
Long format: int64

SqlTraceResponse_info_starttime Up

date (optional)
date format: date

SqlTraceStatementsResponse Up

SqlTraceStatementsResponse_inner Up

sql_id (optional)
Integer format: int32
count (optional)
Integer format: int32
runtime (optional)
Float format: float
lockwait (optional)
Float format: float
iowait (optional)
Float format: float
sql_statement (optional)
String

SqltraceInfoResponse Up

starttime (optional)
PoliciesResponse_task_info_tk_start_time
starttrace (optional)
PoliciesResponse_task_info_tk_start_time
duration (optional)
Integer format: int32
sqlseen (optional)
Integer format: int32
sqlpersec (optional)
Double format: double
memoryused (optional)
Long format: int64
trc_procedures (optional)
Long format: int64
trc_tabnames (optional)
Long format: int64
trc_dbsname (optional)
Long format: int64
trc_hostvars (optional)
Long format: int64

SqltraceResource Up

sqltraceConfig (optional)
map[String, Object]
sqltraceStatementsByType (optional)
BSONObject
sqltraceSummary (optional)
BSONObject
sqltraceTransactions (optional)
BSONObject
sqltraceInfo (optional)
map[String, Object]

StackTraceElement Up

methodName (optional)
String
fileName (optional)
String
lineNumber (optional)
Integer format: int32
className (optional)
String
nativeMethod (optional)
Boolean

Statement Up

closed (optional)
Boolean
fetchDirection (optional)
Integer format: int32
fetchSize (optional)
Integer format: int32
largeMaxRows (optional)
Long format: int64
largeUpdateCount (optional)
Long format: int64
maxFieldSize (optional)
Integer format: int32
maxRows (optional)
Integer format: int32
moreResults (optional)
Boolean
resultSet (optional)
ResultSet
resultSetConcurrency (optional)
Integer format: int32
resultSetHoldability (optional)
Integer format: int32
resultSetType (optional)
Integer format: int32
updateCount (optional)
Integer format: int32
closeOnCompletion (optional)
Boolean
poolable (optional)
Boolean
connection (optional)
Connection
warnings (optional)
SQLWarning
queryTimeout (optional)
Integer format: int32
generatedKeys (optional)
ResultSet

StmttypesResponse Up

StmttypesResponse_inner Up

stmt_type (optional)
String
count (optional)
Long format: int64
avg_runtime (optional)
Double format: double
max_runtime (optional)
Double format: double
avg_mem (optional)
Double format: double
rows_processed (optional)
Long format: int64

StorageDatabaseDbnameRequest Up

action (optional)
String
objects (optional)
array[StorageDatabaseDbnameRequest_objects]

StorageDatabaseDbnameRequest_objects Up

owner (optional)
String
tabname (optional)
String
type (optional)
String
nrows (optional)
Long format: int64
nptotal (optional)
Long format: int64
npused (optional)
Long format: int64
extents (optional)
Long format: int64
compressed (optional)
String
is_fragment (optional)
Double format: double
used_size (optional)
Double format: double
free (optional)
Long format: int64
partly_used (optional)
Long format: int64
mostly_used (optional)
Long format: int64
very_full (optional)
Long format: int64
auto_compressed (optional)
String
uncompressed (optional)
String
has_blob_column (optional)
Boolean
fragments (optional)
array[Object] when dbname is sysadmin and condition is false
estimate (optional)
date format: date
running (optional)
Boolean
isChecked (optional)
Boolean

StorageDatabaseDbnameTrueRequest Up

action (optional)
String
objects (optional)
array[StorageDatabaseDbnameTrueRequest_objects]

StorageDatabaseDbnameTrueRequest_fragments Up

owner (optional)
String
isChecked (optional)
Boolean
nptotal (optional)
Long format: int64
is_fragment (optional)
Long format: int64
type (optional)
String
used_size (optional)
Long format: int64
npused (optional)
Long format: int64
nrows (optional)
Long format: int64
nextents (optional)
Long format: int64
compressed (optional)
String
auto_compressed (optional)
String
uncompressed (optional)
String
partnum (optional)
String
dbspace (optional)
String
tabname (optional)
String
estimate (optional)
date format: date

StorageDatabaseDbnameTrueRequest_objects Up

owner (optional)
String
tabname (optional)
String
type (optional)
String
nrows (optional)
Long format: int64
nptotal (optional)
Long format: int64
npused (optional)
Long format: int64
extents (optional)
Long format: int64
compressed (optional)
String
is_fragment (optional)
Double format: double
used_size (optional)
Double format: double
free (optional)
Long format: int64
partly_used (optional)
Long format: int64
mostly_used (optional)
Long format: int64
very_full (optional)
Long format: int64
auto_compressed (optional)
String
uncompressed (optional)
String
has_blob_column (optional)
Boolean
fragments (optional)
array[StorageDatabaseDbnameTrueRequest_fragments] when dbname is sysmaster and condition is true
estimate (optional)
date format: date
running (optional)
Boolean
isChecked (optional)
Boolean

StorageJobsResponse Up

StorageJobsResponse_inner Up

msg (optional)
String
js_id (optional)
Integer format: int32
js_task (optional)
Long format: int64
start (optional)
Object
end (optional)
Object
command (optional)
String
js_comment (optional)
String
running (optional)
Long format: int64
processed (optional)
Long format: int64
elapsed (optional)
Long format: int64
numrows (optional)
Long format: int64

StoragePoolIdRequest Up

size (optional)
Long format: int64
chunk_size (optional)
Long format: int64
priority (optional)
String
Enum:
High
Medium
Low

StoragePoolRequest Up

path (optional)
String
size (optional)
Long format: int64
offset (optional)
Long format: int64
chunk_size (optional)
Long format: int64
priority (optional)
String
Enum:
High
Medium
Low

StoragePoolResponse Up

StoragePoolResponse_inner Up

entry_id (optional)
Integer format: int32
path (optional)
String
offset (optional)
Long format: int64
device_size (optional)
Long format: int64
chunk_size (optional)
Long format: int64
priority (optional)
Long format: int64
status (optional)
String
last_accessed (optional)
Object
space_remaining (optional)
Long format: int64

StorageResource Up

optimizePolicies (optional)
BSONObject
storageSummary (optional)
BSONObject
backupInfo (optional)
BSONObject
chunks (optional)
BSONObject
dbSpaces (optional)
BSONObject
spaces (optional)
BSONObject
jobList (optional)
BSONObject

StorageResponse Up

dbspace_used (optional)
Long format: int64
dbspace_free (optional)
Long format: int64
tempspace_used (optional)
Long format: int64
tempspace_free (optional)
Long format: int64
blobspace_used (optional)
Long format: int64
blobspace_free (optional)
Long format: int64

StoragepoolSessionIdResponse Up

data (optional)
array[StoragepoolSessionIdResponse_data]
hasMore (optional)
Boolean
runTime (optional)
Integer format: int32

StoragepoolSessionIdResponse_data Up

beg_offset (optional)
DatabasesSqlSessionsMoreResponse_flags
chunk_size (optional)
DatabasesSqlSessionsMoreResponse_flags
end_offset (optional)
DatabasesSqlSessionsMoreResponse_flags
entry_id (optional)
DatabasesSqlSessionsMoreResponse_flags
last_alloc (optional)
Aus_cmd_compSqlResponse_aus_cmd_time
logid (optional)
DatabasesSqlSessionsMoreResponse_flags
logused (optional)
DatabasesSqlSessionsMoreResponse_flags
path (optional)
DatabasesSqlSessionsMoreResponse_tabname
priority (optional)
DatabasesSqlSessionsMoreResponse_flags
status (optional)
DatabasesSqlSessionsMoreResponse_tabname

SuccessResponse Up

ok (optional)
Boolean

SuccessResponseWithResult Up

return_code (optional)
Integer format: int32
result_message (optional)
String

SwitchLogicalLogRequest Up

database (optional)
String sysadmin database
Option_for_switch (optional)
array[SwitchLogicalLogRequest_Option_for_switch]

SwitchLogicalLogRequest_Option_for_switch Up

id (optional)
Long format: int64
Option (optional)
String format: int64
description (optional)
Object

TableBufferPoolActivityResponse Up

dbsname (optional)
String
tabname (optional)
String
buffered_pages (optional)
Integer format: int32
total_pages (optional)
Integer format: int32
total_rows (optional)
Integer format: int32
cache_percent (optional)
Float format: float

TableExtentsResponse Up

dbsname (optional)
String
tabname (optional)
String
size (optional)
Integer format: int32
nextents (optional)
Integer format: int32

TablePrivilegedUserRequest Up

tableName (optional)
String
grantee (optional)
String
grantor (optional)
String
privilegeTypes (optional)
array[String] List of table-level privileges

TablePrivilegedUserResponse Up

tableName (optional)
String
grantee (optional)
String
grantor (optional)
String
tabAuth (optional)
array[String] List of table authentication

TablesResource Up

resourceContext (optional)
ResourceContext
tables (optional)
array[Object]

ThreadCountsResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
ThreadCountsResponse_type

ThreadCountsResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
ThreadCountsResponse_type_meta
fromPackage (optional)
Boolean

ThreadCountsResponse_type_meta Up

default (optional)
ThreadCountsResponse_type_meta_default
metrics (optional)
SLAConnectionsResponse_type_meta_metrics

ThreadCountsResponse_type_meta_default Up

type (optional)
String
sleepBetweenExecution (optional)
Integer format: int32
dataRetentionInterval (optional)
Integer format: int32
sql (optional)
String
collapse (optional)
ChunkwritesResponse_type_meta_default_collapse
defaults (optional)
ThreadCountsResponse_type_meta_default_defaults

ThreadCountsResponse_type_meta_default_defaults Up

running (optional)
BigDecimal format: int 64
ready (optional)
BigDecimal format: int 64
mutex_wait (optional)
BigDecimal format: int 64
join_wait (optional)
BigDecimal format: int 64
cond_wait (optional)
BigDecimal format: int 64
detach_terminated (optional)
BigDecimal format: int 64
terminated (optional)
BigDecimal format: int 64
sleeping (optional)
BigDecimal format: int 64
memsync_wait (optional)
BigDecimal format: int 64

ThreadCountsServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
ThreadCountsResponse_type

Throwable Up

cause (optional)
Throwable
stackTrace (optional)
array[StackTraceElement]
localizedMessage (optional)
String
message (optional)
String
suppressed (optional)
array[Throwable]

TransactionResponse Up

TransactionResponse_inner Up

sql_sid (optional)
Integer format: int32
sql_begintxtime (optional)
Long format: int64
sql_id (optional)
Integer format: int32
count (optional)
Long format: int64
avg_runtime (optional)
Double format: double
max_runtime (optional)
Long format: int64
avg_mem (optional)
Double format: double
rows (optional)
Long format: int64

TransactionSqlIdResponse Up

sql_numstmt (optional)
Long format: int64
sql_runtime (optional)
Double format: double
sql_pgreads (optional)
Long format: int64
sql_bfreads (optional)
Long format: int64
sql_pgwrites (optional)
Long format: int64
sql_bfwrites (optional)
Long format: int64
sql_lockreq (optional)
Long format: int64
sql_lockwaits (optional)
Long format: int64
sql_lockwttime (optional)
Double format: double
sql_logspace (optional)
Long format: int64
sql_sorttotal (optional)
Long format: int64
sql_sortdisk (optional)
Long format: int64
sql_sortmem (optional)
Long format: int64
sql_numiowaits (optional)
Long format: int64
sql_totaliowaits (optional)
Double format: double
sql_avgiowaits (optional)
Double format: double
sql_estcost (optional)
Long format: int64
sql_estrows (optional)
Long format: int64
sql_actualrows (optional)
Long format: int64
sql_sqlmemory (optional)
Long format: int64
sql_rdcache (optional)
Double format: double
sql_wrcache (optional)
Double format: double
sql_sid (optional)
Long format: int64
sql_begintxtime (optional)
Long format: int64
statements (optional)
array[TransactionSqlIdResponse_statements]

TransactionSqlIdResponse_statements Up

sql_id (optional)
Long format: int64
sql_finishtime (optional)
Long format: int64
sql_runtime (optional)
Double format: double
sql_rowspersec (optional)
Double format: double
sql_actualrows (optional)
Long format: int64
sql_lockwttime (optional)
Double format: double
sql_totaliowaits (optional)
Double format: double
sql_statement (optional)
String

UpdateOnlineLogsRotationConfigurationsRequest Up

rotationEnabled (optional)
Boolean
rotationFrequency (optional)
Long format: int64
maxFiles (optional)
Long format: int64

UpdateSensorRequest Up

sensors (optional)
array[UpdateSensorRequest_sensors]

UpdateSensorRequest_sensors Up

dataRetentionInterval (optional)
Long Retention interval in days by when explore will cleanup the agent repository data. format: int64
disabled (optional)
Boolean
runInterval (optional)
Long Interval in seconds on which sensor will execute. format: int64
type (optional)
String

UpdateStatsResponse Up

tabname (optional)
String
colname (optional)
String
mode (optional)
String
build_date (optional)
SqlTraceResponse_info_starttime
sample (optional)
Integer format: int32
nrows (optional)
Integer format: int32
resolution (optional)
Float format: float
confidence (optional)
Integer format: int32

User Up

id (optional)
Long format: int64
name (optional)
String
passwordSalt (optional)
String
locked (optional)
Boolean
lastPasswordUpdate (optional)
Long format: int64
roleExpiry (optional)
Long format: int64
hashingAlgoName (optional)
String
successiveFailedLoginAttempts (optional)
Integer format: int32
defaultAlertingProfile (optional)
AlertingProfile
messengers (optional)
array[AlertingMessenger]
permissions (optional)
array[String]
Enum:
alertingProfiles (optional)
array[AlertingProfile]
passwordHash (optional)
String
expired (optional)
Boolean
bson (optional)
map[String, Object]
settingsBSON (optional)
map[String, Object]

UserDefinedTypesResource Up

udtsDetails (optional)
BSONObject

UserIdResponse Up

permissions (optional)
Integer format: int32
effective (optional)
Long format: int64

UserPermissionsResource Up

userPermissions (optional)
map[String, Object]

VPsClassRequest Up

class (optional)
String
count (optional)
String

VPsClassResponse Up

vpid (optional)
Integer format: int32
class (optional)
String
usercpu (optional)
Float format: float
syscpu (optional)
Float format: float
totalcpu (optional)
Double format: double

VPsResponse Up

class (optional)
String
count (optional)
Integer format: int32
usercpu (optional)
Float format: float
syscpu (optional)
Float format: float
totalcpu (optional)
Double format: double

VirtualProcessorResource Up

virtualProcessorClasses (optional)
BSONObject

VirtualProcessorsSensorResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
VirtualProcessorsSensorResponse_type

VirtualProcessorsSensorResponse_type Up

id (optional)
String
name (optional)
String
description (optional)
String
meta (optional)
VirtualProcessorsSensorResponse_type_meta
fromPackage (optional)
Boolean

VirtualProcessorsSensorResponse_type_meta Up

default (optional)
DBSpaceUsageResponse_type_meta_default
metrics (optional)
VirtualProcessorsSensorResponse_type_meta_metrics

VirtualProcessorsSensorResponse_type_meta_metrics Up

count (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
usercpu (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
syscpu (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time
totalcpu (optional)
CheckpointSensorResponse_type_meta_metrics_cp_time

VirtualProcessorsSensorServerIDResponse Up

runInterval (optional)
Long format: int64
dataRetentionInterval (optional)
Long format: int64
disabled (optional)
Boolean
type (optional)
VirtualProcessorsSensorResponse_type

WarehouseResource Up

iwainfo (optional)
BSONObject

dashboards_drop_body Up

dashboardIds (optional)
array[Long] format: int64

groupId_dashboards_body Up

newDashboards (optional)
array[onedbgroupsgroupIddashboards_newDashboards]

inline_response_200 Up

dashboards (optional)
array[DashboardResponse]

inline_response_200_1 Up

newDashboards (optional)
array[DashboardResponse]

onedbgroupsgroupIddashboards_newDashboards Up

config (optional)
DashboardConfig