Jump to

• Request
• Response

List Protection Policies

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/protectionPolicies

Get protection policies on a Recovery Appliance.

Request

Path Parameters

• 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 : ProtectionPolicyCollection

Type: object

Collection of protection policy objects.

Show Source

• items(required): array items
  List of protection policy objects.

{
    "description":"Collection of protection policy objects.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonProperties"
        },
        {
            "type":"object"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of protection policy objects.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectionPolicySummary"
            }
        }
    }
}

Match All

Show Source

• object CommonProperties
  Collection of summary objects.
• object ProtectionPolicyCollection-allOf[1]

{
    "description":"Collection of protection policy objects.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonProperties"
        },
        {
            "type":"object"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of protection policy objects.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectionPolicySummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of protection policy objects.

Show Source

• Array of: object ProtectionPolicySummary
  Protection policy properties.

{
    "description":"List of protection policy objects.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectionPolicySummary"
    }
}

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 : ProtectionPolicyCollection-allOf[1]

Type: object

Nested Schema : ProtectionPolicySummary

Type: object

Protection policy properties.

Show Source

• allowBackupDeletion: string
  Specifies whether Recovery Appliance will allow deletion of backups via the RMAN DELETE command for databases associated with this protection policy
• archivedLogBackupCompression: string
  Allowed Values: [ "BASIC", "ADVANCED", "MEDIUM", "HIGH" ]

  The compression algorithm that will be used for archived log backups created by the Recovery Appliance
• autotuneReservedSpace: string
  Specifies whether the Recovery Appliance will automatically define and update the reserved space for databases associated with this policy (only applicable to Recovery Appliance versions 21.1 and greater).
• backupRedoFailover: string
  Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy.
• diskRecoveryWindowGoal: string
  A recovery window goal that Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.
• guaranteedBackupCopy: string
  Always accept new backups, even if it requires purging existing backups not yet copied to media or replicated.
• keepCompliance: string
  Specifies whether the Recovery Appliance should keep the backups of the databases associated with this protection policy until the "keep until time" (only applicable to Recovery Appliance versions 21.1 and greater).
• maxDiskBackupRetention: string
  A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be retained beyond the disk recovery window goal as space permits.
• mediaManagerRecoveryWindow: string
  A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.
• name: string
  Protection policy name.
• protectedDatbasesCount: number
  The number of protected databases using this protection policy.
• recoveryWindowCompliance: string
  Specifies a time range that the Recovery Appliance must ensure that all databases using this protection policy can be recovered to (only applicable to Recovery Appliance versions 21.1 and greater).
• unprotectedDataWindowThreshold: string
  The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy

{
    "description":"Protection policy properties.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Protection policy name.",
            "type":"string"
        },
        "diskRecoveryWindowGoal":{
            "description":"A recovery window goal that Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy",
            "type":"string"
        },
        "mediaManagerRecoveryWindow":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "maxDiskBackupRetention":{
            "description":"A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be retained beyond the disk recovery window goal as space permits.",
            "type":"string"
        },
        "guaranteedBackupCopy":{
            "description":"Always accept new backups, even if it requires purging existing backups not yet copied to media or replicated.",
            "type":"string"
        },
        "backupRedoFailover":{
            "description":"Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy.",
            "type":"string"
        },
        "allowBackupDeletion":{
            "description":"Specifies whether Recovery Appliance will allow deletion of backups via the RMAN DELETE command for databases associated with this protection policy",
            "type":"string"
        },
        "archivedLogBackupCompression":{
            "$ref":"#/components/schemas/ArchivedLogBackupCompressionEnum"
        },
        "recoveryWindowCompliance":{
            "description":"Specifies a time range that the Recovery Appliance must ensure that all databases using this protection policy can be recovered to (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        },
        "keepCompliance":{
            "description":"Specifies whether the Recovery Appliance should keep the backups of the databases associated with this protection policy until the \"keep until time\" (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        },
        "autotuneReservedSpace":{
            "description":"Specifies whether the Recovery Appliance will automatically define and update the reserved space for databases associated with this policy (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        },
        "protectedDatbasesCount":{
            "description":"The number of protected databases using this protection policy.",
            "type":"number"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

Match All

Show Source

• object ChildDetailsLink
  Object details Link.
• object ProtectionPolicySummary-allOf[1]

{
    "description":"Protection policy properties.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Protection policy name.",
            "type":"string"
        },
        "diskRecoveryWindowGoal":{
            "description":"A recovery window goal that Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy",
            "type":"string"
        },
        "mediaManagerRecoveryWindow":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "maxDiskBackupRetention":{
            "description":"A maximum time that disk backups should be retained. This value must be greater than or equal to the disk recovery window goal. If not specified, backups will be retained beyond the disk recovery window goal as space permits.",
            "type":"string"
        },
        "guaranteedBackupCopy":{
            "description":"Always accept new backups, even if it requires purging existing backups not yet copied to media or replicated.",
            "type":"string"
        },
        "backupRedoFailover":{
            "description":"Specifies whether protected databases using this protection policy will use this Recovery Appliance as an alternate destination in a backup and redo failover strategy.",
            "type":"string"
        },
        "allowBackupDeletion":{
            "description":"Specifies whether Recovery Appliance will allow deletion of backups via the RMAN DELETE command for databases associated with this protection policy",
            "type":"string"
        },
        "archivedLogBackupCompression":{
            "$ref":"#/components/schemas/ArchivedLogBackupCompressionEnum"
        },
        "recoveryWindowCompliance":{
            "description":"Specifies a time range that the Recovery Appliance must ensure that all databases using this protection policy can be recovered to (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        },
        "keepCompliance":{
            "description":"Specifies whether the Recovery Appliance should keep the backups of the databases associated with this protection policy until the \"keep until time\" (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        },
        "autotuneReservedSpace":{
            "description":"Specifies whether the Recovery Appliance will automatically define and update the reserved space for databases associated with this policy (only applicable to Recovery Appliance versions 21.1 and greater).",
            "type":"string"
        },
        "protectedDatbasesCount":{
            "description":"The number of protected databases using this protection policy.",
            "type":"number"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ChildDetailsLink

Type: object

Object details Link.

Show Source

• links(required): object links
  Navigation links.

{
    "description":"Object details Link.",
    "type":"object",
    "required":[
        "links"
    ],
    "properties":{
        "links":{
            "type":"object",
            "description":"Navigation links.",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : ProtectionPolicySummary-allOf[1]

Type: object

Nested Schema : links

Type: object

Navigation links.

Show Source

• self: object Link
  Represents a link(could be self, previous or next)

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

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : links

Type: object

Navigation links.

Show Source

• next: object Link
  Represents a link(could be self, previous or next)
• self: object Link
  Represents a link(could be self, previous or next)

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

400 Response

Bad Request

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Show Source

• object ErrorResponse
  Error response

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Error response

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Show Source

• object ErrorResponse
  Error response

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Error response

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Show Source

• object ErrorResponse
  Error response

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Error response

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : CommonErrorResponse

Type: object

Common Error response.

Show Source

• code(required): string
  HTTP Status Code
• errors(required): array errors
  List of errors and their details.
• message(required): string
  Error description.

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Match All

Show Source

• object ErrorResponse
  Error response

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of errors and their details.

Show Source

• Array of: object ErrorResponse
  Error response

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

Nested Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top