Oracle Enterprise ManagerのREST API

アーカイブ・バックアップのフリート作成

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/archivalBackups/protectionPolicy/{protectionPolicyName}

リカバリ・アプライアンスの保護ポリシー内にあるすべての保護されたデータベースのアーカイブ・バックアップを作成します。このAPIでは、リカバリ・アプライアンスでZDLRA管理パックを有効にする必要があります。

リクエスト

パス・パラメータ

protectionPolicyName(必須): string
保護ポリシー名。
例:
```
SILVER
```
raTargetId(必須): string
リカバリ・アプライアンスのターゲットID。
例:
```
F76BBCCBD8A0D4719A8AA588375FA8BE
```

ヘッダー・パラメータ

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

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

application/json

ルート・スキーマ: schema

型: object

保護されたデータベースの一意の名前

すべてに一致

保護されたデータベースの一意の名前

ソースの表示

CreateArchivalBackupDetailsPolicyLevel

単一の保護されたデータベースのアーカイブ・バックアップを作成するためのリクエストの詳細。

{
    "type":"object",
    "description":"Protected database's unique name",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupDetailsPolicyLevel"
        }
    ]
}

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

単一の保護されたデータベースのアーカイブ・バックアップを作成するためのリクエストの詳細。

1つのスキーマに一致

ソースの表示

CreateArchivalBackupsPolicyLevelRecurring

アーカイブ・バックアップを作成するための保護ポリシー・レベルの繰返しリクエスト。
object CreateArchivalBackupsPolicyLevelOnetime

アーカイブ・バックアップを作成するための保護ポリシー・レベルの1回かぎりのリクエスト。

{
    "description":"Request details for creating archival backups for a single protected database.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupsPolicyLevelRecurring"
        },
        {
            "$ref":"#/components/schemas/CreateArchivalBackupsPolicyLevelOnetime"
        }
    ]
}

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

アーカイブ・バックアップを作成するための保護ポリシー・レベルの繰返しリクエスト。

すべてに一致

アーカイブ・バックアップを作成するための保護ポリシー・レベルの繰返しリクエスト。

ソースの表示

object CreateArchivalBackupsPolicyLevelRecurringDetails

アーカイブ・バックアップを作成するための保護ポリシー・レベルの繰返しリクエストの詳細。
object ScheduleArchivalBackups

アーカイブ・バックアップの作成を繰り返すためのスケジュール。スケジュール・オプションが指定されていない場合、アーカイブ・バックアップの作成は1回かぎりとみなされます。

{
    "description":"Protection policy level recurring request for archival backups creation.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupsPolicyLevelRecurringDetails"
        },
        {
            "$ref":"#/components/schemas/ScheduleArchivalBackups"
        }
    ]
}

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

型: object

アーカイブ・バックアップを作成するための保護ポリシー・レベルの1回かぎりのリクエスト。

ソースの表示

archivalBackups(必須): array archivalBackups

アーカイブ・バックアップを作成するための保護ポリシー・レベルのリクエストの詳細。

{
    "description":"Protection policy level Onetime request for archival backups creation.",
    "type":"object",
    "required":[
        "archivalBackups"
    ],
    "properties":{
        "archivalBackups":{
            "description":"Protection policy level request details for archival backups creation.",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
                    },
                    {
                        "$ref":"#/components/schemas/RestoreUsingTime"
                    },
                    {
                        "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestoreTime"
                    }
                ]
            }
        }
    }
}

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

型: object

アーカイブ・バックアップを作成するための保護ポリシー・レベルの繰返しリクエストの詳細。

ソースの表示

archivalBackups(必須): array archivalBackups

アーカイブ・バックアップを作成するための保護ポリシー・レベルのリクエストの詳細。

{
    "description":"Protection policy level recurring request details for archival backups creation.",
    "type":"object",
    "required":[
        "archivalBackups"
    ],
    "properties":{
        "archivalBackups":{
            "description":"Protection policy level request details for archival backups creation.",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
                    },
                    {
                        "$ref":"#/components/schemas/RestoreUsingTime"
                    },
                    {
                        "$ref":"#/components/schemas/RecurringArchivalBkupDetails"
                    }
                ]
            }
        }
    }
}

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

型: object

アーカイブ・バックアップの作成を繰り返すためのスケジュール。スケジュール・オプションが指定されていない場合、アーカイブ・バックアップの作成は1回かぎりとみなされます。

ソースの表示

schedule: object ScheduleRAOperations

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

{
    "description":"Schedule for recurring archival backups creation. If the schedule option is not provided, the archival backup creation is considered one-time.",
    "type":"object",
    "properties":{
        "schedule":{
            "$ref":"#/components/schemas/ScheduleRAOperations"
        }
    }
}

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

型: array

アーカイブ・バックアップを作成するための保護ポリシー・レベルのリクエストの詳細。

ソースの表示

配列: items

{
    "description":"Protection policy level request details for archival backups creation.",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
            },
            {
                "$ref":"#/components/schemas/RestoreUsingTime"
            },
            {
                "$ref":"#/components/schemas/RecurringArchivalBkupDetails"
            }
        ]
    }
}

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

すべてに一致

ソースの表示

object CreateArchivalBackupBasicDetails

アーカイブ・バックアップの作成APIの基本的なリクエストの詳細。
object RestoreUsingTime

アーカイブ・バックアップを作成するための時間オプションを使用してリストアします
allOf RecurringArchivalBkupDetails

リストア時間を使用してアーカイブ・バックアップを作成します

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
        },
        {
            "$ref":"#/components/schemas/RestoreUsingTime"
        },
        {
            "$ref":"#/components/schemas/RecurringArchivalBkupDetails"
        }
    ]
}

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

リストア時間を使用してアーカイブ・バックアップを作成します

すべてに一致

リストア時間を使用してアーカイブ・バックアップを作成します

ソースの表示

object RecurringArchivalBkupRecoveryNamePrefix

リストア開始時間を使用してアーカイブ・バックアップを作成します。

{
    "description":"Create archival backup using restore time",
    "allOf":[
        {
            "$ref":"#/components/schemas/RecurringArchivalBkupRecoveryNamePrefix"
        }
    ]
}

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

型: object

アーカイブ・バックアップの作成APIの基本的なリクエストの詳細。

ソースの表示

attributeSetName(必須): string

属性セット名
comments: string

ユーザーが入力したコメント。
compressionAlgorithm: string

指定可能な値: [ "BASIC", "LOW", "MEDIUM", "HIGH", "OFF" ]

リカバリ・アプライアンスの圧縮アルゴリズム。
encryptionAlgorithm: string

指定可能な値: [ "AES128", "AES192", "AES256", "OFF" ]

リカバリ・アプライアンスの暗号化アルゴリズム。
format: string

出力アーカイブ・バックアップ・ピースの命名形式。RMAN FORMATパラメータと同じルールに従います。
keepFor: string

作成するアーカイブ・バックアップの保持期限日を設定するために使用される期間値。値はISO 8601期間形式です。例 - P2D (2日)、P3Y (3年)、P3W (3週間)

例: P30D

{
    "type":"object",
    "description":"Basic request details for create archival backups API",
    "required":[
        "attributeSetName"
    ],
    "properties":{
        "attributeSetName":{
            "type":"string",
            "description":"Attribute set name"
        },
        "format":{
            "type":"string",
            "description":"The naming format of the output archival backup pieces. Follows the same rules as the RMAN FORMAT parameter."
        },
        "keepFor":{
            "type":"string",
            "description":"Duration value used to set the keep until date for the archival backups to be created. Value is in ISO 8601 duration format. Examples - P2D (2 days), P3Y (3 years), P3W (3 weeks)",
            "example":"P30D"
        },
        "compressionAlgorithm":{
            "$ref":"#/components/schemas/CompressionAlgorithmEnum"
        },
        "encryptionAlgorithm":{
            "$ref":"#/components/schemas/EncryptionAlgorithmEnum"
        },
        "comments":{
            "type":"string",
            "description":"User provided comments."
        }
    }
}

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

型: object

アーカイブ・バックアップを作成するための時間オプションを使用してリストアします

ソースの表示

restoreUsing(必須): string

指定可能な値: [ "RESTORE_TIME" ]

このリストア時間を使用してアーカイブ・バックアップを作成します。

{
    "type":"object",
    "description":"Restore using time option for create archival backups",
    "required":[
        "restoreUsing"
    ],
    "properties":{
        "restoreUsing":{
            "$ref":"#/components/schemas/RestoreUsingTimeEnum"
        }
    }
}

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

型: object

リストア開始時間を使用してアーカイブ・バックアップを作成します。

ソースの表示

recoveryPointNamePrefix: string

リカバリ・ポイントの名前付けに使用するリカバリ・ポイント名の接頭辞。後にタイムスタンプ値が続く接頭辞が使用されます。

例: QuarterlyBackup

{
    "description":"Create archival backup using restore from time.",
    "properties":{
        "recoveryPointNamePrefix":{
            "type":"string",
            "description":"Recovery point name prefix to be used to name the recovery point. The prefix followed by the timestamp value will be used.",
            "example":"QuarterlyBackup"
        }
    }
}

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

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

型: array

アーカイブ・バックアップを作成するための保護ポリシー・レベルのリクエストの詳細。

ソースの表示

配列: items

{
    "description":"Protection policy level request details for archival backups creation.",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
            },
            {
                "$ref":"#/components/schemas/RestoreUsingTime"
            },
            {
                "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestoreTime"
            }
        ]
    }
}

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

すべてに一致

ソースの表示

object CreateArchivalBackupBasicDetails

アーカイブ・バックアップの作成APIの基本的なリクエストの詳細。
object RestoreUsingTime

アーカイブ・バックアップを作成するための時間オプションを使用してリストアします
allOf OneTimeArchivalBkupUsingRestoreTime

リストア時間を使用してアーカイブ・バックアップを作成します

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBackupBasicDetails"
        },
        {
            "$ref":"#/components/schemas/RestoreUsingTime"
        },
        {
            "$ref":"#/components/schemas/OneTimeArchivalBkupUsingRestoreTime"
        }
    ]
}

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

リストア時間を使用してアーカイブ・バックアップを作成します

すべてに一致

リストア時間を使用してアーカイブ・バックアップを作成します

ソースの表示

object CreateArchivalBkupUsingRestoreTime

リストア開始時間を使用してアーカイブ・バックアップを作成します。
object ArchivalRestorePointName

アーカイブ・リストア・ポイント名 - 1回かぎりのアーカイブ・バックアップにのみ適用されます

{
    "description":"Create archival backup using restore time",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateArchivalBkupUsingRestoreTime"
        },
        {
            "$ref":"#/components/schemas/ArchivalRestorePointName"
        }
    ]
}

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

型: object

リストア開始時間を使用してアーカイブ・バックアップを作成します。

ソースの表示

restoreUntilTime: string

アーカイブ・バックアップの作成に使用されるリストア開始時間。UTCタイムゾーンの書式は、YYYY-MM-DDTHH:mm:ssZです。restoreUsingがRESTORE_TIMEで、restoreUntilTimeが指定されていないかnull/空の場合、アーカイブ・バックアップは、RAで使用可能な最新のバックアップを使用して作成されます。

例: 2022-09-21T06:00:00.000Z

{
    "description":"Create archival backup using restore from time.",
    "properties":{
        "restoreUntilTime":{
            "type":"string",
            "description":"Restore from time to be used for creating archival backups. Format is YYYY-MM-DDTHH:mm:ssZ in UTC timezone. If restoreUsing is RESTORE_TIME but restoreUntilTime is not specified or null/empty, then the archival backup will be created using the latest backup available on the RA.",
            "example":"2022-09-21T06:00:00.000Z"
        }
    }
}

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

型: object

アーカイブ・リストア・ポイント名 - 1回かぎりのアーカイブ・バックアップにのみ適用されます

ソースの表示

restorePoint: string

アーカイブ・バックアップの命名に使用されるリストア・ポイント名。指定しない場合、アーカイブ・バックアップにはデフォルト名KEEP_BACKUP_timestampが指定されます。

{
    "description":"Archival Restore Point name - applicable only for one time archival backups",
    "properties":{
        "restorePoint":{
            "type":"string",
            "description":"Restore point name to be used for naming the archival backup. If not specified, archival backups will be given a default name KEEP_BACKUP_timestamp."
        }
    }
}

例

先頭に戻る

レスポンス

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

application/json

202レスポンス

許容

ヘッダー

Content-Location:

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

ルート・スキーマ: ArchivalBackupsDpSubmissionDetails

型: object

アーカイブ・バックアップ・デプロイメント・プロシージャ発行の詳細

ソースの表示

executionId: string

デプロイメント・プロシージャの実行ID
instanceId: string

発行されたデプロイメント・プロシージャのインスタンスID
instanceName: string

発行されたデプロイメント・プロシージャのインスタンス名
procedureId: string

デプロイメント・プロシージャの発行ID
submissionBy: string

デプロイメント・プロシージャを発行したEnterprise Managerユーザーの名前
submissionName: string

発行されたデプロイメント・プロシージャの名前

{
    "type":"object",
    "description":"Archival backups deployment procedure submission details",
    "properties":{
        "submissionName":{
            "type":"string",
            "description":"Name of the submitted deployment procedure"
        },
        "submissionBy":{
            "type":"string",
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure"
        },
        "executionId":{
            "type":"string",
            "description":"Deployment procedure execution id"
        },
        "procedureId":{
            "type":"string",
            "description":"Deployment procedure submission id"
        },
        "instanceId":{
            "type":"string",
            "description":"Instance Id of the submitted deployment procedure"
        },
        "instanceName":{
            "type":"string",
            "description":"Instance name of the submitted deployment procedure"
        }
    }
}

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

403レスポンス

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

ルート・スキーマ: 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"
        }
    }
}

409レスポンス

競合

ルート・スキーマ: 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"
        }
    }
}

先頭に戻る