Use GetDatabases API to Query Flink Catalog Databases - Realtime Compute for Apache Flink - Alibaba Cloud - Realtime Compute for Apache Flink

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

stream:GetDatabases

get

*All Resource

*

None

Request syntax

GET /api/v2/namespaces/{namespace}/catalogs/{catalogName}/databases HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
namespace	string	Yes	The name of the namespace.	default-namespace
catalogName	string	Yes	The name of the catalog.	paimon

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	The ID of the workspace.	a14bd5d90a****
databaseName	string	No	The name of the database. If you do not specify this parameter, information about all databases in the catalog is returned.	paimon-ods

Response elements

Element	Type	Description	Example
	object	The data returned.
requestId	string	The ID of the request.	CBC799F0-AS7S-1D30-8A4F-882ED4DD****
success	boolean	Indicates whether the request was successful.	true
httpCode	integer	The HTTP status code. A value of 200 is always returned. To determine whether the request was successful, check the value of the `success` parameter.	200
errorCode	string	If `success` is `false`, an error code is returned. If `success` is `true`, this parameter is empty.	""
errorMessage	string	If `success` is `false`, an error message is returned. If `success` is `true`, this parameter is empty.	""
data	array	The list of databases. This parameter is returned only if the request is successful. If the request fails, this parameter is empty.
	Database	The details of a database.

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "name": "database-test",
      "properties": {
        "test": "test",
        "test2": 1
      },
      "comment": "Test database."
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.