移動先

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

保護ポリシーのフリート作成

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/actions/bulkCreateProtectionPolicies

1つ以上のリカバリ・アプライアンスで1つ以上の保護ポリシーを作成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/json

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

ルート・スキーマ: schema

型: object

1つ以上のリカバリ・アプライアンスに対する保護ポリシー作成/更新/削除APIに使用される属性。

ソースの表示

• raTargetNames(必須): array raTargetNames
  1つ以上のリカバリ・アプライアンスで作成または更新される保護ポリシーのリスト。
• schedule: object ScheduleRAOperations
  デプロイメント・プロシージャまたはジョブのスケジュール。

{
    "description":"Attributes to be used for the Create/Update/Delete protection policy APIs for one or more Recovery Appliances.",
    "type":"object",
    "required":[
        "raTargetNames"
    ],
    "properties":{
        "raTargetNames":{
            "description":"List of protection policies to be created or updated on one or more Recovery Appliances.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectionPoliciesPerTarget"
            }
        },
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

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

型: array

1つ以上のリカバリ・アプライアンスで作成または更新される保護ポリシーのリスト。

ソースの表示

• 配列: object ProtectionPoliciesPerTarget
  リカバリ・アプライアンスで作成される保護ポリシーのリスト。

{
    "description":"List of protection policies to be created or updated on one or more Recovery Appliances.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectionPoliciesPerTarget"
    }
}

ネストされたスキーマ: 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)"
        }
    }
}

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

型: object

リカバリ・アプライアンスで作成される保護ポリシーのリスト。

ソースの表示

• protectionPolicies(必須): array protectionPolicies
  保護ポリシーのリスト。
• raAdminCred: string
  リカバリ・アプライアンスの管理者資格証明。
• raTargetId(必須): string
  保護ポリシーを作成、削除または更新するリカバリ・アプライアンスのターゲットGUID。

{
    "description":"List of protection policies to be created on a Recovery Appliance.",
    "type":"object",
    "required":[
        "raTargetId",
        "protectionPolicies"
    ],
    "properties":{
        "raTargetId":{
            "description":"Recovery Appliance target GUID on which protection policies are to be created, deleted or updated.",
            "type":"string"
        },
        "raAdminCred":{
            "description":"Recovery Appliance administrator credentials.",
            "type":"string"
        },
        "protectionPolicies":{
            "description":"List of protection policies.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectionPolicyProperties"
            }
        }
    }
}

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

型: array

保護ポリシーのリスト。

ソースの表示

• 配列: object ProtectionPolicyProperties
  保護ポリシーのプロパティ。

{
    "description":"List of protection policies.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectionPolicyProperties"
    }
}

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

型: object

保護ポリシーのプロパティ。

ソースの表示

• allowBackupDeletion: string
  リカバリ・アプライアンスで、この保護ポリシーに関連付けられているデータベースのRMAN DELETEコマンドを使用したバックアップの削除を許可するかどうかを指定します。
• archivedLogBackupCompression: string
  指定可能な値: [ "BASIC", "ADVANCED", "MEDIUM", "HIGH" ]

  リカバリ・アプライアンスによって作成されるアーカイブ・ログ・バックアップで使用される圧縮アルゴリズム
• autotuneReservedSpace: string
  リカバリ・アプライアンスで、このポリシーに関連付けられているデータベースの予約領域を自動的に定義および更新するかどうかを指定します(リカバリ・アプライアンス・バージョン21.1以降にのみ適用)。

  例: YES
• backupRedoFailover: string
  この保護ポリシーを使用する保護されたデータベースで、バックアップおよびREDOフェイルオーバー計画の代替宛先としてこのリカバリ・アプライアンスを使用するかどうかを指定します。有効にすると、この保護ポリシーを使用する保護されたデータベースのバックアップおよびREDOは、後でプライマリ・リカバリ・アプライアンスに転送するために一時的に保存され、転送後はこのリカバリ・アプライアンスから削除されます。
• diskRecoveryWindowGoal(必須): string (period)
  ディスク・バックアップを使用したPoint-in-Timeリカバリのために、リカバリ・アプライアンスで達成する必要があるリカバリ・ウィンドウ目標。ISO 8601拡張形式の文字列として指定します(PnYnMnDTnHnMnS。Pは常に存在し、Tはサブ日時コンポーネントの前にあり、存在するすべてのコンポーネントに適切な接尾辞が付きます)。たとえば、P1DT5H (1日と5時間)です。
• enableSecureMode: string
  この保護ポリシーに関連付けられたデータベースのバックアップを暗号化する必要があるかどうかを指定します。セキュア・モードが有効になっている場合、バックアップおよびREDOを暗号化する必要があります。暗号化されていないバックアップまたはREDOログは拒否されます。たとえば、"YES"、"NO"です(リカバリ・アプライアンス・バージョン23.1以上にのみ適用可能)。

  例: YES
• guaranteedBackupCopy: string
  まだメディアにコピーまたはレプリケートされていない既存のバックアップを削除する必要がある場合でも、新しいバックアップを常に受け入れます。
• keepCompliance: string
  リカバリ・アプライアンスで、この保護ポリシーに関連付けられているデータベースのバックアップを"保持期限"まで保持するかどうかを指定します(リカバリ・アプライアンス・バージョン21.1以降にのみ適用)。

  例: YES
• level0Refresh: string (period)
  データベース全体の新しいL0バックアップを作成する必要がある頻度を指定します。定期的なL0バックアップにより、リストアに必要な暗号化キーの数が減ります。推奨値は365日(1年)です。最小値は100日で、最大値は730日(2年)です。ISO 8601拡張形式の文字列(PnD: Pは常に存在し、D (日)単位が付く)として指定します。たとえば、"P365D" (365日)です(リカバリ・アプライアンス・バージョン23.1以上にのみ適用可能)。

  例: P365D
• maxDiskBackupRetention: string (period)
  ディスク・バックアップを保持する必要のある最大期間。この値は、ディスク・リカバリ・ウィンドウ目標以上にする必要があります。指定しない場合は、領域があるかぎり、ディスク・リカバリ・ウィンドウ目標を超えてバックアップが保持されます。ISO 8601拡張形式の文字列として指定します(PnYnMnDTnHnMnS。Pは常に存在し、Tはサブ日時コンポーネントの前にあり、存在するすべてのコンポーネントに適切な接尾辞が付きます)。
• mediaManagerRecoveryWindow: string (period)
  メディア・マネージャ(Oracle Secure Backupなど)からのPoint-in-Timeリカバリ機能が維持されるより長期のウィンドウ。ISO 8601拡張形式の文字列として指定します(PnYnMnDTnHnMnS。Pは常に存在し、Tはサブ日時コンポーネントの前にあり、存在するすべてのコンポーネントに適切な接尾辞が付きます)。
• name(必須): string
  保護ポリシー名。
• recoveryWindowCompliance: string
  この保護ポリシーを使用するすべてのデータベースをリカバリできるようにリカバリ・アプライアンスで保証する必要がある時間範囲を指定します。このリカバリ・ウィンドウ・コンプライアンス属性が設定されている場合は、allowBackupDeletion属性を設定しないでください(リカバリ・アプライアンス・バージョン21.1以降にのみ適用)。ISO 8601拡張形式の文字列として指定します(PnYnMnDTnHnMnS。Pは常に存在し、Tはサブ日時コンポーネントの前にあり、存在するすべてのコンポーネントに適切な接尾辞が付きます)。たとえば、P1DT5H (1日と5時間)です。
• unprotectedDataWindowThreshold: string (period)
  この保護ポリシーに関連付けられているデータベースで、データ損失にさらされる可能性がある最大期間。このポリシーに関連付けられているデータベースで、この期間を超えた場合には、警告が生成されます。ISO 8601拡張形式の文字列として指定します(PnYnMnDTnHnMnS。Pは常に存在し、Tはサブ日時コンポーネントの前にあり、存在するすべてのコンポーネントに適切な接尾辞が付きます)。

{
    "description":"Protection policy properties.",
    "type":"object",
    "required":[
        "name",
        "diskRecoveryWindowGoal"
    ],
    "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. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed). Example, P1DT5H (1 day and 5 hours)",
            "type":"string",
            "format":"period"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy. If this amount of time is exceeded for a database associated with this policy, a warning will be generated. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).",
            "type":"string",
            "format":"period"
        },
        "mediaManagerRecoveryWindow":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).",
            "type":"string",
            "format":"period"
        },
        "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. Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed).",
            "type":"string",
            "format":"period"
        },
        "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. If enabled, backups and redo for protected databases that use this protection policy will be stored temporarily for later forwarding to a primary Recovery Appliance, after which they will be deleted from this Recovery Appliance.",
            "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. If this Recovery Window Compliance attribute is set, do not set allowBackupDeletion attribute (only applicable to Recovery Appliance versions 21.1 and greater). Specified as a string in ISO 8601 extended format (PnYnMnDTnHnMnS with P always present, T preceding any sub-day time components, and all present components properly suffixed). Example, P1DT5H (1 day and 5 hours)",
            "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",
            "example":"YES"
        },
        "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",
            "example":"YES"
        },
        "enableSecureMode":{
            "description":"Specifies whether the backups of the databases associated with this protection policy must be encrypted. If secure mode is enabled, backups and redo must be encrypted. Non-encrypted backups or redo logs will be rejected. Examples, \"YES\", \"NO\". (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"YES"
        },
        "level0Refresh":{
            "description":"Specifies how often a new L0 backup of the whole database must be taken. A periodic L0 backup will reduce the number of encryption keys needed for a restore. The recommended value is 365 days (1 year). The minimum value is 100 days and the maximum value is 730 days (2 years). Specified as a string in ISO 8601 extended format (PnD as P always present with D (day) unit). Example, \"P365D\" (365 days). (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"P365D",
            "format":"period"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

202レスポンス

許容

ヘッダー

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

本文()

ルート・スキーマ: ProtectionPolicyDPSubmission

型: object

保護ポリシー・デプロイメント・プロシージャのステータス。

ソースの表示

• code(必須): integer
  HTTPステータス・コード。
• executionId(必須): string
  プロシージャ発行ID。
• instanceName(必須): string
  プロシージャ・インスタンス名。
• procedureId(必須): string
  プロシージャ発行ID。
• submissionBy(必須): string
  デプロイメント・プロシージャを発行したEnterprise Managerユーザーの名前。
• submissionName(必須): string
  発行されたデプロイメント・プロシージャの名前。

{
    "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レスポンス

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

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

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

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

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

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

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

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

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

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

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

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

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

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

• code: string
  エラーのステータス・コード。

  例: IllegalArgument
• message: string
  説明的なエラー・メッセージ

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

先頭に戻る