Jump to

• Request
• Response

Fleet List Archival Backups

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/archivalBackups/protectionPolicy/{protectionPolicyName}

Get the list of archival backups for all protected databases in a protection policy on a Recovery Appliance. This API requires ZDLRA Management Pack to be enabled on the Recovery Appliance.

Request

Path Parameters

• protectionPolicyName(required): string
  Protection policy name.

  Example:

  SILVER

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

  Example:

  F76BBCCBD8A0D4719A8AA588375FA8BE

Query Parameters

• limit: integer(int32)
  Minimum Value: 1

  Maximum Value: 2000

  To limit the number of rows returned. If the result set is greater, follow the previous and next links in the results.

  Example:

  20

• page: string
  System generated page token used in the self, next and previous links.

Header Parameters

• ORCL-EM-ZDLRATARGET-AUTHORIZATION(required):
  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 : ArchivalBackupProtectionPolicyCollection

Type: object

Collection of Archival Backup objects

Show Source

• items(required): array items
  List of Archival Backup objects

{
    "description":"Collection of Archival Backup objects",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonListProperties"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of Archival Backup objects",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ArchivalBackupSinglePolicySummary"
            }
        }
    }
}

Match All

Collection of Archival Backup objects

Show Source

• object CommonListProperties
  Common properties for list response.

{
    "description":"Collection of Archival Backup objects",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonListProperties"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of Archival Backup objects",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ArchivalBackupSinglePolicySummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of Archival Backup objects

Show Source

• Array of: object ArchivalBackupSinglePolicySummary
  Archival backup Properties

{
    "description":"List of Archival Backup objects",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ArchivalBackupSinglePolicySummary"
    }
}

Nested Schema : CommonListProperties

Type: object

Common properties for list response.

Show Source

• code: integer
  HTTP Response Code.
• count(required): integer
  Count of summary objects in this page.
• message: string
  Response message.
• raTargetName: string
  Recovery appliance target name.
• raTargetTimezone: string
  Recovery appliance timezone.

{
    "description":"Common properties for list response.",
    "required":[
        "count"
    ],
    "properties":{
        "count":{
            "description":"Count of summary objects in this page.",
            "type":"integer"
        },
        "raTargetTimezone":{
            "description":"Recovery appliance timezone.",
            "type":"string"
        },
        "raTargetName":{
            "description":"Recovery appliance target name.",
            "type":"string"
        },
        "code":{
            "description":"HTTP Response Code.",
            "type":"integer"
        },
        "message":{
            "description":"Response message.",
            "type":"string"
        }
    }
}

Nested Schema : ArchivalBackupSinglePolicySummary

Type: object

Archival backup Properties

Match All

Archival backup Properties

Show Source

• object ArchivalBackupSingleDatabase
  Archival backup Properties

{
    "description":"Archival backup Properties",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ArchivalBackupSingleDatabase"
        }
    ]
}

Nested Schema : ArchivalBackupSingleDatabase

Type: object

Archival backup Properties

Show Source

• creationTime: string
  Creation time of the archival backup.
• keepbkpTag: string
  Keep backup tag used for the archival backup.
• keepbkpToTime: string
  Keep backup time used for the archival backup.
• keepUntil: string
  Keep until time of the archival backup.
• name: string
  Archival backup name
• scn: string
  SCN of the database used for the archival backup.
• status: string
  Status of the archival backup. I (Initiated), A (Available), E (Error), D (Deleted)

  Example: A

{
    "description":"Archival backup Properties",
    "type":"object",
    "properties":{
        "name":{
            "description":"Archival backup name",
            "type":"string"
        },
        "scn":{
            "description":"SCN of the database used for the archival backup.",
            "type":"string"
        },
        "keepbkpTag":{
            "description":"Keep backup tag used for the archival backup.",
            "type":"string"
        },
        "keepbkpToTime":{
            "description":"Keep backup time used for the archival backup.",
            "type":"string"
        },
        "keepUntil":{
            "description":"Keep until time of the archival backup.",
            "type":"string"
        },
        "status":{
            "description":"Status of the archival backup.  I (Initiated), A (Available), E (Error), D (Deleted)",
            "type":"string",
            "example":"A"
        },
        "creationTime":{
            "description":"Creation time of the archival backup.",
            "type":"string"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top