For Cloud Run services, the request timeout setting specifies the time within which a response must be returned by services deployed to Cloud Run. If a response isn't returned within the time specified, the request ends and an error 504 is returned. Note that the container instance that served the request is not terminated.
Timeout period
The timeout is set by default to 5 minutes (300 seconds) and can be extended up to 60 minutes (3600 seconds).
You can change this setting when you deploy a container image or by updating the service configuration.
In addition to changing the Cloud Run request timeout, you should also check your language framework to see whether it has its own request timeout setting that you must also update. Some clients of the Cloud Run service might also impose a more restrictive timeout.
Required roles
To get the permissions that you need to configure and deploy Cloud Run services, ask your administrator to grant you the following IAM roles:
-
Cloud Run Developer (
roles/run.developer
) on the Cloud Run service -
Service Account User (
roles/iam.serviceAccountUser
) on the service identity
For a list of IAM roles and permissions that are associated with Cloud Run, see Cloud Run IAM roles and Cloud Run IAM permissions. If your Cloud Run service interfaces with Google Cloud APIs, such as Cloud Client Libraries, see the service identity configuration guide. For more information about granting roles, see deployment permissions and manage access.
Setting and updating request timeout
Any configuration change leads to the creation of a new revision. Subsequent revisions will also automatically get this configuration setting unless you make explicit updates to change it.
You can set request timeout using the Google Cloud console, the gcloud command line, or a YAML file when you create a new service or deploy a new revision.
Console
In the Google Cloud console, go to Cloud Run:
Click Deploy container and select Service to configure a new service. If you are configuring an existing service, click the service, then click Edit and deploy new revision.
If you are configuring a new service, fill out the initial service settings page, then click Container(s), volumes, networking, security to expand the service configuration page.
Click the Container tab.
- In the Request timeout field, enter the timeout value that you want to use in seconds. Use values ranging from
1
to3600
seconds, or from 1 to60
minutes.
- In the Request timeout field, enter the timeout value that you want to use in seconds. Use values ranging from
Click Create or Deploy.
gcloud
You can update the request timeout for a given revision at any time by using the following command:
gcloud run services update SERVICE --timeout=TIMEOUT
Replace:
- SERVICE with the name of your service.
TIMEOUT with the time within which a response must be returned, using an integer value or an absolute duration value, for example
1m20s
which is 1 minute, 20 seconds. If you use an integer value, the unit is assumed to be seconds. The value you specify must be less than 60 minutes.
You can also set the request timeout during deployment using the command:
gcloud run deploy --image IMAGE_URL --timeout=TIMEOUT
Replace:
- IMAGE_URL with a reference to the container image, for
example,
us-docker.pkg.dev/cloudrun/container/hello:latest
. If you use Artifact Registry, the repository REPO_NAME must already be created. The URL has the shapeLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
- TIMEOUT with the time within which a response must be
returned, using an integer value or a duration value, for example
1m20s
which is 1 minute, 20 seconds. If you use an integer value, the unit is assumed to be seconds. The value you specify must be less than 60 minutes.
YAML
If you are creating a new service, skip this step. If you are updating an existing service, download its YAML configuration:
gcloud run services describe SERVICE --format export > service.yaml
Update the
timeoutSeconds
attribute:apiVersion: serving.knative.dev/v1 kind: Service metadata: name: SERVICE spec: template: metadata: name: REVISION spec: containers: - image: IMAGE timeoutSeconds: VALUE
Replace
- SERVICE with the name of your Cloud Run service
- IMAGE_URL with a reference to the container image, for
example,
us-docker.pkg.dev/cloudrun/container/hello:latest
. If you use Artifact Registry, the repository REPO_NAME must already be created. The URL has the shapeLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
- VALUE with the desired timeout, in seconds.
- REVISION with a new revision name or delete it (if present). If you supply a new revision name, it must meet the following criteria:
- Starts with
SERVICE-
- Contains only lowercase letters, numbers and
-
- Does not end with a
-
- Does not exceed 63 characters
- Starts with
Create or update the service using the following command:
gcloud run services replace service.yaml
Terraform
To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.
Add the following to a google_cloud_run_v2_service
resource in your Terraform
configuration, under template
. Replace 300s
with your
service's desired request timeout.
View request timeout settings
To view the current request timeout settings for your Cloud Run service:
Console
In the Google Cloud console, go to Cloud Run:
Click the service you are interested in to open the Service details page.
Click the Revisions tab.
In the details panel at the right, the request timeout setting is listed under the Container tab.
gcloud
Use the following command:
gcloud run services describe SERVICE
Locate the request timeout setting in the returned configuration.