调用CreateEndpointGroup创建终端节点组。

调试

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

请求参数

名称 位置 类型 是否必选 示例值 描述
Action Query String CreateEndpointGroup

系统规定参数。取值:CreateEndpointGroup

AcceleratorId Query String ga-bp1odcab8tmno0hdq****

全球加速实例ID。

Description Query String EndpointGroup

终端节点组描述信息。

EndpointConfigurations.N.Endpoint Query String 120.xx.xx.21

终端节点的IP或域名。

EndpointConfigurations.N.Type Query String Ip

终端节点类型,取值:

  • Domain:自定义域名。
  • Ip:自定义IP。
  • PublicIp:阿里云公网IP。
  • ECS:阿里云ECS实例。
  • SLB:阿里云SLB实例。
说明 终端节点类型取值为ECSSLB时,如果服务关联角色不存在,系统会自动创建一个名称为AliyunServiceRoleForGaVpcEndpoint的服务关联角色。详细信息,请参见服务关联角色
EndpointConfigurations.N.Weight Query Integer 20

终端节点的权重。

EndpointGroupRegion Query String cn-hangzhou

终端节点组所属的地域。

ListenerId Query String lsr-bp1bpn0kn908w4nbw****

监听ID。

Name Query String group1

终端节点组的名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短横线(-)。

RegionId Query String cn-hangzhou

全球加速实例所在的地域,仅取值cn-hangzhou

ClientToken Query String 123e4567-e89b-12d3-a456-426655440000

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

EndpointConfigurations.N.EnableClientIPPreservation Query Boolean false

是否开启保持客户端源IP功能,取值:

  • true:开启保持客户端源IP功能。
  • false(默认值):不开启保持客户端源IP功能。
TrafficPercentage Query Integer 20

监听有多个终端节点组时的权重。

HealthCheckIntervalSeconds Query Integer 3

健康检查的时间间隔,单位为秒。

HealthCheckPath Query String /healthcheck

健康检查路径。

HealthCheckPort Query Integer 20

健康检查的端口。

HealthCheckProtocol Query String tcp

健康检查的协议。

  • tcp:TCP协议。
  • http:HTTP协议。
  • https:HTTPS协议。
ThresholdCount Query Integer 3

健康检查判定终端节点为不健康的次数。

返回数据

名称 类型 示例值 描述
EndpointGroupId String epg-bp1dmlohjjz4kqaun****

终端节点组ID。

RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateEndpointGroup
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&Description=EndpointGroup
&EndpointConfigurations.1.Endpoint=120.xx.xx.21
&EndpointConfigurations.1.Type=Ip
&EndpointConfigurations.1.Weight=20
&EndpointGroupRegion=cn-hangzhou
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&Name=group1
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<CreateEndpointGroupResponse>    
      <EndpointGroupId>epg-bp1dmlohjjz4kqaun****</EndpointGroupId>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</CreateEndpointGroupResponse>

JSON 格式

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

错误码

HttpCode 错误码 错误信息 描述
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. 终端节点组已经存在

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