tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListEventBuses

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 list of event buses.

    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: ListEventBuses.
    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.
    OrderBy No String Indicates by which field to sort the returned results. Valid values: AddTime (creation time), ModTime (modification time)
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
    Order No String Indicates whether the returned results are sorted in ascending or descending order. Valid values: ASC (ascending order), DESC (descending order)
    Filters.N No Array of Filter Filter. For more information, see the Instance Filter Table below. Each request can contain up to 10 Filters and 5 Filter.Values.
    Offset No Integer Pagination offset. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    EventBuses Array of EventBus Event bus information
    TotalCount Integer Total number of event buses
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of event buses

    This example shows you how to query the list of event buses.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "EventBuses": [
            {
                "ModTime": "2020-09-22T00:00:00+00:00",
                "Description": "xx",
                "AddTime": "2020-09-22T00:00:00+00:00",
                "EventBusName": "xx",
                "EventBusId": "xx",
                "Type": "xx"
            }
        ],
        "TotalCount": 0,
        "RequestId": "xx"
    }
}

    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
    InternalError Internal error.
    InvalidParameterValue.Filters The Filters value does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.Limit The Limit value does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.Offset The Offset value does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.Order The Order value does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.OrderBy The OrderBy value does not conform to the specification. Please fix it and try again.
    UnauthorizedOperation.CAM The current account does not have permissions to use EB. Please log in to the CAM console for authorization.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy