Skip to main content

Modify DocumentDB Instance​

Select

SaaS
Customer Managed

This operation modifies the instance properties using Instance ID.

Path Parameters
  • instanceid string required

    ID of the instance

Request Body
  • instanceProperties object
  • instance object
  • instanceId integer required

    Id of the instance

  • applicationId integer
  • clientId integer
  • planEntity object
  • planName string

    Name of storage plan

  • cloudAppsInstance object
  • instanceType string

    Default value: AMAZON_DOCUMENTDB

  • generalCloudProperties object
  • credentials object
  • credentialId integer
  • credentialName string

    Name of AWS credentials

  • amazonInstanceInfo object
  • useIamRole boolean
  • credentialType integer
  • association object
  • entity object[]
  • clientName string required

    Name of cloud account

  • instanceName string required

    Name of inst

  • displayName string
  • instanceId integer
  • clientId integer
  • appName string
  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
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/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "instanceProperties": {

    "instance": {

      "instanceId": 0,

      "applicationId": 0,

      "clientId": 0

    },

    "planEntity": {

      "planName": "string"

    },

    "cloudAppsInstance": {

      "instanceType": "AMAZON_DOCUMENTDB",

      "generalCloudProperties": {

        "credentials": {

          "credentialId": 0,

          "credentialName": "string"

        },

        "amazonInstanceInfo": {

          "useIamRole": true

        }

      },

      "credentialType": 0

    }

  },

  "association": {

    "entity": [

      {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "instanceId": 0,

        "clientId": 0,

        "appName": "string",

        "applicationId": 0,

        "entityInfo": {

          "companyId": 0,

          "companyName": "string",

          "multiCommcellId": 0

        }

      }

    ]

  }

}

curl -L -X POST 'https://ServerURL/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    },
    "planEntity": {
      "planName": "string"
    },
    "cloudAppsInstance": {
      "instanceType": "AMAZON_DOCUMENTDB",
      "generalCloudProperties": {
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        },
        "amazonInstanceInfo": {
          "useIamRole": true
        }
      },
      "credentialType": 0
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "instanceId": 0,
        "clientId": 0,
        "appName": "string",
        "applicationId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    ]
  }
}'