Skip to main content

Modify HANA instance​

HANA instance modify Get Client ID

Path Parameters
  • instanceId string required

    HANA instance ID

Request Body
  • instanceProperties object
  • instance object
  • instanceId integer required

    InstanceId of instance to be modified

  • applicationId integer required

    Default value: 135

  • clientId integer required

    ClientId of HANA pseudo client on which instance is present

  • saphanaInstance object
  • SAPHANAUser object
  • userName string

    HANA DB 'adm' user

  • hdbsqlLocationDirectory string

    hdbsql location directory

  • DBInstances object[]
  • clientId integer required

    HANA physical client ID

  • clientName string required

    HANA physical client name

  • displayName string

    HANA physical client display name

  • dbInstanceNumber string

    DB instance number

  • dbUser object
  • userName string required

    HANA db user name

  • password string required

    Base64 encrypted database user password

  • isUsehdbStoreKey boolean

    Default value: false

    hdbuserstorekey make 'true' and provide, "hdbuserstorekey": "BACKUP"

    BACKUP is store keyname

  • sslEnabled boolean

    Default value: false

    HANA SSL key

  • sslProvider string

    Default value: commoncrypto

    SSL provider

  • sslTrustStore string

    Default value: sapcli.pse

    SSL truststore key

  • planEntity object
  • planId integer

    PlanID of plan to be associated to the client

  • association object
  • entity object[]
  • displayName string

    HANA pseudo client name

  • clientId integer required

    HANA physical client ID

  • instanceName string required

    HANA instance name

  • appName string

    Default value: SAP HANA

    Agent name

  • applicationId integer

    Default value: 135

  • clientName string

    HANA Pseudo client name

  • instanceId integer required

    HANA instance id

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/commandcenter/api
Security Scheme
token
instanceId — path required
Body
{

  "instanceProperties": {

    "instance": {

      "instanceId": 0,

      "applicationId": 135,

      "clientId": 0

    },

    "saphanaInstance": {

      "SAPHANAUser": {

        "userName": "string"

      },

      "hdbsqlLocationDirectory": "string",

      "DBInstances": [

        {

          "clientId": 0,

          "clientName": "string",

          "displayName": "string"

        }

      ],

      "dbInstanceNumber": "string",

      "dbUser": {

        "userName": "string",

        "password": "string"

      },

      "isUsehdbStoreKey": false,

      "sslEnabled": false,

      "sslProvider": "commoncrypto",

      "sslTrustStore": "sapcli.pse"

    },

    "planEntity": {

      "planId": 0

    }

  },

  "association": {

    "entity": [

      {

        "displayName": "string",

        "clientId": 0,

        "instanceName": "string",

        "appName": "SAP HANA",

        "applicationId": 135,

        "clientName": "string",

        "instanceId": 0

      }

    ]

  }

}

curl -L -X POST 'https://localhost/commandcenter/api/instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 135,
      "clientId": 0
    },
    "saphanaInstance": {
      "SAPHANAUser": {
        "userName": "string"
      },
      "hdbsqlLocationDirectory": "string",
      "DBInstances": [
        {
          "clientId": 0,
          "clientName": "string",
          "displayName": "string"
        }
      ],
      "dbInstanceNumber": "string",
      "dbUser": {
        "userName": "string",
        "password": "string"
      },
      "isUsehdbStoreKey": false,
      "sslEnabled": false,
      "sslProvider": "commoncrypto",
      "sslTrustStore": "sapcli.pse"
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "appName": "SAP HANA",
        "applicationId": 135,
        "clientName": "string",
        "instanceId": 0
      }
    ]
  }
}'