Get DynamoDB Instance properties
Select
SaaS
Customer Managed
List the Instance properties of the DynamoDB instance using Instance ID.
Path Parameters
- Instance_id string required
ID of instance
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Instance details
Schema
instanceProperties object[]
clientAppType stringDefault value:
CLOUDDB
isDeleted booleanapplicationSize integerexcludeFromSLA booleanscIdxEnabled integerisSnapEnabled booleanautoDiscovered booleaninstance object
Instance general properties
clientName stringName of the client associated
instanceName stringName of the DynamoDB Instance
displayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integersecurityAssociations object
ownerAssociations objecttagWithCompany object
providerId integerproviderDomainName stringinstanceActivityControl object
activityControlOptions object[]
activityType stringenableAfterADelay booleanenableActivityType booleansecurity object
associatedUserGroups object[]
userGroupId integer_type_ stringuserGroupName stringadvancedPrivacySettings object
isPasskeyFeatureEnabled booleanauthType stringisPrivacyFeatureEnabled booleanpasskeySettings object
enableAuthorizeForRestore booleanexpirationTime object
time integerownerCapabilities objectcloudAppsInstance object
instanceType stringcredentialType stringvsCloudVendor integerrdsInstance object
accessKey stringregionEndPoints stringarrayEntity objectalibabaInstance object
accessKey stringhostURL stringobjectStorageInstance objectgeneralCloudProperties object
regionEndPoints stringcredentials object
credentialId integercredentialName stringaccessNodes object
memberServers object[]
client object
clientId integerclientName string_type_ stringamazonInstanceInfo object
accessKey stringuseIamRole booleanplanEntity object
planType integerplanName stringplanSubtype integerplanId integercloudDBInstance object
overRideAccessNode booleanaccessNodes object
memberServers object[]
client object
clientId integerclientName string_type_ string
{
"instanceProperties": [
{
"clientAppType": "CLOUDDB",
"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
}
},
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "string"
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": "string",
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": "string",
"userGroupName": "string"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": true,
"authType": "string",
"isPrivacyFeatureEnabled": true,
"passkeySettings": {
"enableAuthorizeForRestore": true,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"cloudAppsInstance": {
"instanceType": "string",
"credentialType": "string",
"vsCloudVendor": 0,
"rdsInstance": {
"accessKey": "string",
"regionEndPoints": "string",
"arrayEntity": {}
},
"alibabaInstance": {
"accessKey": "string",
"hostURL": "string"
},
"objectStorageInstance": {},
"generalCloudProperties": {
"regionEndPoints": "string",
"credentials": {
"credentialId": 0,
"credentialName": "string"
},
"accessNodes": {
"memberServers": [
{
"client": {
"clientId": 0,
"clientName": "string",
"_type_": "string"
}
}
]
},
"amazonInstanceInfo": {
"accessKey": "string",
"useIamRole": true
}
}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {
"memberServers": [
{
"client": {
"clientId": 0,
"clientName": "string",
"_type_": "string"
}
}
]
}
}
}
]
}
{
"instanceProperties": [
{
"clientAppType": "CLOUDDB",
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "api_test",
"instanceName": "DynamoDB",
"displayName": "api_test",
"instanceId": 1,
"instanceGUID": "api_test",
"clientId": 1,
"appName": "Cloud Apps",
"applicationId": 134,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": "BACKUP",
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": "RESTORE",
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": "USERGROUP_ENTITY",
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": "USE_LOGIN",
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"cloudAppsInstance": {
"instanceType": "AMAZON_DYNAMODB",
"credentialType": "AMAZON_S3",
"vsCloudVendor": 0,
"rdsInstance": {
"accessKey": "",
"regionEndPoints": "default",
"arrayEntity": {}
},
"alibabaInstance": {
"accessKey": "",
"hostURL": "default"
},
"objectStorageInstance": {},
"generalCloudProperties": {
"regionEndPoints": "default",
"credentials": {
"credentialId": 1,
"credentialName": "api_test"
},
"accessNodes": {
"memberServers": [
{
"client": {
"clientId": 1,
"clientName": "api_test",
"_type_": "CLIENT_ENTITY"
}
}
]
},
"amazonInstanceInfo": {
"accessKey": "",
"useIamRole": false
}
}
},
"planEntity": {
"planType": 2,
"planName": "api_test",
"planSubtype": 33554437,
"planId": 1
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {
"memberServers": [
{
"client": {
"clientId": 1,
"clientName": "api_test",
"_type_": "CLIENT_ENTITY"
}
}
]
}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "string",
"errorCode": 0
}
Loading...