GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves details of a specific batched background migration in a GitLab instance by its ID. It is useful for administrators or developers who need to monitor or manage background migration tasks within GitLab. For example, it can be used to check the status or details of a migration process running in the background.

Use Case Examples

  1. An admin wants to fetch the status of a migration with ID 123 to verify if it completed successfully.
  2. A developer needs to audit background migrations for troubleshooting or reporting purposes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used for the API request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request. Defaults to GET.
Query Parameters Optional query parameters for the request, including 'database' to specify the database name (e.g., main, ci, sec).
Path Parameters Path parameters for the request, specifically the 'id' of the batched background migration to retrieve.

Output

JSON

  • id - The unique identifier of the batched background migration.
  • status - The current status of the migration (e.g., active, completed).
  • job_class_name - The class name of the background migration job.
  • table_name - The database table affected by the migration.
  • column_name - The column in the table affected by the migration.
  • interval - The interval at which the migration batches run.
  • migration_arguments - Arguments passed to the migration job.
  • database_name - The name of the database where the migration is running.
  • created_at - Timestamp when the migration was created.
  • updated_at - Timestamp when the migration was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is provided and is a valid integer; missing or invalid 'id' will cause request failure.
  • Verify that the baseUrl is correct and accessible; incorrect URLs will lead to connection errors.
  • Authentication errors may occur if the API key credential is missing or invalid; ensure proper credentials are configured.
  • If the migration ID does not exist, the API will return a not found error; verify the ID before making the request.

Links

Discussion