Call ListEventBuses to query all event buses - EventBridge - Alibaba Cloud - EventBridge

Operation description

Queries all event buses. You can filter results by name prefix and use pagination.

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

get

*EventBus

acs:eventbridge:{#regionId}:{#accountId}:eventbus/*

None

Request parameters

Parameter	Type	Required	Description	Example
NamePrefix	string	No	The prefix of the names of the event buses that you want to query.	My
Limit	integer	No	The maximum number of entries to return per request. Use with NextToken for pagination. Note A maximum of 100 entries can be returned in a request.	10
NextToken	string	No	If more results are available when Limit is set, this parameter is returned. Use with Limit for pagination.	10

Response elements

Element	Type	Description	Example
	object
Message	string	The returned error message.	InvalidArgument
RequestId	string	The request ID.	D1DCF64A-3F2C-5323-ADCB-3F4DF30FAD2D
Data	object	The returned data.
EventBuses	array<object>	The event buses.
	object
EventBusARN	string	The Alibaba Cloud Resource Name (ARN) of the event bus.	acs:eventbridge:cn-hangzhou:123456789098***:eventbus/default
EventBusName	string	The name of the event bus.	default
Description	string	The description of the event bus.	bus_description
CreateTimestamp	integer	The timestamp when the event bus was created.	1607071602000
NextToken	string	If more results are available, this parameter is returned.	10
Total	integer	The total number of entries.	2
Code	string	The response code. Valid values: Success: The request was successful. Other codes: The request failed. For information about error codes, see Error codes.	200
Success	boolean	Indicates whether the operation was successful. The value true is returned for a successful operation.	true

Examples

Success response

JSON format

{
  "Message": "InvalidArgument",
  "RequestId": "D1DCF64A-3F2C-5323-ADCB-3F4DF30FAD2D",
  "Data": {
    "EventBuses": [
      {
        "EventBusARN": "acs:eventbridge:cn-hangzhou:123456789098***:eventbus/default",
        "EventBusName": "default",
        "Description": "bus_description",
        "CreateTimestamp": 1607071602000
      }
    ],
    "NextToken": "10",
    "Total": 2
  },
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.