9.3. API 4XX エラー設定
要求で問題が発生すると、API は通常、エラーとともに 400 番台の HTTP エラーコードを返します。この場合、次のパターンに従ったエラーメッセージがログに生成されます。
' status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr} '
' status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr} '
メッセージは必要に応じて設定できます。デフォルトの API 4XX エラーログメッセージの形式を変更するには、次の手順を使用します。
手順
-
ナビゲーションパネルから、
を選択します。 - Logging settings ページで、 をクリックします。
- Log Format For API 4XX Errors フィールドを変更します。
{}
で囲まれた項目はログエラー発生時に置換されます。次の変数を使用できます。
- status_code: API が返す HTTP ステータスコード。
- user_name: API 要求を行うときに認証されたユーザーの名前。
- url_path: 呼び出される URL のパス部分 (別名 API エンドポイント)
- remote_addr :Automation Controller が受信したリモートアドレス。
- error: API によって返されるエラーメッセージ。エラーが指定されていない場合は、HTTP ステータスをテキストで返します。