GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
metadata
{
  "labels": {},
  "lastSyncTime": "2023-11-07T05:31:56Z",
  "backupAvailable": true,
  "datashare": true,
  "secrets": [
    {
      "name": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "drifted": true,
  "version": "<string>"
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

Query Parameters

​
filter
string

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:

  • schema: the schema name, support "==" operator.
  • table: the table name, support "==" operator.

For example: schema == "schema-a" table == "table-a" schema == "schema-a" && table == "table-a" The filter used for a specific schema object such as "schemas/schema-a/tables/table-a". The column masking level will only be returned when a table filter is used.

Response

200
application/json

OK

DatabaseMetadata is the metadata for databases.

GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
metadata
{
  "labels": {},
  "lastSyncTime": "2023-11-07T05:31:56Z",
  "backupAvailable": true,
  "datashare": true,
  "secrets": [
    {
      "name": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "drifted": true,
  "version": "<string>"
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

Query Parameters

​
filter
string

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:

  • schema: the schema name, support "==" operator.
  • table: the table name, support "==" operator.

For example: schema == "schema-a" table == "table-a" schema == "schema-a" && table == "table-a" The filter used for a specific schema object such as "schemas/schema-a/tables/table-a". The column masking level will only be returned when a table filter is used.

Response

200
application/json

OK

DatabaseMetadata is the metadata for databases.