Create Instance

Select

SaaS

Customer Managed

The operation is used to create RDS instance. Default subclient will be created with all instances in all regions as content.

application/json

Request Body

instanceProperties object
instance object
instanceName string required
Name of the instance.
applicationId integer required
Default value: 134
clientName string required
Cloud account name.
cloudAppsInstance object
instanceType string
Possible values: [AMAZON_RDS]
planEntity object
planName string required
Name of the plan.
useResourcePoolInfo boolean
Default value: false

Responses

application/json

Schema
Example (from schema)
Example 1

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

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "subclientId": 0,
      "clientId": 0,
      "instanceName": "string",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 457,
      "clientId": 27,
      "instanceName": "RDS",
      "instanceId": 210,
      "_type_": 0
    }
  }
}

Internal server error

application/json

Schema
Example (from schema)
Wrong or Non-existent cloud account name.

Schema

errorMessage string
errorCode integer
entity object
subclientId integer
clientId integer
instanceName string
instanceId integer
_type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "Unknown Event [^1%lu].",
  "errorCode": 1,
  "entity": {
    "subclientId": 0,
    "clientId": -32000,
    "instanceName": "RDS",
    "instanceId": -1,
    "_type_": 0
  }
}

Bad Gateway

application/json

Schema
Example (from schema)
Conflict

Schema

errorMessage string
errorCode integer
entity object
subclientId integer
clientId integer
instanceName string
instanceId integer
_type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "An instance by this name already exists.",
  "errorCode": 3,
  "entity": {
    "subclientId": 0,
    "clientId": 27,
    "instanceName": "RDS",
    "instanceId": -1,
    "_type_": 0
  }
}

POST /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Body

Default
RDS instance creation

{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 134,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_RDS"
    },
    "planEntity": {
      "planName": "string"
    },
    "useResourcePoolInfo": false
  }
}'

Create Instance​

Authorization

Request

Create Instance