Jump to

• Request
• Response

Delete Protection Policies

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/actions/bulkDeleteProtectionPolicies

Delete one or more protection policies on a Recovery Appliance.

Request

Path Parameters

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

  Example:

  F76BBCCBD8A0D4719A8AA588375FA8BE

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Details of protection policies to be deleted from one or more Recovery Appliances.

Show Source

• protectionPolicies(required): array protectionPolicies
  List of protection policies to be deleted from one or more Recovery Appliances.
• schedule: object ScheduleRAOperations
  Schedule with which the protected databases procedure will be scheduled. If the schedule option is not provided, the protected databases procedure runs immediately.

{
    "description":"Details of protection policies to be deleted from one or more Recovery Appliances.",
    "type":"object",
    "required":[
        "protectionPolicies"
    ],
    "properties":{
        "protectionPolicies":{
            "description":"List of protection policies to be deleted from one or more Recovery Appliances.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DeleteProtectionPolicies"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

Nested Schema : protectionPolicies

Type: array

List of protection policies to be deleted from one or more Recovery Appliances.

Show Source

• Array of: object DeleteProtectionPolicies
  Protection policies to be deleted.

{
    "description":"List of protection policies to be deleted from one or more Recovery Appliances.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeleteProtectionPolicies"
    }
}

Nested Schema : ScheduleRAOperations

Type: object

Schedule with which the protected databases procedure will be scheduled. If the schedule option is not provided, the protected databases procedure runs immediately.

Show Source

• daysOfTheMonth: string
  Comma-separated list of days. (Required only if frequency is monthly, or yearly. Example, repeat=1d. The valid range is 1 to 30 inclusive)
• daysOfTheWeek: string
  Comma-separated list of days. (Required only if frequency is weekly. Example, repeat=1D. The valid range is 1 to 7 inclusive)
• endTime: string
  End time for the procedure executions (optional). If it is not specified, the procedure runs indefinitely. W3C Time format (example,2021-12-10T19:16:19.666Z25:66:00)

  Example: 2021-12-10T19:16:19.666Z25:66:00
• frequency: string
  Allowed Values: [ "INTERVAL", "WEEKLY", "MONTHLY", "YEARLY" ]

  Schedule Frequency Options
• gracePeriod: string
  Grace period in minutes (optional)
• monthsOfTheYear: string
  Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive.
• repeat: string
  Frequency with which the procedure will be repeated. (Required only if frequency is set to interval)
• startTime: string
  Time when the procedure is to start executing. W3C Time format (example,2021-11-10T19:16:19.666Z25:66:00)

  Example: 2021-11-10T19:16:19.666Z25:66:00

{
    "description":"Schedule with which the protected databases procedure will be scheduled. If the schedule option is not provided, the protected databases procedure runs immediately.",
    "type":"object",
    "properties":{
        "startTime":{
            "example":"2021-11-10T19:16:19.666Z25:66:00",
            "type":"string",
            "description":"Time when the procedure is to start executing. W3C Time format (example,2021-11-10T19:16:19.666Z25:66:00)"
        },
        "endTime":{
            "example":"2021-12-10T19:16:19.666Z25:66:00",
            "type":"string",
            "description":"End time for the procedure executions (optional). If it is not specified, the procedure runs indefinitely. W3C Time format (example,2021-12-10T19:16:19.666Z25:66:00)"
        },
        "frequency":{
            "$ref":"#/components/schemas/ScheduleFrequencyOptions"
        },
        "repeat":{
            "type":"string",
            "description":"Frequency with which the procedure will be repeated. (Required only if frequency is set to interval)"
        },
        "daysOfTheWeek":{
            "type":"string",
            "description":"Comma-separated list of days. (Required only if frequency is weekly. Example, repeat=1D. The valid range is 1 to 7 inclusive)"
        },
        "daysOfTheMonth":{
            "type":"string",
            "description":"Comma-separated list of days. (Required only if frequency is monthly, or yearly. Example, repeat=1d. The valid range is 1 to 30 inclusive)"
        },
        "monthsOfTheYear":{
            "type":"string",
            "description":"Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive."
        },
        "gracePeriod":{
            "type":"string",
            "description":"Grace period in minutes (optional)"
        }
    }
}

Nested Schema : DeleteProtectionPolicies

Type: object

Protection policies to be deleted.

Show Source

• name(required): string
  Protection policy name.

{
    "description":"Protection policies to be deleted.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Protection policy name.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Headers

• Content-Location:
  Status of the deployment procedure submitted can be viewed in this location.

Body ()

Root Schema : ProtectionPolicyDPSubmission

Type: object

Protection policy deployment procedure status.

Show Source

• code(required): integer
  HTTP status code.
• executionId(required): string
  Procedure submission id.
• instanceName(required): string
  Procedure instance name.
• procedureId(required): string
  Procedure submission id.
• submissionBy(required): string
  Name of the Enterprise Manager user who submitted the deployment procedure.
• submissionName(required): string
  Name of the submitted deployment procedure.

{
    "description":"Protection policy deployment procedure status.",
    "type":"object",
    "required":[
        "code",
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName"
    ],
    "properties":{
        "code":{
            "description":"HTTP status code.",
            "type":"integer"
        },
        "submissionName":{
            "description":"Name of the submitted deployment procedure.",
            "type":"string"
        },
        "submissionBy":{
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure.",
            "type":"string"
        },
        "executionId":{
            "description":"Procedure submission id.",
            "type":"string"
        },
        "procedureId":{
            "description":"Procedure submission id.",
            "type":"string"
        },
        "instanceName":{
            "description":"Procedure instance name.",
            "type":"string"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

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"
        }
    }
}

401 Response

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

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"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

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"
        }
    }
}

404 Response

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

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"
        }
    }
}

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