本記事では、APIを使用して指定されたテナントのプライマリゾーン属性を変更する方法について説明します。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
PUT /api/v1/tenant/:name/primary-zone
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| primary_zone | string | はい | RANDOM | テナントが読み書きサービスを提供するゾーンの優先順位を指定します。例えば、primary_zone ='zone1;zone2,zone3' は、テナントに対する読み書きサービスを優先的に zone1 が提供し、zone1 が zone2、zone3 よりも優先順位が高く、zone2 と zone3 は同じ優先順位であることを意味します。 |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| 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内のすべてのノード情報。Nodeの詳細情報を取得するを参照してください。 |
例
リクエスト例
PUT 10.10.10.1:2886/api/v1/tenant/t1/primary-zone
{
"primary_zone": "random"
}
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T11:47:56.785867645+08:00",
"duration": 140,
"status": 200,
"traceId": "aaef4804b636d263",
"data": {
"id": "16",
"dag_id": 6,
"name": "Modify tenant primary zone",
"stage": 1,
"max_stage": 1,
"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メソッドのリクエスト方法については、テナントのプライマリゾーンの変更を参照してください。