Jump to

• Request
• Response

Get database home by ID

get

/dbhomes/{dbhomeId}

Request

Supported Media Types

• application/json

Path Parameters

• dbhomeId: string
  database home ID

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)
• dbEdition(optional): string
  Database Home Edition(EE/SE).
• dbHomeLocation(optional): string
  Name of the database home.
• dbVersion(optional): string
• id(optional): string
• name(optional): string
  display name for the resource
• state(optional): object ResourceState
• unifiedAuditing(optional): string
  Enable unified auditing for the database or not (TRUE/FALSE).
• updatedTime(optional): string(date-time)

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "description":"display name for the resource",
            "type":"string"
        },
        "dbVersion":{
            "type":"string"
        },
        "dbHomeLocation":{
            "description":"Name of the database home.",
            "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":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "$ref":"#/definitions/ResourceState"
        },
        "updatedTime":{
            "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