公式ノード一覧¶
GET /api/v1/dialing_task/default_region_list
概要¶
現在のワークスペースで選択可能なオンラインのデフォルト Synthetic テストノードを取得します。
呼び出し前の確認と使用手順¶
このエンドポイントには業務パラメータはありません。ノードサービスに owner=default かつ稼働中のノードを問い合わせ、その後ワークスペースのバージョンでフィルタリングします。無料/体験版ワークスペースには海外のデフォルトノードは返されません。特定のワークスペースバージョンでは、海外のデフォルトノードのみが保持される場合があります。実際のレスポンスを基準とし、固定の都市一覧をハードコードしないでください。返却結果はページネーションされません。ノード名はリクエスト言語で表示されます。空配列は今回選択可能なデフォルトノードがないことを示しますが、すべてのセルフホストノードも存在しないことを証明するものではありません。
uuid は通常タスクの regions に書き込みます。モバイルタスクでは、独立したモバイルリソースの node/group ID と nodeSelection を使用し、混在させないでください。セルフホストノードについては、セルフホストノード一覧を参照してください。ノードの到達性は時間とともに変化します。取得に成功したことは、対象 API の Synthetic テストが成功したことを意味しません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得してください。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/dialing_task/default_region_list' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> | 現在選択可能なデフォルトノードの配列。空配列([])の場合があります。 |
| content[].uuid | string | regn_ノードUUID。通常タスクの regions の作成にこの値を使用します。 |
| content[].keycode | string | ノードのデプロイ/識別コード。regions の UUID としては使用しません。 |
| content[].owner | string | このエンドポイントのデフォルトノードは default です。 |
| content[].name | string | 現在のリクエスト言語に基づいて選択された名前。 |
| content[].nameEn | string | 英語互換の表示名。 |
| content[].name_en | string | 上流の旧英語名。条件付きで保持されます。 |
| content[].nameI18n | object | 正規化された言語別名称マッピング。 |
| content[].nameI18n.言語コード | string | その言語での表示名。 |
| content[].internal | boolean | true は国内、false は海外。ネットワークのプライベート性ではありません。 |
| content[].country | string | 国。 |
| content[].province | string | 省。 |
| content[].city | string | 都市。 |
| content[].isp | string | 通信事業者/プロバイダー。 |
| content[].status | string | OK/disabled などのノードサービス状態。タスクの実行状態ではありません。 |
| content[].heartbeat | integer | ノードの最終ハートビート(Unix 秒)。上流の定義に従います。 |
| content[].region | string | 上流のリージョン識別子。 |
| content[].company | string | 企業情報。 |
| content[].external_id | string | セルフホストの帰属などの上流フィールド。デフォルトノードでは通常空です。 |
| content[].parent_ak | string | 上流互換の帰属フィールド。空の場合があります。クライアントはこれを OpenAPI Key として扱いません。 |
| content[].extend_info | string | 上流の拡張 JSON 文字列または空文字列。デフォルトではオブジェクトではありません。 |
| content[].create_at | integer | 上流の作成時間フィールド。履歴では -1 の場合があります。タスクの createAt とは異なります。 |
| content[].declaration | object | 空でない各オブジェクトに共通する宣言。 |
{
"code": 200,
"content": [
{
"uuid": "regn_example",
"keycode": "example-region",
"owner": "default",
"name": "示例节点",
"nameEn": "Example region",
"nameI18n": {
"zh": "示例节点",
"en": "Example region"
},
"internal": true,
"country": "China",
"province": "Zhejiang",
"city": "Hangzhou",
"isp": "example",
"status": "OK",
"heartbeat": 1785427200,
"region": "example-region",
"company": "",
"external_id": "",
"parent_ak": "",
"extend_info": "",
"create_at": -1,
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
通常のダウンストリーム dialtesting.invalidRegion は ft.DialingRegionError にマッピングされ、HTTP を保持します。その他の 4xx は実際の HTTP と error_code を保持します。上記以外のエラーコードが返される場合もあります。>=500 は一律 500 にラップされます。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.DialingBrandNoSetError | ワークスペースに対応する Synthetic テストサービスの設定がありません | {} ブランドの Synthetic テスト設定が未構成です。 |
管理者は Synthetic テストサービスの可用性を確認してください。 |
| 400 | ft.DialingAKNoSetError | Synthetic テストサービスのクエリ署名情報が未設定です | Synthetic テストの AK 情報が未設定です。Launcher のアクティベーション設定を確認してください | 管理者はアクティベーション情報を確認してください。 |
| 400 | ft.DialingServerError | 通常のノードサービスが 400 の業務失敗を返します | Synthetic テストサービス API の呼び出しに失敗しました | サービス状態を確認し、traceId を保持してください。 |
| 500 | ft.InternalServerError | 通常のダウンストリーム 5xx/接続異常、ノードフィールドの形状不一致、またはバージョン/名前処理の異常 | 内部エラー | traceId を保持し、空データと仮定したり、古いノードを自動使用したりしないでください。 |