View Azure Cosmos DB Cassandra API instance properties

Select

SaaS

Customer Managed

This API is used to view Azure Cosmos DB Cassandra api instance properties

Path Parameters

instanceid string required

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

instanceProperties object[]
clientAppType integer
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
instanceActivityControl object
activityControlOptions object[]
activityType integer
enableAfterADelay boolean
enableActivityType boolean
cloudAppsInstance object
instanceType integer
credentialType integer
vsCloudVendor integer
objectStorageInstance object
generalCloudProperties object
credentials object
credentialId integer
credentialName string
azureResourceManager object
tenantId string
serverName string
subscriptionId string
useManagedIdentity boolean
credentials object
userName string
accessNodes object
memberServers object[]
client object
clientId integer
clientName string
_type_ integer
planEntity object
planType integer
planName string
planSubtype integer
planId integer
cloudDBInstance object
overRideAccessNode boolean
accessNodes object

{
  "instanceProperties": [
    {
      "clientAppType": 0,
      "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
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 0,
            "enableAfterADelay": true,
            "enableActivityType": true
          }
        ]
      },
      "cloudAppsInstance": {
        "instanceType": 0,
        "credentialType": 0,
        "vsCloudVendor": 0,
        "objectStorageInstance": {},
        "generalCloudProperties": {
          "credentials": {
            "credentialId": 0,
            "credentialName": "string"
          },
          "azureResourceManager": {
            "tenantId": "string",
            "serverName": "string",
            "subscriptionId": "string",
            "useManagedIdentity": true,
            "credentials": {
              "userName": "string"
            }
          },
          "accessNodes": {
            "memberServers": [
              {
                "client": {
                  "clientId": 0,
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ]
          }
        }
      },
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "cloudDBInstance": {
        "overRideAccessNode": true,
        "accessNodes": {}
      }
    }
  ]
}

{
  "instanceProperties": [
    {
      "clientAppType": 1,
      "isDeleted": false,
      "applicationSize": 0,
      "excludeFromSLA": false,
      "scIdxEnabled": 0,
      "autoDiscovered": false,
      "instance": {
        "clientName": "testcosmos",
        "instanceName": "CASSANDRA API",
        "displayName": "testcosmos",
        "instanceId": 64,
        "instanceGUID": "E3BD0639-08E6-492E-8F60-27BAFCB429AE",
        "clientId": 177,
        "appName": "Cloud Apps",
        "applicationId": 134,
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      },
      "cloudAppsInstance": {
        "instanceType": 44,
        "credentialType": 4,
        "vsCloudVendor": 0,
        "objectStorageInstance": {},
        "generalCloudProperties": {
          "credentials": {
            "credentialId": 16,
            "credentialName": "test_azure"
          },
          "azureResourceManager": {
            "tenantId": "",
            "serverName": "",
            "subscriptionId": "fa35a475-157b-4d5b-94a7-30d6a81a1434",
            "useManagedIdentity": false,
            "credentials": {
              "userName": ""
            }
          },
          "accessNodes": {
            "memberServers": [
              {
                "client": {
                  "clientId": 159,
                  "clientName": "caspf6_3",
                  "_type_": 3
                }
              }
            ]
          }
        }
      },
      "planEntity": {
        "planType": 2,
        "planName": "systestwincs1-dedup",
        "planSubtype": 33554437,
        "planId": 1
      },
      "cloudDBInstance": {
        "overRideAccessNode": false,
        "accessNodes": {}
      }
    }
  ]
}

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
}

View Azure Cosmos DB Cassandra API instance properties​

View Azure Cosmos DB Cassandra API instance properties