文档

CreateListener - 创建监听

更新时间:

监听负责检查连接请求,然后根据调度算法定义的转发策略将请求流量分发至终端节点。您可以调用CreateListener接口为全球加速实例创建监听。

接口说明

在调用本接口时,请注意以下事项:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ga:CreateListenerWrite
  • Listener
    acs:ga:{#regionId}:{#accountId}:listener/*
  • Accelerator
    acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}
  • ga:TLSVersion

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring

全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
Namestring

监听的名称。

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

Listener
Descriptionstring

监听的描述信息。

描述长度最大为 200 个字符,不能以http://https://开头。

Listener
ClientAffinitystring

客户端亲和性。

  • 不传入值时,不保持客户端亲和性,即不能确保来自同一客户端的连接请求始终定向到同一终端节点。

  • 取值为SOURCE_IP时,保持客户端亲和性。即客户端访问有状态的应用程序时,可以将来自同一客户端的所有请求都定向到同一终端节点,而不考虑源端口和协议。

SOURCE_IP
Protocolstring

监听的网络传输协议类型,取值:

  • tcp:TCP 协议。

  • udp:UDP 协议。

  • http:HTTP 协议。

  • https:HTTPS 协议。

tcp
ProxyProtocolboolean

是否开启保持客户端源 IP 功能。

  • true:开启保持客户端源 IP 功能。开启后,支持后端服务查看客户端的原始 IP 地址。

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

说明 该参数后续将不在监听 API 中配置,建议在终端节点组的相关 API 中进行配置。关于 ProxyProtocol,请参见 CreateEndpointGroupUpdateEndpointGroup
false
PortRangesobject []

监听端口信息。 可配置的监听端口范围为 1~65499。 最多可配置端口数量与监听路由类型和监听协议类型相关,更多信息,请参见监听端口

FromPortinteger

用来接收请求并向终端节点进行转发的起始监听端口。

可配置的监听端口范围为 1~65499,且需满足 FromPortToPort

最多可配置端口数量与监听路由类型和监听协议类型相关,更多信息,请参见监听端口

说明 对于 HTTP 或 HTTPS 协议的监听,只支持配置一个监听端口,即起始监听端口和结束监听端口需相同。
20
ToPortinteger

用来接收请求并向终端节点进行转发的结束监听端口。

可配置的监听端口范围为 1~65499,且需满足 FromPortToPort

最多可配置端口数量与监听路由类型和监听协议类型相关,更多信息,请参见监听端口

说明 对于 HTTP 或 HTTPS 协议的监听,只支持配置一个监听端口,即起始监听端口和结束监听端口需相同。
20
Certificatesobject []

SSL 证书列表。

Idstring

SSL 证书 ID。

说明 仅 HTTPS 协议的监听需要配置该参数。
449****-cn-hangzhou
XForwardedForConfigobject

XForward字段配置信息。

XForwardedForGaIdEnabledboolean

是否通过GA-ID头字段获取全球加速实例 ID。取值:

  • true:是。

  • false(默认值):否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XForwardedForGaApEnabledboolean

是否通过GA-AP字段获取加速地域信息。取值:

  • true:是。

  • false(默认值):否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XForwardedForProtoEnabledboolean

是否通过GA-X-Forward-Proto字段获取全球加速实例的监听协议。取值:

  • true:是。

  • false(默认值):否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XForwardedForPortEnabledboolean

是否通过GA-X-Forward-Port字段获取全球加速实例的监听端口。取值:

  • true:是。

  • false(默认值):否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
XRealIpEnabledboolean

是否通过X-Real-IP字段获取真实的客户端 IP。取值:

  • true:是。

  • false(默认值):否。

说明 仅 HTTP 和 HTTPS 监听支持此参数。
false
SecurityPolicyIdstring

安全策略实例 ID。取值:

  • tls_cipher_policy_1_0

    • 支持的 TLS 版本:TLSv1.0、TLSv1.1 和 TLSv1.2。

    • 支持的加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_1

    • 支持的 TLS 版本: TLSv1.1 和 TLSv1.2。

    • 支持的加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_2

    • 支持的 TLS 版本:TLSv1.2。

    • 支持的加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_2_strict

    • 支持的 TLS 版本:TLSv1.2。

    • 支持的加密算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA 和 ECDHE-RSA-AES256-SHA。

  • tls_cipher_policy_1_2_strict_with_1_3

    • 支持的 TLS 版本:TLSv1.2 及 TLSv1.3。

    • 支持的加密算法套件:TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。

说明 仅 HTTPS 监听支持此参数。
tls_cipher_policy_1_0
Typestring

监听的路由类型。取值:

  • Standard(默认值):智能路由类型。
  • CustomRouting:自定义路由类型。
说明
  • 监听支持自定义路由类型的功能邀测中,如需使用,请联系阿里云客户经理。
  • 同一个标准型全球加速实例,不支持同时配置两种路由类型的监听,且路由类型配置完成后不支持变更。更多信息,请参见监听概述
  • Standard
    EndpointGroupConfigurationsobject []

    智能路由类型监听的终端节点组的配置信息。

    您最多可以配置 10 个该类型终端节点组。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    EndpointGroupNamestring

    智能路由类型监听的终端节点组名称。

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

    您最多可以输入 10 个终端节点组名称。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    test
    EndpointGroupDescriptionstring

    智能路由类型监听的终端节点组描述信息。

    描述长度最大 200 字符,不能包含http://https://字符。

    您最多可以输入 10 个终端节点组描述信息。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    test
    EndpointGroupRegionstring

    智能路由类型监听的终端节点组所属地域 ID。

    您最多可以输入 10 个终端节点组的地域 ID。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    cn-hangzhou
    TrafficPercentagelong

    流量调配值,即智能路由类型监听有多个终端节点组时,配置到不同终端节点组的流量比例。

    取值范围:1~100。默认值:100

    您最多可以输入 10 个终端节点组的流量调配值。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    100
    HealthCheckEnabledboolean

    是否为智能路由类型监听的终端节点组开启健康检查。取值:

    • true:开启健康检查。
    • false(默认值):关闭健康检查。

    您最多可以开启 10 个终端节点组的健康检查。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    false
    HealthCheckIntervalSecondslong

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

    您最多可以输入 10 个健康检查的时间间隔。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    3
    HealthCheckPathstring

    健康检查路径。

    您最多可以输入 10 个健康检查路径。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    /healthcheck
    HealthCheckPortlong

    健康检查的端口。取值范围:1~65535

    您最多可以输入 10 个健康检查的端口。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    20
    HealthCheckProtocolstring

    健康检查的协议。取值:

    • tcpTCP:TCP 协议。
    • httpHTTP:HTTP 协议。
    • httpsHTTPS:HTTPS 协议。

    您最多可以输入 10 个健康检查的协议。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    tcp
    ThresholdCountlong

    针对健康检查状态变化所需要的连续健康检查次数,即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。 取值范围:2~10。默认值:3

    您最多可以输入 10 个健康检查状态变化所需要的连续健康检查次数值。

    说明 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
    3
    EndpointConfigurationsobject []

    智能路由类型监听的终端节点配置信息。

    Typestring

    智能路由类型监听的终端节点类型。取值:

    • Domain:自定义域名。
    • Ip:自定义 IP。
    • PublicIp:阿里云公网 IP。
    • ECS:阿里云 ECS 实例。
    • SLB:阿里云 SLB 实例。
    • ALB:阿里云 ALB 实例。
    • OSS:阿里云 OSS 实例。
    • ENI:阿里云弹性网卡。
    • NLB:阿里云 NLB 实例。

    在智能路由类型监听的某个终端节点组中,您最多可以输入 100 个终端节点类型。

    说明
  • Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息,且该参数必填。
  • 终端节点类型取值为 ECSENISLBALBNLB 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaVpcEndpoint 的服务关联角色。
  • 终端节点类型取值为 ALB 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaAlb 的服务关联角色。
  • 终端节点类型取值为 OSS 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaOss 的服务关联角色。
  • 终端节点类型取值为 NLB 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaNlb 的服务关联角色。
  • 更多信息,请参见服务关联角色

    Ip
    Weightlong

    智能路由类型监听的终端节点权重。

    取值范围:0~255

    在智能路由类型监听的某个终端节点组中,您最多可以输入 100 个终端节点的权重。

    说明
  • Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息,且该参数必填。
  • 如果某个终端节点的权重设置为 0,全球加速将终止向该终端节点分发流量,请您谨慎操作。
  • 20
    Endpointstring

    智能路由类型监听的终端节点的 IP 或域名。

    在智能路由类型监听的某个终端节点组中,您最多可以输入 100 个终端节点的 IP 或域名。

    说明 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息,且该参数必填。
    47.0.XX.XX
    SubAddressstring

    弹性网卡的私网 IP 地址。

    说明 当终端节点类型为 ENI 时,可以选择配置该参数,如果不配置默认为 ENI 的主私网 IP 地址。
    172.168.XX.XX
    EndpointRequestProtocolstring

    智能路由类型监听的终端节点后端服务协议。取值:

    • HTTP(默认值):HTTP 协议。
    • HTTPS:HTTPS 协议。

    您最多可以输入 10 个后端服务协议。

    说明
  • 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅为 HTTP 或 HTTPS 协议的智能路由类型监听创建终端节点组时才支持配置该项。
  • 对于 HTTP 协议的监听,后端服务协议支持且仅支持 HTTP
  • HTTP
    EndpointGroupTypestring

    智能路由类型监听的终端节点组类型。取值:

    • default(默认值):默认终端节点组。
    • virtual:虚拟终端节点组。

    您最多可以输入 10 个终端节点组类型。

    说明
  • 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅 HTTP 或 HTTPS 协议的智能路由类型监听才支持创建虚拟终端节点组。
  • default
    PortOverridesobject []

    端口映射关系。

    ListenerPortlong

    配置端口映射时的监听端口。

    您最多可以输入 5 个端口映射中的监听端口。

    说明
  • 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅为 HTTP 或 HTTPS 协议的智能路由类型监听创建终端节点组时才支持创建端口映射关系。
  • 端口映射中的监听端口必须与当前监听的监听端口一致。
  • 443
    EndpointPortlong

    配置端口映射时的终端节点端口。

    您最多可以输入 5 个端口映射中的终端节点端口。

    说明
  • 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅为 HTTP 或 HTTPS 协议的智能路由类型监听创建终端节点组时才支持创建端口映射关系。
  • 80
    EnableClientIPPreservationToaboolean

    是否使用 TOA 方式开启保持客户端源 IP 功能,取值:

    • true:开启保持客户端源 IP 功能。

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

    您最多可以配置 10 个该功能项。

    说明
  • 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅当监听为 TCP 协议类型且终端节点后端服务部署在阿里云上时,支持配置为 true
  • EnableClientIPPreservationToaEnableClientIPPreservationProxyProtocol 不能同时为 true
  • false
    EnableClientIPPreservationProxyProtocolboolean

    是否使用 ProxyProtocol 方式保留客户端源 IP。取值:

    • true:使用 ProxyProtocol 方式保留客户端源 IP。

    • false(默认值):不使用 ProxyProtocol 方式保留客户端源 IP。

    您最多可以配置 10 个该功能项。

    说明
  • 仅当 Type(监听路由类型)值为 Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅当监听为 TCP 协议类型且终端节点后端服务部署在非阿里云上时,支持配置为 true
  • EnableClientIPPreservationToaEnableClientIPPreservationProxyProtocol 不能同时为 true
  • false
    CustomRoutingEndpointGroupConfigurationsobject []

    自定义路由类型监听的终端节点组配置信息。

    您最多可以配置 5 个该类型终端节点组。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    EndpointGroupRegionstring

    自定义路由类型监听的终端节点组所属地域 ID。

    您最多可以输入 5 个终端节点组地域 ID。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    cn-hangzhou
    Namestring

    自定义路由类型监听的终端节点组名称。

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

    最多可以输入 5 个终端节点组名称。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    test
    Descriptionstring

    自定义路由类型监听的终端节点组的描述信息。

    描述长度最大 200 字符,不能包含http://https://字符。

    最多可以输入 5 个终端节点组的描述信息。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    test
    DestinationConfigurationsobject []

    自定义路由类型监听的终端节点组的映射信息配置。

    您需要输入终端节点组后端服务端口范围和协议类型,输入信息与关联的监听端口范围将形成映射关系。

    自定义路由类型监听的每个终端节点组下,最多可输入 20 条映射端口范围和协议类型信息。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    Protocolsarray

    自定义路由类型监听的终端节点组后端服务的协议类型。

    自定义路由类型监听的每个终端节点组映射端口范围和协议类型信息中,最多可以输入 4 个后端服务协议类型。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    string

    自定义路由类型监听的终端节点组后端服务协议类型。取值:

    • TCP:TCP 协议。

    • UDP:UDP 协议。

    • TCP,UDP:TCP 和 UDP 协议。

    自定义路由类型监听的每个终端节点组映射端口范围和协议类型信息中,最多可以输入 4 个后端服务协议类型。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    TCP
    FromPortinteger

    自定义路由类型监听的终端节点组后端服务起始端口。

    取值范围:1~65499,且需满足 FromPortToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。

    自定义路由类型监听的每个终端节点组下,最多可输入 20 条后端服务起始端口信息。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    80
    ToPortinteger

    自定义路由类型监听的终端节点组后端服务结束端口。

    取值范围:1~65499,且需满足 FromPortToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。

    自定义路由类型监听的每个终端节点组下,最多可输入 20 条后端服务结束端口信息。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    80
    EndpointConfigurationsobject []

    自定义路由类型监听的终端节点信息。

    自定义路由类型监听的每个终端节点组下,最多可输入 10 个终端节点信息。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    Typestring

    自定义路由类型监听的终端节点后端服务类型。取值:

    PrivateSubNet(默认值):私网 CIDR。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    PrivateSubNet
    Endpointstring

    自定义路由类型监听的终端节点交换机(vSwitch)实例名称。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    vsw-test01
    TrafficToEndpointPolicystring

    自定义路由类型监听的终端节点后端服务流量通行策略,取值:

    • DenyAll(默认值):拒绝所有访问流量访问指定后端服务。
    • AllowAll:允许所有访问流量访问指定后端服务。
    • AllowCustom:指定可以接收访问流量的通行目标。 您需要指定该通信目标的 IP 地址和端口范围,端口范围输入为空时,表示支持该通行目标的所有端口。
    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    DenyAll
    PolicyConfigurationsobject []

    自定义路由类型监听的终端节点流量通行目标配置。

    自定义路由类型监听的每个终端节点下,最多可输入 20 个通行目标。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    Addressstring

    指定可以接受访问流量的通行目标 IP 地址。

    仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时,该项生效。

    自定义路由类型监听的每个终端节点下,最多可输入 20 个通行目标 IP 地址。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    10.0.XX.XX
    PortRangesobject []

    指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。

    输入为空时,表示支持该通行目标的所有端口。

    仅当 TrafficToEndpointPolicy(流量通行策略)取值为 AllowCustom(指定可接受访问流量的通行目标)时,该项生效。

    自定义路由类型监听的每个终端节点下,最多可输入 20 个通行目标的端口范围,每个通行目标最多可输入 5 个端口范围。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    FromPortinteger

    指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。

    仅当 TrafficToEndpointPolicy(流量通行策略)取值为 AllowCustom(指定可接受访问流量的通行目标)时,该项生效。

    自定义路由类型监听的每个终端节点下,最多可输入 20 个通行目标的端口范围,每个通行目标最多可输入 5 个起始端口。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    80
    ToPortinteger

    指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。

    仅当 TrafficToEndpointPolicy(流量通行策略)取值为 AllowCustom(指定可接受访问流量的通行目标)时,该项生效。

    自定义路由类型监听的每个终端节点下,最多可输入 20 个通行目标的端口范围,每个通行目标最多可输入 5 个结束端口。

    说明 仅当 Type(监听路由类型)值为 CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
    80
    IdleTimeoutinteger

    连接空闲超时时间。单位:秒。

    • TCP:10-900s,默认 900s
    • UDP:10-20s ,默认 20s
    • HTTP/HTTPS:1-60 秒,默认 15s
    900
    RequestTimeoutinteger

    HTTP/HTTPS 的连接请求超时时间。单位:秒。

    可选:1-180 秒,默认 60s。

    说明 仅对 Protocol(网络传输协议类型)为 HTTP 或 HTTPS 的监听有效。如果在超时时间内后端服务器一直没有响应,全球加速将放弃等待,并给客户端返回 HTTP 504 错误码。
    15
    HttpVersionstring

    HTTP 协议的最大版本,取值:

    • http3:HTTP/3。
    • http2(默认值):HTTP/2。
    • http1.1:HTTP/1.1。
    说明 仅 HTTPS 监听支持此参数。
    http2

    返回参数

    名称类型描述示例值
    object

    返回信息列表。

    RequestIdstring

    请求 ID。

    04F0F334-1335-436C-A1D7-6C044FE73368
    ListenerIdstring

    监听 ID。

    lsr-bp1bpn0kn908w4nbw****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400Resource.QuotaFullThe resource quota is exceeded.该资源数量已达配额上限
    400ProtocalIllegal.ListenerThe specified listener protocol is invalid.监听协议配置非法
    400NotExist.AcceleratorThe accelerated instance does not exist.加速实例不存在。
    400StateError.AcceleratorThe state of the accelerated instance is invalid.加速实例状态非法。
    400QuotaExceeded.ListenerThe maximum number of listeners is exceeded.监听器达到Quota限制
    400QuotaExceeded.ListenerPortThe maximum number of listener ports is exceeded.监听端口达到Quota限制
    400NotExist.ListenerPortlistener port %s is not exist-
    400PortRangeIllegal.ListenerThe specified listener port range is invalid.监听端口范围配置非法
    400PortRangeIllegal.CountThe hugePort listener only supports one port range.海量端口监听(端口数>300)仅支持配置一个端口范围
    400PortConflict.ListenerThe listener port configuration is in conflict.监听端口配置冲突
    400PortRangeIllegal.ExceedGaAbilityThe 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).监听端口范围非法,每个全球加速实例只支持创建每种协议(TCP/UDP)各一个端口范围超过300的监听
    400PortRangeIllegal.UDPUDP ports 250, 4789, and 4790 are system reserved ports.-
    400SystemPort.ListenerPorts 65500-65535 are system reserved ports.端口65500-65535为系统保留端口。
    400PortRanges.MustOneThe portRanges must be one for HTTPS and HTTP type listener.HTTPS/HTTP类型监听只支持一个端口
    400SecurityPolicyId.NotNeedNo security policy ID is required for the listener.当前监听不需要配置安全策略ID。
    400SecurityPolicyIdIllegal.ListenerThe listener security policy ID %s is illegal.监听安全策略ID不合法。
    403Forbbiden.SubUserYou are not authorized to operate on the specified resource because your account was created by another user.该账号为其他账号的子账号,没有操作特定资源的权限。
    403ForbiddenThe user is not authorized to operate on the specified resource.该账号没有操作特定资源的权限。
    500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.处理请求时出现错误,请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    2024-03-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:HttpVersion
    2023-11-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:IdleTimeout
      新增入参:RequestTimeout
    2023-10-25OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    2023-04-20OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    • 本页导读 (1)