Skip to main content

Create Instance​

Select

SaaS
Customer Managed

This API creates a new AWS Redsift instance

This operation creates a default subclient. To specify the clusters to be added, update the subclient (cluster group) to specify the clusters and regions to be backed up.

Request Body

Post the necessary fields for the API to create a new Instance.

  • instanceProperties object
  • instance object
  • instanceName string required

    Name of the instance

  • applicationId integer
  • clientId integer
  • clientName string required

    Name of the cloud account

  • cloudAppsInstance object
  • instanceType string required

    This should be set to "AMAZON_REDSHIFT"

  • planEntity object
  • planId integer

    The ID that corresponds to your storage plan

  • useResourcePoolInfo boolean
Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://ServerURL/commandcenter/api
Security Scheme
token
Body
{

  "instanceProperties": {

    "instance": {

      "instanceName": "string",

      "applicationId": 0,

      "clientId": 0,

      "clientName": "string"

    },

    "cloudAppsInstance": {

      "instanceType": "string"

    },

    "planEntity": {

      "planId": 0

    },

    "useResourcePoolInfo": true

  }

}
Accept
curl -L -X POST 'https://ServerURL/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'