tencent cloud

Feedback

UpdateEventBus

Last updated: 2023-12-01 16:50:03

    1. API Description

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

    This API is used to update 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: UpdateEventBus.
    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
    Description No String Event bus description, which can contain up to 200 characters of any type.
    EventBusName No String Event bus name: it can contain 2-60 letters, digits, underscores, and hyphens and must start with a letter and end with a digit or letter.
    SaveDays No Integer Log retention period
    LogTopicId No String EventBridge log topic ID
    EnableStore No Boolean Whether to enable log retention

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Updating an event bus

    This example shows you how to update an event bus.

    Input Example

    POST / HTTP/1.1
    Host: eb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: UpdateEventBus
    <Common request parameters>
    
    {
        "EventBusName": "test111",
        "EventBusId": "eb-l65vlc2"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "18484e4f-f6f1-4b87-8827-27422b30c8c4"
        }
    }
    

    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
    FailedOperation.RegisterCLSService Failed to register the CLS service.
    InvalidParameter.Payload Payload does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.Description The Description value does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.EventBusName The value of EventBusName is invalid. Please check and try again.
    InvalidParameterValue.EventTraceConfig The linkage tracing parameter is invalid. Please check and try again.
    OperationDenied.DefaultCLSResourceUnsupported You cannot create a CLS event target based on the default EventBridge logset in the custom event bus.
    OperationDenied.ResourceImmutable The operation failed, as the resource could not be modified or deleted.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.EventBus The specified event bus was not found. Please create it and try again.