Fetch cloud database instances
This operation returns the list of cloud PaaS instances configured in AWS.
Query Parameters
- clientId integer required
Id of the cloud Account
- appType integer required
Possible values: [
125
,104
,22
]Id of the App Type. 104-MySQL/MariaDB, 125-PostgreSQL, 22-Oracle, 81-MSSQL
- cloudDBEngineType integer
Possible values:
>= 1
and<= 5
Id of the Database Engine Type. 1-PostgreSQL, 2-Aurora PostgreSQL, 3-MySQL, 4-Aurora MySQL, 5-MariaDB (Not needed for Oracle and MSSQL)
- regionId integer
Id of the region, Use select region to get ID. Application for SaaS
- backupgateways string
Comma separated backupGateway Client IDs. Application for SaaS
Responses
- 200
- 500
OK
- application/json
- Schema
- Example (from schema)
- List Instances
Schema
rdsDBInstances object[]
allocatedStorage integerdbName stringregionName stringreadReplicaSourceDBInstanceIdentifier stringavailabilityZone stringpreferredBackupWindow stringdbInstanceStatus stringsecondaryAvailabilityZone stringengine stringiops integerpubliclyAccessible booleanengineVersion stringmasterUsername stringisMultAZ booleandbInstanceIdentifier stringvpcSecurityGroup stringcharacterSetName stringinstanceCreateTime integerdBInstanceClass stringdbSecurityGroup stringendPoint stringport integerlicenseModel stringpreferredMaintenanceWindow stringbackupRetentionPeriod integerdbSubnetGroup stringautoMinorVersionUpgrade booleanlatestRestorableTime integer
{
"rdsDBInstances": [
{
"allocatedStorage": 0,
"dbName": "string",
"regionName": "string",
"readReplicaSourceDBInstanceIdentifier": "string",
"availabilityZone": "string",
"preferredBackupWindow": "string",
"dbInstanceStatus": "string",
"secondaryAvailabilityZone": "string",
"engine": "string",
"iops": 0,
"publiclyAccessible": true,
"engineVersion": "string",
"masterUsername": "string",
"isMultAZ": true,
"dbInstanceIdentifier": "string",
"vpcSecurityGroup": "string",
"characterSetName": "string",
"instanceCreateTime": 0,
"dBInstanceClass": "string",
"dbSecurityGroup": "string",
"endPoint": "string",
"port": 0,
"licenseModel": "string",
"preferredMaintenanceWindow": "string",
"backupRetentionPeriod": 0,
"dbSubnetGroup": "string",
"autoMinorVersionUpgrade": true,
"latestRestorableTime": 0
}
]
}
{
"rdsDBInstances": [
{
"allocatedStorage": 20,
"dbName": "enctest",
"regionName": "ap-south-1",
"readReplicaSourceDBInstanceIdentifier": "",
"availabilityZone": "ap-south-1a",
"preferredBackupWindow": "18:27-18:57",
"dbInstanceStatus": "available",
"secondaryAvailabilityZone": "",
"engine": "mariadb",
"iops": 0,
"publiclyAccessible": true,
"engineVersion": "10.6.14",
"masterUsername": "admin",
"isMultAZ": false,
"dbInstanceIdentifier": "mariadb/enctest",
"vpcSecurityGroup": "sg-b285d2d",
"characterSetName": "",
"instanceCreateTime": 1700466458,
"dBInstanceClass": "db.t3.micro",
"dbSecurityGroup": "",
"endPoint": "enctest.ap-south-1.rds.amazonaws.com",
"port": 3306,
"licenseModel": "general-public-license",
"preferredMaintenanceWindow": "thu:11:10-thu:11:40",
"backupRetentionPeriod": 1,
"dbSubnetGroup": "default",
"autoMinorVersionUpgrade": true,
"latestRestorableTime": 1705304100
},
{
"allocatedStorage": 20,
"dbName": "dbenc",
"regionName": "us-east-1",
"readReplicaSourceDBInstanceIdentifier": "",
"availabilityZone": "us-east-1d",
"preferredBackupWindow": "04:05-04:35",
"dbInstanceStatus": "available",
"secondaryAvailabilityZone": "",
"engine": "mariadb",
"iops": 0,
"publiclyAccessible": true,
"engineVersion": "10.6.14",
"masterUsername": "admin",
"isMultAZ": false,
"dbInstanceIdentifier": "mariadb/database",
"vpcSecurityGroup": "sg-bc78cce",
"characterSetName": "",
"instanceCreateTime": 1652176438,
"dBInstanceClass": "db.t3.micro",
"dbSecurityGroup": "",
"endPoint": "database.us-east-1.rds.amazonaws.com",
"port": 3306,
"licenseModel": "general-public-license",
"preferredMaintenanceWindow": "wed:05:09-wed:05:39",
"backupRetentionPeriod": 7,
"dbSubnetGroup": "default",
"autoMinorVersionUpgrade": true,
"latestRestorableTime": 1705304100
}
]
}
Internal Server Error
Loading...