Tuning Manager APIリファレンスガイド

2.7.2 Errorオブジェクト

リクエストに対してエラーが発生した場合，「2.8 ステータスコード」に示すステータスコードとともに，次の表に示すスキーマで定義するErrorオブジェクトが返されます。ただし，Jobオブジェクトを返すAPIの場合は，エラーの発生個所によってJobオブジェクトが返されることがあります。

表2-10 Errorオブジェクトのスキーマ

変数名	型	説明
errorSource	string	APIクライアントが送信したURI。
message	string	エラーメッセージ。 ログ出力する場合と同等のエラーメッセージです。
messageID	string	メッセージID。 ログ出力する場合と同等のメッセージIDです。
actions	string型の配列	APIクライアントが取るべき対処。

Errorオブジェクトに含まれるメッセージおよび対処は，英語で返されます。

Errorオブジェクトの例を次に示します。

Errorオブジェクトの例（アラート機能の場合）

{"errorSource":"http://server_1:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs",
"message":"KAIC18813-E Failed to read the request body.",
"messageID":"KAIC18813",
"actions":["Check the request body, and then try again."]}

Errorオブジェクトの例（パフォーマンスデータの取得の場合）

{"errorSource":"https://localhost:22016/TuningManager/v1/objects/AgentForRAID",
"message":"The media type specified in the Content-Type header is unsupported.",
"messageID":"KATR00111-E",
"actions":["Request does not contain the Content-Type header, or specified the media type is not supported by Tuning Manager Server."]}

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.