コンテンツにスキップ

マルチステップ API テスト


マルチステップ API テストは、複数の API リクエストを直列に接続して複雑なビジネスプロセスやユーザー操作パスをシミュレートする高度なモニタリングツールです。複数の API 接続のレスポンスデータを使用してテストを作成できるため、重要なビジネストランザクションの検証、エンドツーエンドのユーザージャーニーのシミュレート、認証および認可のサポートが可能です。このテスト方式により、サービスの可用性とパフォーマンスを能動的に監視し、複雑なプロセスの正常な運用を確保し、問題発生時に迅速にアラートを通知できます。

作成

タスク > 作成 > マルチステップ API テスト をクリックします。

1. 基本情報

  1. Synthetic テスト名を定義します。
  2. 必要に応じて説明を入力します。

2. Synthetic テストノードを選択

現在、Guanceは世界 14 か所の Synthetic テストノードをカバーしています。中国リージョンまたは海外リージョン(商用プラン以上のユーザーのみ)から 1 つ以上のノードを選択して、サイトのサービス品質監視をすばやく開始できます。

3. Synthetic テスト頻度を選択

Synthetic テストの実行頻度を選択します。以下のオプションに対応しています。

  • 1 分(商用プラン以上のユーザーのみ)
  • 5 分(商用プラン以上のユーザーのみ)
  • 15 分(商用プラン以上のユーザーのみ)
  • 30 分
  • 1 時間
  • 6 時間
  • 12 時間
  • 24 時間

システムが提供する上記の特定オプション以外にも、カスタム crontab タスク を入力して、分、時、日、月、週などの周期で定期タスクの実行を設定できます。

4. リクエストステップを定義

最初のリクエストを作成 をクリックします。

名前

リクエスト名を定義します。

リクエスト形式を定義

  1. リクエスト URL を定義します。
  2. 必要に応じて詳細設定を行います。

可用性の判定

デフォルトモード

判断条件を追加して、Synthetic テスト結果の成功条件を定義します。

複数の条件間では「すべて」または「いずれか」を選択して、AND または OR の論理関係を実現できます。

タイプ 演算子
レスポンスボディ 含む、含まない、等しい、等しくない、正規表現マッチ、正規表現不一致
リクエストヘッダー 含む、含まない、等しい、等しくない、正規表現マッチ、正規表現不一致
レスポンスタイム 未満
ステータスコード 等しい、等しくない、正規表現マッチ、正規表現不一致
スクリプトモード

マルチステップ API テストタスクでは、スクリプトモードで Pipeline スクリプトを作成することで、以下の機能を実現できます。

  • 判断条件の設定:ビジネスニーズに応じて複雑な判断ロジックをカスタマイズできます。単一条件または複数条件の組み合わせ判断に対応します。
  • 結果データの処理:Synthetic テスト結果に対してデータクレンジングやフォーマット変換などのカスタム処理を実行します。
  • フィールドの抽出と変数の定義:レスポンスから特定のフィールドを抽出し、変数として定義して、後続のステップで再利用できます。

スクリプトモードは、レスポンスから特定のフィールドを抽出したり、複雑な条件判断を行うニーズに柔軟に対応できます。

例:

body = load_json(response["body"])

if body["code"] == 200 {
  result["is_failed"] = false
  vars["token"] = body["token"]
} else {
  result["is_failed"] = true
  result["error_message"] = body["message"]
}

上記のスクリプトでは、まず load_json を使用してレスポンス内容を JSON オブジェクトとして解析し、レスポンスのステータスコードが 200 であるかどうかを判断します。200 の場合は、レスポンス内容から token を抽出し、vars に保存して後続のリクエストで使用できるようにします。それ以外の場合は、result の is_failed を true に設定し、error_message をレスポンス内容の message に設定します。

詳細については、カスタム Synthetic テストタスク を参照してください。

ローカル変数

現在のマルチステップ API テストタスクで定義したローカル変数は、後続のリクエストステップで参照できます。

注意

変数を定義するには、先にスクリプト内で対応するフィールドを抽出する必要があります。

  1. 変数名を入力します。通常は大文字、数字、アンダースコアが使用でき、名前を重複させることはできません。
  2. 変数値を選択します。つまり、スクリプトモードで変数として定義したフィールドを選択します。
  3. 必要に応じて変数値を暗号化するかどうかを選択します。チェックすると、テスト結果で現在の変数値が非表示になります。

作成した変数は、左上の「変数」エリアにまとめて表示されます。変数の数は {x}xx の形式で表示され、{x} は変数識別子、xx は変数の数を表します。例えば、{x}3 は現在 3 つの変数があることを示します。

「リクエスト形式の定義 > 詳細設定 > リクエストヘッダー」でローカル変数を参照できます。

図のように、ステップ 1 でローカル変数 {{DS_ID}} が定義されており、その値は dashboard_id です。リクエスト 2 では、URL でこの変数を直接参照して値を取得できます。

これらの変数を管理する場合は、「ローカル変数設定」エリアの右側にあるボタンをクリックすると、編集または削除操作を実行できます。

注意
  • ローカル変数を削除すると、現在のマルチステップ API テストでこの変数を参照しているリクエストは、その変数を使用できなくなります。
  • ローカル変数の名前を変更すると、元の名前を参照しているステップはその変数を認識できなくなります。

実行設定

「このステップが失敗した場合は、次のステップを続行する」を選択すると、現在のステップが失敗した場合にエラーをスキップして後続のステップを続行できます。

テスト

タスクステップの作成が完了したら、「テスト」ボタンをクリックしてテスト結果をすばやく検証できます。テストタスクは非同期で実行されます。実行が完了すると、システムは以下の情報を表示します。

  • テストパフォーマンス:テストプロセス中のパフォーマンス指標を表示します。
  • レスポンス詳細:詳細なレスポンス内容を提供し、問題の調査に役立てます。
  • 変数:現在のタスクのリクエストと URL に設定されている変数を確認できます。

最初のリクエストタスク以降のステップからテストを開始する場合は、現在のタスクを直接テストすることも、最初のタスクからテストを開始することも選択できます。

テストが失敗した場合、未知の変数が存在する可能性があります。「最初のステップから現在のリクエストまでテスト」ボタンをクリックして、テストを再実行し調査できます。

リクエストステップの作成を続行

最初のステップの Synthetic テストタスクを作成した後、「HTTP リクエストを作成」または「待機ステップを作成」を続行できます。

注意

最大 10 個のステップを作成できます(HTTP リクエストと待機を含む)。

待機ステップ

指定した時間だけ待機してから次のステップを続行します。待機時間は、1 秒、5 秒、15 秒、30 秒、1 分、2 分、3 分から選択できます。

タスクの管理

リクエストステップの作成が完了したら、保存をクリックします。

作成済みのタスクは、以下の操作で管理できます。

  • タスク左側のドラッグアイコンをクリックすると、ステップの実行順序を変更できます。
  • タスク右側の をクリックすると、このステップのクローンまたは削除を選択できます。
  • 「一括」をクリックすると、タスクを一括でクローンまたは削除できます。
注意

リクエストステップをクローンする際、ローカル変数は一緒にクローンされません。

フィードバック

このページは役に立ちましたか?