移動先

• リクエスト
• レスポンス

保護されたデータベースの追加

post

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

保護されたデータベースをリカバリ・アプライアンスに追加します。

リクエスト

パス・パラメータ

• raTargetId(必須): string
  リカバリ・アプライアンスのターゲットID。

  例:

  F76BBCCBD8A0D4719A8AA588375FA8BE

ヘッダー・パラメータ

• ORCL-EM-ZDLRATARGET-AUTHORIZATION(必須):
  リカバリ・アプライアンスの管理者資格証明。書式は、NAMED: (NAMED:ORSADMINなど)またはPREFERRED: (PREFERRED:PREF_ORSADMINなど)である必要があります。値を指定しない場合は、優先資格証明が使用されます。

  例:

  NAMED:ORSADMIN

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

リカバリ・アプライアンスに追加する保護されたデータベースの詳細。

ソースの表示

• protectedDatabases(必須): array protectedDatabases
  リカバリ・アプライアンスに追加する保護されたデータベースのリスト。
• schedule: object ScheduleRAOperations
  デプロイメント・プロシージャまたはジョブのスケジュール。

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

ネストされたスキーマ: protectedDatabases

型: array

リカバリ・アプライアンスに追加する保護されたデータベースのリスト。

ソースの表示

• 配列: object ProtectedDatabaseProperties
  保護されたデータベースのプロパティ。

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

ネストされたスキーマ: ScheduleRAOperations

型: object

デプロイメント・プロシージャまたはジョブのスケジュール。

ソースの表示

• daysOfTheMonth: string
  日数のカンマ区切りリスト。(頻度がmonthlyまたはyearlyに設定されている場合のみ必要です。たとえば、repeat=1dです。有効範囲は1と30を含むその範囲です)
• daysOfTheWeek: string
  日数のカンマ区切りリスト。(頻度がweeklyに設定されている場合のみ必要です。たとえば、repeat=1Dです。有効範囲は1と7を含むその範囲です)
• endTime: string
  プロシージャ実行の終了時間(オプション)。指定しない場合、プロシージャは無限に実行されます。W3C時間書式。

  例: 2025-12-31T20:00:00UTC, 2025-12-31T20:00:00America/New_York, 2025-12-31T20:00:00Z, 2025-12-31T20:00:00+05:00
• frequency: string
  指定可能な値: [ "INTERVAL", "WEEKLY", "MONTHLY", "YEARLY" ]

  スケジュール頻度オプション
• gracePeriod: string
  分単位の猶予期間(オプション)
• monthsOfTheYear: string
  月数のカンマ区切りリスト。(頻度がyearlyに設定されている場合のみ必要です。)有効範囲は1と12を含むその範囲です。
• repeat: string
  ジョブを繰り返す必要がある頻度。(frequencyをintervalに設定した場合にのみ必須)
• startTime: string
  プロシージャの実行を開始する時間。W3C時間書式。

  例: 2024-12-31T20:00:00UTC, 2024-12-31T20:00:00America/New_York, 2024-12-31T20:00:00Z, 2024-12-31T20:00:00+05:00

{
    "description":"Schedule for deployment procedure or job.",
    "type":"object",
    "properties":{
        "startTime":{
            "example":"2024-12-31T20:00:00UTC, 2024-12-31T20:00:00America/New_York, 2024-12-31T20:00:00Z, 2024-12-31T20:00:00+05:00",
            "type":"string",
            "description":"Time when the procedure is to start executing. W3C Time format."
        },
        "endTime":{
            "example":"2025-12-31T20:00:00UTC, 2025-12-31T20:00:00America/New_York, 2025-12-31T20:00:00Z, 2025-12-31T20:00:00+05:00",
            "type":"string",
            "description":"End time for the procedure executions (optional). If it is not specified, the procedure runs indefinitely. W3C Time format."
        },
        "frequency":{
            "$ref":"#/components/schemas/ScheduleFrequencyOptions"
        },
        "repeat":{
            "type":"string",
            "description":"Frequency with which the job must 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)"
        }
    }
}

ネストされたスキーマ: ProtectedDatabaseProperties

型: object

保護されたデータベースのプロパティ。

ソースの表示

• granteeName: string
  Enterprise Managerユーザーのカンマ区切りリスト。リカバリ・アプライアンスにバックアップを送信するようにデータベースを構成するために、vpcUserCredで指定されたリカバリ・アプライアンス仮想プライベート・カタログ・ユーザー資格証明にアクセスする必要があるEnterprise Managerデータベース管理者ユーザーのリスト。Enterprise Managerユーザーのリストは、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です

  例: EMUSER_ADMIN, INFRA_ADMIN, OPER, DESIGNER
• name(必須): string
  リカバリ・アプライアンスに登録される単一インスタンスまたはクラスタ・データベースのEnterprise Managerターゲット名。グループ・ターゲット名を指定できますが、その場合はグループのすべてのデータベース・メンバーが登録されます。データベースの一意の名前も使用できます。

  例: Oemrep_Database
• protectionPolicyName(必須): string
  リカバリ・アプライアンスに登録するデータベースに使用される保護ポリシーの名前。

  例: MYPOLICY
• reservedSpace: string
  指定可能な値: [ "G", "T", "P" ]

  保護されたデータベース用に、リカバリ・アプライアンスに割り当てられる予約済の領域。これは、GB (G)、TB (T)またはPB (P)で指定できます(例: 10.4G、1.2T)。単位を指定しない場合、デフォルトはGB (G)です。targetTypeが指定されていない場合、これは必須フィールドで、それ以外の場合は不要です。デフォルトでは、値が指定されていないデータベースの場合、予約領域は、式((2 x ) + 100) GBに従って設定されます。

  例: 10.4G
• targetType(必須): string
  指定可能な値: [ "oracle_database", "rac_database", "composite" ]

  ターゲット名で指定されたターゲットに対応するターゲット・タイプ。oracle_database、rac_databaseまたはcompositeを指定できます。データベースの一意の名前を保護されたデータベースとして登録する場合、このtargetTypeは空白にする必要があります。

  例: oracle_database
• vpcUserCred(必須): string
  既存のリカバリ・アプライアンス・データベース・ユーザーに、保護されたデータベースのバックアップやリストアができるようになる資格証明を指定します。vpcUserCredのカンマ区切りリストを指定できます。書式は、NAMED: (NAMED:RMANやNAMED:RMAN,NAMED:RASYS,NAMED:VPCUSER1など)またはPREFERRED: (PREFERRED:PREF_RMANなど)である必要があります。

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

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

202レスポンス

許容

ヘッダー

• Content-Location:
  発行されたデプロイメント・プロシージャの実行の詳細。

本文()

ルート・スキーマ: ProtectedDatabaseDPSubmissionAdd

型: object

保護されたデータベース・デプロイメント・プロシージャのステータス。

ソースの表示

• code(必須): integer
  HTTPステータス・コード。

  例: 202
• executionId(必須): string
  プロシージャ実行ID。

  例: D2931B1862AF72E8E05355044B645556
• instanceName(必須): string
  プロシージャ・インスタンス名。

  例: ADD_PROTECTED_DB_120321215846
• message(必須): string
  発行されたデプロイメント・プロシージャのステータス。

  例: Submitted successfully
• procedureId(必須): string
  プロシージャ発行ID。

  例: D292F6B09ADA65FAE05355044B64D425
• submissionBy(必須): string
  プロシージャを発行したEnterprise Managerユーザー。

  例: SYSMAN
• submissionName(必須): string
  発行されたデプロイメント・プロシージャの名前。

  例: 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レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

競合

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): 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"
        }
    }
}

先頭に戻る