Skip to main content

Get DB Instances​

Select

SaaS
Customer Managed

This endpoint is used to return the list of instances.

Responses

Success

Schema
  • instances object[]
  • id int32

    Gives the id of the instance.

  • name string

    Gives the name of the instance.

  • server string

    Gives the server to which the instance belongs to.

  • client object
  • id int32
  • name string
  • vendor string

    Possible values: [NOT_APPLICABLE, AMAZON, MICROSOFT_AZURE, GOOGLE_CLOUD, ALIBABA_CLOUD]

    The cloud vendor for the instance.

  • databaseEngine string

    Possible values: [AURORA_MYSQL, DB2, DB2_MULTINODE, DOCUMENT_DB, DYNAMO_DB, INFORMIX, MARIA_DB, MYSQL, ORACLE, ORACLE_RAC, POSTGRESQL, RDS, REDSHIFT, SAP_FOR_ORACLE, SAP_HANA, SQL_SERVER, SYBASE]

    Name of database engine which is the underlying software component that a database management system uses to create, read, update and delete data from the database.

  • status string

    Possible values: [READY, NOT_READY]

    The status of the instance. If the instance isn't ready, the reason is also provided.

  • notReadyReason string

    If the instance isn't ready, this provides the reason as to why the instance isn't ready.

  • lastBackup object
  • jobId int32

    Returns the job id of the last backup job performed.

  • status string

    Possible values: [NEVER_BACKED_UP, COMPLETED, FAILED, COMPLETED_WITH_ERRORS, KILLED, SUSPENDED, INTERRUPTED, ANY_STATUS, SKIPPED, FAILED_TO_START, SYNCHRONIZED, NOT_SYNCHRONIZED, NOT_ATTEMPTED, STARTED, COMPLETED_WITH_WARNINGS, SYSTEM_FAILED, COMMITTED]

    Status of the last backup job performed.

  • time int64

    Shows the time when the last back up job was carried out. The time is provided in unix time format.

  • failureReason string

    Gives the reason for the last backup job failing, if the last backup job fails.

  • applicationSize int32

    Gives the application size of the instance. It is returned in bytes.

  • plan object
  • id int32
  • name string
  • SLAStatus string

    Possible values: [MET_SLA, MISSED_SLA, EXCLUDED_SLA, YET_TO_BE_PROTECTED, MIGHT_MISS_SLA, UNKNOWN]

  • company object
  • id int32
  • name string
  • commcell object
  • name string

    Name of the commcell the entity belongs to.

Loading...