Method: projects.locations.instances.list

Lists Data Fusion instances in the specified project and location.

HTTP request

GET https://datafusion.googleapis.com/v1beta1/{parent=projects/*/locations/*}/instances

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as '-' (wildcard), then all regions available to the project are queried, and the results are aggregated.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.

pageToken

string

The nextPageToken value to use if there are additional results to retrieve for this list request.

filter

string

List filter.

orderBy

string

Sort results. Supported values are "name", "name desc", or "" (unsorted).

Request body

The request body must be empty.

Response body

Response message for the list instance request.

If successful, the response body contains data with the following structure:

JSON representation
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
instances[]

object (Instance)

Represents a list of Data Fusion instances.

nextPageToken

string

Token to retrieve the next page of results or empty if there are no more results in the list.

unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.