Skip to main content

Modify DocumentDB cluster group

This operation modifies subclient (cluster group) properties.

Path Parameters
  • subclientid string required

    ID of the subclient

Request Body
  • subclientProps object
  • cloudAppsSubClientProp object
  • instanceType integer required

    Default value: 27

  • cloudDbContent object
  • children object[]
  • displayName string
  • name string required

    Name of DocumentDB Cluster

  • path string required

    Region cluster is located in

  • type string required
  • allOrAnyChildren boolean
  • negation boolean
  • cloudDbFilter object
  • commonProperties object
  • numberOfBackupStreams integer
Responses

OK


Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • _type_ integer
POST /subclient/:subclientid    

Authorization

type: apiKeyname: Authtokenin: header

Request

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

{
"subclientProps": {
"cloudAppsSubClientProp": {
"instanceType": 27
},
"cloudDbContent": {
"children": [
{
"displayName": "string",
"name": "string",
"path": "string",
"type": "string",
"allOrAnyChildren": true,
"negation": true
}
]
},
"cloudDbFilter": {},
"commonProperties": {
"numberOfBackupStreams": 0
}
}
}
curl -L -X POST 'https://ServerURL/commandcenter/api/subclient/:subclientid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subclientProps": {
"cloudAppsSubClientProp": {
"instanceType": 27
},
"cloudDbContent": {
"children": [
{
"displayName": "string",
"name": "string",
"path": "string",
"type": "string",
"allOrAnyChildren": true,
"negation": true
}
]
},
"cloudDbFilter": {},
"commonProperties": {
"numberOfBackupStreams": 0
}
}
}'