tencent cloud

Feedback

DeleteOriginGroup

Last updated: 2024-02-21 20:20:00

    1. API Description

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

    This API is used to delete an origin group. Note that an origin group can not be deleted if it is referenced by services (e.g. L4 Proxy, domain name service, load balancing, rule engines).

    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: DeleteOriginGroup.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    ZoneId Yes String Zone ID.
    GroupId No String Origin server group ID. This parameter is required.

    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 Deleting an origin group

    This example shows you how to delete an origin group.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DeleteOriginGroup
    <Common request parameters>
    
    {
        "ZoneId": "zone-2kblak89bkx1",
        "GroupId": "origin-057c4d82-383c-11ee-8888-525400682e90"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5453af19-f084-4038-915c-88d9c4fe9c4e"
        }
    }
    

    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 Operation failed.
    OperationDenied Operation denied.
    OperationDenied.OriginGroupAccelerationDomainUsed Failed to delete: The acceleration domain name is in use.
    OperationDenied.OriginGroupL4Used The Layer 4 proxy is in use and cannot be deleted.
    OperationDenied.OriginGroupLBUsed The Cloud Load Balancer is in use and cannot be deleted.
    OperationDenied.OriginGroupRuleEngineUsed The rule engine is in use and cannot be deleted.
    ResourceNotFound The resource doesn’t exist.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    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