VM Migration API (vmmigration:v1)

2025-08-28

8 new methods

Additions

    Methods
  • vmmigration.projects.locations.sources.fetchStorageInventory

      Path : v1/{+source}:fetchStorageInventory

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}:fetchStorageInventory

      HTTP Method : GET

      Parameters :

        source

          Description : Required. The name of the Source.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+$

          Location : path

          Required : Yes

          Type : string

        type

          Description : Required. The type of the storage inventory to fetch.

          Location : query

          Type : string

          Enum Descriptions :

        • The type is unspecified.
        • The type is disks.
        • The type is snapshots.
        • Enum :

        • STORAGE_TYPE_UNSPECIFIED
        • DISKS
        • SNAPSHOTS

        forceRefresh

          Description : Optional. If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower.

          Location : query

          Type : boolean

        pageSize

          Description : Optional. The maximum number of VMs to return. The service may return fewer than this value.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A page token, received from a previous `FetchStorageInventory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchStorageInventory` must match the call that provided the page token.

          Location : query

          Type : string

      Parameter Order : source

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : List remote source's inventory of storage resources. The remote source is another cloud vendor (e.g. AWS, Azure). The inventory describes the list of existing storage resources in that source. Note that this operation lists the resources on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

  • vmmigration.projects.locations.sources.diskMigrationJobs.create

      Path : v1/{+parent}/diskMigrationJobs

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The DiskMigrationJob's parent.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+$

          Location : path

          Required : Yes

          Type : string

        diskMigrationJobId

          Description : Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen.

          Location : query

          Type : string

        requestId

          Description : Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a new disk migration job in a given Source.

  • vmmigration.projects.locations.sources.diskMigrationJobs.list

      Path : v1/{+parent}/diskMigrationJobs

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent, which owns this collection of DiskMigrationJobs.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A page token, received from a previous `ListDiskMigrationJobs` call. Provide this to retrieve the subsequent page. When paginating, all parameters provided to `ListDiskMigrationJobs` except `page_size` must match the call that provided the page token.

          Location : query

          Type : string

        filter

          Description : Optional. The filter request (according to AIP-160).

          Location : query

          Type : string

        orderBy

          Description : Optional. Ordering of the result list.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists DiskMigrationJobs in a given Source.

  • vmmigration.projects.locations.sources.diskMigrationJobs.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the DiskMigrationJob.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets details of a single DiskMigrationJob.

  • vmmigration.projects.locations.sources.diskMigrationJobs.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Output only. Identifier. The identifier of the DiskMigrationJob.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Field mask is used to specify the fields to be overwritten in the DiskMigrationJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, then a mask equivalent to all fields that are populated (have a non-empty value), will be implied.

          Location : query

          Type : string

          Format : google-fieldmask

        requestId

          Description : Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Updates the parameters of a single DiskMigrationJob.

  • vmmigration.projects.locations.sources.diskMigrationJobs.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the DiskMigrationJob.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a single DiskMigrationJob.

  • vmmigration.projects.locations.sources.diskMigrationJobs.run

      Path : v1/{+name}:run

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the DiskMigrationJob.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Runs the disk migration job.

  • vmmigration.projects.locations.sources.diskMigrationJobs.cancel

      Path : v1/{+name}:cancel

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the DiskMigrationJob.

          Pattern : ^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Cancels the disk migration job.