Actions5
Start Workstation
AI-generatedOverview
This node, named "Google IDX Action," is designed to perform various workstation-related operations using Google OAuth2 credentials linked to Google Cloud projects and IDX workspaces. It supports actions such as starting, stopping, checking the status of a workstation, running commands on it, or generating access tokens.
Typical use cases include automating management of development or build workstations hosted in Google Cloud environments, especially when integrated with IDX workspaces. For example, a user can start a specific workstation cluster, run a command remotely, or retrieve an access token for further API interactions.
Properties
| Name | Meaning |
|---|---|
| Is List | Boolean flag indicating whether multiple items (workstations) are processed at once (true) or a single item (false). |
| Credentinals Name | Select or enter your Google Cloud project credential. Options: - From List: select from available Google Cloud accounts. - By Name: enter the credential name manually. |
| Project ID | Select or enter your Google Cloud project ID. Only shown if Is List is false. Options:- From List: select from available Google Cloud projects associated with the chosen credential. |
Output
The node outputs JSON data representing the result of the requested workstation operation. The structure depends on the specific operation performed but generally includes details about the workstation's state or the command execution result.
If the node runs commands or generates tokens, the output JSON will contain relevant response data from those actions.
No binary data output is indicated by the source code.
Dependencies
- Requires a valid Google OAuth2 credential configured in n8n to authenticate API requests.
- Depends on an internal API endpoint (likely part of the user's infrastructure) accessed via a base URL stored in the credentials.
- Uses a sub-workflow template (
subWorkflowTemplate.json) to execute the actual workstation operations. - Requires proper configuration of IDX workspaces and Google Cloud projects linked to the credentials.
Troubleshooting
- Invalid input format error: The node expects commands in a strict format like
/run -a USER -ws SLUG[,SLUG2] [-c COMMAND]. Ensure inputs follow this pattern exactly. - Missing or invalid input: If the credential or workspace slug is missing or malformed, the node throws an error. Verify that all required parameters are correctly set.
- No workspace found: If no matching workspace is found for the provided slugs, the node will error out. Confirm that the workspace names exist and are correctly linked to the selected credential.
- Credential issues: Authentication failures may occur if the Google OAuth2 credentials are invalid or expired. Re-authenticate or update credentials as needed.
- Execution errors: Errors during sub-workflow execution are caught and rethrown with descriptive messages. Check the underlying workflow and API responses for more details.