tencent cloud

APIs

CreateEndpointGroup

下载
聚焦模式
字号
最后更新时间: 2026-09-14 20:56:35

1. API Description

Domain name for API request: ga2.intl.tencentcloudapi.com.

This API is used to create a terminal node group.

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: CreateEndpointGroup.
Version Yes String Common Params. The value used for this API: 2025-01-15.
Region No String Common Params. This parameter is not required.
GlobalAcceleratorId Yes String

Global acceleration instance ID.

ListenerId Yes String

Listener ID.

EndpointGroupType Yes String

Node group type.

Enumeration values:

  • VIRTUAL: custom endpoint node group
  • DEFAULT: default terminal node group
EndpointGroupConfiguration Yes EndpointGroupConfiguration

Terminal node group configuration.

3. Output Parameters

Parameter Name Type Description
TaskId String

Task ID.

EndpointGroupId String

Instance ID of the terminal node group.

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 Endpoint Group

Input Example

POST / HTTP/1.1
Host: ga2.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEndpointGroup
<Common request parameters>

{
    "GlobalAcceleratorId": "ga-80bzejka",
    "ListenerId": "lsr-kzjzfs7n",
    "EndpointGroupType": "DEFAULT",
    "EndpointGroupConfiguration": {
        "Name": "group-1",
        "EndpointGroupRegion": "ap-guangzhou",
        "Description": "description",
        "EndpointConfigurations": [
            {
                "EndpointType": "CustomDomain",
                "EndpointService": "www.aaa.com",
                "Weight": 10
            }
        ],
        "EnableHealthCheck": true,
        "ConnectTimeout": 10,
        "HealthCheckInterval": 5,
        "UnhealthyThreshold": 10,
        "HealthyThreshold": 10,
        "CheckType": "HTTP",
        "CheckPort": "12",
        "ContextType": "context",
        "CheckSendContext": "context",
        "CheckRecvContext": "context",
        "CheckDomain": "www.ccc.com",
        "CheckPath": "/url1"
    }
}

Output Example

{
    "Response": {
        "RequestId": "a6e9b84a-fa0f-4db7-820e-3a268871ec28",
        "EndpointGroupId": "epg-agq25w5q",
        "TaskId": "c6fc23d3-2b36-4262-89f9-1c0ab634e44c"
    }
}

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
InvalidParameter.DisableHealthCheckNotCarryParameters Health check is disabled for the terminal node group configuration. Carrying the parameter %(parameter)s is forbidden.
InvalidParameter.EnableHealthCheckNotCarryParameters Health check is disabled for the terminal node group, so the parameter %(parameter)s cannot be carried.
InvalidParameter.EndpointGroupCheckTypeHttpCarryParameters When configuring HTTP check, you need to carry the parameter %(value)s.
InvalidParameter.HttpsOriginServerProtocolSupportsParameters The %(value)s parameter is supported only for the HTTPS back-to-source protocol.
InvalidParameter.InputOutOfRange The in-progress request input parameter %(key)s is required and within the %(value)s range.
InvalidParameter.InputRepeat The input parameter %(key)s in the request has duplicate values.
InvalidParameter.OnlyEndpointGroupCheckTypeHttpCarryParameters The %(value)s parameter is required only when HTTP check is configured.
InvalidParameter.TcpEndpointGroupCannotCarryParameters Tcp terminal node groups do not support carrying the parameter %(value)s.
InvalidParameter.TransportLayerEndpointGroupCannotCarryParameters L4 terminal node groups do not support carrying the parameter %(value)s.
InvalidParameter.UdpEndpointGroupCannotCarryParameters Udp terminal node group does not support carrying the parameter %(value)s.
InvalidParameterValue.Empty Parameter %(parameter)s cannot be empty.
InvalidParameterValue.InstanceMismatch The instance object %(value)s has a mismatched relationship.
InvalidParameterValue.LimitExceeded The number of %(parameter)s values %(value)s exceeds the limit. It cannot be greater than %(limit)s.
InvalidParameterValue.ListenerPortNotEqual The terminal node group listening port should be consistent with the listener port that the terminal node group belongs to.
InvalidParameterValue.Malformed Parameter value %(value)s of %(parameter)s is invalid. A correct and complete value is in the form of %(template)s.
InvalidParameterValue.NotMappingManyPort A listener port cannot be mapped to multiple origin ports currently.
InvalidParameterValue.NotTencentRegion
InvalidParameterValue.NotWithinPublicNetwork Parameter %(value)s is not in the allowed public IP ranges.
InvalidParameterValue.SpecificCharacters Parameter value %(value)s can only contain characters %(key)s.
InvalidParameterValue.ThirdAreaListenerPortSegment Currently, the global acceleration instance does not support configuring listener port ranges for third-party nodes.
InvalidParameterValue.TooLong Parameter value %(value)s length cannot be greater than %(max_size)s.
InvalidParameterValue.WrongAttributionRelationship
LimitExceeded The quota limit is exceeded.
MissingParameter Parameters are missing.
MissingParameter.ApplicationLayerEndpointGroupParameter Currently a layer-7 terminal node group. The request is missing the required parameter %(parameter)s.
MissingParameter.CustomCheckTypeParameter When the terminal node group configuration is set to custom check, the request is missing required parameter %(parameter)s.
MissingParameter.EnableHealthCheckParameter Health check is enabled for the terminal node group configuration. The request is missing the required parameter %(parameter)s.
MissingParameter.IspType
UnsupportedOperation.CurrentAccountNotAllowed The current account does not support this operation.
UnsupportedOperation.ExistAcceptAclPolicy A default access control policy that permits all traffic through the access channel exists. The current operation is not supported.
UnsupportedOperation.ExistDropAcceptAclRule An access rule with a deny policy is configured. The current operation is not supported.
UnsupportedOperation.HttpVersionInconsistent The maximum HTTP protocol version of the listener and terminal node group should be consistent.
UnsupportedOperation.InstanceNotRunning The instance is not in the running state. The current operation is not supported.
UnsupportedOperation.InternalEndpointFeatureNotEnabled The current global acceleration instance does not have the private network origin-pull feature enabled.
UnsupportedOperation.Ipv6NotSupport IPv6 is not supported.
UnsupportedOperation.NotSetCrossBorderType The global acceleration instance has no cross-border type set. Cross-border acceleration regions or terminal node groups cannot be created.
UnsupportedOperation.OnlyInternalClb
UnsupportedOperation.SameDomain The current operation makes the terminal node group domain name the same as the global acceleration instance domain. The current operation is not supported.
UnsupportedOperation.SamePublicIp The current operation makes the terminal node group domain name match the public IP address of the global acceleration instance's acceleration region. The current operation is not supported.
UnsupportedOperation.ThirdAreaHavePortEqualListener
UnsupportedOperation.ThreeNetworksEndpointGroup Creation of a triple-network terminal node group is not supported.
UnsupportedOperation.UnableCreateThirdPartyNodes Creation of third-party nodes is not supported.
UnsupportedOperation.UnableCrossBorder Currently, cross-border acceleration regions or terminal node groups cannot be created for global acceleration instances.
UnsupportedOperation.VirtualEndpointGroupUnsupportedTcpAndUdp Virtual terminal node groups do not support Tcp and Udp terminal node groups.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈