削除¶
GET /api/v1/dialing_region/{region_uuid}/delete
概要¶
セルフホストノードを削除し、そのノードに関連付けられたタスク設定を停止します。
呼び出し前の注意事項と使用手順¶
このレガシーインターフェースは実際には GET ですが削除の副作用があります。明示的に削除する場合にのみ呼び出し、自動プリフェッチ、ヘルスチェック、盲目的な再試行は行わないでください。本ワークスペースの owner=custom ノードである必要があります。まず関連タスクを照会し、このノードをタスクの regions から削除して、ノードサービスへこのリージョン上のタスク設定の一括削除を要求します。その後、ローカルタスクの更新をコミットし、最後にトランザクション外でノードを削除します。元の報告済みデータはノード設定の削除に伴って削除されません。他のノードは引き続き実行できます。最後のノードが削除された後もタスクは残る可能性がありますが、実行リージョンが存在しなくなり、タスクは自動削除されません。
この処理はサービス間のアトミックトランザクションではありません。タスク/リモートリージョンの停止またはローカルコミットが成功していても、最終的なノード削除は失敗する可能性があります。エラー時はまずノード一覧と各関連タスクの regions を確認し、完全に未実行だったと直ちに判断しないでください。ノードがすでに一覧にない場合、再度削除すると 403 になる可能性があります。レガシー regionsInfo には古いノードのスナップショットが残る場合があります。実際の実行選択は、更新後の regions とプラットフォーム状態で確認し、古い表示スナップショットだけでまだ実行中と判断しないでください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| region_uuid | string | Y | デフォルトのパブリックノード、モバイルノードID、keycode、またはタスクUUIDではありません。 例: regn_example取得または入力方法: セルフホストノード一覧の uuid から現在のワークスペースの owner=custom ノードを取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/dialing_region/regn_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | JSON | 上流の削除 content をそのまま返します。通常は {} で、固定の true ではありません。明示的な上流の [] はそのまま返すことがあります。成功レスポンス辞書に content がない場合、SDK が {} を補います。 |
| content.declaration | object | 空でないオブジェクトを返す場合にのみ付加され、空の {} の場合は付加されません。空でないオブジェクト配列はオブジェクトごとに付加されます。 |
{
"code": 200,
"content": {},
"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 | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 403 | ft.ForbiddenInvalidSelfBuiltNode | UUID が本ワークスペースのセルフホストノード集合に存在しません | 不正な操作、無効なセルフホストノードID | 本ワークスペースのセルフホスト一覧で確認してください。削除済みオブジェクトの冪等成功は保証されません。 |
| 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 コードで固定マッチングしないでください。 |