機能の概要
このAPIは、指定されたOceanBaseクラスタに読み取り専用レプリカインスタンスを作成するために使用します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/readonlyInstance
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Header
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | hxq3ztx3377nby3v87ry**** |
Body
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| readOnlyReplicaType | String | はい | 読み取り専用レプリカタイプ：
|
ROW_STORE |
| zone | String | はい | ゾーン | ap-beijing-3 |
| instanceClass | String | はい | スペック | 4C16G |
| diskSize | Integer | いいえ | ディスクサイズ | 70 |
| nodeNum | Integer | いいえ | ノード数 | 1 |
| dryRun | Boolean | いいえ | プリフライトチェックの有無 | false |
実行結果
パラメータ |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | クラスタ情報。 | |
| orderId | string | 注文ID。 | NL25******** |
| instanceId | string | インスタンスID。 | ob******** |
| dryRun | Boolean | プリフライトチェックの有無。 | NL25******** |
| dryRunResult | Boolean | プリフライトチェック結果 | NL25******** |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X POST \
-H 'X-Ob-Project-Id: {X-Ob-Project-Id}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/readonlyInstance?requestId={requestId}' \
--data '{
"readOnlyReplicaType": "ROW_STORE",
"zone": "ap-beijing-3",
"instanceClass": "4C16G",
"diskSize": 100,
"nodeNum": 4,
"dryRun": true
}'
レスポンス例
JSON形式
{
"data": {
"instanceId": "ob********",
"orderId": "NL25********"
},
"requestId": "f257f51e-****-****-8fba-ec1b9554cc78",
"success": true
}