機能の概要
OBProxyクラスタを作成するために使用するインターフェースです。
呼び出しの説明
インターフェース制約
呼び出し元はOCPアプリケーションサービスの認証を通過している必要があります。
リクエストパス
POST /api/v2/obproxy/clusters
リクエストパラメータ
body:
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| name | String | はい | OBProxy001 | OBProxyクラスタ名。 |
| address | String | はい | foo.bae | OBProxyクラスタのアクセスアドレス。 |
| port | Integer | はい | 2883 | OBProxyクラスタのアクセスポート。 |
| workMode | String | はい | CONFIG_URL | OBProxyクラスタの動作モード: |
| obproxyInstallParam | Object | はい | -- | OBProxyクラスタ作成時にインストールするOBProxy情報。 |
| ├─hostIds | Array | はい | [1,2] | OBProxyをインストールするホストID。 |
| ├─sqlPort | Integer | はい | 2883 | OBProxy SQLポート。 |
| ├─exportPort | Integer | はい | 2884 | OBProxy Exproterポート。 |
| ├─version | String | いいえ | obproxy-x.x.x.-752024120610.el7.x86_64.rpm | OBProxyソフトウェアパッケージのバージョン。OBProxy Serverをデプロイしない場合は指定不要。 |
| obLinks | Array | いいえ | -- | OceanBaseクラスタへの接続情報。詳細はObLinkデータ構造を参照。 |
| startupParameters | Array | いいえ | -- | OBProxy起動パラメータ。詳細はObproxyParameterデータ構造を参照。空配列も可能です。 |
| parameters | Array | いいえ | -- | OBProxy非起動パラメータ。詳細はObproxyParameterデータ構造を参照。空配列も可能です。 |
| password | String | いいえ | -- | proxysysアカウントのパスワード。OBProxy V3.1.0未満のバージョンではこのパスワードの指定はサポートされていません。 |
| installPath | String | はい | /home/admin/obproxy | OBProxyのインストールパス。 |
| runUser | String | はい | admin | OBProxyの実行ユーザー。 |
ObLinkデータ構造
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| clusterName | String | はい | foo | クラスタ名。 |
| obClusterId | Integer | いいえ | 1 | OceanBase側でのクラスタID。 |
| username | String | はい | proxyro | クラスタ接続ユーザー。 |
ObproxyParameterデータ構造
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| name | String | はい | foo | パラメータ名。 |
| value | String | はい | bar | パラメータ値。 |
実行結果
基本データ構造
パラメータ |
型 |
説明 |
|---|---|---|
| data | Object | 非同期タスク情報。詳細については、タスク情報を参照してください。 |
| successful | Boolean | リクエストが成功したかどうかを示します。 |
| timestamp | Datetime | サーバーがリクエストを完了したタイムスタンプ。 |
| duration | Integer | サーバーがリクエストを処理した時間(ミリ秒)。 |
| status | Integer | HTTPステータスコード。 |
| traceId | String | リクエストのトレースID。問題の調査に使用されます。 |
| server | String | リクエストに応答したアプリケーションサービスのアドレス。 |
例
リクエスト例
POST /api/v2/obproxy/clusters
{
"name": "OBProxy001",
"installPath": "/home/admin/obproxy",
"runUser": "admin",
"address": "foo.bae",
"port": 2883,
"password": "",
"workMode": "CONFIG_URL",
"obproxyInstallParam": {
"version": "obproxy-x.x.x.-752024120610.el7.x86_64.rpm",
"sqlPort": 2883,
"rpcPort": 2885,
"exporterPort": 2884,
"hostIds": [1]
}
}
実行結果例
{
"data": {
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 31257,
"name": "Install obproxy",
"operation": "EXECUTE",
"startTime": "2021-09-03T15:05:01.101+08:00",
"status": "RUNNING",
"subtasks": [{
"description": "Finish node",
"downstreams": [],
"id": 32955,
"name": "Finish node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"timeout": 0,
"upstreams": [32954]
},
{
"description": "Prepare obproxy install",
"downstreams": [32955],
"id": 32954,
"name": "Prepare obproxy install",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 0,
"status": "READY",
"timeout": 300,
"upstreams": []
}],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 82,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T15:05:01.106+08:00",
"traceId": "e874a2cead544112"
}