tencent cloud

Feedback

CreateTargetGroup

Last updated: 2024-09-05 19:28:10

    1. API Description

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

    This API is used to create a target group. This feature is in beta test, if you want to try it out, please submit a ticket.

    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: CreateTargetGroup.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    TargetGroupName No String Target group name (up to 50 characters)
    VpcId No String vpcid attribute of a target group. If this parameter is left empty, the default VPC will be used.
    Port No Integer Default port of the target group, which can be used for adding servers subsequently. Either the Port or the port in TargetGroupInstances.N should be input.
    TargetGroupInstances.N No Array of TargetGroupInstance Real server bound to a target group

    3. Output Parameters

    Parameter Name Type Description
    TargetGroupId String ID generated after target group creation
    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 Creating a target group

    This example shows you how to create a target group.

    Input Example

    POST / HTTP/1.1
    Host: clb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateTargetGroup
    <Common request parameters>
    
    {
        "VpcId": "vpc-i1cnjuhx",
        "Port": "80",
        "TargetGroupName": "czhtest"
    }
    

    Output Example

    {
        "Response": {
            "TargetGroupId": "lbtg-81******",
            "RequestId": "9a4096dd-45a1-4e03-be8e-482a2fb48b59"
        }
    }
    

    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.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded Quota exceeded.
    UnauthorizedOperation Unauthorized operation.
    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