Oracle Enterprise ManagerのREST API

保護されたデータベースのリスト

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/protectedDatabases

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

リクエスト

パス・パラメータ

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

問合せパラメータ

limit: integer(int32)
最小値: 1

最大値: 2000

返される行の数を制限するため。結果セットがそれより大きい場合は、結果内のpreviousリンクとnextリンクに従います。
例:
```
20
```
nameOnly: string

保護されたデータベース名のみを取得します。
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。

ヘッダー・パラメータ

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

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/json

200レスポンス

操作成功

ルート・スキーマ: ProtectedDatabaseSummary

型: object

保護されたデータベース・オブジェクトのコレクション。

ソースの表示

items(必須): array items

保護されたデータベース・オブジェクトのリスト。

{
    "description":"Collection of protected database objects.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonProperties"
        },
        {
            "type":"object"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of protected database objects.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectedDatabase"
            }
        }
    }
}

すべてに一致

ソースの表示

object CommonProperties

サマリー・オブジェクトのコレクション。
object ProtectedDatabaseSummary-allOf[1]

{
    "description":"Collection of protected database objects.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonProperties"
        },
        {
            "type":"object"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of protected database objects.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtectedDatabase"
            }
        }
    }
}

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

型: array

保護されたデータベース・オブジェクトのリスト。

ソースの表示

配列: object ProtectedDatabase

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

{
    "description":"List of protected database objects.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectedDatabase"
    }
}

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

型: object

サマリー・オブジェクトのコレクション。

ソースの表示

count(必須): integer

このページのサマリー・オブジェクトの数。

例: 1
links(必須): object links

ナビゲーション・リンク。
nextPage: string

アイテム・リストのページ分割用。リストをページングする際に、この値がレスポンスに表示される場合は、まだ取得するアイテムが残っています。この値を、後続の"List"リクエストのページ・パラメータとして含めます。

{
    "description":"Collection of summary objects.",
    "type":"object",
    "required":[
        "count",
        "links"
    ],
    "properties":{
        "count":{
            "example":"1",
            "description":"Count of summary objects in this page.",
            "type":"integer"
        },
        "nextPage":{
            "description":"For pagination of a list of items. When paging through a list, if this value appears in the \nresponse, then there are additional items still to get. Include this value as the page \nparameter for the subsequent \"List\" request.\n",
            "type":"string"
        },
        "links":{
            "type":"object",
            "description":"Navigation links.",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

ネストされたスキーマ: ProtectedDatabaseSummary-allOf[1]

型: object

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

型: object

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

ソースの表示

allowBackupDeletion: string

この保護ポリシーを使用するデータベースのRMANバックアップを削除できるかどうかを制御する設定です。
backupRedoFailover: string

この保護ポリシーを使用する保護されたデータベースで、バックアップおよびREDOフェイルオーバー計画の代替宛先としてこのリカバリ・アプライアンスを使用するかどうかを指定します。
copyToCloudEnabled: string

このデータベースに対するcopy-to-cloud操作を有効(YES)または無効(NO)にします。
copyToTapeEnabled: string

このデータベースに対するcopy-to-tape操作を有効(YES)または無効(NO)にします。
creationTime: string

タスクの作成時刻。
databaseKey: string

リカバリ・アプライアンス・メタデータ・データベースでのこのデータベースの主キー。
databaseSize: string

データベースのサイズ。
databaseVersion: string

データベースのバージョン。
dbid: string

この保護されたデータベースのDBID。
dbUniqueName: string

データベースの一意の名前。
deduplicationFactor: string

この保護されたデータベースのアプライアンスで実際に消費された領域に対する、仮想完全バックアップの合計サイズの比率。
deleting: string

YES: このデータベースが現在削除されている場合。
diskRecoveryWindowCurrent: string

この保護されたデータベースに対するリカバリ・ウィンドウの現在の値(秒)。
diskRecoveryWindowGoal: string

ディスク・バックアップを使用したPoint-in-Timeリカバリのために、リカバリ・アプライアンスで達成する必要があるリカバリ・ウィンドウ目標。
diskRecoveryWindowNeededSpace: string

リカバリ・ウィンドウ目標を満たすのに必要な推定領域(GB)。
diskReservedSpace: string

このデータベースの排他的使用のために予約されたディスク領域の量(GB)。
finalChangeNumber: string

リカバリ・アプライアンスで使用可能なバックアップとREDOログを使用する場合に、このデータベースをリカバリできる最も大きいSCN。
guaranteedBackupCopy: string

まだメディアにコピーまたはレプリケートされていない既存のバックアップを削除する必要がある場合でも、新しいバックアップを常に受け入れます。
keepSpace: string

データベースのKEEPバックアップを保持するために使用される領域。
lastCompleteBackup: string

データベース内のすべてのデータファイルのバックアップが存在する最新の時間。
lastCopyToCloud: string

このデータベースに対する最後の完全なcopy-to-cloud操作のタイムスタンプ。
lastCopyToTape: string

このデータベースに対する最後の完全なcopy-to-tape操作のタイムスタンプ。
lastReplication: string

このデータベースに対する最後の完全なレプリケーション操作のタイムスタンプ。
maxDiskBackupRetention: string

ディスク・バックアップを保持する必要のある最大期間。この値は、ディスク・リカバリ・ウィンドウ目標以上にする必要があります。指定しない場合は、領域があるかぎり、ディスク・リカバリ・ウィンドウ目標を超えてバックアップが保持されます。
mediaManagerRecoveryWindowGoal: string

メディア・マネージャ(Oracle Secure Backupなど)からのPoint-in-Timeリカバリ機能が維持されるより長期のウィンドウ。
minimumRecoveryNeeded: string

保護されたデータベースを現在までリストアするのに必要な最小間隔。
name: string

保護されたデータベースのターゲット名またはデータベースの一意の名前。
nzdlActive: string

YES: リアルタイムREDOトランスポートがアクティブの場合。NO: REDOが最近受信されていない場合。
protectionPolicyName: string

このデータベースで使用される保護ポリシーの名前。
replicationEnabled: string

このデータベースに対するレプリケーション操作を有効(YES)または無効(NO)にします。
replicationServerList: string

この保護ポリシーに関連付けられたレプリケーション・サーバー構成のリスト。
replicationSetupStatus: string

このデータベースのダウンストリーム・レプリケーション・アプライアンスに対する設定のステータス。
restoreWindow: string

リカバリ・ウィンドウ目標を達成するために必要な推定領域の値の計算に使用される時間範囲。
spaceUsage: string

この保護されたデータベースで現在使用されているディスク領域の容量(GB)。
storageLocation: string

この保護されたデータベースで使用されるリカバリ・アプライアンスの記憶域の場所の名前。
targetName: string

保護されたデータベースのターゲット名。
targetType: string

targetNameで指定されたターゲットに対応するターゲット・タイプ。oracle_database、rac_databaseまたはcompositeを指定できます。
timeZone: string

保護されたデータベースのタイムゾーン・オフセット。
unprotectedDataWindowCurrent: string

追加REDOが使用できないかぎり、リカバリが不可能になるポイント。
unprotectedDataWindowThreshold: string

この保護されたデータベースに関連付けられているデータベースで、データ損失にさらされる可能性がある最大期間。
vpcUser: string

この保護されたデータベースのリカバリ・アプライアンス・リカバリ・カタログ・ユーザーのリスト。

{
    "description":"Protected database properties.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Protected database target name or database unique name.",
            "type":"string"
        },
        "targetName":{
            "description":"Protected database target name.",
            "type":"string"
        },
        "targetType":{
            "description":"Target type corresponding to the target specified by targetName. This can be oracle_database, rac_database or composite.",
            "type":"string"
        },
        "dbUniqueName":{
            "description":"Database unique name.",
            "type":"string"
        },
        "databaseVersion":{
            "description":"Database version.",
            "type":"string"
        },
        "databaseSize":{
            "description":"Database size.",
            "type":"string"
        },
        "protectionPolicyName":{
            "description":"The name of the protection policy used by this database.",
            "type":"string"
        },
        "diskRecoveryWindowGoal":{
            "description":"Recovery window goal that the Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.",
            "type":"string"
        },
        "diskRecoveryWindowCurrent":{
            "description":"The current value (in seconds) of the recovery window for this protected database.",
            "type":"string"
        },
        "diskRecoveryWindowNeededSpace":{
            "description":"The estimated space (in GB) that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protected database.",
            "type":"string"
        },
        "unprotectedDataWindowCurrent":{
            "description":"The point beyond which recovery is impossible unless additional redo is available.",
            "type":"string"
        },
        "mediaManagerRecoveryWindowGoal":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "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 be retained beyond the disk recovery window goal as space permits.",
            "type":"string"
        },
        "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.",
            "type":"string"
        },
        "lastCompleteBackup":{
            "description":"The latest time for which a backup of all datafiles in the database exists.",
            "type":"string"
        },
        "lastCopyToTape":{
            "description":"The timestamp of the last complete copy-to-tape operation for this database.",
            "type":"string"
        },
        "lastCopyToCloud":{
            "description":"The timestamp of the last complete copy-to-cloud operation for this database.",
            "type":"string"
        },
        "lastReplication":{
            "description":"The timestamp of the last complete replication operation for this database.",
            "type":"string"
        },
        "copyToCloudEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-cloud operation for this database.",
            "type":"string"
        },
        "copyToTapeEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-tape operation for this database.",
            "type":"string"
        },
        "replicationEnabled":{
            "description":"Enabled (YES) or disabled (NO) of replication operation for this database.",
            "type":"string"
        },
        "finalChangeNumber":{
            "description":"The highest SCN to which this database can be recovered when using backups and redo logs available on Recovery Appliance.",
            "type":"string"
        },
        "replicationServerList":{
            "description":"The list of replication server configurations associated with this protection policy.",
            "type":"string"
        },
        "databaseKey":{
            "description":"The primary key for this database in the Recovery Appliance metadata database.",
            "type":"string"
        },
        "deleting":{
            "description":"YES if this database is currently being deleted.",
            "type":"string"
        },
        "dbid":{
            "description":"The DBID for this protected database.",
            "type":"string"
        },
        "creationTime":{
            "description":"The time of task creation.",
            "type":"string"
        },
        "storageLocation":{
            "description":"The name of the Recovery Appliance storage location used by this protected database.",
            "type":"string"
        },
        "timeZone":{
            "description":"The time zone offset of the protected database.",
            "type":"string"
        },
        "spaceUsage":{
            "description":"The amount of disk space (in GB) currently used by this protected database.",
            "type":"string"
        },
        "keepSpace":{
            "description":"The space used to hold KEEP backups for the database.",
            "type":"string"
        },
        "diskReservedSpace":{
            "description":"The amount of disk space(in GB) reserved for the exclusive use of this database.",
            "type":"string"
        },
        "replicationSetupStatus":{
            "description":"The status of the setup for the downstream replication appliance for this database.",
            "type":"string"
        },
        "restoreWindow":{
            "description":"The time range used to compute the value of the estimated space that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "minimumRecoveryNeeded":{
            "description":"The minimum interval needed to restore the protected database to the present.",
            "type":"string"
        },
        "nzdlActive":{
            "description":"YES if real-time redo transport is active. NO if redo has not recently been received.",
            "type":"string"
        },
        "allowBackupDeletion":{
            "description":"The setting that controls whether RMAN backups for databases that use this protection policy can be deleted.",
            "type":"string"
        },
        "deduplicationFactor":{
            "description":"The ratio of the total size of virtual full backups to the actual consumed space on the appliance for this protected database.",
            "type":"string"
        },
        "vpcUser":{
            "description":"The list of Recovery Appliance recovery catalog user for this protected database.",
            "type":"string"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

すべてに一致

ソースの表示

object ChildDetailsLink

オブジェクトの詳細のリンク。
object ProtectedDatabase-allOf[1]

{
    "description":"Protected database properties.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Protected database target name or database unique name.",
            "type":"string"
        },
        "targetName":{
            "description":"Protected database target name.",
            "type":"string"
        },
        "targetType":{
            "description":"Target type corresponding to the target specified by targetName. This can be oracle_database, rac_database or composite.",
            "type":"string"
        },
        "dbUniqueName":{
            "description":"Database unique name.",
            "type":"string"
        },
        "databaseVersion":{
            "description":"Database version.",
            "type":"string"
        },
        "databaseSize":{
            "description":"Database size.",
            "type":"string"
        },
        "protectionPolicyName":{
            "description":"The name of the protection policy used by this database.",
            "type":"string"
        },
        "diskRecoveryWindowGoal":{
            "description":"Recovery window goal that the Recovery Appliance should attempt to meet for point-in-time recovery using disk backups.",
            "type":"string"
        },
        "diskRecoveryWindowCurrent":{
            "description":"The current value (in seconds) of the recovery window for this protected database.",
            "type":"string"
        },
        "diskRecoveryWindowNeededSpace":{
            "description":"The estimated space (in GB) that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protected database.",
            "type":"string"
        },
        "unprotectedDataWindowCurrent":{
            "description":"The point beyond which recovery is impossible unless additional redo is available.",
            "type":"string"
        },
        "mediaManagerRecoveryWindowGoal":{
            "description":"A longer window within which point-in-time recovery capability from a media manager (e.g., Oracle Secure Backup) will be maintained.",
            "type":"string"
        },
        "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 be retained beyond the disk recovery window goal as space permits.",
            "type":"string"
        },
        "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.",
            "type":"string"
        },
        "lastCompleteBackup":{
            "description":"The latest time for which a backup of all datafiles in the database exists.",
            "type":"string"
        },
        "lastCopyToTape":{
            "description":"The timestamp of the last complete copy-to-tape operation for this database.",
            "type":"string"
        },
        "lastCopyToCloud":{
            "description":"The timestamp of the last complete copy-to-cloud operation for this database.",
            "type":"string"
        },
        "lastReplication":{
            "description":"The timestamp of the last complete replication operation for this database.",
            "type":"string"
        },
        "copyToCloudEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-cloud operation for this database.",
            "type":"string"
        },
        "copyToTapeEnabled":{
            "description":"Enabled (YES) or disabled (NO) of copy-to-tape operation for this database.",
            "type":"string"
        },
        "replicationEnabled":{
            "description":"Enabled (YES) or disabled (NO) of replication operation for this database.",
            "type":"string"
        },
        "finalChangeNumber":{
            "description":"The highest SCN to which this database can be recovered when using backups and redo logs available on Recovery Appliance.",
            "type":"string"
        },
        "replicationServerList":{
            "description":"The list of replication server configurations associated with this protection policy.",
            "type":"string"
        },
        "databaseKey":{
            "description":"The primary key for this database in the Recovery Appliance metadata database.",
            "type":"string"
        },
        "deleting":{
            "description":"YES if this database is currently being deleted.",
            "type":"string"
        },
        "dbid":{
            "description":"The DBID for this protected database.",
            "type":"string"
        },
        "creationTime":{
            "description":"The time of task creation.",
            "type":"string"
        },
        "storageLocation":{
            "description":"The name of the Recovery Appliance storage location used by this protected database.",
            "type":"string"
        },
        "timeZone":{
            "description":"The time zone offset of the protected database.",
            "type":"string"
        },
        "spaceUsage":{
            "description":"The amount of disk space (in GB) currently used by this protected database.",
            "type":"string"
        },
        "keepSpace":{
            "description":"The space used to hold KEEP backups for the database.",
            "type":"string"
        },
        "diskReservedSpace":{
            "description":"The amount of disk space(in GB) reserved for the exclusive use of this database.",
            "type":"string"
        },
        "replicationSetupStatus":{
            "description":"The status of the setup for the downstream replication appliance for this database.",
            "type":"string"
        },
        "restoreWindow":{
            "description":"The time range used to compute the value of the estimated space that is needed to meet the recovery window goal.",
            "type":"string"
        },
        "minimumRecoveryNeeded":{
            "description":"The minimum interval needed to restore the protected database to the present.",
            "type":"string"
        },
        "nzdlActive":{
            "description":"YES if real-time redo transport is active. NO if redo has not recently been received.",
            "type":"string"
        },
        "allowBackupDeletion":{
            "description":"The setting that controls whether RMAN backups for databases that use this protection policy can be deleted.",
            "type":"string"
        },
        "deduplicationFactor":{
            "description":"The ratio of the total size of virtual full backups to the actual consumed space on the appliance for this protected database.",
            "type":"string"
        },
        "vpcUser":{
            "description":"The list of Recovery Appliance recovery catalog user for this protected database.",
            "type":"string"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

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

型: object

オブジェクトの詳細のリンク。

ソースの表示

links(必須): object links

ナビゲーション・リンク。

{
    "description":"Object details Link.",
    "type":"object",
    "required":[
        "links"
    ],
    "properties":{
        "links":{
            "type":"object",
            "description":"Navigation links.",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

ネストされたスキーマ: ProtectedDatabase-allOf[1]

型: object

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

型: object

ナビゲーション・リンク。

ソースの表示

self: object Link

リンクを表します(self、previous、nextのいずれか)

{
    "type":"object",
    "description":"Navigation links.",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

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

型: object

ナビゲーション・リンク。

ソースの表示

next: object Link

リンクを表します(self、previous、nextのいずれか)
self: object Link

リンクを表します(self、previous、nextのいずれか)

{
    "type":"object",
    "description":"Navigation links.",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

400レスポンス

不正なリクエスト

ルート・スキーマ: CommonErrorResponse

型: object

一般的なエラー・レスポンス。

ソースの表示

code(必須): string

HTTPステータス・コード
errors(必須): array errors

エラーとその詳細のリスト。
message(必須): string

エラーの説明。

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

すべてに一致

ソースの表示

object ErrorResponse

エラー・レスポンス

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

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

型: array

エラーとその詳細のリスト。

ソースの表示

配列: object ErrorResponse

エラー・レスポンス

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

ネストされたスキーマ: 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レスポンス

認証に失敗しました

ルート・スキーマ: CommonErrorResponse

型: object

一般的なエラー・レスポンス。

ソースの表示

code(必須): string

HTTPステータス・コード
errors(必須): array errors

エラーとその詳細のリスト。
message(必須): string

エラーの説明。

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

すべてに一致

ソースの表示

object ErrorResponse

エラー・レスポンス

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

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

型: array

エラーとその詳細のリスト。

ソースの表示

配列: object ErrorResponse

エラー・レスポンス

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

ネストされたスキーマ: 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レスポンス

許可されていません

ルート・スキーマ: CommonErrorResponse

型: object

一般的なエラー・レスポンス。

ソースの表示

code(必須): string

HTTPステータス・コード
errors(必須): array errors

エラーとその詳細のリスト。
message(必須): string

エラーの説明。

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

すべてに一致

ソースの表示

object ErrorResponse

エラー・レスポンス

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

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

型: array

エラーとその詳細のリスト。

ソースの表示

配列: object ErrorResponse

エラー・レスポンス

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

ネストされたスキーマ: 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レスポンス

見つかりません

ルート・スキーマ: CommonErrorResponse

型: object

一般的なエラー・レスポンス。

ソースの表示

code(必須): string

HTTPステータス・コード
errors(必須): array errors

エラーとその詳細のリスト。
message(必須): string

エラーの説明。

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

すべてに一致

ソースの表示

object ErrorResponse

エラー・レスポンス

{
    "description":"Common Error response.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ],
    "required":[
        "code",
        "message",
        "errors"
    ],
    "properties":{
        "code":{
            "description":"HTTP Status Code",
            "type":"string"
        },
        "message":{
            "description":"Error description.",
            "type":"string"
        },
        "errors":{
            "description":"List of errors and their details.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ErrorResponse"
            }
        }
    }
}

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

型: array

エラーとその詳細のリスト。

ソースの表示

配列: object ErrorResponse

エラー・レスポンス

{
    "description":"List of errors and their details.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ErrorResponse"
    }
}

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

先頭に戻る