Jump to

• Request
• Response

Remove Protected Database

delete

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

Remove a protected database from a Recovery Appliance.

Request

Path Parameters

• protectedDatabaseName(required): string
  Protected database unique name or target name. If the value specified is a database target name in Enterprise Manager, then targetType parameter must also be specified in the URL. If targetType is not specified, this name will be assumed to be the protected database unique name.

  Example:

  PROTDB1

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

  Example:

  F76BBCCBD8A0D4719A8AA588375FA8BE

Query Parameters

• targetType: string
  Protected Database target type. This can be oracle_database or rac_database. If this parameter is not specified, the protectedDatabaseName specified will be assumed to be the protected database unique name.

  Example:

  oracle_database

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

202 Response

Accepted

Headers

• Content-Location:
  Execution details of the deployment procedure submitted.

Body ()

Root Schema : ProtectedDatabaseDPSubmissionRemove

Type: object

Protected database deployment procedure status.

Show Source

• code(required): integer
  HTTP status code.

  Example: 202
• executionId(required): string
  Procedure execution id.

  Example: D2931B1862AF72E8E05355044B645556
• instanceName(required): string
  Procedure instance name.

  Example: REMOVE_PROTECTED_DB_120321215846
• message(required): string
  Status of the submitted deployment procedure.

  Example: Submitted successfully
• procedureId(required): string
  Procedure submission id.

  Example: D292F6B09ADA65FAE05355044B64D425
• submissionBy(required): string
  Enterprise Manager user that submitted the procedure.

  Example: SYSMAN
• submissionName(required): string
  Deployment Procedure submission name.

  Example: REMOVE_PROTECTED_DB_120321215846

{
    "description":"Protected database deployment procedure status.",
    "type":"object",
    "required":[
        "code",
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName",
        "message"
    ],
    "properties":{
        "code":{
            "example":"202",
            "description":"HTTP status code.",
            "type":"integer"
        },
        "submissionName":{
            "example":"REMOVE_PROTECTED_DB_120321215846",
            "description":"Deployment Procedure submission name.",
            "type":"string"
        },
        "submissionBy":{
            "example":"SYSMAN",
            "description":"Enterprise Manager user that submitted the procedure.",
            "type":"string"
        },
        "executionId":{
            "example":"D2931B1862AF72E8E05355044B645556",
            "description":"Procedure execution id.",
            "type":"string"
        },
        "procedureId":{
            "example":"D292F6B09ADA65FAE05355044B64D425",
            "description":"Procedure submission id.",
            "type":"string"
        },
        "instanceName":{
            "example":"REMOVE_PROTECTED_DB_120321215846",
            "description":"Procedure instance name.",
            "type":"string"
        },
        "message":{
            "example":"Submitted successfully",
            "description":"Status of the submitted deployment procedure.",
            "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