ListEventBuses - EventBridge - Alibaba Cloud Documentation Center

Queries all event buses.

Operation description

You can call this API operation to query all event buses.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eventbridge:ListEventBuses	Read	EventBus acs:eventbridge:{#regionId}:{#accountId}:eventbus/*	none	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 be returned in a call. You can use this parameter and NextToken to implement paging. Note: Up to 100 entries can be returned in a call.	10
NextToken	string	No	If you set Limit and excess return values exist, this parameter is returned.	10

Response parameters

Parameter	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	object []	The timestamp that indicates when the event bus was created.
EventBusARN	string	The Alibaba Cloud Resource Name (ARN) of the queried event bus.	acs:eventbridge:cn-hangzhou:123456789098***:eventbus/default
EventBusName	string	The name of the queried event bus.	default
Description	string	The description of the queried event bus.	bus_description
CreateTimestamp	long	The timestamp that indicates when the event bus was created.	1607071602000
NextToken	string	If excess return values exist, this parameter is returned.	10
Total	integer	The total number of entries.	2
Code	string	The returned HTTP status code. The HTTP status code 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the event buses are successfully queried. Valid values: true and false.	true

Examples

Sample success responses

JSONformat

{
  "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
403	ServiceNotEnable	Service not enable

For a list of error codes, visit the Service error codes.