Fetch HANA instance properties

Select

SaaS

Customer Managed

Get HANA instance details

Query Parameters

instanceId integer required
Instance ID of HANA instance to get details

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

instanceProperties object[]
isDeleted boolean
applicationSize integer
excludeFromSLA boolean
version string
scIdxEnabled integer
autoDiscovered boolean
instance object
clientName string
instanceName string
displayName string
instanceId integer
instanceGUID string
clientId integer
appName string
applicationId integer
instanceActivityControl object
activityControlOptions object[]
activityType integer
enableAfterADelay boolean
enableActivityType boolean
saphanaInstance object
logBackupFrequency integer
spsVersion string
databaseName string
cmdBackupPrefix string
enableCmdlineThreshold boolean
cmdlineThresholdStreams integer
dbInstanceNumber string
sslProvider string
hdbsqlLocationDirectory string
enableLogDataThreshold boolean
numberOfNodes integer
sslTrustStore string
libPaths string
sslEnabled boolean
logBackupPrefix string
isUsehdbStoreKey boolean
clientOSType integer
hdbuserstorekey string
logDataThresholdStreams integer
isRMANEnableForTapeMovement boolean
hanaVersion string
isolationLevel integer
containerMode integer
SAPHANAUser object
userName string
dbUser object
domainName string
userName string
saphanaStorageDevice object
networkAgents integer
softwareCompression integer
throttleNetworkBandwidth integer
deDuplicationOptions object
generateSignature integer
logBackupStoragePolicy object
storagePolicyName string
storagePolicyId integer
commandLineStoragePolicy object
storagePolicyName string
storagePolicyId integer
DBInstances object[]
clientId integer
clientName string
planEntity object
planType integer
planName string
planSubtype integer
planId integer
cloudDBInstance object
overRideAccessNode boolean
accessNodes object

{
  "instanceProperties": [
    {
      "isDeleted": true,
      "applicationSize": 0,
      "excludeFromSLA": true,
      "version": "string",
      "scIdxEnabled": 0,
      "autoDiscovered": true,
      "instance": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "instanceId": 0,
        "instanceGUID": "string",
        "clientId": 0,
        "appName": "string",
        "applicationId": 0
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 0,
            "enableAfterADelay": true,
            "enableActivityType": true
          }
        ]
      },
      "saphanaInstance": {
        "logBackupFrequency": 0,
        "spsVersion": "string",
        "databaseName": "string",
        "cmdBackupPrefix": "string",
        "enableCmdlineThreshold": true,
        "cmdlineThresholdStreams": 0,
        "dbInstanceNumber": "string",
        "sslProvider": "string",
        "hdbsqlLocationDirectory": "string",
        "enableLogDataThreshold": true,
        "numberOfNodes": 0,
        "sslTrustStore": "string",
        "libPaths": "string",
        "sslEnabled": true,
        "logBackupPrefix": "string",
        "isUsehdbStoreKey": true,
        "clientOSType": 0,
        "hdbuserstorekey": "string",
        "logDataThresholdStreams": 0,
        "isRMANEnableForTapeMovement": true,
        "hanaVersion": "string",
        "isolationLevel": 0,
        "containerMode": 0,
        "SAPHANAUser": {
          "userName": "string"
        },
        "dbUser": {
          "domainName": "string",
          "userName": "string"
        },
        "saphanaStorageDevice": {
          "networkAgents": 0,
          "softwareCompression": 0,
          "throttleNetworkBandwidth": 0,
          "deDuplicationOptions": {
            "generateSignature": 0
          },
          "logBackupStoragePolicy": {
            "storagePolicyName": "string",
            "storagePolicyId": 0
          },
          "commandLineStoragePolicy": {
            "storagePolicyName": "string",
            "storagePolicyId": 0
          }
        },
        "DBInstances": [
          {
            "clientId": 0,
            "clientName": "string"
          }
        ]
      },
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "cloudDBInstance": {
        "overRideAccessNode": true,
        "accessNodes": {}
      }
    }
  ]
}

{
  "instanceProperties": [
    {
      "isDeleted": false,
      "applicationSize": 36700160,
      "excludeFromSLA": false,
      "version": "",
      "scIdxEnabled": 0,
      "autoDiscovered": false,
      "instance": {
        "clientName": "niraj_REP",
        "instanceName": "REP",
        "displayName": "niraj_REP",
        "instanceId": 54,
        "instanceGUID": "939D4247-8A7F-4A41-9A7D-67F38484877A",
        "clientId": 48,
        "appName": "SAP HANA",
        "applicationId": 135
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      },
      "saphanaInstance": {
        "logBackupFrequency": 900,
        "spsVersion": "SPS06",
        "databaseName": "",
        "cmdBackupPrefix": "",
        "enableCmdlineThreshold": false,
        "cmdlineThresholdStreams": 0,
        "dbInstanceNumber": "00",
        "sslProvider": "commoncrypto",
        "hdbsqlLocationDirectory": "/usr/sap/REP/HDB00/exe",
        "enableLogDataThreshold": false,
        "numberOfNodes": 1,
        "sslTrustStore": "sapcli.pse",
        "libPaths": "",
        "sslEnabled": false,
        "logBackupPrefix": "",
        "isUsehdbStoreKey": false,
        "clientOSType": 0,
        "hdbuserstorekey": "",
        "logDataThresholdStreams": 0,
        "isRMANEnableForTapeMovement": false,
        "hanaVersion": "2.00.064.00.1660047502",
        "isolationLevel": 0,
        "containerMode": 1,
        "SAPHANAUser": {
          "userName": "repadm"
        },
        "dbUser": {
          "domainName": "",
          "userName": "system"
        },
        "saphanaStorageDevice": {
          "networkAgents": 2,
          "softwareCompression": 2,
          "throttleNetworkBandwidth": 0,
          "deDuplicationOptions": {
            "generateSignature": 1
          },
          "logBackupStoragePolicy": {
            "storagePolicyName": "test",
            "storagePolicyId": 5
          },
          "commandLineStoragePolicy": {
            "storagePolicyName": "test",
            "storagePolicyId": 5
          }
        },
        "DBInstances": [
          {
            "clientId": 16,
            "clientName": "sde-newhana1"
          }
        ]
      },
      "planEntity": {
        "planType": 2,
        "planName": "test",
        "planSubtype": 33554437,
        "planId": 1
      },
      "cloudDBInstance": {
        "overRideAccessNode": false,
        "accessNodes": {}
      }
    }
  ]
}

Bad Request

application/json

Schema
Example 1

Schema

string

Request body is empty or format is invalid

Unauthorized

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Fetch HANA instance properties​

Fetch HANA instance properties