ListLumaCatalogs - EventBridge - Alibaba Cloud Documentation Center

Lists all data catalogs bound to a Luma Agent. Returns the complete set of bindings without pagination.

Operation description

Lists the data catalogs bound to a Luma Agent. Results are returned in pages. Pass the NextToken from the previous response to retrieve the next page. An empty NextToken indicates that no more data is available. Expired bindings are skipped, so the number of entries on a single page may be less than the Limit value. Do not use an insufficient page count to determine whether the last page has been reached.

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

eventbridge:ListLumaCatalogs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentName	string	Yes	The name of the agent.	my_agent

Response elements

Element	Type	Description	Example
	object
Code	string	The response code. A value of Success indicates a successful call. If the call fails, a specific error code is returned.	Success
Data	object	The list of data catalogs bound to the agent, including entries and pagination information.
Catalogs	array	The list of data catalogs bound to the agent.	[{"Name":"my_catalog"}]
	Catalog	The details of a single data catalog.
Limit	integer	The effective page size for this request. If the Limit parameter is not specified, the server default value is used. If the specified value exceeds the upper limit, the value is adjusted to the maximum allowed value.	10
NextToken	string	The token for the next page. Pass this value as the NextToken in the next request to retrieve the next page. An empty value indicates that no more data is available.	10
TotalCount	integer	The total number of data catalogs bound to the agent, regardless of the number of entries returned on the current page.	10
Message	string	The response message. A value of Operation success is returned if the call succeeds. A specific error description is returned if the call fails.	Operation success
RequestId	string	The unique ID of the request. Use this ID for troubleshooting and when submitting a ticket.	34AD682D-5B91-5773-8132-AA38C130****
Success	boolean	Indicates whether the call is successful. A value of true indicates success.	true

Examples

Success response

JSON format

{
  "Code": "Success",
  "Data": {
    "Catalogs": [
      {
        "Name": "my_catalog",
        "Type": "RELATIONAL",
        "Provider": "EventHouse",
        "Comment": "Test data catalog",
        "Properties": {
          "IndexPattern": "my-index-*"
        },
        "ConnectionName": "my_connection"
      }
    ],
    "Limit": 10,
    "NextToken": "10",
    "TotalCount": 10
  },
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The specified parameter is invalid
403	ServiceNotEnable	Service not enable
404	AgentNotFound	Agent not found
404	ResourceNotFound	The specified resource is not bound to the agent

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.