Message catalog: resources/update_resource
API
| 項目 | 値 |
|---|---|
| domain | resources |
| api | update_resource |
| routes | PUT /resources/{resourceId} (updateResource) |
| router | src/app/apis/resources/update_resource/router.py |
| messages | 4 |
| logger wrapper calls | 4 |
| levels | WARNING:3, ERROR:1 |
生成・検証方針
- WARNING以上のMessage catalogは
router.py、functions.pyまたはresponse_builders.pyのops_logger.warning/error(...)kwargsを一次情報にする。 api_error_response(...)のstatus/detailとlogger呼び出しのstatus/detailを照合する。- 実装中の
app.core.loggingラッパー呼び出しを検出し、WARN以上はAPI operation内のemitとcatalog定義の一致を検証する。 logging.getLogger(...)、logger.info(...)などの直接呼び出しは許可しない。- WARNING以上は運用上の意味を持つ前提で、必要な確認手順・runbook・contextを検証対象にする。
メッセージ一覧
| id | message_id | ログ概要 |
|---|---|---|
M001 |
updateResource.caller_cannot_manage_resources |
呼び出し元が管理者ではないため、資源編集を拒否した。 |
M002 |
updateResource.stale_resource_version |
資源の公開版が現在値と一致しないため、資源編集を拒否した。 |
M003 |
updateResource.future_reservations_exist |
開始前の確定予約が残っているため、資源の無効化を拒否した。 |
M004 |
updateResource.router_api_function_error |
Routerで捕捉したApiFunctionErrorにより資源編集が失敗した。 |
ログ詳細
M001 updateResource.caller_cannot_manage_resources
| 項目 | 内容 |
|---|---|
| id | M001 |
| message_id | updateResource.caller_cannot_manage_resources |
| level | WARNING |
| status | 403 |
| wrapper calls | 1 |
| ログ概要 | 呼び出し元が管理者ではないため、資源編集を拒否した。 |
| 説明 | 呼び出し元が管理者groupに所属していない場合。 |
| 対応すべきこと | actorPrincipalIdと管理者groupの割当てを確認する。 |
| runbook | RUNBOOK-authorization-forbidden |
| 実装参照 | src/app/apis/resources/update_resource/functions.py wrapper: src/app/apis/resources/update_resource/functions.py (ops_logger.warning) |
出力項目
| 出力項目 | 型 | 説明 |
|---|---|---|
traceId |
string | null |
リクエストとログを横断して追跡する相関IDです。 |
actorPrincipalId |
string | null |
APIを呼び出した認証主体IDです。 |
api.statusCode |
integer | null |
API responseとして返したHTTP status codeです。 |
resource |
ErrorResource |
ログに出力するAPI固有のErrorResourceです。 |
resource.resourceId |
string | null |
編集対象資源の存在確認、再取得、問い合わせに使用する資源IDです。 |
error.code |
string | null |
エラー分類を表す機械処理向けコードです。 |
error.message |
string | null |
エラー内容を運用者が理解するための説明です。 |
M002 updateResource.stale_resource_version
| 項目 | 内容 |
|---|---|
| id | M002 |
| message_id | updateResource.stale_resource_version |
| level | WARNING |
| status | 409 |
| wrapper calls | 1 |
| ログ概要 | 資源の公開版が現在値と一致しないため、資源編集を拒否した。 |
| 説明 | 編集要求のversionが資源の現在の公開版と一致しない場合。 |
| 対応すべきこと | 利用者へ資源を再取得して編集し直すよう案内する。 |
| runbook | RUNBOOK-optimistic-lock-conflict |
| 実装参照 | src/app/apis/resources/update_resource/functions.py wrapper: src/app/apis/resources/update_resource/functions.py (ops_logger.warning) |
出力項目
| 出力項目 | 型 | 説明 |
|---|---|---|
traceId |
string | null |
リクエストとログを横断して追跡する相関IDです。 |
actorPrincipalId |
string | null |
APIを呼び出した認証主体IDです。 |
api.statusCode |
integer | null |
API responseとして返したHTTP status codeです。 |
resource |
ErrorResource |
ログに出力するAPI固有のErrorResourceです。 |
resource.resourceId |
string | null |
編集対象資源の存在確認、再取得、問い合わせに使用する資源IDです。 |
error.code |
string | null |
エラー分類を表す機械処理向けコードです。 |
error.message |
string | null |
エラー内容を運用者が理解するための説明です。 |
M003 updateResource.future_reservations_exist
| 項目 | 内容 |
|---|---|
| id | M003 |
| message_id | updateResource.future_reservations_exist |
| level | WARNING |
| status | 409 |
| wrapper calls | 1 |
| ログ概要 | 開始前の確定予約が残っているため、資源の無効化を拒否した。 |
| 説明 | activeをfalseにする要求で、開始前の確定予約が1件以上ある場合。 |
| 対応すべきこと | 将来予約の取消または移動を予約者と調整してから無効化する。 |
| runbook | RUNBOOK-resource-deactivation |
| 実装参照 | src/app/apis/resources/update_resource/functions.py wrapper: src/app/apis/resources/update_resource/functions.py (ops_logger.warning) |
出力項目
| 出力項目 | 型 | 説明 |
|---|---|---|
traceId |
string | null |
リクエストとログを横断して追跡する相関IDです。 |
actorPrincipalId |
string | null |
APIを呼び出した認証主体IDです。 |
api.statusCode |
integer | null |
API responseとして返したHTTP status codeです。 |
resource |
ErrorResource |
ログに出力するAPI固有のErrorResourceです。 |
resource.resourceId |
string | null |
編集対象資源の存在確認、再取得、問い合わせに使用する資源IDです。 |
error.code |
string | null |
エラー分類を表す機械処理向けコードです。 |
error.message |
string | null |
エラー内容を運用者が理解するための説明です。 |
M004 updateResource.router_api_function_error
| 項目 | 内容 |
|---|---|
| id | M004 |
| message_id | updateResource.router_api_function_error |
| level | ERROR |
| status | |
| wrapper calls | 1 |
| ログ概要 | Routerで捕捉したApiFunctionErrorにより資源編集が失敗した。 |
| 説明 | ROUTER_HANDLED_EXCEPTIONSを捕捉した場合。 |
| 対応すべきこと | 同一routeの5xx率、直近deploy、DB状態を確認する。 |
| runbook | RUNBOOK-unexpected-api-failure |
| 実装参照 | src/app/apis/resources/update_resource/functions.py wrapper: src/app/apis/resources/update_resource/functions.py (ops_logger.error) |
出力項目
| 出力項目 | 型 | 説明 |
|---|---|---|
traceId |
string | null |
リクエストとログを横断して追跡する相関IDです。 |
actorPrincipalId |
string | null |
APIを呼び出した認証主体IDです。 |
api.statusCode |
integer | null |
API responseとして返したHTTP status codeです。 |
resource |
ErrorResource |
ログに出力するAPI固有のErrorResourceです。 |
resource.resourceId |
string | null |
編集対象資源の存在確認、再取得、問い合わせに使用する資源IDです。 |
resource.version |
integer | null |
編集要求で指定した資源の公開版です。 |
error.code |
string | null |
エラー分類を表す機械処理向けコードです。 |
error.message |
string | null |
エラー内容を運用者が理解するための説明です。 |
error.exceptionType |
string | null |
捕捉された例外の型名です。 |
strict検証で要求する項目
| Level | 必須項目 |
|---|---|
WARNING |
why_production |
ERROR |
check_procedure, context_model, runbook |
CRITICAL |
remediation_procedure, context_model, runbook, escalation |