Create DocumentDB Instance

Select

SaaS

Customer Managed

This API creates a new AWS DocumentDB 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.

application/json

Request Body

Post the necessary fields for the API to create a DocumentDB 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
Default value: AMAZON_DOCUMENTDB
planEntity object
planId integer required
Id of storage
useResourcePoolInfo boolean

Responses

application/json
application/xml

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": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "subclientId": 0,
      "clientId": 0,
      "instanceName": "string",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

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

<root>
  <processinginstructioninfo>
    <attributes>
      <name>string</name>
      <value>string</value>
    </attributes>
  </processinginstructioninfo>
  <response>
    <warningCode>0</warningCode>
    <errorCode>0</errorCode>
    <warningMessage>string</warningMessage>
    <entity>
      <subclientId>0</subclientId>
      <clientId>0</clientId>
      <instanceName>string</instanceName>
      <instanceId>0</instanceId>
      <_type_>0</_type_>
    </entity>
  </response>
</root>

{
    "processinginstructioninfo": {
        "attributes": [
            {
                "name": "exitval",
                "value": "0"
            }
        ]
    },
    "response": {
        "warningCode": 0,
        "errorCode": 0,
        "warningMessage": "",
        "entity": {
            "subclientId": 16195,
            "clientId": 1079,
            "instanceName": "DocumentDB",
            "instanceId": 5528,
            "_type_": 0
        }
    }
}

POST /instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://ServerURL/commandcenter/api

Security Scheme

token

Body

Default
Create User Bob Fellow

{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 0,
      "clientId": 0,
      "clientName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_DOCUMENTDB"
    },
    "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": "AMAZON_DOCUMENTDB"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'

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": "AMAZON_DOCUMENTDB"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'

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": "AMAZON_DOCUMENTDB"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'

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": "AMAZON_DOCUMENTDB"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'

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": "AMAZON_DOCUMENTDB"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'

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": "AMAZON_DOCUMENTDB"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'

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": "AMAZON_DOCUMENTDB"
    },
    "planEntity": {
      "planId": 0
    },
    "useResourcePoolInfo": true
  }
}'

Create DocumentDB Instance​

Authorization

Request

Create DocumentDB Instance