Get Instance Properties
This operation returns properties about the DocumentDB instance.
Path Parameters
- instanceid string required
ID of the instance
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
- Example 2
Schema
instanceProperties object[]
clientAppType integerisDeleted booleanapplicationSize integerexcludeFromSLA booleanscIdxEnabled integerisSnapEnabled booleanautoDiscovered booleaninstance object
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleancloudAppsInstance object
instanceType integercredentialType integervsCloudVendor integerrdsInstance object
accessKey stringregionEndPoints stringarrayEntity object
arrayId integeralibabaInstance object
accessKey stringhostURL stringobjectStorageInstance object
generalCloudProperties object
regionEndPoints stringcredentials object
credentialId integercredentialName stringaccessNodes object
memberServers object[]
client object
clientId integerclientName string_type_ integeramazonInstanceInfo object
accessKey stringuseIamRole booleanplanEntity object
planType integerplanName stringplanSubtype integerplanId integercloudDBInstance object
overRideAccessNode booleanaccessNodes object
{
"instanceProperties": [
{
"clientAppType": 0,
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": true,
"instance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"instanceGUID": "string",
"clientId": 0,
"appName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"cloudAppsInstance": {
"instanceType": 0,
"credentialType": 0,
"vsCloudVendor": 0,
"rdsInstance": {
"accessKey": "string",
"regionEndPoints": "string",
"arrayEntity": {
"arrayId": 0
}
},
"alibabaInstance": {
"accessKey": "string",
"hostURL": "string"
},
"objectStorageInstance": {},
"generalCloudProperties": {
"regionEndPoints": "string",
"credentials": {
"credentialId": 0,
"credentialName": "string"
},
"accessNodes": {
"memberServers": [
{
"client": {
"clientId": 0,
"clientName": "string",
"_type_": 0
}
}
]
},
"amazonInstanceInfo": {
"accessKey": "string",
"useIamRole": true
}
}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"clientAppType": 0,
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": true,
"instance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"instanceGUID": "string",
"clientId": 0,
"appName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"cloudAppsInstance": {
"instanceType": 0,
"credentialType": 0,
"vsCloudVendor": 0,
"rdsInstance": {
"accessKey": "string",
"regionEndPoints": "string",
"arrayEntity": {
"arrayId": 0
}
},
"alibabaInstance": {
"accessKey": "string",
"hostURL": "string"
},
"objectStorageInstance": {},
"generalCloudProperties": {
"regionEndPoints": "string",
"credentials": {
"credentialId": 0,
"credentialName": "string"
},
"accessNodes": {
"memberServers": [
{
"client": {
"clientId": 0,
"clientName": "string",
"_type_": 0
}
}
]
},
"amazonInstanceInfo": {
"accessKey": "string",
"useIamRole": true
}
}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"clientAppType": 1,
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "sdesai",
"instanceName": "DocumentDB2",
"displayName": "sdesai",
"instanceId": 5529,
"instanceGUID": "31EE68D4-15DB-486E-AA24-92629F0F1123",
"clientId": 1455,
"appName": "Cloud Apps",
"applicationId": 134,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"cloudAppsInstance": {
"instanceType": 27,
"credentialType": 102,
"vsCloudVendor": 0,
"rdsInstance": {
"accessKey": "",
"regionEndPoints": "default",
"arrayEntity": {
"arrayId": 202
}
},
"alibabaInstance": {
"accessKey": "",
"hostURL": "default"
},
"objectStorageInstance": {},
"generalCloudProperties": {
"regionEndPoints": "default",
"credentials": {
"credentialId": 124,
"credentialName": "sampath_sk_aws"
},
"accessNodes": {
"memberServers": [
{
"client": {
"clientId": 1115,
"clientName": "sam-cs1",
"_type_": 3
}
}
]
},
"amazonInstanceInfo": {
"accessKey": "",
"useIamRole": false
}
}
},
"planEntity": {
"planType": 2,
"planName": "1sai-plan-recreated",
"planSubtype": 33554437,
"planId": 15
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Loading...