Skip to main content

# SapInstance

No description

    type SapInstance implements MonitoredSystem {
      id: ID!
      mst: Int!
      checks(
        where: FilterInput
        order: OrderInput
      ): [Check!]!
      checkCount(
        where: FilterInput
      ): Int!
      checkCountSummary(
        filter: CheckKind
      ): CheckCountSummary!
      checksRelay(
        first: Int
        after: String
        where: FilterInput
        order: OrderInput
      ): CheckConnection
      customAttributes: [CustomAttribute!]!
      customData: String
      customer: Customer!
      description: String
      maintenance: Boolean
      monitorOff: Boolean
      monitorOffUntil: DateTime
      monitorSwitchReason: String
      monitorSwitchDate: DateTime
      name: String
      operational: Boolean
      operationalSince: Date
      operationalUntil: Date
      status: Status!
      statusId: Int!
      systemRole: String @deprecated
      role: SystemRole
      type: MonitoredSystemType!
      timestamp: DateTime
      uuid: String
      instanceType: String!
      sapInstanceType: SapInstanceType!
      instanceProfile: String
      kernelRelease: String
      kernelPatchLevel: Int
      j2eeKernelRelease: String
      j2eeKernelPatchLevel: String
      sapControlUser: UserPassword
      lastSeen: DateTime
      sapSystem: SapSystem!
      server: Server
      actions(
        actionType: [SystemActionType!] = [Start, Stop, Restart]
      ): [SystemAction!]!
      central: Boolean!
      performance: MonitoredSystemPerformanceData
      administrator: User
      administratorDeputy: User
      systemNumber: String
      remote: Boolean!
      info: [InfoNode]
      applicationType: String
      assignedSLA: ServiceLevelAgreement
      kernelMakeVariant: String
      monitorLevel: MonitorLevel!
      credentialPurposes: [CredentialsPurpose]!
      credentials: [CredentialsBase]!
      notSeen: Boolean
      notifications(
        where: FilterInput
        order: OrderInput
      ): [Notification]!
      pagedNotifications(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): NotificationPage!
      managedStatus: ManagedSystemStatus!
      monitoringParametersGroups: [MonitoringParameterGroup!]!
      monitoringParameterByName(
        name: String!
      ): ValueParameter
      draft: Boolean!
      application: ApplicationType
      changes(
        where: FilterInput
        order: OrderInput
      ): [Change!]!
      pagedChanges(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): ChangePage
      systemParameterSets: [SystemParameterSet!]!
    }

### Fields​

#### `SapInstance.id` ● `ID!` non-null scalar​

#### `SapInstance.mst` ● `Int!` non-null scalar​

The numeric monitored system type. 0 = Server 1 = SapInstance 2 = SapSystem 3 = Database (can be StandaloneDatabase or SapSystemDatabase) (4 = BusinessService) 5 = SapBusinessObject 6 = CloudService

#### `SapInstance.checks` ● `[Check!]!` non-null interface​

Get all the available RTM checks for the given status selection. If the call should return different kind of checks the filter input has to be used with the explicit value for the kind field. If there is no kind filter field defined it defaults to: { name: "kind" operator: eq value: "RTM" }

##### `SapInstance.checks.where` ● `FilterInput` input​

The filter conditions for this query.

##### `SapInstance.checks.order` ● `OrderInput` input​

The order of the results.

#### `SapInstance.checkCount` ● `Int!` non-null scalar​

Count the affected checks.

##### `SapInstance.checkCount.where` ● `FilterInput` input​

The filter conditions for this query.

#### `SapInstance.checkCountSummary` ● `CheckCountSummary!` non-null object​

Get a check count summary.

##### `SapInstance.checkCountSummary.filter` ● `CheckKind` enum​

#### `SapInstance.checksRelay` ● `CheckConnection` object​

##### `SapInstance.checksRelay.first` ● `Int` scalar​

##### `SapInstance.checksRelay.after` ● `String` scalar​

##### `SapInstance.checksRelay.where` ● `FilterInput` input​

##### `SapInstance.checksRelay.order` ● `OrderInput` input​

#### `SapInstance.customAttributes` ● `[CustomAttribute!]!` non-null object​

Custom attributes defined for this monitored system.

#### `SapInstance.customData` ● `String` scalar​

Special data for this monitored system

#### `SapInstance.customer` ● `Customer!` non-null object​

#### `SapInstance.description` ● `String` scalar​

#### `SapInstance.maintenance` ● `Boolean` scalar​

#### `SapInstance.monitorOff` ● `Boolean` scalar​

#### `SapInstance.monitorOffUntil` ● `DateTime` scalar​

#### `SapInstance.monitorSwitchReason` ● `String` scalar​

#### `SapInstance.monitorSwitchDate` ● `DateTime` scalar​

#### `SapInstance.name` ● `String` scalar​

#### `SapInstance.operational` ● `Boolean` scalar​

#### `SapInstance.operationalSince` ● `Date` scalar​

#### `SapInstance.operationalUntil` ● `Date` scalar​

#### `SapInstance.status` ● `Status!` non-null enum​

The status of the monitored system

#### `SapInstance.statusId` ● `Int!` non-null scalar​

The check status as number: 2 => CRITICAL 1 => WARNING 0 => OK -1 => UNKNOWN -2 => DISABLED

#### `SapInstance.systemRole` ● `String` deprecated scalar​

DEPRECATED

Use the improved variant role that points to a SystemRole type.

The role of this system.

#### `SapInstance.role` ● `SystemRole` object​

The role of this system.

#### `SapInstance.type` ● `MonitoredSystemType!` non-null enum​

#### `SapInstance.timestamp` ● `DateTime` scalar​

#### `SapInstance.uuid` ● `String` scalar​

#### `SapInstance.instanceType` ● `String!` non-null scalar​

#### `SapInstance.sapInstanceType` ● `SapInstanceType!` non-null object​

The associated SAP instance type.

#### `SapInstance.instanceProfile` ● `String` scalar​

#### `SapInstance.kernelRelease` ● `String` scalar​

#### `SapInstance.kernelPatchLevel` ● `Int` scalar​

#### `SapInstance.j2eeKernelRelease` ● `String` scalar​

#### `SapInstance.j2eeKernelPatchLevel` ● `String` scalar​

#### `SapInstance.sapControlUser` ● `UserPassword` object​

#### `SapInstance.lastSeen` ● `DateTime` scalar​

#### `SapInstance.sapSystem` ● `SapSystem!` non-null object​

The SAP system this instance belongs to.

#### `SapInstance.server` ● `Server` object​

The server this SAP instance is monitored on.

#### `SapInstance.actions` ● `[SystemAction!]!` non-null object​

Get all the possible system actions. They can be used with mutation executeSystemAction(...).

##### `SapInstance.actions.actionType` ● `[SystemActionType!]` list enum​

#### `SapInstance.central` ● `Boolean!` non-null scalar​

Flag to know whether this instance is a central instance or not.

#### `SapInstance.performance` ● `MonitoredSystemPerformanceData` object​

This field holds information about the available performance resources for this monitored system.

#### `SapInstance.administrator` ● `User` object​

Who is responsible as administrator for this system.

#### `SapInstance.administratorDeputy` ● `User` object​

Who is responsible as administrator deputy for this system.

#### `SapInstance.systemNumber` ● `String` scalar​

SAP Instance number is a two-digit number between 00 to 99. SAP instances are numbered because system can contain more than once instance at a specific point of time.

#### `SapInstance.remote` ● `Boolean!` non-null scalar​

Is this a remote system

#### `SapInstance.info` ● `[InfoNode]` list object​

Information about this monitored system.

#### `SapInstance.applicationType` ● `String` scalar​

The application type of this monitored system.

#### `SapInstance.assignedSLA` ● `ServiceLevelAgreement` object​

The assigned SLA (service level agreement).

#### `SapInstance.kernelMakeVariant` ● `String` scalar​

The kernel make variant of this SAP instance.

#### `SapInstance.monitorLevel` ● `MonitorLevel!` non-null enum​

The monitor level

#### `SapInstance.credentialPurposes` ● `[CredentialsPurpose]!` non-null object​

Available credential purposes for this system.

#### `SapInstance.credentials` ● `[CredentialsBase]!` non-null interface​

Available credentials for this system.

#### `SapInstance.notSeen` ● `Boolean` scalar​

Whether this system is "not seen". Not seen means the system was once seen on an agent but now it isn't.

#### `SapInstance.notifications` ● `[Notification]!` non-null interface​

Associated notification actions

##### `SapInstance.notifications.where` ● `FilterInput` input​

##### `SapInstance.notifications.order` ● `OrderInput` input​

#### `SapInstance.pagedNotifications` ● `NotificationPage!` non-null object​

The paged variant for the notification field.

##### `SapInstance.pagedNotifications.pageRequest` ● `PageRequest!` non-null input​

##### `SapInstance.pagedNotifications.where` ● `FilterInput` input​

##### `SapInstance.pagedNotifications.order` ● `OrderInput` input​

#### `SapInstance.managedStatus` ● `ManagedSystemStatus!` non-null enum​

Managed status for this system.

#### `SapInstance.monitoringParametersGroups` ● `[MonitoringParameterGroup!]!` non-null object​

Monitoring parameter groups

#### `SapInstance.monitoringParameterByName` ● `ValueParameter` object​

Query a single monitoring parameter by its name. Here is an example query: query MoniParams { systems { agentConnect: monitoringParameterByName(name: "AgentListenerPort") { id name values } agentEnv: monitoringParameterByName(name: "AgentEnvironment") { id name values } } }

##### `SapInstance.monitoringParameterByName.name` ● `String!` non-null scalar​

#### `SapInstance.draft` ● `Boolean!` non-null scalar​

Tells if a draft or a saved system.

#### `SapInstance.application` ● `ApplicationType` object​

The application type for this monitored system.

#### `SapInstance.changes` ● `[Change!]!` non-null object​

Changes for this monitored system.

##### `SapInstance.changes.where` ● `FilterInput` input​

##### `SapInstance.changes.order` ● `OrderInput` input​

#### `SapInstance.pagedChanges` ● `ChangePage` object​

Paged changes for this monitored system.

##### `SapInstance.pagedChanges.pageRequest` ● `PageRequest!` non-null input​

##### `SapInstance.pagedChanges.where` ● `FilterInput` input​

##### `SapInstance.pagedChanges.order` ● `OrderInput` input​

#### `SapInstance.systemParameterSets` ● `[SystemParameterSet!]!` non-null object​

Returns all available system parameter sets.

### Interfaces​

#### `MonitoredSystem` interface​

Interface for a monitored system

### Returned By​

`sapInstance` query ● `sapInstances` query ● `turnMonitoringOffForSapInstance` mutation ● `turnMonitoringOnForSapInstance` mutation

### Member Of​

`CreateSapInstancePayload` object ● `SapInstancePage` object ● `SapSystem` object ● `Server` object ● `UpdateSapInstancePayload` object