ALIYUN::GA::EndpointGroup类型用于创建终端节点组。

语法

{
  "Type": "ALIYUN::GA::EndpointGroup",
  "Properties": {
    "HealthCheckIntervalSeconds": Integer,
    "EndpointGroupRegion": String,
    "TrafficPercentage": Integer,
    "Description": String,
    "HealthCheckPath": String,
    "HealthCheckProtocol": String,
    "ThresholdCount": Integer,
    "HealthCheckPort": Integer,
    "AcceleratorId": String,
    "EndpointConfigurations": List,
    "Name": String,
    "ListenerId": String,
    "HealthCheckEnabled": Boolean,
    "EndpointGroupType": String,
    "EndpointRequestProtocol": String
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
HealthCheckIntervalSeconds Integer 健康检查的时间间隔。 单位:秒。
EndpointGroupRegion String 终端节点组所属的地域。
TrafficPercentage Integer 监听有多个终端节点组时的权重。
Description String 终端节点组描述信息。
HealthCheckPath String 健康检查路径。
HealthCheckProtocol String 健康检查的协议。 取值:
  • tcp:TCP协议。
  • http:HTTP协议。
  • https:HTTPS协议。
ThresholdCount Integer 健康检查判定终端节点为不健康的次数。
HealthCheckPort Integer 健康检查的端口。
AcceleratorId String 全球加速实例ID。
EndpointConfigurations List 终端节点。 最多设置4个终端节点。

更多信息,请参见EndpointConfigurations属性

Name String 终端节点组的名称。
ListenerId String 监听ID。
HealthCheckEnabled Boolean 是否开启健康检查。 取值:
  • true(默认值):开启健康检查。
  • false:关闭健康检查。
EndpointGroupType String 终端节点组类型。 取值:
  • default(默认值):默认终端节点组。
  • virtual:虚拟终端节点组。
说明 仅HTTP或HTTPS协议的监听实例才支持创建虚拟终端节点组。
EndpointRequestProtocol String 后端服务协议。 取值:
  • HTTP(默认值)
  • HTTPS
说明
  • 仅为HTTP或HTTPS协议的监听实例创建终端节点组时才支持配置该项。
  • 对于HTTP协议的监听实例,后端服务协议支持且仅支持HTTP。

EndpointConfigurations语法

"EndpointConfigurations": [
  {
    "Type": String,
    "Endpoint": String,
    "Weight": Integer,
    "EnableClientIPPreservation": Boolean,
    "EnableProxyProtocol": Boolean
  }
]

EndpointConfigurations属性

属性名称 类型 必须 允许更新 描述 约束
Type String 终端节点类型。 取值:
  • Domain:自定义域名。
  • Ip:自定义IP。
Endpoint String 终端节点的IP或域名。
Weight Integer 终端节点的权重。
EnableClientIPPreservation Boolean 是否使用TOA方式开启保持客户端源IP功能。 取值:
  • true:开启保持客户端源IP功能。
  • false(默认值):不开启保持客户端源IP功能。
EnableProxyProtocol Boolean 指定是否使用TCP选项地址(TOA)模块获取和保留访问端点的客户端的IP地址。

返回值

Fn::GetAtt

EndpointGroupId:终端节点组ID。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "EndpointGroupRegion": {
      "Type": "String",
      "Description": "The region ID of the endpoint group."
    },
    "AcceleratorId": {
      "Type": "String",
      "Description": "The ID of the Global Accelerator instance with which the endpoint group will be associated."
    },
    "EndpointConfigurations": {
      "Type": "Json",
      "Description": "",
      "MinLength": 1,
      "MaxLength": 4
    },
    "ListenerId": {
      "Type": "String",
      "Description": "The ID of the listener to be associated with the endpoint group."
    }
  },
  "Resources": {
    "EndpointGroup": {
      "Type": "ALIYUN::GA::EndpointGroup",
      "Properties": {
        "EndpointGroupRegion": {
          "Ref": "EndpointGroupRegion"
        },
        "AcceleratorId": {
          "Ref": "AcceleratorId"
        },
        "EndpointConfigurations": {
          "Ref": "EndpointConfigurations"
        },
        "ListenerId": {
          "Ref": "ListenerId"
        }
      }
    }
  },
  "Outputs": {
    "EndpointGroupId": {
      "Description": "The ID of the endpoint group.",
      "Value": {
        "Fn::GetAtt": [
          "EndpointGroup",
          "EndpointGroupId"
        ]
      }
    }
  }
}