Oracle Enterprise ManagerのREST API

保護ポリシーのリスト

get

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

リカバリ・アプライアンスの保護ポリシーを取得します。

リクエスト

パス・パラメータ

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

問合せパラメータ

limit: integer(int32)
最小値: 1

最大値: 2000

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

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

ヘッダー・パラメータ

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

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

操作成功

ルート・スキーマ: ProtectionPolicyCollection

型: object

保護ポリシー・オブジェクトのコレクション。

ソースの表示

items(必須): array items

保護ポリシー・オブジェクトのリスト。

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

すべてに一致

ソースの表示

object CommonProperties

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

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

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

型: array

保護ポリシー・オブジェクトのリスト。

ソースの表示

配列: object ProtectionPolicySummary

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

{
    "description":"List of protection policy objects.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtectionPolicySummary"
    }
}

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

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

型: object

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

型: object

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

ソースの表示

allowBackupDeletion: string

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

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

リカバリ・アプライアンスによって作成されるアーカイブ・ログ・バックアップで使用される圧縮アルゴリズム
autotuneReservedSpace: string

リカバリ・アプライアンスで、このポリシーに関連付けられているデータベースの予約領域を自動的に定義および更新するかどうかを指定します(リカバリ・アプライアンス・バージョン21.1以降にのみ適用)。

例: YES
backupRedoFailover: string

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

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

この保護ポリシーに関連付けられたデータベースのバックアップを暗号化する必要があるかどうかを指定します。セキュア・モードが有効になっている場合、バックアップおよびREDOを暗号化する必要があります。暗号化されていないバックアップまたはREDOログは拒否されます。たとえば、値"YES"、"NO"です(リカバリ・アプライアンス・バージョン23.1以上にのみ適用可能)。

例: YES
guaranteedBackupCopy: string

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

リカバリ・アプライアンスで、この保護ポリシーに関連付けられているデータベースのバックアップを"保持期限"まで保持するかどうかを指定します(リカバリ・アプライアンス・バージョン21.1以降にのみ適用)。

例: YES
level0Refresh: string

データベース全体の新しいL0バックアップを作成する必要がある頻度を指定します。定期的なL0バックアップにより、リストアに必要な暗号化キーの数が減ります。たとえば、値"P365D" (365日)です(リカバリ・アプライアンス・バージョン23.1以上にのみ適用可能)。

例: P365D
maxDiskBackupRetention: string

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

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

保護ポリシー名。
protectedDatbasesCount: number

この保護ポリシーを使用する保護されたデータベースの数。
recoveryWindowCompliance: string

この保護ポリシーを使用するすべてのデータベースをリカバリできるようにリカバリ・アプライアンスで保証する必要がある時間範囲を指定します(リカバリ・アプライアンス・バージョン21.1以降にのみ適用)。
unprotectedDataWindowThreshold: string

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

{
    "description":"Protection policy properties.",
    "type":"object",
    "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.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy",
            "type":"string"
        },
        "mediaManagerRecoveryWindow":{
            "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 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"
        },
        "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 (only applicable to Recovery Appliance versions 21.1 and greater).",
            "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. Example values, \"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. Example value, \"P365D\" (365 days). (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"P365D"
        },
        "protectedDatbasesCount":{
            "description":"The number of protected databases using this protection policy.",
            "type":"number"
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/ChildDetailsLink"
        },
        {
            "type":"object"
        }
    ]
}

すべてに一致

ソースの表示

object ChildDetailsLink

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

{
    "description":"Protection policy properties.",
    "type":"object",
    "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.",
            "type":"string"
        },
        "unprotectedDataWindowThreshold":{
            "description":"The maximum amount of time in which there is potential data loss exposure for databases associated with this protection policy",
            "type":"string"
        },
        "mediaManagerRecoveryWindow":{
            "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 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"
        },
        "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 (only applicable to Recovery Appliance versions 21.1 and greater).",
            "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. Example values, \"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. Example value, \"P365D\" (365 days). (only applicable to Recovery Appliance versions 23.1 and greater).",
            "type":"string",
            "example":"P365D"
        },
        "protectedDatbasesCount":{
            "description":"The number of protected databases using this protection policy.",
            "type":"number"
        }
    },
    "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"
                }
            }
        }
    }
}

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

先頭に戻る