View CockroachDB instance properties

Select

SaaS

Customer Managed

This API is used to view CockroachDB instance properties

Path Parameters

instanceid string required

Responses

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": 0,
      "excludeFromSLA": false,
      "scIdxEnabled": 1,
      "autoDiscovered": false,
      "instance": {
        "clientName": "testcockroachDBapi2",
        "instanceName": "testcockroachDBapi2",
        "displayName": "testcockroachDBapi2",
        "instanceId": 55,
        "instanceGUID": "E8B41CB6-34D4-41C1-BF77-28F4D91900DB",
        "clientId": 157,
        "appName": "Big Data Apps",
        "applicationId": 64,
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "distributedClusterInstance": {
        "clusterType": 18,
        "instance": {
          "instanceName": "testcockroachDBapi2",
          "instanceId": 55
        },
        "clusterConfig": {
          "cockroachdbConfig": {
            "port": 26257,
            "sslKey": "/home/certs/client.root.key",
            "dbHost": "hwcrdb4.devemc.commvault.com",
            "sslRootCert": "/home/certs/ca.crt",
            "sslCert": "/home/certs/client.root.crt",
            "dbCredentials": {
              "credentialId": 0,
              "credentialName": ""
            },
            "user": {
              "userName": "root"
            },
            "staging": {
              "stagingType": 1,
              "serviceHost": "s3.amazonaws.com",
              "cloudURL": "s3.amazonaws.com",
              "recordType": 102,
              "instanceType": 5,
              "stagingPath": "/huixiaS3",
              "stagingCredentials": {
                "credentialId": 10,
                "credentialName": "AWS_S3"
              }
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "",
              "clientId": 88,
              "clientName": "h1centos75",
              "displayName": "h1centos75",
              "_type_": 3
            }
          ]
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      },
      "cloudDBInstance": {
        "overRideAccessNode": false,
        "accessNodes": null
      }
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

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

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

Not Found

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

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

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

GET /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

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>'

View CockroachDB instance properties​

Authorization

Request

View CockroachDB instance properties