Select Database Instance
Select
SaaS
Customer Managed
This API returns list of instances for the selected cloud account.
Query Parameters
- regionId integer
Id of the region, Use select region to get ID. Application for SaaS
- cloudAccountId integer required
Id of the cloud Account
- backupGateways string
Comma separated backupGateway Client IDs. Not needed for directCloudBackup
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
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": 51200,
"dbName": "pg11servereastus",
"regionName": "eastus",
"readReplicaSourceDBInstanceIdentifier": "",
"availabilityZone": "eastus",
"preferredBackupWindow": "",
"dbInstanceStatus": "Ready",
"secondaryAvailabilityZone": "",
"engine": "postgresql",
"iops": -132130768,
"publiclyAccessible": true,
"engineVersion": "11",
"masterUsername": "postgres",
"isMultAZ": true,
"dbInstanceIdentifier": "pg11servereastus",
"vpcSecurityGroup": "",
"characterSetName": "",
"instanceCreateTime": 2927961440,
"dBInstanceClass": "",
"dbSecurityGroup": "",
"endPoint": "pg11servereastus.####.database.azure.com",
"port": 5432,
"licenseModel": "",
"preferredMaintenanceWindow": "",
"backupRetentionPeriod": 7,
"dbSubnetGroup": "",
"autoMinorVersionUpgrade": true,
"latestRestorableTime": 3057545024
},
{
"allocatedStorage": 51200,
"dbName": "jah-pgdb",
"regionName": "eastus",
"readReplicaSourceDBInstanceIdentifier": "",
"availabilityZone": "eastus",
"preferredBackupWindow": "",
"dbInstanceStatus": "Ready",
"secondaryAvailabilityZone": "",
"engine": "postgresql",
"iops": -132130768,
"publiclyAccessible": true,
"engineVersion": "11",
"masterUsername": "postgres",
"isMultAZ": true,
"dbInstanceIdentifier": "jah-pgdb",
"vpcSecurityGroup": "",
"characterSetName": "",
"instanceCreateTime": 2927961440,
"dBInstanceClass": "",
"dbSecurityGroup": "",
"endPoint": "jah-pgdb.###.database.azure.com",
"port": 5432,
"licenseModel": "",
"preferredMaintenanceWindow": "",
"backupRetentionPeriod": 7,
"dbSubnetGroup": "",
"autoMinorVersionUpgrade": true,
"latestRestorableTime": 3057545024
}
]
}
Loading...