Jump to

• Request
• Response

Add Protected Databases

post

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

Add protected databases to 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 protected databases to be added to a Recovery Appliance.

Show Source

• protectedDatabases(required): array protectedDatabases
  List of protected databases to be added to a Recovery Appliance.
• 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 protected databases to be added to a Recovery Appliance.",
    "type":"object",
    "required":[
        "protectedDatabases"
    ],
    "properties":{
        "protectedDatabases":{
            "description":"List of protected databases to be added to a Recovery Appliance.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectedDatabaseProperties"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

Nested Schema : protectedDatabases

Type: array

List of protected databases to be added to a Recovery Appliance.

Show Source

• Array of: object ProtectedDatabaseProperties
  Protected database properties.

{
    "description":"List of protected databases to be added to a Recovery Appliance.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectedDatabaseProperties"
    }
}

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 : ProtectedDatabaseProperties

Type: object

Protected database properties.

Show Source

• granteeName: string
  A comma separated list of Enterprise Manager users. A list of Enterprise Manager database administrator users that need access to the Recovery Appliance virtual private catalog user credentials specified by vpcUserCred, in order to configure databases to send backups to the Recovery Appliance. The list of Enterprise Manager users is ALL, CLOUD_SWLIB_USER, DESIGNER, EMCLOUD_ADMIN, EMSSA_ADMIN, EMUSER_ADMIN, INFRA_ADMIN, OPER, PLUGIN_ADMIN, PLUGIN_AGENT_ADMIN, PLUGIN_OMS_ADMIN, PLUGIN_USER, PROV_DESIGNER, PROV_OPERATOR, TESTSUPERADMIN, VIEWER

  Example: EMUSER_ADMIN, INFRA_ADMIN, OPER, DESIGNER
• name(required): string
  Enterprise Manager target name of a single-instance or cluster database to be enrolled with the Recovery Appliance. A group target name can be specified, in which case all the database members of the group will be enrolled. Database unique name can also be used.

  Example: Oemrep_Database
• protectionPolicyName(required): string
  Name of protection policy to be used for the databases being enrolled on the Recovery Appliance.

  Example: MYPOLICY
• reservedSpace: string
  Allowed Values: [ "G", "T", "P" ]

  Reserved space to be allocated on the Recovery Appliance for the protected databases. This can be specified in gigabytes(G), terabytes (T), or petabytes (P) (examples, 10.4G, 1.2T). The default is gigabytes(G) if the unit is not specified. This is required field if targetType is not specified, and no otherwise. By default, for any databases for which a value is not specified, reserved space will be set according to the following formula ((2 x ) + 100) GB.

  Example: 10.4G
• targetType(required): string
  Allowed Values: [ "oracle_database", "rac_database", "composite" ]

  Target type corresponding to the target specified by target name. This can be oracle_database, rac_database, or composite. If database unique name to be enrolled as a protected database, then this targetType should be blank.

  Example: oracle_database
• vpcUserCred(required): string
  Specify credentials for an existing Recovery Appliance database user that will be given the ability to backup and restore the protected databases. A comma separated list of vpcUserCred can be specified. The format must be NAMED: (e.g. NAMED:RMAN or NAMED:RMAN,NAMED:RASYS,NAMED:VPCUSER1) or PREFERRED: (e.g. PREFERRED:PREF_RMAN).

  Example: NAMED:RMAN

{
    "description":"Protected database properties.",
    "type":"object",
    "required":[
        "protectionPolicyName",
        "name",
        "targetType",
        "vpcUserCred"
    ],
    "properties":{
        "protectionPolicyName":{
            "example":"MYPOLICY",
            "description":"Name of protection policy to be used for the databases being enrolled on the Recovery Appliance.",
            "type":"string"
        },
        "name":{
            "example":"Oemrep_Database",
            "description":"Enterprise Manager target name of a single-instance or cluster database to be enrolled with the Recovery Appliance. A group target name can be specified, in which case all the database members of the group will be enrolled. Database unique name can also be used.",
            "type":"string"
        },
        "targetType":{
            "$ref":"#/components/schemas/TargetTypeOptions"
        },
        "reservedSpace":{
            "$ref":"#/components/schemas/ReservedSpaceAddOptions"
        },
        "vpcUserCred":{
            "example":"NAMED:RMAN",
            "description":"Specify credentials for an existing Recovery Appliance database user that will be given the ability to backup and restore the protected databases. A comma separated list of vpcUserCred can be specified. The format must be NAMED:<credName> (e.g. NAMED:RMAN or NAMED:RMAN,NAMED:RASYS,NAMED:VPCUSER1) or PREFERRED:<credName> (e.g. PREFERRED:PREF_RMAN).",
            "type":"string"
        },
        "granteeName":{
            "$ref":"#/components/schemas/EnterpriseManagerUserOptions"
        }
    }
}

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 : ProtectedDatabaseDPSubmissionAdd

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: ADD_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
  Name of the submitted deployment procedure.

  Example: ADD_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":"ADD_PROTECTED_DB_120321215846",
            "description":"Name of the submitted deployment procedure.",
            "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":"ADD_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

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

409 Response

Conflict

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