コンテンツにスキップ

【モバイル Synthetic テスト】ノード選択テンプレート一覧



GET /api/v1/dialing_task/mobile/templates

概要

現在のワークスペースのモバイル Synthetic テストにおけるノード選択テンプレート一覧を取得します。

呼び出し前および使用手順

保存済みスナップショットを読み取り、実行プラットフォームへのリアルタイムアクセスは行いません。モバイル Synthetic テストのスイッチがオフの場合でも読み取り可能です。一覧が未設定の場合は [] を返し、ページネーションは行わず、並び順も保証されません。件数の上限は保存 API によって制御されます。テンプレートには名前とノード選択のみが含まれ、HTTP/TCP ターゲットやプロトコル設定は含まれません。使用時は nodeSelection を新しいタスクへコピーします。

selectedNodeMappings は nodes の静的な表示情報のみを補完し、groups またはマッピングが欠落している場合は空になることがあります。読み取りに成功しても、これらの ID が現在オンラインであることは保証されません。編集/削除には現在のワークスペースの templateUUID を使用します。テンプレートを変更しても、保存済みタスクは自動的に更新されません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

パラメータの補足説明

返される各テンプレート項目には selectedNodeMappings 配列が付属し、要素は resources.nodes[].mapping を再利用します。nodeId:string、continent/country/province/city/operator:{code,zh,en}|null、network/client_type:string です。 nodeSelection.ids の現在のデータベース表示マッピングのみを取得し、ID を文字列に変換して重複を排除し、見つからない場合はスキップします。マッピングが欠落している場合、または groups モードの場合は [] を返します。表示情報はリアルタイムの可用性を示すものではなく、一覧のバッチではマッピングを 1 回だけ読み取ります。 このフィールドは読み取り専用で永続化されず、保存時に返送しないでください。元のリアルタイムリソースと選択有効性の検証は維持されます。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/dialing_task/mobile/templates' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。

フィールド 型 説明
content array<object> ワークスペーステンプレート配列。未設定の場合は []。
content[].templateUUID string dsel_ ワークスペース内テンプレート UUID。タスク ID またはノード ID ではありません。
content[].name string trim 後のテンプレート名。
content[].nodeSelection object 保存されたノード選択スナップショット。タスクへコピーするもので、リアルタイム参照ではありません。
content[].nodeSelection.mode string nodes/groups。
content[].nodeSelection.ids array<string> 空でなく重複のない元のノードまたはグループ ID 配列。保存前に重複は拒否され、元の ID/順序が保持されます。region UUID は指定できません。
content[].nodeSelection.ids[] string 対応するリソース ID。
content[].nodeSelection.sampleCount integer 各ノードの独立したサンプリング回数(1..5)。
content[].selectedNodeMappings array<object> nodes のみの選択済み静的マッピング。リアルタイムの可用性は照会しません。欠落時または groups の場合は []。
content[].selectedNodeMappings[].nodeId string ノードの文字列 ID。
content[].selectedNodeMappings[].network string 静的なネットワーク種別。
content[].selectedNodeMappings[].client_type string 静的なクライアント種別。
content[].selectedNodeMappings[].continent object または null 静的な地域/通信事業者ラベル。province は null の場合があります。
content[].selectedNodeMappings[].continent.code string コード。
content[].selectedNodeMappings[].continent.zh string 中国語名。
content[].selectedNodeMappings[].continent.en string 英語名。
content[].selectedNodeMappings[].country object または null 静的な地域/通信事業者ラベル。province は null の場合があります。
content[].selectedNodeMappings[].country.code string コード。
content[].selectedNodeMappings[].country.zh string 中国語名。
content[].selectedNodeMappings[].country.en string 英語名。
content[].selectedNodeMappings[].province object または null 静的な地域/通信事業者ラベル。province は null の場合があります。
content[].selectedNodeMappings[].province.code string コード。
content[].selectedNodeMappings[].province.zh string 中国語名。
content[].selectedNodeMappings[].province.en string 英語名。
content[].selectedNodeMappings[].city object または null 静的な地域/通信事業者ラベル。province は null の場合があります。
content[].selectedNodeMappings[].city.code string コード。
content[].selectedNodeMappings[].city.zh string 中国語名。
content[].selectedNodeMappings[].city.en string 英語名。
content[].selectedNodeMappings[].operator object または null 静的な地域/通信事業者ラベル。province は null の場合があります。
content[].selectedNodeMappings[].operator.code string コード。
content[].selectedNodeMappings[].operator.zh string 中国語名。
content[].selectedNodeMappings[].operator.en string 英語名。
content[].declaration object 空でない各テンプレートの共通宣言。
{
  "code": 200,
  "content": [
    {
      "templateUUID": "dsel_example",
      "name": "本番ノード",
      "nodeSelection": {
        "mode": "nodes",
        "ids": [
          "NODE-ID"
        ],
        "sampleCount": 1
      },
      "selectedNodeMappings": [],
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
500 ft.InternalServerError ストレージの読み取り、履歴設定、またはローカル静的マッピングのフォーマット処理で例外が発生 内部エラー 具体的なタスク/テンプレートまたはフィルターに絞り込み、継続して失敗する場合は traceId を保持して読み取り段階を確認します。

フィードバック

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