tencent cloud

All product documents
APIs
DocumentationAPIsEvent BridgeEvent Bus APIsGetEventBus
GetEventBus
Last updated: 2023-12-01 16:50:03
GetEventBus
Last updated: 2023-12-01 16:50:03

1. API Description

Domain name for API request: eb.tencentcloudapi.com.

This API is used to get the details of an event bus.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: GetEventBus.
Version Yes String Common Params. The value used for this API: 2021-04-16.
Region No String Common Params. This parameter is not required for this API.
EventBusId Yes String Event bus ID

3. Output Parameters

Parameter Name Type Description
ModTime Timestamp ISO8601 Update time
Description String Event bus description
ClsTopicId String Log topic ID
AddTime Timestamp ISO8601 Creation time.
ClsLogsetId String Logset ID
EventBusName String Event bus name
EventBusId String Event bus ID
Type String (Disused) Event bus type
PayMode String Billing mode
SaveDays Integer EventBridge log storage period
Note: This field may return null, indicating that no valid values can be obtained.
LogTopicId String EventBridge log topic ID
Note: This field may return null, indicating that no valid values can be obtained.
EnableStore Boolean Whether to enable log storage
Note: This field may return null, indicating that no valid values can be obtained.
LinkMode String Whether to sort the message
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying details of an event bus

This example shows you how to query details of an event bus.

Input Example

POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetEventBus
<Common request parameters>

{
    "EventBusId": "eb-l65vlc2"
}

Output Example

{
    "Response": {
        "AddTime": "2022-12-12T20:09:46+08:00",
        "ClsLogsetId": "",
        "ClsTopicId": "",
        "Description": "",
        "EventBusId": "eb-0gdrbv5q",
        "EventBusName": "default",
        "ModTime": "2022-12-12T20:09:46+08:00",
        "PayMode": "",
        "LogTopicId": "xxx",
        "SaveDays": "1",
        "EnableStore": true,
        "LinkMode": "Disorder",
        "RequestId": "ffd4aae2-c29e-40a8-b18c-037a17ed810c",
        "Type": "Cloud"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue.EventBusId The EventBusId value does not conform to the specification. Please fix it and try again.
ResourceNotFound The resource does not exist.
ResourceNotFound.EventBus The specified event bus was not found. Please create it and try again.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon