設計書 → 40.apis → resources → list_resources → messages_gen.md
Message catalog: resources/list_resources
API
| 項目 |
値 |
| domain |
resources |
| api |
list_resources |
| routes |
GET /resources (listResources) |
| router |
src/app/apis/resources/list_resources/router.py |
| messages |
1 |
| logger wrapper calls |
1 |
| levels |
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 |
listResources.router_api_function_error |
Routerで捕捉したApiFunctionErrorにより資源一覧取得が失敗した。 |
ログ詳細
M001 listResources.router_api_function_error
| 項目 |
内容 |
| id |
M001 |
| message_id |
listResources.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/list_resources/functions.py wrapper: src/app/apis/resources/list_resources/functions.py (ops_logger.error) |
出力項目
| 出力項目 |
型 |
説明 |
traceId |
string | null |
リクエストとログを横断して追跡する相関IDです。 |
actorPrincipalId |
string | null |
APIを呼び出した認証主体IDです。 |
api.statusCode |
integer | null |
API responseとして返したHTTP status codeです。 |
error.code |
string | null |
エラー分類を表す機械処理向けコードです。 |
error.message |
string | null |
エラー内容を運用者が理解するための説明です。 |
error.exceptionType |
string | null |
捕捉された例外の型名です。 |
resource |
ErrorResource |
ログに出力するAPI固有のErrorResourceです。 |
resource.nextToken |
PageToken | null |
一覧復帰時に同じ位置から再取得するための継続tokenです。 |
strict検証で要求する項目
| Level |
必須項目 |
WARNING |
why_production |
ERROR |
check_procedure, context_model, runbook |
CRITICAL |
remediation_procedure, context_model, runbook, escalation |