Get Instance using parameters

Select

SaaS

Customer Managed

This operation returns properties of a particular instance using client name, app name and instance name.

Path Parameters

• clientName string required
• appName string required
• instanceName string required

Header Parameters

• Accept string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• instanceProperties object[]

  isDeleted boolean

  instance object

  clientId integer

  clientName string

  instanceName string

  appName string

  instanceId integer

  applicationId integer

  instanceGUID string

  instanceActivityControl object

  activityControlOptions object[]

  activityType integer

  enableAfterADelay boolean

  enableActivityType boolean

  mssqlInstance object

  awsSqlInfo object

  sqlInstanceCredentials object

  agProperties object

  SQLAvailabilityReplicasList object

  availabilityGroup object

  proxyClient object

  azureInfo object

  azureCredentials object

  azureSqlInstanceCredentials object

{
  "instanceProperties": [
    {
      "isDeleted": true,
      "instance": {
        "clientId": 0,
        "clientName": "string",
        "instanceName": "string",
        "appName": "string",
        "instanceId": 0,
        "applicationId": 0,
        "instanceGUID": "string"
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 0,
            "enableAfterADelay": true,
            "enableActivityType": true
          }
        ]
      },
      "mssqlInstance": {
        "awsSqlInfo": {
          "sqlInstanceCredentials": {}
        },
        "agProperties": {
          "SQLAvailabilityReplicasList": {},
          "availabilityGroup": {},
          "proxyClient": {}
        },
        "azureInfo": {
          "azureCredentials": {},
          "azureSqlInstanceCredentials": {}
        }
      }
    }
  ]
}

{
  "instanceProperties": [
    {
      "isDeleted": false,
      "instance": {
        "clientId": 5,
        "clientName": "firewalltestma_2",
        "instanceName": "Test",
        "appName": "SQL Server",
        "instanceId": 3,
        "applicationId": 81,
        "instanceGUID": "33C8B996-2213-4000-A105-31BB061E1921"
      },
      "instanceActivityControl": {
        "activityControlOptions": [
          {
            "activityType": 1,
            "enableAfterADelay": false,
            "enableActivityType": true
          },
          {
            "activityType": 2,
            "enableAfterADelay": false,
            "enableActivityType": true
          }
        ]
      },
      "mssqlInstance": {
        "awsSqlInfo": {
          "sqlInstanceCredentials": {}
        },
        "agProperties": {
          "SQLAvailabilityReplicasList": {},
          "availabilityGroup": {},
          "proxyClient": {}
        },
        "azureInfo": {
          "azureCredentials": {},
          "azureSqlInstanceCredentials": {}
        }
      }
    }
  ]
}

Loading...