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: string
  Database Name

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(optional): integer
  Total number of records in the current response.
• hasMore(optional): boolean
  Indicates if there are more records to be retrieved.
• items(optional): array items
• limit(optional): integer
  The actual page size limit on number of records applied by the server.
• links(optional): array links
• offset(optional): integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/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":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DataguardInstanceItem

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : DataguardInstanceItem

Type: object

Show Source

• active_state(optional): string
• archiver(optional): string
• blocked(optional): string
• con_id(optional): integer
• database_status(optional): string
• database_type(optional): string
• edition(optional): string
• family(optional): string
• host_name(optional): string
• inst_id(optional): integer
• instance_mode(optional): string
• instance_name(optional): string
• instance_number(optional): integer
• instance_role(optional): string
• log_switch_wait(optional): string
• logins(optional): string
• parallel(optional): string
• shutdown_pending(optional): string
• startup_time(optional): string(date-time)
• status(optional): string
• thread#(optional): integer
• version(optional): string
• version_full(optional): string
• version_legacy(optional): 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: string
• rel: string

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

Back to Top