ErrorModel interface
発生したエラーを定義します。
プロパティ
code | エラーのカテゴリを特定するエラー コード。 使用できる値は、'None'、'ServerError'、'InvalidRequest'、'RateLimitExceeded'、'InvalidAuthorization'、'InsufficientAuthorization' です。 既定値は 'None' です。 |
message | エラーの説明。 |
more |
エラーに関する追加情報を提供する説明。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
parameter | エラーの原因となった要求の パラメーター。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
sub |
エラーの特定に役立つエラー コード。 使用できる値は、'UnexpectedError'、'ResourceError'、'NotImplemented'、'ParameterMissing'、'ParameterInvalidValue'、'HttpNotAllowed'、'Blocked'、'AuthorizationMissing'、'AuthorizationRedundancy'、'AuthorizationDisabled'、'AuthorizationExpired' です。このプロパティはシリアル化されません。サーバーによってのみ設定できます。 |
value | 無効な要求内のパラメーターの値。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
プロパティの詳細
code
エラーのカテゴリを特定するエラー コード。 使用できる値は、'None'、'ServerError'、'InvalidRequest'、'RateLimitExceeded'、'InvalidAuthorization'、'InsufficientAuthorization' です。 既定値は 'None' です。
code: ErrorCode
プロパティ値
message
エラーの説明。
message: string
プロパティ値
string
moreDetails
エラーに関する追加情報を提供する説明。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
moreDetails?: string
プロパティ値
string
parameter
エラーの原因となった要求の パラメーター。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
parameter?: string
プロパティ値
string
subCode
エラーの特定に役立つエラー コード。 使用できる値は、'UnexpectedError'、'ResourceError'、'NotImplemented'、'ParameterMissing'、'ParameterInvalidValue'、'HttpNotAllowed'、'Blocked'、'AuthorizationMissing'、'AuthorizationRedundancy'、'AuthorizationDisabled'、'AuthorizationExpired' です。このプロパティはシリアル化されません。サーバーによってのみ設定できます。
subCode?: ErrorSubCode
プロパティ値
value
無効な要求内のパラメーターの値。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
value?: string
プロパティ値
string