explainworkload: 照会ワークロードの EXPLAIN

explainworkload API に照会ワークロードの名前を 渡すと、この API によって、その照会ワークロードが EXPLAIN され、EXPLAIN されたステートメントの数が返されます。

入力パラメーター

この URL を使用して、以下のキーと値のペアを API に渡します。 https://localhost/tuning/explainworkload

表 1. 入力パラメーター
キー 使用可能な値
dbType データ・サーバーのタイプ。 ZOS
dbHost データ・サーバーのホスト。 ドメイン・ネームまたは IP アドレス
dbPort データ・サーバーのポート番号  
dbName データ・サーバーの名前  
dbUser データ・サーバーに接続するときに使用する ID  
dbPassword データ・サーバーに接続するときに使用するパスワード。  
workloadName EXPLAIN する照会ワークロードの名前。  
schema SQL ステートメント内の非修飾オブジェクトに対して使用される EXPLAIN プロセスのスキーマ。 この値は、tuning_service.properties ファイルに設定されている値をオーバーライドします。  

出力パラメーター

API は以下のキーと値のペアを返します。

表 2. 出力パラメーター
キー
code web API からの戻りコード。
0
完了 (警告なし)
4
完了 (警告あり)
8
エラーが原因で完了せずに終了
output API によって EXPLAIN された SQL ステートメントの数。 いずれかのステートメントが EXPLAIN 不可である場合、この数は、照会ワークロード内のステートメントの数より小さくなります。
message エラー・メッセージまたは警告メッセージ。
例外 例外に関する情報 (例外が発生した場合)。 この情報は、お客様が IBM サポートと連携して問題解決にあたる場合に IBM サポートの参考になる可能性があります。

この例では、cURL を使用して 照会ワークロードの名前を explainworkload API に渡しています。 この API からは、EXPLAIN された SQL ステートメントの数が返されます。

入力
curl 
--insecure 
-X POST 
-H "Content-Type: application/json; charset=UTF-8"
--data "{ 
   dbType:ZOS, 
   dbHost:host, 
   dbPort:port_number, 
   dbName:subsystem, 
   dbUser:user_ID, 
   dbPassword:password, 
   workloadName:Sample_Workload,
   }"
https://localhost/tuning/explainworkload
出力
{ 
"code":0
}

フィードバック