Get v1instances databases
Permissions required: bb.databases.list
Path Parameters
The instance id.
Query Parameters
The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 10 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
A page token, received from a previous ListDatabases
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDatabases
must
match the call that provided the page token.
Filter is used to filter databases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
- environment: the environment full name in "environments/{id}" format, support "==" operator.
- name: the database name, support ".matches()" operator.
- project: the project full name in "projects/{id}" format, support "==" operator.
- instance: the instance full name in "instances/{id}" format, support "==" operator.
- engine: the database engine, check Engine enum for values. Support "==", "in [xx]", "!(in [xx])" operator.
- label: the database label in "{key}:{value1},{value2}" format. Support "==" operator.
- exclude_unassigned: should be "true" or "false", will not show unassigned databases if it's true, support "==" operator.
- drifted: should be "true" or "false", show drifted databases if it's true, support "==" operator.
- table: filter by the database table, support "==" and ".matches()" operator.
For example: environment == "environments/{environment resource id}" project == "projects/{project resource id}" instance == "instances/{instance resource id}" name.matches("database name") engine == "MYSQL" engine in ["MYSQL", "POSTGRES"] !(engine in ["MYSQL", "POSTGRES"]) label == "region:asia" label == "tenant:asia,europe" label == "region:asia" && label == "tenant:bytebase" exclude_unassigned == true drifted == true table == "sample" table.matches("sam")
You can combine filter conditions like: environment == "environments/prod" && name.matches("employee")
Show deleted database if specified.
Response
OK
The response is of type object
.