Cloud Composer 1 is in the post-maintenance mode. Google does not release any further updates to Cloud Composer 1, including new versions of Airflow, bugfixes, and security updates. We recommend planning migration to Cloud Composer 2.
Required. The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Authorization requires the following IAM permission on the specified resource environment:
composer.environments.update
Request body
The request body contains data with the following structure:
JSON representation
{"imageVersion": string}
Fields
imageVersion
string
Optional. The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?). When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version.
The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or latest. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias.
The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version.
In all cases, the resolved image version is stored in the same field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-25 UTC."],[[["This webpage details how to check if an environment upgrade will succeed using a `POST` HTTP request to the Google Cloud Composer API."],["The request URL requires a specific format, incorporating the project, location, and environment ID, and the operation requires the `composer.environments.update` IAM permission."],["The request body must include the target `imageVersion`, specifying the desired Cloud Composer and Apache Airflow versions, in a JSON format."],["The response body, if the request is successful, will provide an `Operation` instance with details regarding the upgrade check, or the issues encountered."],["Authentication requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform`."]]],[]]
