GetCatalogs API Overview - Realtime Compute for Apache Flink - Alibaba Cloud - Realtime Compute for Apache Flink

Retrieves the details of a specified catalog or all catalogs.

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:GetCatalogs

get

*All Resource

*

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	The ID of the workspace.	a14bd5d90a****
catalogName	string	No	The name of the catalog. If this parameter is left empty, all catalogs are listed.	paimon

Response elements

Element	Type	Description	Example
	object	The response data.
requestId	string	The request ID.	CBC799F0-ABCD-1D30-8A4F-882ED4DD****
success	boolean	Indicates whether the request was successful.	True
httpCode	integer	The business status code. This is always 200. Use the `success` parameter to determine whether the request was successful.	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	If `success` is `true`, a list of catalogs that meet the criteria is returned. If `success` is `false`, this parameter is empty.
	Catalog	The details of the catalog.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.