新增终端节点组CreateEndpointGroup--全球加速-火山引擎

文档中心

立即注册

导航

新增终端节点组CreateEndpointGroup

最近更新时间：2024.09.24 16:30:09首次发布时间：2024.09.24 16:30:09

本接口用于新增终端节点组。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateEndpointGroup&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `CreateEndpointGroup`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
AcceleratorId	String	是	与终端节点组关联的标准型加速器ID。	`accelerator-xxxx`
ListenerId	String	是	监听器 ID 。	`listener-xxxx`
Region	String	是	终端节点组所在区域。 CN_North：华北 CN_East：华东 CN_South：华南 CN_NorthEast：东北 CN_Central：华中 CN_NorthWest：西北 CN_SouthWest：西南 AP1：亚太1	`CN_East`
Name	String	否	终端节点组名称。	`xxxx`
TrafficPercentage	Integer	是	流量调配权重，即本终端节点组接入的流量在所有终端节点组接入流量的比例。一个监听默认可以关联2个默认终端节点组，如果需要创建更多默认终端节点组，请联系客服经理。每个终端节点组的流量调配取值范围：1~100。	`1`
KeepClientIP	Boolean	是	是否开启保持客户端源IP功能。 true：启用保持客户端源IP功能。 false：不启用此功能。	`true`
KeepClientIPMethod	String	否	保持客户端源IP，支持取值如下： Proxy Protocol v1：仅在`Protocol`为`TCP`时有效。通过为报文添加Proxy Protocol v1报头（ASCII码格式）传递客户端源IP。 Proxy Protocol v2：通过报文添加 Proxy Protocol v2报头（二进制格式）传递客户端源IP。注意如果您的后端服务器不支持解析Proxy Protocol，则会导致后端服务器无法正确解析加速流量。	`Proxy Protocol v1`
EndpointType	String	否	终端节点类型，支持取值： public：公网 private：私网	`public`
SourceIP	Object[]	否	私网回源IP网段，仅在终端节点为私网类型时必填。	`-`
EndpointConfigurations	Object[]	是	终端节点组的配置信息。	`-`
HealthyConfig	Object	是	健康检查的配置信息。	`-`

返回参数

参数名称	数据类型	参数说明	示例
EndpointGroupId	String	终端节点组ID	`endpointgroup-xxxx`

请求示例

POST https://open.volcengineapi.com?Action=CreateEndpointGroup&Version=2022-03-01
{
    "AcceleratorId": "accelerator-xxxx",
    "ListenerId": "listener-xxxx",
    "Region": "CN_East",
    "TrafficPercentage": 1,
    "KeepClientIP": false,
    "EndpointConfigurations": [
        {
            "Type": "IP",
            "Endpoint": "1.1.1.1",
            "Weight": 1
        }
    ],
    "HealthyConfig": {
        "HealthCheckEnable": false
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateEndpointGroup",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "EndpointGroupId": "endpointgroup-xxxx"
    }
}