Method: projects.locations.connectionProfiles.list

Retrieve a list of all connection profiles in a given project and location.

HTTP request

GET https://datamigration.googleapis.com/v1alpha2/{parent}/connectionProfiles

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of connection profiles.

Authorization requires the following IAM permission on the specified resource parent:

  • datamigration.connectionprofiles.list

Query parameters

Parameters
pageSize

integer

The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous connectionProfiles.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to connectionProfiles.list must match the call that provided the page token.

filter

string

A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.username = %lt;my_username%gt; to list all connection profiles configured to connect with a specific username.

orderBy

string

the order by fields for the result.

Request body

The request body must be empty.

Response body

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

Response message for 'connectionProfiles.list' request.

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

object (ConnectionProfile)

The response list of connection profiles.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

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.