List the database instances of a client

Select

SaaS

Customer Managed

List the Instance properties of all the database instances associated to the client.

Query Parameters

• clientName string required

  Name of the Cloud Account

• applicationId integer required

  Possible values: [104, 125, 22]

  Id of the App Type. 104-MySQL/MariaDB, 125-PostgreSQL, 22-Oracle

Responses

• 200
• 404

---

OK

application/json

• Schema
• Example (from schema)
• App Id-104

---

Schema

• instanceProperties object[]

  clientAppType integer

  isDeleted boolean

  applicationSize integer

  excludeFromSLA boolean

  scIdxEnabled integer

  isSnapEnabled boolean

  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

{
  "instanceProperties": [
    {
      "clientAppType": 0,
      "isDeleted": true,
      "applicationSize": 0,
      "excludeFromSLA": true,
      "scIdxEnabled": 0,
      "isSnapEnabled": true,
      "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
          }
        ]
      }
    }
  ]
}

{
  "instanceProperties": [
    {
      "clientAppType": 1,
      "isDeleted": false,
      "applicationSize": 0,
      "excludeFromSLA": false,
      "scIdxEnabled": 0,
      "isSnapEnabled": false,
      "autoDiscovered": false,
      "instance": {
        "clientName": "ApI-TEST",
        "instanceName": "mariadb/enctest2[ap-south-1]",
        "displayName": "ApI-TEST",
        "instanceId": 718,
        "instanceGUID": "4BCB19CD-74C3-4BD3-810B-58507C04335B",
        "clientId": 299,
        "appName": "MariaDB",
        "applicationId": 104,
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      }
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "No client is specified",
  "errorCode": 4
}

Loading...