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

application/json

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

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

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
      }
    }
  ]
}

Loading...