Skip to main content

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

OK

Schema
  • rdsDBInstances object[]
  • allocatedStorage integer
  • dbName string
  • regionName string
  • readReplicaSourceDBInstanceIdentifier string
  • availabilityZone string
  • preferredBackupWindow string
  • dbInstanceStatus string
  • secondaryAvailabilityZone string
  • engine string
  • iops integer
  • publiclyAccessible boolean
  • engineVersion string
  • masterUsername string
  • isMultAZ boolean
  • dbInstanceIdentifier string
  • vpcSecurityGroup string
  • characterSetName string
  • instanceCreateTime integer
  • dBInstanceClass string
  • dbSecurityGroup string
  • endPoint string
  • port integer
  • licenseModel string
  • preferredMaintenanceWindow string
  • backupRetentionPeriod integer
  • dbSubnetGroup string
  • autoMinorVersionUpgrade boolean
  • latestRestorableTime integer
GET /v4/azuredb/postgresql/instance

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
cloudAccountId — query required
regionId — query
backupGateways — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/postgresql/instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'