调用CreateEndpointGroup创建终端节点组_全球加速(GA)-阿里云帮助中心

调用CreateEndpointGroup接口创建终端节点组。

接口说明

调用本接口为四层协议监听创建虚拟终端节点组时，请确保已创建默认终端节点组。
CreateEndpointGroup 接口属于异步接口，即系统会先返回一个终端节点组 ID，但终端节点组并未创建完成，系统后台的创建任务仍在进行。您可以调用 DescribeEndpointGroup 查询终端节点组的状态：
- 当终端节点组处于 init 状态时，表示终端节点组正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。
- 当终端节点组处于 active 状态时，表示终端节点组创建完成。
CreateEndpointGroup 接口不支持在同一个全球加速实例内并发创建终端节点组。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作

操作	访问级别	资源类型	条件关键字	关联操作
ga:CreateEndpointGroup	create	EndpointGroup `acs:ga:{#regionId}:{#accountId}:endpointgroup/` Listener `acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}` Accelerator `acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}`	ga:AcceleratorMainland	无

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值cn-hangzhou。	cn-hangzhou
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	是	全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
Name	string	否	终端节点组的名称。名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。	group1
Description	string	否	终端节点组描述信息。描述长度最大 200 字符，不能以`http://`和`https://`开头。	EndpointGroup
EndpointGroupRegion	string	是	终端节点组所属的地域 ID。	cn-hangzhou
ListenerId	string	是	监听实例 ID。	lsr-bp1bpn0kn908w4nbw****
TrafficPercentage	integer	否	监听实例有多个终端节点组时，配置到不同终端节点组的流量比例。取值范围：1~100。	20
HealthCheckIntervalSeconds	integer	否	健康检查的时间间隔，单位：秒。	3
HealthCheckPath	string	否	健康检查路径。	/healthcheck
HealthCheckPort	integer	否	健康检查的端口。	20
HealthCheckProtocol	string	否	健康检查的协议。取值： tcp 或 TCP：TCP 协议。 http 或 HTTP：HTTP 协议。 https 或 HTTPS：HTTPS 协议。	tcp
ThresholdCount	integer	否	针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。取值范围：2~10。默认值：3。	3
EndpointConfigurations	array<object>	否	终端节点配置信息。
	object	否	终端节点配置信息。
Type	string	是	终端节点类型，取值： Domain：自定义域名。 Ip：自定义 IP。 IpTarget：自定义私网 IP。 PublicIp：阿里云公网 IP。 ECS：阿里云 ECS 实例。 SLB：阿里云 CLB 实例。 ALB：阿里云 ALB 实例。 OSS：阿里云 OSS 实例。 ENI：阿里云弹性网卡。 NLB：阿里云 NLB 实例。说明终端节点类型取值为 ECS、ENI、SLB、ALB、NLB 或 IpTarget 时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaVpcEndpoint 的服务关联角色。终端节点类型取值为 ALB 时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaAlb 的服务关联角色。终端节点类型取值为 OSS 时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaOss 的服务关联角色。终端节点类型取值为 NLB 时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaNlb 的服务关联角色。更多信息，请参见服务关联角色。	Ip
EnableClientIPPreservation	boolean	否	是否使用自动获取方式开启保持客户端源 IP 功能，取值： true：开启保持客户端源 IP 功能。 false（默认值）：不开启保持客户端源 IP 功能。说明 UDP/TCP 监听对应的终端节点组默认不开启保持客户端源 IP，您可根据业务需要配置。 HTTP（S）监听对应的终端节点组默认开启保持客户端源 IP，通过 X-Forwarded-For 头字段获取。不支持关闭。 EnableClientIPPreservation 与 EnableProxyProtocol 不能同时为 true。更多信息请参考保持客户端源 IP。	false
Weight	integer	是	终端节点的权重。取值范围：0~255。说明如果某个终端节点的权重设置为 0，全球加速将终止向该终端节点分发流量，请您谨慎操作。	20
EnableProxyProtocol	boolean	否	是否使用 ProxyProtocol 方式开启保持客户端源 IP 功能，取值： true：开启保持客户端源 IP 功能。 false（默认值）：不开启保持客户端源 IP 功能。说明仅支持 TCP 监听对应的终端节点组配置。 EnableClientIPPreservation 与 EnableProxyProtocol 不能同时为 true。更多信息请参考保持客户端源 IP。	false
Endpoint	string	是	根据 Type（终端节点类型）输入对应的 IP、域名或实例 ID。	120.1.XX.XX
SubAddress	string	否	弹性网卡的私网 IP 地址。说明当终端节点类型为 ENI 时，可以选择配置该参数，如果不配置默认为 ENI 的主私网 IP 地址。	172.168.X.X
VpcId	string	否	专有网络 ID。在智能路由类型监听的某个终端节点组中，您最多可以输入 1 个专有网络 ID。说明仅当终端节点类型为 IpTarget 时有效且必填。	vpc-bp1quce3451z5b2hv****
VSwitchIds	array	否	VPC 下的交换机列表。
	string	否	虚拟交换机 ID。在智能路由类型监听的某个终端节点组中，您最多可以输入 2 个虚拟交换机 ID。说明仅当终端节点类型为 IpTarget 时有效且必填。该虚拟交换机属于 VpcId 参数指定的专有网络。	vsw-bp12mho4ze51ezagm****
EndpointRequestProtocol	string	否	后端服务协议。取值： HTTP（默认值） HTTPS 说明仅为 HTTP 或 HTTPS 协议的监听实例创建终端节点组时才支持配置该项。对于 HTTP 协议的监听实例，后端服务协议支持且仅支持 HTTP。	HTTP
EndpointProtocolVersion	string	否	后端服务协议版本。取值： HTTP1.1（默认值）：HTTP1.1 版本。 HTTP2：HTTP2 协议。说明仅当 EndpointRequestProtocol（后端服务协议）值为 HTTPS 时，支持配置终端节点后端服务协议版本。	HTTP1.1
EndpointGroupType	string	否	终端节点组类型。取值： default（默认值）：默认终端节点组。 virtual：虚拟终端节点组。说明为四层监听创建虚拟终端节点组时，请确保已创建默认终端节点组。	default
PortOverrides	array<object>	否	端口映射关系。
	object	否	端口映射关系。
ListenerPort	integer	否	配置端口映射时的监听端口。说明对于 TCP 监听：虚拟终端节点组不支持配置端口映射。如果监听下已存在虚拟终端节点组，则默认终端节点组无法配置端口映射。如果默认终端节点组已配置端口映射，则无法添加虚拟终端节点组。配置端口映射后，后续监听变更时有以下限制：除 HTTP 和 HTTPS 之间的协议切换以外，不支持修改监听协议。监听端口：您修改的监听端口范围必须包含当前所配置端口映射的全量监听端口。例如，当监听端口范围为 80-82，并配置端口映射至终端节点端口 100-102 时，后续修改监听端口范围时，不支持修改为 80-81。	443
EndpointPort	integer	否	配置端口映射时的终端节点端口。	80
HealthCheckEnabled	boolean	否	是否开启健康检查。取值： true：开启健康检查。 false：关闭健康检查。	true
Tag	array<object>	否	终端节点组的标签。
	object	否	终端节点组的标签。
Key	string	否	终端节点组的标签键。一旦输入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。最多支持输入 20 个标签键。	test-key
Value	string	否	终端节点组的标签值。一旦输入该值，可以为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。最多支持输入 20 个标签值。	test-value
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会创建终端节点组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回 HTTP 2xx 状态码。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接创建终端节点组。	false

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object	返回信息列表。
EndpointGroupId	string	终端节点组 ID。	epg-bp1dmlohjjz4kqaun****
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368

示例

正常返回示例

JSON格式

        
{
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

错误码

HTTP status code	错误码	错误信息	描述

HTTP status code	错误码	错误信息	描述
400	Domain.NotFit	The domain is not fit the rule	域名未备案
400	Resource.QuotaFull	The resource quota is exceeded.	该资源数量已达配额上限
400	NotExist.ListenerPort	The listening port %s does not exist.	监听端口 %s 不存在
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	该账号没有启用健康检查的权限。
400	NotExist.Listener	The listener does not exist.	监听器不存在
400	NotActive.Listener	The state of the listener is not active.	监听器状态非稳态
400	NotExist.Accelerator	The accelerated instance does not exist.	加速实例不存在。
400	StateError.Accelerator	The state of the accelerated instance is invalid.	加速实例状态非法。
400	NotExist.BusinessRegion	The business region does not exist.	业务region并不存在
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	缺少基础带宽包
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	终端节点达到Quota限制
400	Exist.EndpointGroup	The endpoint group already exists.	终端节点组已存在
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	用户没有创建服务关联角色的权限，请联系主账号或权限管理员授权当前用户AliyunGlobalAccelerationFullAccess或者创建服务关联角色的自定义权限。自定义权限策略的相关信息包含以下内容：ServiceName为vpcendpoint.ga.aliyuncs.com，服务关联角色名称为AliyunServiceRoleForGaVpcEndpoint，执行该操作所需的用户权限为ram:CreateServiceLinkedRole。
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal	-
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	端口转发数量超过限制
400	NotExist.ListenerPort	listener port %s is not exist	-
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	处理请求时出现错误，请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作
2024-12-23	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-07-20	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-11-22	OpenAPI 错误码发生变更	查看变更详情
2023-09-14	OpenAPI 错误码发生变更	查看变更详情
2023-06-20	OpenAPI 错误码发生变更	查看变更详情
2023-04-20	OpenAPI 错误码发生变更	查看变更详情
2023-03-31	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情