Method: projects.locations.pluggableDatabases.list

Lists all the PluggableDatabases for the given project, location and Container Database.

HTTP request

GET https://oracledatabase.googleapis.com/v1/{parent=projects/*/locations/*}/pluggableDatabases

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.

pageToken

string

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

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

filter

string

Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: database="projects/{project}/locations/{location}/databases/{database}"

Request body

The request body must be empty.

Response body

The response for PluggableDatabase.List.

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

JSON representation
{
  "pluggableDatabases": [
    {
      object (PluggableDatabase)
    }
  ],
  "nextPageToken": string
}
Fields
pluggableDatabases[]

object (PluggableDatabase)

The list of PluggableDatabases.

nextPageToken

string

A token identifying a page of results the server should return.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • oracledatabase.pluggableDatabases.list

For more information, see the IAM documentation.