本記事では、APIを使用して指定されたテナントのレプリカを追加する方法について説明します。一度に複数のレプリカを追加することも可能です。
呼び出しの説明
パスワードが設定されている場合は、認証を通過する必要があります。詳細については、APIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/tenant/:name/replicas
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| zone_list | []ZoneParam | はい | 詳細については、以下のZoneParamのデータ構造を参照してください | 新規レプリカに使用するリソース仕様および配置状況。 |
ZoneParamのデータ構造：
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| name | string | はい | zone1 | Zoneの名前を設定します。 |
| replica_type | string | いいえ | FULL | テナントのZone上のレプリカタイプを設定します。FULL(フル機能型レプリカ)またはREADONLY(読み取り専用型レプリカ)に設定できます。デフォルトはFULLです。 |
| unit_config_name | string | はい | s1 | テナントリソースプールがZone上で使用するリソース仕様を設定します。 |
| unit_num | int | はい | 1 | テナントのZone上のユニット数を設定します。 |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| 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の詳細情報を取得するを参照してください。 |
例
リクエスト例
POST 10.10.10.1:2886/api/v1/tenant/t1/replicas
{
"zone_list": [
{
"name": "zone1",
"unit_config_name": "s1",
"unit_num": 1
}
]
}
レスポンス例
{
"successful": true,
"timestamp": "2024-10-14T10:46:38.20335278+08:00",
"duration": 69,
"status": 200,
"traceId": "fbd20f5a7060af66",
"data": {
"id": "13",
"dag_id": 3,
"name": "Scale out 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メソッドのリクエスト方法の詳細については、テナントレプリカの追加を参照してください。