Jump to

• Request
• Response

Get the current broker database instances information

get

/database/dataguard/databases/{database}/instances/

All the broker databases. A client requires SQL Administrator role to invoke this service.

Request

Path Parameters

• database(required): string
  Database Name

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Information of all database instances.

Body ()

Root Schema : DataguardInstanceCollection

Type: object

Show Source

• count: integer
  Total number of records in the current response.
• hasMore: boolean
  Indicates if there are more records to be retrieved.
• items: array items
• limit: integer
  The actual page size limit on number of records applied by the server.
• links: array links
• offset: integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataguardInstanceItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DataguardInstanceItem

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataguardInstanceItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : DataguardInstanceItem

Type: object

Show Source

• active_state: string
• archiver: string
• blocked: string
• con_id: integer
• database_status: string
• database_type: string
• edition: string
• family: string
• host_name: string
• inst_id: integer
• instance_mode: string
• instance_name: string
• instance_number: integer
• instance_role: string
• log_switch_wait: string
• logins: string
• parallel: string
• shutdown_pending: string
• startup_time: string (date-time)
• status: string
• thread#: integer
• version: string
• version_full: string
• version_legacy: string

{
    "type":"object",
    "properties":{
        "inst_id":{
            "type":"integer"
        },
        "instance_number":{
            "type":"integer"
        },
        "instance_name":{
            "type":"string"
        },
        "host_name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "version_legacy":{
            "type":"string"
        },
        "version_full":{
            "type":"string"
        },
        "startup_time":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "parallel":{
            "type":"string"
        },
        "thread#":{
            "type":"integer"
        },
        "archiver":{
            "type":"string"
        },
        "log_switch_wait":{
            "type":"string"
        },
        "logins":{
            "type":"string"
        },
        "shutdown_pending":{
            "type":"string"
        },
        "database_status":{
            "type":"string"
        },
        "instance_role":{
            "type":"string"
        },
        "active_state":{
            "type":"string"
        },
        "blocked":{
            "type":"string"
        },
        "con_id":{
            "type":"integer"
        },
        "instance_mode":{
            "type":"string"
        },
        "edition":{
            "type":"string"
        },
        "family":{
            "type":"string"
        },
        "database_type":{
            "type":"string"
        }
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Back to Top