一覧取得¶
GET /api/v1/dialing_region/list
概要¶
現在のワークスペースのセルフホスト Synthetic テストノード一覧を取得します。
呼び出し前の確認と使用手順¶
owner=custom かつ本ワークスペースに属するもののみで、デフォルトのパブリックノードやモバイルリソースは含みません。isAlive を省略すると生存状態を制限せず、true は生存のみ、false は非生存のみです。結果は上流の create_at の降順で、ページネーションや総数はありません。名前は現在のリクエスト言語でフォールバック表示され、nameI18n は多言語マッピングを保持します。
createAt/creator/updateAt/updator は extend_info から補完され、上流の create_at/heartbeat とは異なります。一覧ではさらに ID 情報を補完し、一致しない場合は {} です。一覧内のノード uuid は通常タスクの regions に使用します。登録に成功してもインストール/ハートビートが未実施のノードはオンラインとは限りません。インストールと検証についてはセルフホストノード管理を参照してください。デフォルトノードはデフォルト地域リストを、モバイルノードはモバイルリソース入口を使用します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isAlive | string | 任意。省略すると生存状態を制限しません。Query 文字列であり、JSON boolean やタスクの ok/stop ではありません。 null を許可: True 選択可能な値: ['true', 'false'] 例: true取得または入力方法: オンラインノードのみを表示するかどうかに応じて true/false 文字列を選択します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/dialing_region/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode isAlive=true
レスポンス¶
HTTP 200、application/json。以下の例では、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> | セルフホストノードの配列。空の場合は [] で、pageInfo は含みません。 |
| content[].uuid | string | regn_ ノード UUID。通常タスクの regions 作成時にこの値を使用します。 |
| content[].keycode | string | ノードのデプロイ/識別コード。regions UUID としては使用しません。 |
| content[].owner | string | セルフホストノードの custom。 |
| 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[].其他上游字段 | JSON | 上流互換の追加フィールドをそのまま引き継ぎます。一覧にないキーを直接書き込み可能なパラメータとして扱わないでください。 |
| content[].createAt | integer | extend_info から読み取った作成 Unix 秒。存在しない場合は -1。 |
| content[].creator | string | 拡張情報から読み取った作成 ID。存在しない場合は空文字列。 |
| content[].updateAt | integer | 拡張情報から読み取った更新 Unix 秒。存在しない場合は -1。 |
| content[].updator | string | 拡張情報から読み取った更新 ID。存在しない場合は空文字列。 |
| content[].creatorInfo | object | 一覧でのみ ID 情報を補完します。一致しない場合は {} です。 |
| content[].creatorInfo.uuid | string | 条件付きで返却;ID UUID。 |
| content[].creatorInfo.name | string | 条件付きで返却;表示名。 |
| content[].creatorInfo.email | string | 条件付きで返却;メールアドレス。 |
| content[].creatorInfo.username | string | 条件付きで返却;ログイン名。 |
| content[].creatorInfo.status | integer | 条件付きで返却;アカウント状態。 |
| content[].creatorInfo.wsAccountStatus | integer | 条件付きで返却;ワークスペース関係の状態。 |
| content[].creatorInfo.iconUrl | string | 条件付きで返却;アバター URL。 |
| content[].creatorInfo.mobile | string | 条件付きで返却;携帯電話番号。 |
| content[].creatorInfo.countryCode | string | 条件付きで返却;携帯電話の国番号。 |
| content[].creatorInfo.acntWsNickname | string | 条件付きで返却;ワークスペースでのニックネーム。 |
| content[].updatorInfo | object | 一覧でのみ ID 情報を補完します。一致しない場合は {} です。 |
| content[].updatorInfo.uuid | string | 条件付きで返却;ID UUID。 |
| content[].updatorInfo.name | string | 条件付きで返却;表示名。 |
| content[].updatorInfo.email | string | 条件付きで返却;メールアドレス。 |
| content[].updatorInfo.username | string | 条件付きで返却;ログイン名。 |
| content[].updatorInfo.status | integer | 条件付きで返却;アカウント状態。 |
| content[].updatorInfo.wsAccountStatus | integer | 条件付きで返却;ワークスペース関係の状態。 |
| content[].updatorInfo.iconUrl | string | 条件付きで返却;アバター URL。 |
| content[].updatorInfo.mobile | string | 条件付きで返却;携帯電話番号。 |
| content[].updatorInfo.countryCode | string | 条件付きで返却;携帯電話の国番号。 |
| content[].updatorInfo.acntWsNickname | string | 条件付きで返却;ワークスペースでのニックネーム。 |
| content[].declaration | object | 空でない各オブジェクトの共通宣言。 |
{
"code": 200,
"content": [
{
"uuid": "regn_example",
"keycode": "example-self-node",
"owner": "custom",
"name": "生产自建节点",
"nameEn": "Production self node",
"nameI18n": {
"zh": "生产自建节点",
"en": "Production self node"
},
"internal": true,
"country": "China",
"province": "Zhejiang",
"city": "Hangzhou",
"isp": "example",
"status": "OK",
"heartbeat": 1785427200,
"region": "example-region",
"company": "",
"external_id": "wksp_example",
"parent_ak": "",
"extend_info": "",
"create_at": 1785427200,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427200,
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
通常の Synthetic テスト SDK は、ダウンストリームの error_code=dialtesting.invalidRegion を一律に ft.DialingRegionError へマッピングし、実際の HTTP(400 に限らない)を保持します。その他のダウンストリーム 4xx は実際の HTTP と error_code/message(ft プレフィックスのない上流コードを含む)を保持します。一覧にないコードが返されることもあります。500 以上は公開エントリポイントで一律に 500 ft.InternalServerError にラップされます。SDK は上流の content を返し、本コントローラーは固定の regionInfo/ak 構造に一律に再ラップしません。実際のデプロイバージョンに応じて、フラットな形式または互換ラップ形式を識別する必要があり、未知の追加フィールドは互換性のため保持されます。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 406 | ft.DialingBrandNoSetError | ワークスペースに対応する Synthetic テストサービスのブランド設定がありません | {} ブランドの Synthetic テスト設定が構成されていません。 |
管理者が現在のワークスペースの Synthetic テストサービスを確認してください。 |
| 400 | ft.DialingAKNoSetError | Synthetic テストサービスの署名資格情報が構成されていません | Synthetic テストの AK 情報が構成されていません。Launcher のアクティベーション設定を確認してください。 | 管理者がサービスアクティベーション情報を確認してください。クライアントは本 Body でこれらの資格情報を送信しません。 |
| 400 | ft.DialingServerError | ダウンストリームの Synthetic テストノードインターフェースが 400 の業務失敗を返した、またはレスポンスのメディアを解析できない | Synthetic テストサービスインターフェースの呼び出しに失敗 | message/traceId を確認し、管理者がノードサービスを検査してください。失敗をノードなしとして扱わないでください。 |
| 500 | ft.InternalServerError | 通常のダウンストリーム 5xx/接続異常、または履歴ノード/関連フィールドの形式、名前、レスポンス組み立ての異常 | 内部エラー | 具体的なノード/フィルターに絞り込み、上流のレスポンス形式とサービスの可用性を確認してください。継続的に失敗する場合は traceId を保持してください。 |
| 400 | ft.DialingRegionError | ダウンストリーム HTTP 400 かつ error_code=dialtesting.invalidRegion。その他の 4xx も同じコードにマッピングされ、実際の HTTP が保持されます | 現在のタスクに一部の Synthetic テストノードの失効があります。設定を更新して再保存してください。 | 有効なセルフホストノードとノードサービスの状態を確認してください。元の dialtesting コードによる固定マッチングは行わないでください。 |