Get Instance Properties

Select

SaaS

Customer Managed

This operation returns properties about the Redshift instance.

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
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
cloudAppsInstance object
instanceType integer
credentialType integer
vsCloudVendor integer
rdsInstance object
accessKey string
regionEndPoints string
arrayEntity object
arrayId integer
alibabaInstance object
accessKey string
hostURL string
objectStorageInstance object
generalCloudProperties object
regionEndPoints string
credentials object
credentialId integer
credentialName string
accessNodes object
memberServers object[]
client object
clientId integer
clientName string
_type_ integer
amazonInstanceInfo object
accessKey string
useIamRole boolean
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,
      "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
          }
        ]
      },
      "cloudAppsInstance": {
        "instanceType": 0,
        "credentialType": 0,
        "vsCloudVendor": 0,
        "rdsInstance": {
          "accessKey": "string",
          "regionEndPoints": "string",
          "arrayEntity": {
            "arrayId": 0
          }
        },
        "alibabaInstance": {
          "accessKey": "string",
          "hostURL": "string"
        },
        "objectStorageInstance": {},
        "generalCloudProperties": {
          "regionEndPoints": "string",
          "credentials": {
            "credentialId": 0,
            "credentialName": "string"
          },
          "accessNodes": {
            "memberServers": [
              {
                "client": {
                  "clientId": 0,
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ]
          },
          "amazonInstanceInfo": {
            "accessKey": "string",
            "useIamRole": true
          }
        }
      },
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "cloudDBInstance": {
        "overRideAccessNode": true,
        "accessNodes": {}
      }
    }
  ]
}

{
  "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
          }
        ]
      },
      "cloudAppsInstance": {
        "instanceType": 0,
        "credentialType": 0,
        "vsCloudVendor": 0,
        "rdsInstance": {
          "accessKey": "string",
          "regionEndPoints": "string",
          "arrayEntity": {
            "arrayId": 0
          }
        },
        "alibabaInstance": {
          "accessKey": "string",
          "hostURL": "string"
        },
        "objectStorageInstance": {},
        "generalCloudProperties": {
          "regionEndPoints": "string",
          "credentials": {
            "credentialId": 0,
            "credentialName": "string"
          },
          "accessNodes": {
            "memberServers": [
              {
                "client": {
                  "clientId": 0,
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ]
          },
          "amazonInstanceInfo": {
            "accessKey": "string",
            "useIamRole": true
          }
        }
      },
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "cloudDBInstance": {
        "overRideAccessNode": true,
        "accessNodes": {}
      }
    }
  ]
}

Get Instance Properties​

Get Instance Properties