全球加速2.0 修改终端节点组

1. 接口描述

接口请求域名： ga2.tencentcloudapi.com 。

修改终端节点组。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyEndpointGroup。
Version	是	String	公共参数，本接口取值：2025-01-15。
Region	否	String	公共参数，此参数为可选参数。
GlobalAcceleratorId	是	String	全球加速实例ID。示例值：ga-ask56kjh
ListenerId	是	String	监听器ID。示例值：listener-ask56kjh
EndpointGroupId	是	String	终端节点组ID。示例值：epg-ask56kjh
EndpointConfigurations.N	否	Array of EndpointConfigurations	终端节点配置。
Name	否	String	名称。入参限制：最大长度不能超过128个字节。以大小写字母或中文开头。示例值：name
Description	否	String	描述信息。入参限制：最大长度不能超过100个字节。示例值：description
EnableHealthCheck	否	Boolean	是否开启健康检查。示例值：true
ConnectTimeout	否	Integer	响应超时时间。取值范围：[1, 100] 当开启健康检查时候，此参数必传。示例值：3
HealthCheckInterval	否	Integer	健康检查间隔。取值范围：[5, 300] 当开启健康检查时，此参数必传。示例值：3
UnhealthyThreshold	否	Integer	不健康阀值。取值范围：[1, 10] 当开启健康检查时，此字段必传。示例值：3
HealthyThreshold	否	Integer	健康阀值。取值范围：[1, 10] 当开启健康检查时，此字段必传。示例值：3
CheckType	否	String	检查协议。入参限制：支持填写：'TCP', 'HTTP', 'PING', 'CUSTOM'。 1、当监听器是TCP时，可以选CUSTOM+TCP。 2、当监听器是UDP时，可以选PING+CUSTOM。 3、当监听器是HTTP或HTTPS时，可以选HTTP。示例值：TCP
CheckPort	否	Integer	检查端口。取值范围：[1, 65535] 当CheckType是CUSTOM时，此字段必传。示例值：3
ContextType	否	String	检查内容。入参限制：仅支持TEXT。当CheckType是CUSTOM时，此字段必传。示例值：TEXT
CheckSendContext	否	String	检查请求。入参限制：长度范围在1-500。当CheckType是CUSTOM时，此字段必传。示例值：check_context
CheckRecvContext	否	String	检查返回结果。入参限制：长度范围在1-500。当CheckType是CUSTOM时，此字段必传。示例值：check_recv_context
CheckDomain	否	String	检查域名。入参限制：长度范围在3-80。当CheckType是HTTP时，此字段必传。示例值：www.test.com
CheckPath	否	String	检查URL。入参限制：长度范围在3-80。当CheckType是HTTP时，此字段必传。示例值：/test
CheckMethod	否	String	请求方式。入参限制：支持填写 'GET', 'HEAD'。当CheckType是HTTP时，此字段必传。示例值：GET
StatusMask.N	否	Array of String	状态检测码。入参限制：支持选择'http_2xx', 'http_3xx', 'http_4xx', 'http_5xx'。当CheckType是HTTP时，此字段必传。示例值：["http_2xx"]
ForwardProtocol	否	String	回源协议。入参限制：支持选择：'HTTP', 'HTTPS'。当监听器协议是HTTP时只能配置HTTP，是HTTPS时能配HTTP或HTTPS。示例值：HTTP
PortOverrides.N	否	Array of PortOverride	端口映射。当监听器协议是HTTP或HTTPS支持配置一对。当监听器协议是UDP或TCP支持配置最多30对。
CipherPolicyId	否	String	HPPTS加密算法套件入参限制：支持选择'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'。当监听器协议是HTTPS时，才支持修改此参数。示例值：tls_policy_1.0-2
HttpVersion	否	String	仅HTTPS回源协议支持选择['HTTP/1.1', 'HTTP/2'] 枚举值： HTTP/1.1：版本HTTP/1.1 HTTP/2：版本HTTP/2 示例值：HTTP/2

3. 输出参数

参数名称	类型	描述
TaskId	String	任务ID。示例值：b83b144d-a14d-45fb-91ec-04649d3c7537
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改终端接节点组

输入示例

POST / HTTP/1.1
Host: ga2.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyEndpointGroup
<公共请求参数>

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.EndpointGroupCheckTypeHttpCarryParameters	当配置HTTP检查时需要携带参数`%(value)s` 。
InvalidParameter.HttpsOriginServerProtocolSupportsParameters	仅HTTPS回源协议支持携带参数`%(value)s`。
InvalidParameter.InputMustExistOne	请求中传入参数必选有 `%(value)s` 其中一个。
InvalidParameter.InputOutOfRange	请求中传入参数 `%(key)s` 必选再 `%(value)s` 范围内。
InvalidParameter.InputRepeat	请求中传入参数 `%(key)s` 存在重复值。
InvalidParameter.OnlyEndpointGroupCheckTypeHttpCarryParameters	仅当配置HTTP检查时需要携带参数`%(value)s` 。
InvalidParameter.TransportLayerEndpointGroupCannotCarryParameters	四层终端节点组不支持携带参数`%(value)s` 。
InvalidParameterValue.InstanceMismatch	实例对象 `%(value)s` 关系不匹配。
InvalidParameterValue.ListenerPortNotEqual	终端节点组监听端口要和终端节点组所属监听器端口保持一致。
InvalidParameterValue.Malformed	参数 `%(parameter)s` 值 `%(value)s` 是无效的。正确且完整的值形如 `%(template)s`。
InvalidParameterValue.NotWithinPublicNetwork	参数 `%(value)s` 不在公网网段内。
InvalidParameterValue.SpecificCharacters	参数值 `%(value)s` 仅能含有字符 `%(key)s`。
MissingParameter.CustomCheckTypeParameter	终端节点组配置为自定义检查时，请求缺少必填参数 `%(parameter)s`。
UnsupportedOperation.DefaultEndpointGroupModify	默认终端节点组不支持修改。
UnsupportedOperation.HttpVersionInconsistent	监听器和终端节点组的HTTP最大协议版本需要保持一致。
UnsupportedOperation.InstanceNotRunning	实例不是运行状态，不支持当前操作。
UnsupportedOperation.InternalEndpointFeatureNotEnabled	当前全球加速实例未开通内网回源特性。
UnsupportedOperation.Ipv6NotSupport	不支持IPV6。
UnsupportedOperation.SameDomain	当前操作使终端节点组域名和全球加速实例域名一致，不支持当前操作。
UnsupportedOperation.SamePublicIp	当前操作使终端节点组域名和全球加速实例加速地域公网IP一致，不支持当前操作。

修改终端节点组

本页目录：