tencent cloud

文档反馈

UpdateConnection

最后更新时间:2023-12-01 16:50:02

    1. API Description

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

    This API is used to update an event connector.

    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: UpdateConnection.
    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.
    ConnectionId Yes String Connector ID
    EventBusId Yes String Event bus ID
    Enable No Boolean Switch
    Description No String Description
    ConnectionName No String Connector name

    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 a Connector

    Input Example

    POST / HTTP/1.1
    Host: eb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: UpdateConnection
    <Common request parameters>
    
    {
        "EventBusId": "eb-l65vlc2u",
        "ConnectionId": "connection-l65vlc2u"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "b3103b8d-77a6-4b55-b42f-a25e2dc453a9"
        }
    }
    

    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.UpdateConnection Failed to update the connector. Please make sure the resource exists, and the status is normal.
    InvalidParameter.EnableAPIGateway APIGateway cannot be enabled or disabled. Please check and try again.
    InvalidParameterValue.ConnectionId The ConnectionId value does not conform to the specification. Please fix it and try again.
    InvalidParameterValue.EventBusId The EventBusId value does not conform to the specification. Please fix it and try again.
    OperationDenied.ResourceImmutable The operation failed, as the resource could not be modified or deleted.
    ResourceNotFound.Connection The specified Connection was not found. Please create it and try again.