All Products
Search
Document Center

EventBridge:GetEventBus

Last Updated:Dec 04, 2024

Queries the detailed information about an event bus.

Operation description

You can call this API operation to query the detailed information about an event bus.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
eventbridge:GetEventBusget
*EventBus
acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EventBusNamestringYes

The name of the event bus.

MyEventBus

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The error message that is returned if the request failed.

EventBusNotExist
RequestIdstring

The request ID.

d5bfc188-4452-4ba7-b73a-a9005e522439
Dataobject

The data returned.

EventBusARNstring

The Alibaba Cloud Resource Name (ARN) of the event bus.

acs:eventbridge:cn-hangzhou:123456789098****:eventbus/MyEventBus
EventBusNamestring

The name of the event bus.

MyEventBus
Descriptionstring

The description of the event bus.

demo
CreateTimestamplong

The timestamp that indicates when the event bus was created.

1641781825000
Codestring

The response code. The value Success indicates that the request was successful. Other values indicate that the request failed. For more information about error codes, see Error codes.

Success
Successboolean

Indicates whether the operation was successful. If the operation was successful, the value true is returned.

true

Examples

Sample success responses

JSONformat

{
  "Message": "EventBusNotExist",
  "RequestId": "d5bfc188-4452-4ba7-b73a-a9005e522439",
  "Data": {
    "EventBusARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/MyEventBus",
    "EventBusName": "MyEventBus",
    "Description": "demo",
    "CreateTimestamp": 1641781825000
  },
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status codeError codeError message
403ServiceNotEnableService not enable

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

Change history

Change timeSummary of changesOperation
No change history