tencent cloud

Feedback

DeleteUpstream

Last updated: 2024-04-08 15:11:09

    1. API Description

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

    This API is used to delete an upstream. Note that you can only delete an upstream when it’s not bound with any APIs.

    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: DeleteUpstream.
    Version Yes String Common Params. The value used for this API: 2018-08-08.
    Region No String Common Params. This parameter is not required for this API.
    UpstreamId Yes String ID of the upstream to be deleted

    3. Output Parameters

    Parameter Name Type Description
    UpstreamId String ID of the deleted upstream
    Note: This field may return NULL, indicating that no valid value was found.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Deleting an upstream

    Input Example

    https://apigateway.tencentcloudapi.com/?Action=DeleteUpstream
    &UpstreamId=“upstream-0c96l2bo”
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "UpstreamId": "xx",
            "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
    AuthFailure Error with CAM signature/authentication.
    DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation The operation is unauthorized.
    UnsupportedOperation Unsupported operation.
    UnsupportedOperation.UnsupportedDeleteUpstream Operation failed: There are resources associated with this upstream.
    Contact Us

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

    Technical Support

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

    7x24 Phone Support