CreateEndpointGroup_全球加速_API文档-阿里云OpenAPI开发者门户

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

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

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	无

请求参数

字段名称	字段详情
RegionIdstring	全球加速实例所在的地域 ID，仅取值cn-hangzhou。示例值:cn-hangzhou
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring	全球加速实例 ID。示例值:ga-bp1odcab8tmno0hdq****参考取值来源: ListAccelerators CreateAccelerator UpdateAcceleratorAutoRenewAttribute
Namestring	终端节点组的名称。展开详情示例值:group1
Descriptionstring	终端节点组描述信息。展开详情示例值:EndpointGroup
EndpointGroupRegionstring	终端节点组所属的地域 ID。示例值:cn-hangzhou参考取值来源: ListEndpointGroups DescribeEndpointGroup GetBasicEndpointGroup CreateCustomRoutingEndpointGroups
ListenerIdstring	监听实例 ID。示例值:lsr-bp1bpn0kn908w4nbw****参考取值来源: ListListeners CreateListener AssociateAclsWithListener DissociateAclsFromListener
TrafficPercentageinteger<int32>	监听实例有多个终端节点组时，配置到不同终端节点组的流量比例。展开详情示例值:20
HealthCheckIntervalSecondsinteger<int32>	健康检查的时间间隔，单位：秒。示例值:3
HealthCheckPathstring	健康检查路径。示例值:/healthcheck
HealthCheckPortinteger<int32>	健康检查的端口。示例值:20
HealthCheckProtocolstring	健康检查的协议。取值：展开详情示例值:tcp
ThresholdCountinteger<int32>	针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。展开详情示例值:3
EndpointConfigurationsarray<object>	终端节点配置信息。
EndpointRequestProtocolstring	后端服务协议。取值：展开详情示例值:HTTP参考取值来源: DescribeEndpointGroup ListEndpointGroups
EndpointProtocolVersionstring	后端服务协议版本。取值：展开详情示例值:HTTP1.1参考取值来源: DescribeEndpointGroup ListEndpointGroups
EndpointGroupTypestring	终端节点组类型。取值：展开详情示例值:default枚举值:defaultvirtual参考取值来源: ListEndpointGroups DescribeEndpointGroup
PortOverridesarray<object>	端口映射关系。子级条数 <= 100
HealthCheckEnabledboolean	是否开启健康检查。取值：展开详情示例值:true
Tagarray<object>	终端节点组的标签。子级条数 <= 21
DryRunboolean	是否只预检此次请求。取值：展开详情示例值:false

返回参数

字段名称	字段详情
EndpointGroupIdstring	终端节点组 ID。示例值:epg-bp1dmlohjjz4kqaun****
RequestIdstring	请求 ID。示例值:04F0F334-1335-436C-A1D7-6C044FE73368

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
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.	诊断
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	诊断
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	诊断
400	Exist.EndpointGroup	The endpoint group already exists.	诊断
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	诊断
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal	诊断
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	诊断
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-12-23	变更请求参数EndpointConfigurations 新增请求参数DryRun
	2024-07-19	新增请求参数EndpointProtocolVersion
	2023-11-22	变更请求参数EndpointConfigurations
	2023-09-14	变更请求参数EndpointConfigurations
	2023-06-20	变更请求参数EndpointConfigurations
	2023-03-31	新增请求参数Tag

CreateEndpointGroup_全球加速_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例