Create DynamoDB Instance

Select

SaaS

Customer Managed

This operation creates DynamoDB Instance.

application/json

Request Body

• instanceProperties object

  useResourcePoolInfo boolean

  instance object

  clientName string

  Client Name

  instanceName string

  Name of the Instance to be created

  clientId integer

  ClientId of client on which instance is present

  applicationId integer

  Default value: 134

  cloudAppsInstance object

  instanceType integer

  Default value: 22

  planEntity object

  planId integer

  ID of the plan to be associated to the client

Responses

• 200
• 400
• 401

---

OK

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": 1,
      "clientId": 1,
      "instanceName": "DynamoDB",
      "instanceId": 1,
      "_type_": 0
    }
  }
}

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid.

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

POST /instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Instance creation

---

{
  "instanceProperties": {
    "useResourcePoolInfo": true,
    "instance": {
      "clientName": "string",
      "instanceName": "string",
      "clientId": 0,
      "applicationId": 134
    },
    "cloudAppsInstance": {
      "instanceType": 22
    },
    "planEntity": {
      "planId": 0
    }
  }
}

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

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

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

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

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

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

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