Jump to

• Request
• Response

Get Protected Database Restore Information

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/protectedDatabases/{protectedDatabaseUniqueName}/restoreInfo

Get restore information for a protected database on a Recovery Appliance.

Request

Path Parameters

• protectedDatabaseUniqueName(required): string
  Protected database unique name.

  Example:

  PROTDB1

• raTargetId(required): string
  Recovery Appliance Target id.

  Example:

  F76BBCCBD8A0D4719A8AA588375FA8BE

Header Parameters

• ORCL-EM-ZDLRATARGET-AUTHORIZATION(required): string
  Recovery Appliance Administrator Credentials. The format must be NAMED: (e.g. NAMED:ORSADMIN) or PREFERRED: (e.g. PREFERRED:PREF_ORSADMIN). If no value is specified, the system will use preferred credentials.

  Example:

  NAMED:ORSADMIN

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Operation

Body ()

Root Schema : ProtectedDatabaseRestoreInfo

Type: object

Collection of protected database restore information.

Show Source

• items(required): array items
  List of protected database restore information objects.

{
    "description":"Collection of protected database restore information.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonProperties"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of protected database restore information objects.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestoreInfoSummary"
            }
        }
    }
}

Match All

Collection of protected database restore information.

Show Source

• object CommonProperties
  Collection of summary objects.

{
    "description":"Collection of protected database restore information.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonProperties"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of protected database restore information objects.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestoreInfoSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of protected database restore information objects.

Show Source

• Array of: object RestoreInfoSummary
  Restore information of a protected database.

{
    "description":"List of protected database restore information objects.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestoreInfoSummary"
    }
}

Nested Schema : CommonProperties

Type: object

Collection of summary objects.

Show Source

• count(required): integer
  Count of summary objects in this page.

  Example: 1
• links(required): object links
  Navigation links.
• nextPage: string
  For pagination of a list of items. When paging through a list, if this value appears in the response, then there are additional items still to get. Include this value as the page parameter for the subsequent "List" request.

{
    "description":"Collection of summary objects.",
    "type":"object",
    "required":[
        "count",
        "links"
    ],
    "properties":{
        "count":{
            "example":1,
            "description":"Count of summary objects in this page.",
            "type":"integer"
        },
        "nextPage":{
            "description":"For pagination of a list of items. When paging through a list, if this value appears in the \nresponse, then there are additional items still to get. Include this value as the page \nparameter for the subsequent \"List\" request.\n",
            "type":"string"
        },
        "links":{
            "type":"object",
            "description":"Navigation links.",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : RestoreInfoSummary

Type: object

Restore information of a protected database.

Show Source

• highTime: string
  High time of the restore range. Format will be YYYY-MM-DDTHH:mm:ssZ in UTC timezone.
• lowTime: string
  Low time of the restore range. Format will be YYYY-MM-DDTHH:mm:ssZ in UTC timezone.
• protectedDatabaseName: string
  Protected database unique name.
• protectedDatabaseTimeZone: string
  Protected database time zone.
• restorePointNames: array restorePointNames
  Restore point names.
• restorePointScns: array restorePointScns
  Restore SCNs.

{
    "description":"Restore information of a protected database.",
    "type":"object",
    "properties":{
        "protectedDatabaseName":{
            "description":"Protected database unique name.",
            "type":"string"
        },
        "protectedDatabaseTimeZone":{
            "description":"Protected database time zone.",
            "type":"string"
        },
        "lowTime":{
            "description":"Low time of the restore range. Format will be YYYY-MM-DDTHH:mm:ssZ in UTC timezone.",
            "type":"string"
        },
        "highTime":{
            "description":"High time of the restore range. Format will be YYYY-MM-DDTHH:mm:ssZ in UTC timezone.",
            "type":"string"
        },
        "restorePointNames":{
            "description":"Restore point names.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "restorePointScns":{
            "description":"Restore SCNs.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : restorePointNames

Type: array

Restore point names.

Show Source

• Array of: string

{
    "description":"Restore point names.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : restorePointScns

Type: array

Restore SCNs.

Show Source

• Array of: string

{
    "description":"Restore SCNs.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: object

Navigation links.

Show Source

• next: object Link
  A link
• self: object Link
  A link

{
    "type":"object",
    "description":"Navigation links.",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : Link

Type: object

A link

Show Source

• href: string
  URL for link.

{
    "description":"A link",
    "type":"object",
    "properties":{
        "href":{
            "description":"URL for link.",
            "type":"string"
        }
    }
}

400 Response

Bad Request.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

401 Response

Unauthorized.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

403 Response

Forbidden.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

404 Response

Not Found.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

500 Response

Internal Server Error.

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

503 Response

Service Unavailable

Headers

• ORCL-EM-RETRY-LINK:
  Link of the request that failed.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent in the case of an error.

Show Source

• code(required): string
  Error code.

  Example: InvalidParameter
• message(required): string
  Error description.

  Example: Parameter cannot be empty

{
    "description":"Response sent in the case of an error.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"Error code.",
            "example":"InvalidParameter"
        },
        "message":{
            "type":"string",
            "description":"Error description.",
            "example":"Parameter cannot be empty"
        }
    }
}

Back to Top