Oracle Enterprise ManagerのREST API

バックアップのフリート・スケジュール

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/actions/bulkSubmitBackup

複数のデータベースのバックアップをスケジュールします。このAPIでは、選択した宛先がリカバリ・アプライアンスの場合、リカバリ・アプライアンスでZDLRA管理パックを有効にする必要があります。

リクエスト

ヘッダー・パラメータ

ORCL-EM-DBTARGET-AUTHORIZATION(必須):

データベースへの接続に使用されるデータベース資格証明。
ORCL-EM-HOSTTARGET-AUTHORIZATION(必須):

データベースのバックアップおよびリカバリ操作の実行に使用されるオペレーティング・システム資格証明であるホスト資格証明。
ORCL-EM-RMANTARGET-AUTHORIZATION:

RMAN暗号化パスワード用の名前付き資格証明。

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

application/json

ルート・スキーマ: schema

型: object

バックアップを作成するためのパラメータ。

すべてに一致

ソースの表示

object BackupDetailsCommon

バックアップを作成するためのパラメータ。

{
    "type":"object",
    "description":"Parameters for creating a backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsCommon"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateBackupDetailsControlFile"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsRASuggested"
        }
    ]
}

1つのスキーマに一致

ソースの表示

制御ファイルのバックアップ計画
CreateBackupDetailsOCI

OCIバックアップを作成するためのパラメータ。
CreateBackupDetailsRASuggested

リカバリ・アプライアンス推奨のバックアップを作成するためのパラメータ。

{
    "type":"object",
    "description":"Parameters for creating a backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsCommon"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/CreateBackupDetailsControlFile"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/CreateBackupDetailsRASuggested"
        }
    ]
}

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

型: object

バックアップを作成するためのパラメータ。

ソースの表示

backupStrategy: string

指定可能な値: [ "ORACLE_SUGGESTED", "CUSTOM", "CONTROL_FILE" ]

バックアップ計画。

例: ORACLE_SUGGESTED
destinationMediaType: string

指定可能な値: [ "OCI", "RA" ]

宛先メディア・タイプ。

例: RA
targets: array Targets

データベース・ターゲットのリスト。

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "targets":{
            "$ref":"#/components/schemas/Targets"
        },
        "backupStrategy":{
            "type":"string",
            "description":"Backup strategy.",
            "enum":[
                "ORACLE_SUGGESTED",
                "CUSTOM",
                "CONTROL_FILE"
            ],
            "example":"ORACLE_SUGGESTED"
        },
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "enum":[
                "OCI",
                "RA"
            ],
            "example":"RA"
        }
    }
}

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

OCIバックアップを作成するためのパラメータ。

すべてに一致

ソースの表示

object CreateBackupDetailsBase

バックアップを作成するためのパラメータ。
object BackupDetailsEncryption

バックアップを作成するためのパラメータ。
object BackupDetailsDPParamsSchedule

バックアップをスケジュールするためのパラメータ。

{
    "description":"Parameters for creating OCI backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateBackupDetailsBase"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsEncryption"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

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

リカバリ・アプライアンス推奨のバックアップを作成するためのパラメータ。

すべてに一致

ソースの表示

object BackupDetailsRASuggested

バックアップを作成するためのパラメータ。
object BackupDetailsDPParamsSchedule

バックアップをスケジュールするためのパラメータ。

{
    "description":"Parameters for creating Recovery Appliance suggested backup.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BackupDetailsRASuggested"
        },
        {
            "$ref":"#/components/schemas/BackupDetailsDPParamsSchedule"
        }
    ]
}

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

型: array

データベース・ターゲットのリスト。

ソースの表示

配列: object items

{
    "description":"List of database targets.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "targetName":{
                "type":"string",
                "description":"Target name.",
                "example":"DB1"
            },
            "targetTypeName":{
                "type":"string",
                "description":"Target type.",
                "example":"oracle_database"
            },
            "rmanEncryptionCredentials":{
                "type":"string",
                "description":"Named credential for RMAN encryption password at a database target level.",
                "example":"NAMED:RMAN:SYSMAN"
            }
        }
    },
    "example":[
        {
            "targetName":"DB1",
            "targetTypeName":"oracle_database",
            "rmanEncryptionCredentials":"NAMED:RMAN:SYSMAN"
        },
        {
            "targetName":"DB2",
            "targetTypeName":"rac_database"
        }
    ]
}

例:

[
    {
        "targetName":"DB1",
        "targetTypeName":"oracle_database",
        "rmanEncryptionCredentials":"NAMED:RMAN:SYSMAN"
    },
    {
        "targetName":"DB2",
        "targetTypeName":"rac_database"
    }
]

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

型: object

ソースの表示

rmanEncryptionCredentials: string

データベース・ターゲット・レベルでのRMAN暗号化パスワード用の名前付き資格証明。

例: NAMED:RMAN:SYSMAN
targetName: string

ターゲット名。

例: DB1
targetTypeName: string

ターゲット・タイプ。

例: oracle_database

{
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target name.",
            "example":"DB1"
        },
        "targetTypeName":{
            "type":"string",
            "description":"Target type.",
            "example":"oracle_database"
        },
        "rmanEncryptionCredentials":{
            "type":"string",
            "description":"Named credential for RMAN encryption password at a database target level.",
            "example":"NAMED:RMAN:SYSMAN"
        }
    }
}

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

型: object

バックアップを作成するためのパラメータ。

ソースの表示

backupScope: string

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

バックアップ範囲。

例: WHOLE
backupType: string

指定可能な値: [ "FULL", "INCREMENTAL0", "INCREMENTAL1" ]

バックアップのタイプ。

例: INCREMENTAL0
incrementalType: string

指定可能な値: [ "DIFFERENTIAL", "CUMULATIVE" ]

増分タイプ。

例: DIFFERENTIAL
isDeleteArchivedLogsPostBackup: boolean

バックアップの成功後にアーカイブ・ログを削除する必要があるかどうかを指定します。

例: false
isDeleteObsoleteBackups: boolean

不要なバックアップを削除する必要があるかどうかを指定します。

例: false
isSkipBackupArchivedLogs: boolean

バックアップ中にアーカイブ・ログをスキップする必要があるかどうかを指定します。

例: false
maxFilesPerSet: integer

バックアップセット当たりの最大ファイル数。

例: 1
sectionSizeInMBs: integer

バックアップのセクション・サイズ。

例: 10

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "backupScope":{
            "type":"string",
            "description":"Backup Scope.",
            "enum":[
                "WHOLE"
            ],
            "example":"WHOLE"
        },
        "backupType":{
            "type":"string",
            "description":"Backup Type.",
            "enum":[
                "FULL",
                "INCREMENTAL0",
                "INCREMENTAL1"
            ],
            "example":"INCREMENTAL0"
        },
        "incrementalType":{
            "type":"string",
            "description":"Incremental Type.",
            "enum":[
                "DIFFERENTIAL",
                "CUMULATIVE"
            ],
            "example":"DIFFERENTIAL"
        },
        "isSkipBackupArchivedLogs":{
            "type":"boolean",
            "description":"Specifies if archived logs have to be skipped during backup.",
            "example":false
        },
        "isDeleteArchivedLogsPostBackup":{
            "type":"boolean",
            "description":"Specifies if the archived logs have to be deleted after a successful backup.",
            "example":false
        },
        "isDeleteObsoleteBackups":{
            "type":"boolean",
            "description":"Specifies if the obsolete backups have to be deleted.",
            "example":false
        },
        "maxFilesPerSet":{
            "type":"integer",
            "description":"Maximum files per backupset.",
            "example":"1"
        },
        "sectionSizeInMBs":{
            "type":"integer",
            "description":"Section size of the backup.",
            "example":"10"
        }
    }
}

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

型: object

バックアップを作成するためのパラメータ。

ソースの表示

backupEncryptionMode: string

指定可能な値: [ "WALLET", "PASSWORD", "BOTH" ]

バックアップ暗号化モード

例: PASSWORD
encryptionAlogrithm: string

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

暗号化アルゴリズム

例: AES128

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "backupEncryptionMode":{
            "type":"string",
            "description":"Backup Encryption Mode",
            "enum":[
                "WALLET",
                "PASSWORD",
                "BOTH"
            ],
            "example":"PASSWORD"
        },
        "encryptionAlogrithm":{
            "type":"string",
            "description":"Encryption Alogrithm",
            "enum":[
                "AES128",
                "AES192",
                "AES256"
            ],
            "example":"AES128"
        }
    }
}

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

型: object

バックアップをスケジュールするためのパラメータ。

ソースの表示

schedule: Discriminator: type

弁別子: { "propertyName":"type", "mapping":{ "immediately":"#/components/schemas/ScheduleImmediately", "later":"#/components/schemas/ScheduleLater", "repeating":"#/components/schemas/ScheduleRepeating" } }

デプロイメント・プロシージャのスケジュールを指定します。

{
    "description":"Parameters for scheduling a backup.",
    "type":"object",
    "properties":{
        "schedule":{
            "description":"Specifies schedule of the deployment procedure..",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ScheduleImmediately"
                },
                {
                    "$ref":"#/components/schemas/ScheduleLater"
                },
                {
                    "$ref":"#/components/schemas/ScheduleRepeating"
                }
            ],
            "discriminator":{
                "propertyName":"type",
                "mapping":{
                    "immediately":"#/components/schemas/ScheduleImmediately",
                    "later":"#/components/schemas/ScheduleLater",
                    "repeating":"#/components/schemas/ScheduleRepeating"
                }
            }
        }
    }
}

ネストされたスキーマ: Discriminator: type

型: object

弁別子: type

{
    "description":"Specifies schedule of the deployment procedure..",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

デプロイメント・プロシージャのスケジュールを指定します。

1つのスキーマに一致

ソースの表示

immediately - object ScheduleImmediately

即時スケジュール。
later - object ScheduleLater

後でスケジュール。
object Discriminator: repeatFrequency

弁別子: { "propertyName":"repeatFrequency", "mapping":{ "WEEKLY":"#/components/schemas/ScheduleWeekly", "MONTHLY":"#/components/schemas/ScheduleMonthly", "YEARLY":"#/components/schemas/ScheduleYearly", "INTERVAL":"#/components/schemas/ScheduleInterval" } }

繰返しスケジュール。

{
    "description":"Specifies schedule of the deployment procedure..",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

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

型: object

即時スケジュール。

ソースの表示

type(必須): string

スケジュールのタイプ。

例: immediately

{
    "type":"object",
    "description":"Schedule immediately.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"immediately"
        }
    }
}

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

型: object

後でスケジュール。

ソースの表示

startTime: date-time

デプロイメント・プロシージャの開始がスケジュールされている日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。

例: 2021/08/30 23:00
timeZone: string

Javaタイムゾーン。

例: America/New_York
type(必須): string

スケジュールのタイプ。

例: later

{
    "type":"object",
    "description":"Schedule later.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"later"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        }
    }
}

ネストされたスキーマ: Discriminator: repeatFrequency

型: object

弁別子: repeatFrequency

弁別子の値

WEEKLY
MONTHLY
YEARLY
INTERVAL

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

繰返しスケジュール。

すべてに一致

ソースの表示

object ScheduleRepeatingBase

繰返しスケジュール。

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

1つのスキーマに一致

ソースの表示

WEEKLY - object ScheduleWeekly

繰返し頻度(週次)の値を繰り返します。
MONTHLY - object ScheduleMonthly

繰返し頻度(月次)の値を繰り返します。
YEARLY - object ScheduleYearly

繰返し頻度(年次)の値を繰り返します。
INTERVAL - object ScheduleInterval

繰返し頻度(間隔)の値を繰り返します。

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

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

型: object

繰返しスケジュール。

ソースの表示

endtime: date-time

ジョブの有効期限が切れる日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。指定しない場合、繰返しは永久に続きます。

例: 2021/08/30 23:00
repeatFrequency(必須): string

指定可能な値: [ "WEEKLY", "MONTHLY", "YEARLY", "INTERVAL" ]

繰返し頻度タイプ。
startTime(必須): date-time

デプロイメント・プロシージャの開始がスケジュールされている日付。yyyy/MM/dd HH:mm形式の文字列として指定されます。

例: 2021/08/30 23:00
timeZone: string

Javaタイムゾーン。

例: America/New_York
type(必須): string

スケジュールのタイプ。

例: repeating

{
    "type":"object",
    "description":"Repeating schedule.",
    "required":[
        "type",
        "startTime",
        "repeatFrequency"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"repeating"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        },
        "endtime":{
            "$ref":"#/components/schemas/ScheduleEndTime"
        },
        "repeatFrequency":{
            "$ref":"#/components/schemas/ScheduleRepeatFrequency"
        }
    }
}

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

型: object

繰返し頻度(週次)の値を繰り返します。

ソースの表示

days(必須): array days

曜日。

{
    "description":"Repeat value for repeat frequency - weekly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Days of the week.",
            "type":"array",
            "example":"1,4",
            "items":{
                "$ref":"#/components/schemas/DaysOfTheWeekEnum"
            }
        }
    }
}

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

型: object

繰返し頻度(月次)の値を繰り返します。

ソースの表示

days(必須): array days

月次の値を繰り返します。

{
    "description":"Repeat value for repeat frequency - monthly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Repeat value for monthly.",
            "type":"array",
            "example":"1,30,31",
            "items":{
                "type":"integer",
                "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
            }
        }
    }
}

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

型: object

繰返し頻度(年次)の値を繰り返します。

ソースの表示

months(必須): array months

年次の値を繰り返します。

{
    "description":"Repeat value for repeat frequency - yearly.",
    "required":[
        "months"
    ],
    "properties":{
        "months":{
            "description":"Repeat value for yearly.",
            "type":"array",
            "example":"1,3",
            "items":{
                "type":"integer",
                "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
            }
        }
    }
}

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

型: object

繰返し頻度(間隔)の値を繰り返します。

ソースの表示

repeatEvery(必須): string

N値ごとに繰り返します - m(分)、h(時間)、d(日)、w(週)。

例: 10m, 3h, 5d, 2w

{
    "description":"Repeat value for repeat frequency - interval.",
    "required":[
        "repeatEvery"
    ],
    "properties":{
        "repeatEvery":{
            "description":"Repeat every N value - m(minutes), h(hours), d(days), w(week).",
            "type":"string",
            "example":"10m, 3h, 5d, 2w"
        }
    }
}

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

型: array

曜日。

ソースの表示

配列: integer

指定可能な値: [ "1", "2", "3", "4", "5", "6", "7" ]

曜日。日曜日は1、月曜日は2など。

{
    "description":"Days of the week.",
    "type":"array",
    "example":"1,4",
    "items":{
        "$ref":"#/components/schemas/DaysOfTheWeekEnum"
    }
}

例:

1,4

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

型: array

月次の値を繰り返します。

ソースの表示

配列: integer

日番号。int -1、1..5は、どの日番号かを表します。-1は最後の日を表します。

{
    "description":"Repeat value for monthly.",
    "type":"array",
    "example":"1,30,31",
    "items":{
        "type":"integer",
        "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
    }
}

例:

1,30,31

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

型: array

年次の値を繰り返します。

ソースの表示

配列: integer

月番号。int 1、2、3..は、月(1月、2月、3月など)を表します。

{
    "description":"Repeat value for yearly.",
    "type":"array",
    "example":"1,3",
    "items":{
        "type":"integer",
        "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
    }
}

例:

1,3

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

型: object

バックアップを作成するためのパラメータ。

ソースの表示

isCrosscheckArchivelog: boolean

クロスチェック・アーカイブ・ログを実行する必要があるかどうかを指定します。

例: true
isDeleteArchivedLogsPostBackup: boolean

バックアップの成功後にアーカイブ・ログを削除する必要があるかどうかを指定します。

例: true

{
    "description":"Parameters for creating a backup.",
    "type":"object",
    "properties":{
        "isCrosscheckArchivelog":{
            "type":"boolean",
            "description":"Specifies whether the crosscheck archived log has to be performed.",
            "example":true
        },
        "isDeleteArchivedLogsPostBackup":{
            "type":"boolean",
            "description":"Specifies whether the archived log has be deleted after a successful backup.",
            "example":true
        }
    }
}

例

先頭に戻る

レスポンス

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

application/json

202レスポンス

許容。

ヘッダー

Content-Location:

発行されたデプロイメント・プロシージャの実行の詳細。
ORCL-EM-PROCESSING-TIME:

デプロイメント・プロシージャが発行されてからの経過時間(ミリ秒)。

ルート・スキーマ: BulkSubmitBackupDatabase

型: object

バックアップ・デプロイメント・プロシージャのステータス

ソースの表示

code(必須): integer

HTTPステータス・コード

例: 202
executionId(必須): string

デプロイメント・プロシージャの実行ID。
instanceName(必須): string

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

デプロイメント・プロシージャの発行ID。
submissionBy(必須): string

デプロイメント・プロシージャを発行したユーザー。
submissionName(必須): string

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

{
    "description":"Backup Deployment Procedure Status",
    "type":"object",
    "required":[
        "code",
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status code",
            "type":"integer",
            "example":"202"
        },
        "submissionName":{
            "description":"Name of the deployment procedure submitted.",
            "type":"string"
        },
        "submissionBy":{
            "description":"User that submitted the deployment procedure.",
            "type":"string"
        },
        "executionId":{
            "description":"Deployment procedure execution ID.",
            "type":"string"
        },
        "procedureId":{
            "description":"Deployment procedure submission ID.",
            "type":"string"
        },
        "instanceName":{
            "description":"Instance name of the deployment procedure submitted.",
            "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"
        }
    }
}

先頭に戻る