Skip to main content

modify Instance using instance id​

This operation associates a server plan to a SQL Server Instance.

Path Parameters
  • InstanceId string required
Request Body
  • instanceProperties object
  • instance object
  • instanceId integer
  • applicationId integer
  • clientId integer
  • oracleInstance object
  • oracleUser object
  • userName string
  • oracleHome string
  • sqlConnect object
  • userName string
  • password string
  • domainName string
  • confirmPassword string
  • useCatalogConnect boolean
  • TNSAdminPath string
  • blockSize integer
  • oracleStorageDevice object
  • commandLineStoragePolicy object
  • storagePolicyId integer
  • storagePolicyName string
  • flags object
  • entityInfo object
  • logBackupStoragePolicy object
  • storagePolicyId integer
  • storagePolicyName string
  • flags object
  • entityInfo object
  • crossCheckTimeout integer
  • planEntity object
  • planId integer
  • association object
  • entity object[]
  • applicationId integer
  • clientName string
  • displayName string
  • flags object
  • instanceId integer
  • clientId integer
  • instanceGUID string
  • entityInfo object
  • instanceName string
  • appName string
Responses

OK

POST /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "instanceProperties": {

    "instance": {

      "instanceId": 0,

      "applicationId": 0,

      "clientId": 0

    },

    "oracleInstance": {

      "oracleUser": {

        "userName": "string"

      },

      "oracleHome": "string",

      "sqlConnect": {

        "userName": "string",

        "password": "string",

        "domainName": "string",

        "confirmPassword": "string"

      },

      "useCatalogConnect": true,

      "TNSAdminPath": "string",

      "blockSize": 0,

      "oracleStorageDevice": {

        "commandLineStoragePolicy": {

          "storagePolicyId": 0,

          "storagePolicyName": "string",

          "flags": {},

          "entityInfo": {}

        },

        "logBackupStoragePolicy": {

          "storagePolicyId": 0,

          "storagePolicyName": "string",

          "flags": {},

          "entityInfo": {}

        }

      },

      "crossCheckTimeout": 0

    },

    "planEntity": {

      "planId": 0

    }

  },

  "association": {

    "entity": [

      {

        "applicationId": 0,

        "clientName": "string",

        "displayName": "string",

        "flags": {},

        "instanceId": 0,

        "clientId": 0,

        "instanceGUID": "string",

        "entityInfo": {},

        "instanceName": "string",

        "appName": "string"

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/instance/:InstanceId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    },
    "oracleInstance": {
      "oracleUser": {
        "userName": "string"
      },
      "oracleHome": "string",
      "sqlConnect": {
        "userName": "string",
        "password": "string",
        "domainName": "string",
        "confirmPassword": "string"
      },
      "useCatalogConnect": true,
      "TNSAdminPath": "string",
      "blockSize": 0,
      "oracleStorageDevice": {
        "commandLineStoragePolicy": {
          "storagePolicyId": 0,
          "storagePolicyName": "string",
          "flags": {},
          "entityInfo": {}
        },
        "logBackupStoragePolicy": {
          "storagePolicyId": 0,
          "storagePolicyName": "string",
          "flags": {},
          "entityInfo": {}
        }
      },
      "crossCheckTimeout": 0
    },
    "planEntity": {
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "applicationId": 0,
        "clientName": "string",
        "displayName": "string",
        "flags": {},
        "instanceId": 0,
        "clientId": 0,
        "instanceGUID": "string",
        "entityInfo": {},
        "instanceName": "string",
        "appName": "string"
      }
    ]
  }
}'