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