Jump to

• Request
• Response

Get database home by name

get

/dbhomes/name/{dbhomeName}

Get details about the Oracle Database Home given the Database Home Name

Request

Supported Media Types

• application/json

Path Parameters

• dbhomeName: string
  database home Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : DbHome

Type: object

Show Source

• createTime(optional): string(date-time)
  Database Home creation timestamp
• dbEdition(optional): string
  Database Home Edition(EE/SE).
• dbHomeLocation(optional): string
  Database Home location
• dbVersion(optional): string
  Database version
• id(optional): string
  Database home resource ID
• name(optional): string
  Display name for the database home resource
• state(optional): object ResourceState
• unifiedAuditing(optional): string
  Enable unified auditing for the database or not (TRUE/FALSE).
• updatedTime(optional): string(date-time)
  Database Home last updated timestamp

{
    "properties":{
        "id":{
            "description":"Database home resource ID",
            "type":"string"
        },
        "name":{
            "description":"Display name for the database home resource",
            "type":"string"
        },
        "dbVersion":{
            "description":"Database version",
            "type":"string"
        },
        "dbHomeLocation":{
            "description":"Database Home location",
            "type":"string"
        },
        "dbEdition":{
            "description":"Database Home Edition(EE/SE).",
            "type":"string"
        },
        "unifiedAuditing":{
            "description":"Enable unified auditing for the database or not (TRUE/FALSE).",
            "type":"string"
        },
        "createTime":{
            "description":"Database Home creation timestamp",
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "description":"Database Home resource state",
            "$ref":"#/definitions/ResourceState"
        },
        "updatedTime":{
            "description":"Database Home last updated timestamp",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : ResourceState

Type: object

Show Source

• status(optional): string
  Allowed Values: [ "CREATING", "CONFIGURED", "UPDATING", "DELETING", "FAILED", "RUNNING", "ENABLED", "DISABLED", "STALE" ]

{
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "CREATING",
                "CONFIGURED",
                "UPDATING",
                "DELETING",
                "FAILED",
                "RUNNING",
                "ENABLED",
                "DISABLED",
                "STALE"
            ]
        }
    }
}

Default Response

An unexpected error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top