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

接口说明

在调用本接口时，请注意以下事项：

CreateListener 接口属于异步接口，即系统会先返回一个监听 ID，但监听并未创建完成，系统后台的创建任务仍在进行。您可以调用 DescribeListener 查询监听的状态：
- 当监听处于 init 状态时，表示监听正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。
- 当监听处于 active 状态时，表示监听创建完成。
CreateListener 接口不支持在同一个全球加速实例内并发创建监听。

流控信息

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

授权信息

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

具体说明如下：展开详情

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

ga:CreateListener	Create	Listener acs:ga:{#regionId}:{#accountId}:listener/* Accelerator acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}	ga:TLSVersion	无

请求参数

字段名称	字段详情
RegionIdstring	全球加速实例所在的地域 ID，仅取值cn-hangzhou。示例值:cn-hangzhou
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring	全球加速实例 ID。示例值:ga-bp1odcab8tmno0hdq****参考取值来源: ListAccelerators CreateAccelerator UpdateAcceleratorAutoRenewAttribute
Namestring	监听的名称。展开详情示例值:Listener
Descriptionstring	监听的描述信息。展开详情示例值:Listener
ClientAffinitystring	客户端亲和性。展开详情示例值:SOURCE_IP
Protocolstring	监听的网络传输协议类型，取值：展开详情示例值:tcp
PortRangesarray<object>	监听端口信息。展开详情子级条数 <= 100
Certificatesarray<object>	SSL 证书列表。子级条数 <= 10
XForwardedForConfigobject	`XForward`字段配置信息。
SecurityPolicyIdstring	安全策略实例 ID。取值：展开详情示例值:tls_cipher_policy_1_0参考取值来源: ListSystemSecurityPolicies
Typestring	监听的路由类型。取值：展开详情示例值:Standard参考取值来源: ListIspTypes
EndpointGroupConfigurationsarray<object>	智能路由类型监听的终端节点组的配置信息。展开详情
CustomRoutingEndpointGroupConfigurationsarray<object>	自定义路由类型监听的终端节点组配置信息。展开详情
IdleTimeoutinteger<int32>	连接空闲超时时间。单位：秒。展开详情示例值:900
RequestTimeoutinteger<int32>	HTTP/HTTPS 的连接请求超时时间。单位：秒。展开详情示例值:15
HttpVersionstring	HTTP 协议的最大版本，取值：展开详情示例值:http2

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:04F0F334-1335-436C-A1D7-6C044FE73368
ListenerIdstring	监听 ID。示例值:lsr-bp1bpn0kn908w4nbw****

返回示例

错误码

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

全局错误码

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

400	Resource.QuotaFull	The resource quota is exceeded.	诊断
400	ProtocalIllegal.Listener	The specified listener protocol is invalid.	诊断
400	NotExist.Accelerator	The accelerated instance does not exist.	诊断
400	StateError.Accelerator	The state of the accelerated instance is invalid.	诊断
400	QuotaExceeded.Listener	The maximum number of listeners is exceeded.	诊断
400	QuotaExceeded.ListenerPort	The maximum number of listener ports is exceeded.	诊断
400	NotExist.ListenerPort	listener port %s is not exist	诊断
400	PortRangeIllegal.Listener	The specified listener port range is invalid.	诊断
400	PortRangeIllegal.Count	The hugePort listener only supports one port range.	诊断
400	PortConflict.Listener	The listener port configuration is in conflict.	诊断
400	PortRangeIllegal.ExceedGaAbility	The listener port range is invalid. For each accelerator instance, you can only create a listener with port range over 300 for each protocol (TCP and UDP).	诊断
400	PortRangeIllegal.UDP	UDP ports 250, 4789, and 4790 are system reserved ports.	诊断
400	SystemPort.Listener	Ports 65500-65535 are system reserved ports.	诊断
400	PortRanges.MustOne	The portRanges must be one for HTTPS and HTTP type listener.	诊断
400	SecurityPolicyId.NotNeed	No security policy ID is required for the listener.	诊断
400	SecurityPolicyIdIllegal.Listener	The listener security policy ID %s is illegal.	诊断
403	Forbbiden.SubUser	You are not authorized to operate on the specified resource because your account was created by another user.	诊断
403	Forbidden	The user is not authorized to operate on the specified resource.	诊断
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-12-23	删除请求参数ProxyProtocol 变更请求参数EndpointGroupConfigurations
	2024-07-19	变更请求参数EndpointGroupConfigurations
	2024-03-27	新增请求参数HttpVersion
	2023-11-06	新增请求参数IdleTimeout 新增请求参数RequestTimeout
	2023-10-25	变更请求参数EndpointGroupConfigurations
	2022-09-22	新增请求参数EndpointGroupConfigurations 新增请求参数CustomRoutingEndpointGroupConfigurations

CreateListener_全球加速_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例