Create Azure Cosmos DB Cassandra API Instance

Select

SaaS

Customer Managed

This API is used to create an Azure Cosmos DB Cassandra api instanc

application/json

Request Body

• instanceProperties object

  instance object

  clientId integer

  clientName string

  applicationId integer

  instanceName string

  cloudAppsInstance object

  instanceType integer

  Default value: 44

  rdsInstance object

  amazonDynamoDB object

  azureTableStorageInstance object

  planEntity object

  planId integer

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": 407,
      "clientId": 177,
      "instanceName": "CASSANDRA API",
      "instanceId": 64,
      "_type_": 0
    }
  }
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

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
• Example 1

---

{
  "instanceProperties": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "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": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "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": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "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": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "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": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "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": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "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": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "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": {
    "instance": {
      "clientId": 0,
      "clientName": "string",
      "applicationId": 0,
      "instanceName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": 44,
      "rdsInstance": {},
      "amazonDynamoDB": {},
      "azureTableStorageInstance": {}
    },
    "planEntity": {
      "planId": 0
    }
  }
}'