Managed Service for MySQL API, REST: Database.List

Field

Description

clusterId

string

Required field. ID of the cluster to list databases in.
To get this ID, make a ClusterService.List request.

The maximum string length in characters is 50.

Field

Description

pageSize

string (int64)

The maximum number of results per page to return.
If the number of available results is larger than pageSize, the API returns a ListDatabasesResponse.nextPageToken that can be used to get the next page of results in the subsequent DatabaseService.List requests.

Acceptable values are 0 to 1000, inclusive.

pageToken

string

Page token that can be used to iterate through multiple pages of results.
To get the next page of results, set pageToken to the ListDatabasesResponse.nextPageToken returned by the previous DatabaseService.List request.

The maximum string length in characters is 100.

Field

Description

databases[]

Database

List of databases.

nextPageToken

string

The token that can be used to get the next page of results.
If the number of results is larger than ListDatabasesRequest.pageSize, use the nextPageToken as the value for the ListDatabasesRequest.pageToken in the subsequent DatabaseService.List request to iterate through multiple pages of results.
Each of the subsequent DatabaseService.List requests should use the nextPageToken value returned by the previous request to continue paging through the results.

Field

Description

name

string

Name of the database.

clusterId

string

ID of the cluster that the database belongs to.

deletionProtectionMode

enum (DeletionProtectionMode)

Deletion Protection inhibits deletion of the database
Default value: DELETION_PROTECTION_MODE_DISABLED (protection is disabled)

• DELETION_PROTECTION_MODE_DISABLED: Deletion protection is disabled
• DELETION_PROTECTION_MODE_ENABLED: Deletion protection is enabled
• DELETION_PROTECTION_MODE_INHERITED: Deletion protection mode is inherited from the cluster