本記事では、APIを使用して指定したテナントのレプリカを削除する方法について説明します。レプリカが使用していたリソースプールも解放されます。一度に指定したテナントの複数のレプリカを削除することも可能です。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/tenant/:name/replicas
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| zones | []string | はい | ["zone1","zone2"] | 削除するレプリカが配置されているゾーンを指定します。 |
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| data | DagDetailDTO | 非同期タスク情報です。詳細については、後述の DagDetailDTOデータ構造 を参照してください。 |
| error | ApiError | リクエストで発生したエラーです。以下の情報が含まれます：
|
DagDetailDTO情報のデータ構造は以下のとおりです：
パラメータ |
型 |
説明 |
|---|---|---|
| id | string | DAG共通ID。 |
| dag_id | int | DAG id。OceanBaseデータベースに記録される主キーです。 |
| name | string | DAG名。 |
| stage | int | DAGの現在の実行段階。 |
| max_stage | int | DAG実行プロセス中の段階総数。 |
| state | string | DAG実行状態。 |
| operator | string | DAG実行操作タイプ。 |
| start_time | time.Time | DAG実行開始時間。 |
| end_time | time.Time | DAG実行終了時間。 |
| additional_data | map[string]any | DAGその他のデータ。 |
| nodes | []NodeDetailDTO | DAG内のすべてのノード情報。ノードの詳細情報を取得するを参照してください。 |
例
リクエスト例
DELETE 10.10.10.1:2886/api/v1/tenant/t1/replicas
{
"zones": [
"zone1"
]
}
返却例
{
"successful": true,
"timestamp": "2024-10-14T10:44:51.611972458+08:00",
"duration": 101,
"status": 200,
"traceId": "f80f9f2a1048b8e0",
"data": {
"id": "12",
"dag_id": 2,
"name": "Scale in tenant replicas",
"stage": 1,
"max_stage": 2,
"state": "READY",
"operator": "RUN",
"start_time": "0001-01-01T00:00:00Z",
"end_time": "0001-01-01T00:00:00Z",
"additional_data": null,
"nodes": null
}
}
関連ドキュメント
コマンドラインでAPIを呼び出すほかに、SDKのメソッドを通じてAPIを呼び出すこともできます。
obshell-sdk-pythonを使用したAPIメソッドのリクエスト方法については、テナントレプリカの削除を参照してください。
obshell-sdk-goを使用したAPIメソッドのリクエスト方法については、テナントレプリカの削除を参照してください。