機能の概要
このAPIは、読み取り専用レプリカのディスクサイズを変更するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元は、マルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
PUT /api/v2/instances/{instanceId}/readonlyInstance/diskSize
リクエストパラメータ
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 |
| targetDiskSize | Integer | はい | ターゲットディスクサイズ、GB単位 | 70 |
| dryRun | Boolean | いいえ | プリフライトチェックを実行するかどうか | false |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | クラスタ情報。 | |
| orderId | string | 注文ID。 | NL25******** |
| instanceId | string | インスタンスID。 | ob******** |
| dryRun | Boolean | プリフライトチェックを実行するかどうか。 | NL25******** |
| dryRunResult | Boolean | プリフライトチェック結果 | NL25******** |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X PUT \
-H 'X-Ob-Project-Id: {X-Ob-Project-Id}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/readonlyInstance/diskSize?requestId={requestId}' \
--data '{
"readonlyInstanceId": "obxxx",
"targetDiskSize": 70,
"dryRun": false
}'
レスポンス例
JSON形式
{
"data":{
"instanceId":"ob********",
"orderId":"NL25********"
},
"requestId":"f257f51e-****-****-8fba-ec1b9554cc78",
"success":true
}