tencent cloud

APIs

DokumentasiAPIsGlobal Accelerator 2.0Global Acceleration APIsModifyEndpointGroup

ModifyEndpointGroup

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-14 20:55:48

1. API Description

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

This API is used to modify 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: ModifyEndpointGroup.
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.
EndpointGroupId Yes String

Terminal node group ID.
EndpointConfigurations.N No Array of EndpointConfigurations

Terminal node configuration.
Name No String

Name.

Parameter format: starting with a letter or Chinese characters, 2–128 characters in length, supporting letters, digits, Chinese characters, . - _
Description No String

Description.

Input limit: maximum length cannot exceed 100 bytes.
EnableHealthCheck No Boolean

Whether to enable health check.
ConnectTimeout No Integer

Response timeout.

Value range: [1, 100]

This parameter is required when health check is enabled.
HealthCheckInterval No Integer

Health check interval.

Value range: [5, 300].

This parameter is required when health check is enabled.
UnhealthyThreshold No Integer

Unhealthy threshold.

Value range: [1, 10]

This field is required when health check is enabled.
HealthyThreshold No Integer

Health threshold.

Value range: [1, 10]

This field is required when health check is enabled.
CheckType No String

Select the protocol.

Input parameter limits: support filling in: 'TCP', 'HTTP', 'PING', 'CUSTOM'.

1. When the listener is TCP, you can choose CUSTOM+TCP.
2. When the listener is UDP, you can choose PING+CUSTOM.
3. When the listener is HTTP or HTTPS, you can choose HTTP.
CheckPort No Integer

Check port.

Value range: [1, 65535]

This field is required when CheckType is CUSTOM.
ContextType No String

Check content.

Input parameter limit: Only TEXT is supported.

This field is required when CheckType is CUSTOM.
CheckSendContext No String

Check request.

Input parameter limit: The length range is 1-500.

This field is required when CheckType is CUSTOM.
CheckRecvContext No String

Check returned results.

Input parameter limit: length range is 1-500.

When CheckType is CUSTOM, this field is required.
CheckDomain No String

Check domain name.

Input parameter limit: The length range is 3-80.

This field is required when CheckType is HTTP.
CheckPath No String

Check the URL.

Input parameter limit: length range 3-80.

This field is required when CheckType is HTTP.
CheckMethod No String

Request method.

Input parameter limit: support filling in 'GET', 'HEAD'.

This field is required when CheckType is HTTP.
StatusMask.N No Array of String

Status check code.

Input parameter limits: support selecting 'http_2xx', 'http_3xx', 'http_4xx', 'http_5xx'.

This field is required when CheckType is HTTP.
ForwardProtocol No String

Origin-pull protocol.

Input parameter limits. Supported values: 'HTTP', 'HTTPS'.

When the CLB listener protocol is HTTP, only HTTP can be configured. When it is HTTPS, HTTP or HTTPS can be configured.
PortOverrides.N No Array of PortOverride

Port mapping.

When the CLB listener protocol is HTTP or HTTPS, one pair can be configured. When the CLB listener protocol is UDP or TCP, up to 30 pairs can be configured.
CipherPolicyId No String

HPPTS encryption algorithm kit

Input parameter limit: support selecting 'tls_policy_1.0-2', 'tls_policy_1.1-2', 'tls_policy_1.2', 'tls_policy_1.2_strict', 'tls_policy_1.2_strict-1.3'.

This parameter can be modified only when the CLB listener protocol is HTTPS.
HttpVersion No String

Only the HTTPS back-to-source protocol supports selecting ['HTTP/1.1', 'HTTP/2']

Enumeration values:

  • HTTP/1.1: version HTTP/1.1
  • HTTP/2: version HTTP/2

3. Output Parameters

Parameter Name Type Description
TaskId String

Task ID.
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 Modify an Edge Node Group

Input Example

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

{
    "GlobalAcceleratorId": "ga-lb2dx0f4",
    "ListenerId": "lsr-7sadofix",
    "EndpointGroupId": "epg-poo6fkq2",
    "Name": "moify"
}

Output Example

{
    "Response": {
        "RequestId": "82c22f64-a8e3-4958-9655-e5a425e1e046",
        "TaskId": "0668dba1-f4fa-4edc-84c5-f8bf91ba7b5f"
    }
}

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.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.InputMustExistOne The in-progress request must have one of the %(value)s input parameters.
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.TransportLayerEndpointGroupCannotCarryParameters L4 terminal node groups do 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.InstanceName Instance name must start with an uppercase/lowercase character or Chinese character, and support digits, periods, hyphens, and underscores.
InvalidParameterValue.LengthRange
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.Range The value %(value)s of the parameter %(parameter)s must be within the range %(value_range)s.
InvalidParameterValue.TooLong Parameter value %(value)s length cannot be greater than %(max_size)s.
InvalidParameterValue.WrongAttributionRelationship
LimitExceeded The quota limit is exceeded.
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.InternalNetworkSource
UnsupportedOperation.CurrentAccountNotAllowed The current account does not support this operation.
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.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.
Topik sebelumnya: ModifyForwardingPolicyTopik selanjutnya: ModifyAccessLogStatus

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan

Search
    Enter keywords to search documentation