Overview
You can call this API to modify the disk size of a read-only instance.
API details
Constraints
The caller must have an AccessKey for accessing the APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT api/v2/instances/{instanceId}/readonlyInstance/diskSize
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obxxx |
body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| readonlyInstanceId | String | Yes | The ID of the read-only instance. | obxxx |
| targetDiskSize | Integer | Yes | The target disk size, in GB. | 70 |
| dryRun | Boolean | No | Specifies whether to perform a pre-check. | false |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | object | The information about the instance. | |
| orderId | string | The ID of the order. | NL25******** |
| instanceId | string | The ID of the instance. | ob******** |
| dryRun | Boolean | Specifies whether to perform a pre-check. | NL25******** |
| dryRunResult | Boolean | The result of the pre-check | NL25******** |
Examples
Request example
curl --digest -u 'ak:sk' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/readonlyInstance/diskSize' \
--data '{
"readonlyInstanceId": "obxxx",
"targetDiskSize": 70,
"dryRun": false
}'
Response example
JSON format
{
"data":{
"instanceId":"ob********",
"orderId":"NL25********"
},
"requestId":"f257f51e-****-****-8fba-ec1b9554cc78",
"success":true
}