1. 接口描述
接口请求域名: ga2.tencentcloudapi.com 。
创建终端节点组。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateEndpointGroup。 |
| Version | 是 | String | 公共参数,本接口取值:2025-01-15。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| GlobalAcceleratorId | 是 | String | 全球加速实例ID。 示例值:ga-ask56kjh |
| ListenerId | 是 | String | 监听器ID。 示例值:["listener-ask56kjh"] |
| EndpointGroupType | 是 | String | 终端节点组类型。支持VIRTUAL,DEFAULT。 示例值:VIRTUAL |
| EndpointGroupConfiguration | 是 | EndpointGroupConfiguration | 终端节点组配置。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID。 示例值:4b995c0a-98f2-4dbc-84cc-71b1a63642e5 |
| EndpointGroupId | String | 终端节点组实例ID。 示例值:epg-agq25w5q |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建终端节点组
输入示例
POST / HTTP/1.1
Host: ga2.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEndpointGroup
<公共请求参数>
{
"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"
}
}
输出示例
{
"Response": {
"RequestId": "a6e9b84a-fa0f-4db7-820e-3a268871ec28",
"EndpointGroupId": "epg-agq25w5q",
"TaskId": "c6fc23d3-2b36-4262-89f9-1c0ab634e44c"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.DisableHealthCheckNotCarryParameters | 终端节点组配置为关闭健康检查,禁止携带参数 %(parameter)s。 |
| InvalidParameter.EnableHealthCheckNotCarryParameters | 终端节点组配置为关闭健康检查,禁止携带参数 %(parameter)s。 |
| InvalidParameter.EndpointGroupCheckTypeHttpCarryParameters | 当配置HTTP检查时需要携带参数%(value)s 。 |
| InvalidParameter.HttpsOriginServerProtocolSupportsParameters | 仅HTTPS回源协议支持携带参数%(value)s。 |
| InvalidParameter.InputOutOfRange | 请求中传入参数 %(key)s 必选再 %(value)s 范围内。 |
| InvalidParameter.InputRepeat | 请求中传入参数 %(key)s 存在重复值。 |
| InvalidParameter.OnlyEndpointGroupCheckTypeHttpCarryParameters | 仅当配置HTTP检查时需要携带参数%(value)s 。 |
| InvalidParameter.TcpEndpointGroupCannotCarryParameters | Tcp终端节点组不支持携带参数%(value)s 。 |
| InvalidParameter.TransportLayerEndpointGroupCannotCarryParameters | 四层终端节点组不支持携带参数%(value)s 。 |
| InvalidParameter.UdpEndpointGroupCannotCarryParameters | Udp终端节点组不支持携带参数%(value)s 。 |
| InvalidParameterValue.InstanceMismatch | 实例对象 %(value)s 关系不匹配。 |
| InvalidParameterValue.ListenerPortNotEqual | 终端节点组监听端口要和终端节点组所属监听器端口保持一致。 |
| InvalidParameterValue.NotMappingManyPort | 当前不支持一个监听器端口映射到多个回源端口。 |
| InvalidParameterValue.NotWithinPublicNetwork | 参数 %(value)s 不在公网网段内。 |
| InvalidParameterValue.SpecificCharacters | 参数值 %(value)s 仅能含有字符 %(key)s。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.ApplicationLayerEndpointGroupParameter | 当前为七层终端节点组,请求缺少必填参数 %(parameter)s。 |
| MissingParameter.CustomCheckTypeParameter | 终端节点组配置为自定义检查时,请求缺少必填参数 %(parameter)s。 |
| MissingParameter.EnableHealthCheckParameter | 终端节点组配置为开启健康检查,请求缺少必填参数 %(parameter)s。 |
| UnsupportedOperation.ExistAcceptAclPolicy | 存在默认准许所有流量访问通道访问控制策略,不支持当前操作。 |
| UnsupportedOperation.ExistDropAcceptAclRule | 配置了策略为拒绝的访问规则,不支持当前操作。 |
| UnsupportedOperation.InstanceNotRunning | 实例不是运行状态,不支持当前操作。 |
| UnsupportedOperation.Ipv6NotSupport | 不支持IPV6。 |
| UnsupportedOperation.NotSetCrossBorderType | 当前全球加速实例没有设置跨境类型。无法创建跨境加速地域或终端节点组。 |
| UnsupportedOperation.SameDomain | 当前操作使终端节点组域名和全球加速实例域名一致,不支持当前操作。 |
| UnsupportedOperation.SamePublicIp | 当前操作使终端节点组域名和全球加速实例加速地域公网IP一致,不支持当前操作。 |
| UnsupportedOperation.ThreeNetworksEndpointGroup | 不支持创建三网类型的终端节点组。 |
| UnsupportedOperation.UnableCreateThirdPartyNodes | 不支持创建第三方节点。 |
| UnsupportedOperation.UnableCrossBorder | 当前全球加速实例无法创建跨境加速地域或终端节点组。 |
| UnsupportedOperation.VirtualEndpointGroupUnsupportedTcpAndUdp | 虚拟终端节点组不支持Tcp和Udp类型终端节点组。 |