【モバイル Synthetic テスト】ノードとノードグループのクエリ¶
GET /api/v1/dialing_task/mobile/resources
概要¶
モバイル Synthetic テストで利用可能なリアルタイムノードおよび静的表示マッピングを照会します。
呼び出し前の準備と使用手順¶
type=mobile を渡すか、本ワークスペースに既存の mobile taskUUID を指定します。後者が優先されます。タスクは変更せず、Synthetic テストも実行しません。現在の公開呼び出しはリアルタイムノードのみを要求し、上流のノードグループは要求しないため、groups は通常 [] に固定されます。有効化できる include_groups Query は存在せず、内部 SDK パラメータを推測することはできません。groups モードは既存テンプレート/確認済みグループ ID と互換性があり、保存時に現在のメンバーを再確認します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| taskUUID | string | 任意。指定した場合は type より優先され、存在と実際の型を確認します。リモート ID ではありません。 例: dial_example取得または入力方法: 本ワークスペースのタスク一覧から type=mobile の uuid を取得します。 |
|
| type | string | 任意。type/taskUUID の少なくとも一方が有効な選択である必要があり、taskUUID がない場合は mobile が必須です。 選択可能な値: ['mobile'] 例: mobile取得または入力方法: 新しいモバイルタスクを作成する場合は type=mobile を選択します。既存の対象がある場合は taskUUID も使用できます。 |
パラメータの補足説明¶
nodes は vivo のリアルタイムリストとデータベースの静的マッピングを文字列 ID で関連付けたフラットな積集合です。旧 id/area/location/isp/clientType はそのまま保持され、mapping には nodeId、continent/country/province/city/operator の code/zh/en および network/client_type が含まれ、province は null になる場合があります。nodeMapping は version/sha256 または null を返します。マッピングがない場合や一致しない場合、nodes は空になり、上流の失敗時は引き続きエラーを返します。groups の契約は維持されます。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/dialing_task/mobile/resources' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode type=mobile
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.nodes | array<object> | リアルタイムノードとローカル静的マッピングを文字列 ID で関連付けた積集合。マッピングなし/一致なしの場合は []。 |
| content.nodes[].id | string または integer | 上流の元ノード ID。nodeSelection.ids に書き込む際は文字列に変換する必要があります。 |
| content.nodes[].area | JSON | 上流の旧リージョンフィールドをそのまま保持。 |
| content.nodes[].location | JSON | 上流の旧位置フィールドをそのまま保持。 |
| content.nodes[].isp | JSON | 上流の旧キャリアフィールドをそのまま保持。 |
| content.nodes[].clientType | JSON | 上流の旧クライアントタイプをそのまま保持。 |
| content.nodes[].mapping | object | 静的マッピングからの表示情報。 |
| content.nodes[].mapping.nodeId | string | ノードの文字列 ID。 |
| content.nodes[].mapping.network | string | 静的なネットワーク種別。 |
| content.nodes[].mapping.client_type | string | 静的なクライアントタイプ。 |
| content.nodes[].mapping.continent | object または null | 静的な地域/キャリアラベル。province は null になる場合があります。 |
| content.nodes[].mapping.continent.code | string | ソースコード。 |
| content.nodes[].mapping.continent.zh | string | 中国語名。 |
| content.nodes[].mapping.continent.en | string | 英語名。 |
| content.nodes[].mapping.country | object または null | 静的な地域/キャリアラベル。province は null になる場合があります。 |
| content.nodes[].mapping.country.code | string | ソースコード。 |
| content.nodes[].mapping.country.zh | string | 中国語名。 |
| content.nodes[].mapping.country.en | string | 英語名。 |
| content.nodes[].mapping.province | object または null | 静的な地域/キャリアラベル。province は null になる場合があります。 |
| content.nodes[].mapping.province.code | string | ソースコード。 |
| content.nodes[].mapping.province.zh | string | 中国語名。 |
| content.nodes[].mapping.province.en | string | 英語名。 |
| content.nodes[].mapping.city | object または null | 静的な地域/キャリアラベル。province は null になる場合があります。 |
| content.nodes[].mapping.city.code | string | ソースコード。 |
| content.nodes[].mapping.city.zh | string | 中国語名。 |
| content.nodes[].mapping.city.en | string | 英語名。 |
| content.nodes[].mapping.operator | object または null | 静的な地域/キャリアラベル。province は null になる場合があります。 |
| content.nodes[].mapping.operator.code | string | ソースコード。 |
| content.nodes[].mapping.operator.zh | string | 中国語名。 |
| content.nodes[].mapping.operator.en | string | 英語名。 |
| content.groups | array<object> | 互換グループ配列。現在の本公開呼び出しはデフォルトで上流グループを要求しないため [] を返しますが、これをもって過去のグループが存在しないと判断することはできません。 |
| content.groups[].id | string または integer | 互換グループ ID。現在はエントリを生成しません。 |
| content.groups[].clusterGroupId | string または integer | 旧グループ ID との互換。 |
| content.groups[].name | string | グループ名。 |
| content.groups[].description | string | グループの説明。 |
| content.groups[].clientType | JSON | グループのクライアントタイプ。 |
| content.groups[].children | array | 互換グループメンバー。現在の公開呼び出しでは生成されません。 |
| content.groups[].children[] | string または integer または object | 上流グループメンバーの形状。実際のリソースプロトコルに従って処理します。 |
| content.groups[].children[].id | string または integer | オブジェクトメンバー ID。省略可能。 |
| content.maxSampleCount | integer | 固定値 5。ノードごとの独立したサンプリング上限。 |
| content.nodeMapping | object または null | 静的マッピングのバージョン/ダイジェスト。利用可能なマッピングがない場合は null。 |
| content.nodeMapping.version | integer | マッピング構造のバージョン。現在は 2。 |
| content.nodeMapping.sha256 | string | マッピング内容のダイジェスト。認証情報やタスク ID ではありません。 |
| content.declaration | object | 外側の共通宣言。 |
{
"code": 200,
"content": {
"nodes": [
{
"id": "NODE-ID",
"area": "示例区域",
"location": "示例位置",
"isp": "示例运营商",
"clientType": "mobile",
"mapping": {
"nodeId": "NODE-ID",
"network": "mobile",
"client_type": "mobile",
"continent": {
"code": "asia",
"zh": "亚洲",
"en": "Asia"
},
"country": {
"code": "cn",
"zh": "中国",
"en": "China"
},
"province": null,
"city": {
"code": "example",
"zh": "示例城市",
"en": "Example city"
},
"operator": {
"code": "example",
"zh": "示例运营商",
"en": "Example ISP"
}
}
}
],
"groups": [],
"maxSampleCount": 5,
"nodeMapping": {
"version": 2,
"sha256": "SHA256-EXAMPLE"
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.ParamsValidateError | 識別子、選択ポイントの構造/範囲、名前、テンプレート数、またはプロトコルパラメータが現在の契約に適合していない | パラメータ検証に失敗しました: {} | message と任意の content.reason/field に従って修正し、まず本ワークスペースの一覧から対象を再取得してください。 |
| 400 | ft.InvalidAction | モバイル Synthetic テストが現在有効になっていない、または許可されていない操作/トランザクション状態が存在する | 無効な操作 | 管理者がモバイル Synthetic テスト機能を確認します。テンプレートの読み取り/削除はスイッチの無効化によって自動的に禁止されるものではありません。 |
| 400 | ft.DialingServerError | モバイルサービスの呼び出しに失敗した、またはリソースの返却形状/バインディング情報が一致しない | Synthetic テストサービスの API 呼び出しに失敗しました | reason、outcomeUnknown を確認し、traceId と合わせて照合してください。静的マッピングの欠落で上流の失敗を覆い隠すことはできません。 |
| 404 | ft.NotFoundDialTask | taskUUID が本ワークスペースの未削除タスクに属していない | 指定されたクラウド Synthetic テストタスクが見つかりません | 本ワークスペースの一覧から mobile の UUID を取得してください。通常のタスクは存在していても使用できません。 |
| 500 | ft.InternalServerError | ストレージ読み取り、履歴設定、またはローカル静的マッピングのフォーマット異常 | 内部エラー | 具体的なタスク/テンプレートまたはフィルタまで絞り込み、失敗が継続する場合は traceId を保持して読み取り段階を照合してください。 |