View couchbase instance properties

This API is used to view couchbase instance properties

Path Parameters

• instanceid string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• instanceProperties object[]

  isDeleted boolean

  applicationSize integer

  excludeFromSLA boolean

  scIdxEnabled integer

  autoDiscovered boolean

  instance object

  clientName string

  instanceName string

  displayName string

  instanceId integer

  instanceGUID string

  clientId integer

  appName string

  applicationId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  distributedClusterInstance object

  clusterType integer

  instance object

  instanceName string

  instanceId integer

  clusterConfig object

  couchbaseConfig object

  port integer

  user object

  userName string

  staging object

  stagingType integer

  serviceHost string

  cloudURL string

  recordType integer

  instanceType integer

  stagingPath string

  stagingCredentials object

  credentialId integer

  dataAccessNodes object

  dataAccessNodes object[]

  hostName string

  clientId integer

  clientName string

  displayName string

  instanceActivityControl object

  activityControlOptions object[]

  activityType integer

  enableAfterADelay boolean

  enableActivityType boolean

  cloudDBInstance object

  overRideAccessNode boolean

  accessNodes object

{
  "instanceProperties": [
    {
      "isDeleted": true,
      "applicationSize": 0,
      "excludeFromSLA": true,
      "scIdxEnabled": 0,
      "autoDiscovered": true,
      "instance": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "instanceId": 0,
        "instanceGUID": "string",
        "clientId": 0,
        "appName": "string",
        "applicationId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      },
      "distributedClusterInstance": {
        "clusterType": 0,
        "instance": {
          "instanceName": "string",
          "instanceId": 0
        },
        "clusterConfig": {
          "couchbaseConfig": {
            "port": 0,
            "user": {
              "userName": "string"
            },
            "staging": {
              "stagingType": 0,
              "serviceHost": "string",
              "cloudURL": "string",
              "recordType": 0,
              "instanceType": 0,
              "stagingPath": "string",
              "stagingCredentials": {
                "credentialId": 0
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string"
            }
          ]
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 0,
            "enableAfterADelay": true,
            "enableActivityType": true
          }
        ]
      },
      "cloudDBInstance": {
        "overRideAccessNode": true,
        "accessNodes": {}
      }
    }
  ]
}

{
  "instanceProperties": [
    {
      "isDeleted": false,
      "applicationSize": 508559360,
      "excludeFromSLA": false,
      "scIdxEnabled": 1,
      "autoDiscovered": false,
      "instance": {
        "clientName": "0022cb",
        "instanceName": "0022cb",
        "displayName": "0022cb",
        "instanceId": 276,
        "instanceGUID": "EF88B781-1573-4030-BE54-785D21A488D0",
        "clientId": 330,
        "appName": "Big Data Apps",
        "applicationId": 64,
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "distributedClusterInstance": {
        "clusterType": 17,
        "instance": {
          "instanceName": "0022cb",
          "instanceId": 276
        },
        "clusterConfig": {
          "couchbaseConfig": {
            "port": 18091,
            "user": {
              "userName": "Administrator"
            },
            "staging": {
              "stagingType": 0,
              "serviceHost": "",
              "cloudURL": "",
              "recordType": 0,
              "instanceType": 0,
              "stagingPath": "/data0903",
              "stagingCredentials": {
                "credentialId": 0
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "",
              "clientId": 327,
              "clientName": "couch705_1",
              "displayName": "couch705_1"
            },
            {
              "hostName": "",
              "clientId": 328,
              "clientName": "couch705_2",
              "displayName": "couch705_2"
            }
          ]
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      },
      "cloudDBInstance": {
        "overRideAccessNode": false,
        "accessNodes": {}
      }
    }
  ]
}

GET /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

instanceid — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceid' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'