Shrink instance storage capacity

MySQL | PostgreSQL | SQL Server

This page shows you how to manage the storage capacity of a Cloud SQL instance using storage shrink capabilities.

Before you begin

Review the feature's limitations.
If you're using gcloud CLI, make sure you are using the latest version of Google Cloud SDK and gcloud CLI.
- Install the latest gcloud CLI version.
- To get the current gcloud CLI version, run gcloud --version.
- To update the gcloud CLI version, run gcloud components update.
Get the following IAM permissions:
- cloudsql.instances.getDiskShrinkConfig
- cloudsql.instances.performDiskShrink
These permissions are available in either of the following roles. When assigning your role, we recommend applying the principle of least privilege:
- Cloud SQL Admin (roles/cloudsql.admin)
- Cloud SQL Editor (roles/cloudsql.editor)
For more information, see the following resources:

Prepare the instance

Complete the following requirements before you begin.

These steps are the same for primary instances and read replicas.

If updating a read replica, make sure to shrink the capacity of the primary instance first, then shrink the size of the replica.

Get the project ID of the project containing the instance you want to manage.
Check the current state of the instance to make sure it is running. One way to check is to use the describe command:
```
  gcloud sql instances describe
```
Returns the following status:
```
  RUNNABLE
```
If not, start the instance.
Create a backup of the current instance. This lets you restore the instance later if you run into issues during configuration.
Disable all extensions or features that enable outbound connections (or require outbound data transfer).

Shrink the storage capacity of an instance

The following steps are the same for primary instances and read replicas.

Check the target minimum storage capacity of the instance and the estimated operation time. This information can help you plan your storage shrink operation.

Note: This capability is unavailable for read replicas. Read replica storage capacity typically matches its associated primary instance.
gcloud
Run the gcloud sql instances get-storage-shrink-config command:
```
gcloud sql instances get-storage-shrink-config INSTANCE_NAME
```
Replace the following:
- INSTANCE_NAME: the name of the primary instance.
The response includes a value for minimalTargetSizeGb. You can use this value to determine the value you want to use for the --storage-size parameter when you run a storage shrink operation.

The response also returns a message with an estimated operation time, similar to the following:
```
...
"The estimated operation time is 20 minutes".
```
REST v1
Use the GET method to view the instance's target minimum storage capacity.

Before using any of the request data, make the following replacements:
- PROJECT_ID: the name of the project where the primary instance resides.
- INSTANCE_ID: the instance ID of the primary instance.
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID/getDiskShrinkConfig
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID/getDiskShrinkConfig"
PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID/getDiskShrinkConfig" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{ "kind": "sql#instance", "min_target_size_gb": "1234" "message": "The size of your instance's storage impacts IOPS, and therefore shrinking your storage may have a negative impact on IOPS. Before shrinking your storage, please refer to our documentation on Cloud SQL limits to understand what impact shrinking your storage might have: https://cloud.google.com/sql/docs/quotas#fixed-limits. Additionally, we recommend leaving an appropriate buffer for operational purposes, like reindexing, etc. We recommend a buffer of at least 100 GB or 20% more than current usage, whichever is larger. For more details, please refer to: https://cloud.google.com/sql/docs/shared-responsibility. The estimated operation time is 20 minutes." }
The response includes a value for min_target_size_gb. You can use this value to determine the value you want to use for the --storage-size parameter when you run a storage shrink operation.

The response also returns a message with an estimated operation time, similar to the following:
```
...
"The estimated operation time is 20 minutes".
```
REST v1beta4
Use the GET method to view the instance's target minimum storage capacity.

Before using any of the request data, make the following replacements:
- PROJECT_ID: the name of the project where the primary instance resides.
- INSTANCE_ID: the instance ID of the primary instance.
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID/getDiskShrinkConfig
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID/getDiskShrinkConfig"
PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID/getDiskShrinkConfig" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{ "kind": "sql#instance", "min_target_size_gb": "1234" "message": "The size of your instance's storage impacts IOPS, and therefore shrinking your storage may have a negative impact on IOPS. Before shrinking your storage, please refer to our documentation on Cloud SQL limits to understand what impact shrinking your storage might have: https://cloud.google.com/sql/docs/quotas#fixed-limits. Additionally, we recommend leaving an appropriate buffer for operational purposes, like reindexing, etc. We recommend a buffer of at least 100 GB or 20% more than current usage, whichever is larger. For more details, please refer to: https://cloud.google.com/sql/docs/shared-responsibility. The estimated operation time is 20 minutes." }
The response includes a value for min_target_size_gb. You can use this value to determine the value you want to use for the --storage-size parameter when you run a storage shrink operation.

The response also returns a message with an estimated operation time, similar to the following:
```
...
"The estimated operation time is 20 minutes".
```
Shrink storage capacity of the instance.
gcloud
Run the following command to shrink storage on the instance:
```
gcloud sql instances perform-storage-shrink INSTANCE_NAME \
  --storage-size=TARGET_STORAGE_SIZE --async
```
Replace the following:
- INSTANCE_NAME: the name of the instance.
- TARGET_STORAGE_SIZE: the target storage capacity in GB. For example, 100 GB.
We recommend using the --async flag to wait for the operation asynchronously.
REST v1

Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID of the project where the instance resides.
- INSTANCE_ID: the ID of the instance.
- TARGET_STORAGE_SIZE: the target storage size in GB.
HTTP method and URL:
POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID/performDiskShrink
Request JSON body:
{ "targetSizeGb": TARGET_STORAGE_SIZE }
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Save the request body in a file named request.json, and execute the following command:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID/performDiskShrink"
PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Save the request body in a file named request.json, and execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID/performDiskShrink" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{ "kind": "sql#operation", "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID", "status": "PENDING", "user": "user@example.com", "insertTime": "2019-09-25T22:19:33.735Z", "operationType": "UPDATE", "name": "operation-id", "targetId": "INSTANCE_ID", "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/operation-id", "targetProject": "PROJECT_ID" }
REST v1beta4

Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID of the project where the instance resides.
- INSTANCE_ID: the ID of the instance.
- TARGET_STORAGE_SIZE: the target storage size of the instance.
HTTP method and URL:
POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID/performDiskShrink
Request JSON body:
{ "targetSizeGb": TARGET_STORAGE_SIZE }
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Save the request body in a file named request.json, and execute the following command:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID/performDiskShrink"
PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Save the request body in a file named request.json, and execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID/performDiskShrink" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{ "kind": "sql#operation", "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID", "status": "PENDING", "user": "user@example.com", "insertTime": "2019-09-25T22:19:33.735Z", "operationType": "UPDATE", "name": "operation-id", "targetId": "INSTANCE_ID", "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/operation-id", "targetProject": "PROJECT_ID" }
To check the status of the storage shrink operation, see Check the status of an operation.

Cancel storage shrink operation

Get the storage shrink operation ID.

You can retrieve the operation ID by running the following list command:
```
gcloud sql operations list
```
Send a cancellation request.
gcloud
Run the following command to cancel the request:
```
gcloud sql operations cancel OPERATION_ID
```
Replace the following:

OPERATION_ID: the ID of the storage shrink operation you want to cancel.
REST v1

Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID of the project where the instance resides.
- OPERATION_ID: the ID of the storage shrink operation you want to cancel.
HTTP method and URL:
POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID/cancel
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d "" \
"https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID/cancel"
PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID/cancel" | Select-Object -Expand Content
You should receive a successful status code (2xx) and an empty response.
REST v1beta4

Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID of the project where the instance resides.
- OPERATION_ID: the ID of the storage shrink operation you want to cancel.
HTTP method and URL:
POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID/cancel
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d "" \
"https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID/cancel"
PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID/cancel" | Select-Object -Expand Content
You should receive a successful status code (2xx) and an empty response.

Check the status of a cancellation request or other operation

To check the status of a request, run the following commands:

gcloud

Get the operation ID for the cancellation request:
```
gcloud sql operations list
```
Check the status of the operation:
```
gcloud sql operations describe OPERATION_ID
```
Replace the following:

OPERATION_ID: the ID of the operation you want to check.

REST v1

Before using any of the request data, make the following replacements:

PROJECT_ID: the name of the project where the instance resides.
OPERATION_ID: the ID of the storage shrink operation.

HTTP method and URL:

GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID"

PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

Response

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "RUNNING",
  "user": "user@example.com",
  "insertTime": "2023-12-18T22:43:09.849Z",
  "startTime": "2023-12-18T22:43:10.373Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "example_instance",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

Before using any of the request data, make the following replacements:

PROJECT_ID: the name of the project where the instance resides.
OPERATION_ID: the ID of the storage shrink operation.

HTTP method and URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID"

PowerShell (Windows)

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

Response

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "RUNNING",
  "user": "user@example.com",
  "insertTime": "2023-12-18T22:43:09.849Z",
  "startTime": "2023-12-18T22:43:10.373Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "example_instance",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Troubleshooting

For information regarding troubleshooting, see Issues updating storage capacity.

Shrink instance storage capacity Stay organized with collections Save and categorize content based on your preferences.

Before you begin

Prepare the instance

Shrink the storage capacity of an instance

gcloud

REST v1

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Response

REST v1beta4

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Response

gcloud

REST v1

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Response

REST v1beta4

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Response

Cancel storage shrink operation

gcloud

REST v1

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

REST v1beta4

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Check the status of a cancellation request or other operation

gcloud

REST v1

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Response

REST v1beta4

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Response

Troubleshooting

What's next

Shrink instance storage capacity