数据结构

最近更新时间:2026-07-08 02:05:07

我的收藏

AcceleratorAreas

加速地域信息

被如下接口引用:CreateAccelerateAreas, DescribeAccelerateAreas, ModifyAccelerateAreas。

名称 类型 必选 描述
AccelerateRegion String

加速地域。


示例值:ap-guangzhou
Bandwidth Integer

带宽。


示例值:10
IspType String

支持'BGP', 'QUALITY_BGP', 'STATIC_IP',默认BGP。

枚举值:

  • BGP: BGP
  • STATIC_IP: 三网
  • QUALITY_BGP: 精品BGP

示例值:BGP
IpVersion String

仅支持IPv4,默认是IPv4。


示例值:IPv4
AcceleratorAreaId String

加速地域ID。


示例值:area-np7tkvgs
IpAddress Array of String

IP。


示例值:["154.8.187.136"]
IpAddressInfoSet Array of IpAddressInfoSet

IP信息。


注意:此字段可能返回 null,表示取不到有效值。

AcceleratorRegionSet

可加速地域信息

被如下接口引用:DescribeAccelerateRegions。

名称 类型 描述
Name String

地域中文名称。


示例值:广州
IsAvailable Integer

是否可用;0:不可用,1:可用。


示例值:0
Region String

地域信息。


示例值:ap-guangzhou
AreaName String

地区名称。


示例值:中国大陆
IsChinaMainland Integer

是否中国地域。


示例值:1
SupportIspType Array of String

支持IspType类型。


示例值:["BGP"]
IsTencentRegion Integer

是否腾讯地域。


示例值:0

EndpointConfigurations

终端节点配置

被如下接口引用:CreateEndpointGroup, DescribeEndpointGroups, ModifyEndpointGroup。

名称 类型 必选 描述
EndpointType String

域名类型。可选值'Domain', 'PublicIp'。


示例值:Domain
EndpointService String

域名。


示例值:www.test.com
Weight Integer

权重。


示例值:10
HealthCheckStatus String

健康检查状态;HEALTH:健康;UNHEALTH:不健康。


示例值:HEALTH

EndpointGroupConfiguration

终端节点组配置

被如下接口引用:CreateEndpointGroup。

名称 类型 必选 描述
Name String

终端节点组名称。

最大长度不能超过128个字节。必须以字母(a-z, A-Z)或中文字符开头。


示例值:name
EndpointGroupRegion String

终端节点组所在地域。


示例值:ap-guangzhou
EndpointConfigurations Array of EndpointConfigurations

终端节点配置。

CheckType String

检查协议。支持配置'TCP', 'HTTP', 'PING', 'CUSTOM'。

枚举值:

  • TCP: 当终端节点组所在监听器协议是TCP时,可以选择检查协议为TCP。
  • HTTP: 当终端节点组所在监听器协议是HTTP或HTTPS时,可以选择检查协议为HTTP。
  • PING: 当终端节点组所在监听器协议是UDP时,可以选择检查协议为PING。
  • CUSTOM: 当终端节点组所在监听器协议是UDP或TCP时,可以选择检查协议为CUSTOM。

当开启健康检查时此字段必传。


示例值:TCP
Description String

描述信息。

默认值:默认值为空,代表不配置描述信息。

最大长度不能超过100个字节。


示例值:description
CheckPort String

检查端口。

入参限制:范围是1-65535。

当CheckType为CUSTOM时候,此字段必传。


示例值:10
ContextType String

检查内容。支持配置'TEXT'。

枚举值:

  • TEXT: 文本内容。

当CheckType为CUSTOM时候,此字段必传。


示例值:check_type_test
CheckSendContext String

检查请求。

入参限制:字节长度要在1-500范围内。

当CheckType为CUSTOM时候,此字段必传。


示例值:check_send_context_test
CheckRecvContext String

检查返回结果。

入参限制:字节长度要在1-500范围内。

当CheckType为CUSTOM时候,此字段必传。


示例值:check_recv_context_test
EnableHealthCheck Boolean

是否开启健康检查。

默认值:False


示例值:true
ConnectTimeout Integer

响应超时时间。

取值范围:[1, 100]

默认值:2

开启健康检查时,此字段必传。


示例值:10
HealthCheckInterval Integer

健康检查间隔。

取值范围:[5, 300]

默认值:30

开启健康检查,此字段必传。


示例值:10
UnhealthyThreshold Integer

不健康阀值。

取值范围:[1, 10]

默认值:3

开启健康检查,此字段必传。


示例值:10
HealthyThreshold Integer

健康阈值。

取值范围:[1, 10]

默认值:3

开启健康检查,此字段必传。


示例值:10
ForwardProtocol String

回源协议。支持配置'HTTP', 'HTTPS'。

枚举值:

  • HTTP: HTTP回源;当终端节点组所在监听器协议是HTTP或HTTPS时可以配置HTTP。
  • HTTPS: HTTPS回源;当终端节点组所在监听器协议是HTTPS时可以配置HTTPS。

当终端节点组所在监听器协议为HTTP或HTTPS时候,此字段必传。


示例值:HTTP
CheckDomain String

检查域名。

入参限制:字节长度范围是3-80。

当CheckType是HTTP时,此字段必传。


示例值:www.ccc.com
CheckPath String

检查URL。

参数格式:必须满足正则:^[a-zA-Z0-9_.-/]{1,80}$

当CheckType是HTTP时,此字段必传。


示例值:/path
CheckMethod String

请求方式。支持配置'GET', 'HEAD'。

枚举值:

  • GET: 请求方式为GET。
  • HEAD: 请求方式为HEAD。

当CheckType是HTTP时,此字段必传。


示例值:GET
StatusMask Array of String

状态检测码。支持配置'http_2xx', 'http_3xx', 'http_4xx', 'http_5xx'。

枚举值:

  • http_2xx: 2开头的http code。
  • http_3xx: 3开头的http code。
  • http_4xx: 4开头的http code。
  • http_5xx: 5开头的http code。

当CheckType是HTTP时,此字段必传。


示例值:["http_2xx"]
PortOverrides Array of PortOverride

端口映射。

入参限制:七层支持1个端口映射,四层支持最多30个端口映射。

IspType String

运营商类型。支持配置'CMCC', 'CTCC', 'CUCC'。

枚举值:

  • CMCC: 中国移动
  • CUCC: 中国联通
  • CTCC: 中国电信

当终端节点组地域为三网地域时,此字段必传。


示例值:CMCC
CipherPolicyId String

HPPTS加密算法套件;支持配置'tls_policy_1.0-2', 'tls_policy_1.1-2', 'tls_policy_1.2', 'tls_policy_1.2_strict', 'tls_policy_1.2_strict-1.3';

枚举值:

  • tls_policy_1.0-2: 加密算法套件。
  • tls_policy_1.1-2: 加密算法套件。
  • tls_policy_1.2: 加密算法套件。
  • tls_policy_1.2_strict: 加密算法套件。
  • tls_policy_1.2_strict-1.3: 加密算法套件。

当回源协议为HTTPS,此字段必传。


示例值:tls_policy_1.0-2
HttpVersion String

回源协议。支持配置'HTTP/1.1', 'HTTP/2'。

枚举值:

  • HTTP/1.1: 版本HTTP/1.1
  • HTTP/2: 版本HTTP/2

当回源协议为HTTPS时,此字段必传。


示例值:HTTP/2

EndpointGroupConfigurationSet

终端节点组信息

被如下接口引用:DescribeEndpointGroups。

名称 类型 描述
GlobalAcceleratorId String

全球加速实例ID。


示例值:ga-shj492kj
ListenerId String

监听器实例ID。


示例值:listener-shj492kj
EndpointGroupId String

终端节点组ID。


示例值:epg-shj492kj
Name String

名称。


示例值:name
EndpointGroupRegion String

地域。


示例值:ap-guangzhou
Description String

描述。


示例值:description
EndpointConfigurations Array of EndpointConfigurations

终端节点信息。

EnableHealthCheck Boolean

是否开启健康检查。


示例值:true
ConnectTimeout Integer

响应超时时间。


示例值:10
HealthCheckInterval Integer

健康检查间隔。


示例值:12
UnhealthyThreshold Integer

不健康阈值。


示例值:12
HealthyThreshold Integer

健康阈值。


示例值:12
CheckType String

检查协议。


示例值:TCP
CheckPort Integer

检查端口。


示例值:12
ContextType String

检查内容。


示例值:asdg12
CheckSendContext String

检查请求。


示例值:sdjsd
CheckRecvContext String

检查返回结果。


示例值:/sdjsd
CheckDomain String

检查域名。


示例值:/asld
CheckPath String

检查URL。


示例值:/asld
CheckMethod String

请求方式。


示例值:GET
StatusMask Array of String

状态检测码。


示例值:["http_2xx"]
EndpointGroupType String

终端节点组类型。


示例值:DEFAULT
ForwardProtocol String

回源协议。


示例值:HTTP
PortOverrides Array of PortOverride

端口映射信息。

VirtualExistForwardingRuleFlag Boolean

自定义终端节点组是否绑定七层转发规则。


示例值:false
OriginPublicIps Array of String

出终端节点组公网IP。


示例值:["101.42.53.111"]
IspType String

运营商类型;中国移动(CMCC),中国联通(CUCC),中国电信(CTCC)。


示例值:CMCC
CipherPolicyId String

HPPTS加密算法套件


示例值:tls_policy_1.1-2
HttpVersion String

仅HTTPS回源协议支持选择['HTTP/1.1', 'HTTP/2']

枚举值:

  • HTTP/1.1: 版本HTTP/1.1
  • HTTP/2: 版本HTTP/2

示例值:HTTP/2

Filter

过滤器

被如下接口引用:DescribeEndpointGroups, DescribeGlobalAccelerators, DescribeListeners。

名称 类型 必选 描述
Name String 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
示例值:ga-name
Values Array of String 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。当值类型为布尔类型时,可直接取值为字符串"TRUE"或 "FALSE"。
示例值:["ga-A"]

ForwardingPolicySet

七层转发策略信息

被如下接口引用:DescribeForwardingPolicy。

名称 类型 描述
GlobalAcceleratorId String 全球加速实例ID。
示例值:ga-dz058dxi
ListenerId String 监听器ID。
示例值:lsr-io48ae1d
ForwardingPolicyId String 策略ID。
示例值:dm-00000ju6
Host String 域名。
示例值:www.979137.com
DefaultHostFlag Boolean 是否为默认域名。
示例值:True

ForwardingRuleSet

七层转发规则信息

被如下接口引用:DescribeForwardingRule。

名称 类型 描述
RuleCondition Array of RuleCondition 七层转发规则条件信息。
RuleAction Array of RuleAction 七层转发规则行为信息。
EnableOriginSni Boolean 是否开启回源Sni。
OriginSni String 回源Sni。
OriginHeaders Array of OriginHeader 回源Herder信息。
OriginHost String 回源Host。
GlobalAcceleratorId String 全球加速实例ID。
示例值:ga-80bzejka
ListenerId String 监听器ID。
示例值:lsr-nd3qmz7h
ForwardingPolicyId String 七层转发策略ID。
示例值:dm-kzk3neks
ForwardingRuleId String 七层转发规则ID。
示例值:rule-5lybgwaw

GlobalAcceleratorSet

全球加速实例信息

被如下接口引用:DescribeGlobalAccelerators。

名称 类型 描述
GlobalAcceleratorId String

全球加速实例ID。


示例值:ga-xfg498km
Name String

全球加速实例名称。


示例值:name
Description String

全球加速实例描述。


示例值:description
CreateTime String

全球加速实例创建时间。


示例值:2025-01-12 17:16:52
State String

全球加速实例状态。


示例值:ACTIVE
InstanceChargeType String

全球加速实例付费类型。


示例值:POSTPAID
DdosId String

全球加速实例DdosId。


示例值:xfg498km
ListenerCounts Integer

所属加速实例监听器个数。


示例值:1
AcceleratorAreaCounts Integer

所属加速实例加速地域个数。


示例值:1
Status String

全球加速实例状态。


示例值:ACTIVE
Cname String

域名。


示例值:a-cr2dpapy-dev.gaapacc020.com.cn
CrossBorderType String

跨境类型;HighQuality(精品跨境)、Unicom(联通跨境)、NotAvailable(未开通)。


注意:此字段可能返回 null,表示取不到有效值。
示例值:HighQuality
TagSet Array of Tag

标签信息。

HideResponseHeaders

隐藏Header

被如下接口引用:CreateForwardingRule, ModifyForwardingRule。

名称 类型 必选 描述
Key String

key

入参限制:长度不能超过128

如果字符串包含$,那仅能配置'$remote_addr', '$remote_port',否则不支持。


示例值:key-2
Value String

value

当前传''值即可。


示例值:value-2

IpAddressInfoSet

加速地域公网IP信息

被如下接口引用:CreateAccelerateAreas, DescribeAccelerateAreas, ModifyAccelerateAreas。

名称 类型 必选 描述
IpAddress String

IP地址。


示例值:1.1.1.1
IspType String

IP类型。


示例值:BGP
DdosProtectionType String

Ddos类型


示例值:Basic

ListenerSet

监听器信息

被如下接口引用:DescribeListeners。

名称 类型 描述
GlobalAcceleratorId String 全球加速实例ID。
示例值:ga-sjk45jnn
ListenerId String 监听器ID。
示例值:listener-sjk45jnn
Name String 监听器名称。
示例值:name
Description String 监听器描述。
示例值:description
Protocol String 协议。
示例值:TCP
PortRanges PortRanges 端口范围。
XForwardedForRealIp Boolean 是否打开七层获取源IP方式。
示例值:True
ClientAffinity String 开启会话保持。
示例值:Open
ClientAffinityTime Integer 会话保持时间。
示例值:10
CertificationType String SSL解析方式。
示例值:UNIDIRECTIONAL
ServerCertificates Array of String 服务器证书。
ClientCaCertificates Array of String 客户端证书。
CipherPolicyId String TLS密码套件包。
示例值:tls_cipher_policy_1_0
HttpVersion String HTTP版本。
示例值:HTTP3
RequestTimeout Integer 请求超时时间。
示例值:1
CreateTime String 创建时间。
示例值:2025-03-09 17:48:54
ListenerType String 监听路由类型。
示例值:Standard
Status String 监听器状态。
示例值:ACTIVE
EndpointGroupCounts Integer 所属监听器终端节点组个数。
示例值:2
GetRealIpType String 四层获取源IP方式。
示例值:ProxyProtocol
IdleTimeout Integer 连接超时时间。
示例值:15

OriginHeader

回源Header信息

被如下接口引用:CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule。

名称 类型 必选 描述
Key String

键。

参数格式:1、字符串只包含可打印的ASCII字符 2、不能包含这些字符()<>@,;:"/[ ]?={ }

入参限制:长度在1-40。


注意:此字段可能返回 null,表示取不到有效值。
示例值:key
Value String

值。

入参限制:长度不能超过128

如果字符串包含$,那仅能配置'$remote_addr', '$remote_port',否则不支持。


注意:此字段可能返回 null,表示取不到有效值。
示例值:value

PortOverride

端口映射

被如下接口引用:CreateEndpointGroup, DescribeEndpointGroups, ModifyEndpointGroup。

名称 类型 必选 描述
ListenerPort Integer 监听端口。
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
EndpointPort Integer 映射端口。
注意:此字段可能返回 null,表示取不到有效值。
示例值:13

PortRanges

端口范围

被如下接口引用:CreateListener, DescribeListeners。

名称 类型 必选 描述
FromPort Integer 起始端口。
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
ToPort Integer 终点端口。
注意:此字段可能返回 null,表示取不到有效值。
示例值:21

ResponseHeaders

响应Header

被如下接口引用:CreateForwardingRule, ModifyForwardingRule。

名称 类型 必选 描述
Key String

key

参数格式:1、字符串只包含可打印的ASCII字符 2、不能包含这些字符()<>@,;:"/[ ]?={ }

入参限制:长度在1-40。


示例值:key-1
Value String

value

入参限制:长度不能超过128

如果字符串包含$,那仅能配置'$remote_addr', '$remote_port',否则不支持。


示例值:value-1

RuleAction

七层转发规则行为信息

被如下接口引用:CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule。

名称 类型 必选 描述
RuleActionType String

七层转发规则行为类型

枚举值:

  • ForwardGroup: 转发策略为转发至终端节点组。
  • Drop: 转发策略为丢弃。

注意:此字段可能返回 null,表示取不到有效值。
示例值:Drop
RuleActionValue String

七层转发规则行为值

当RuleActionType是Drop时,此字段不用传;当RuleActionType是ForwardGroup时,此字段必传,需要填写的是自定义终端节点组ID, 不支持配置默认终端节点组。


注意:此字段可能返回 null,表示取不到有效值。
示例值:epg-80c0umq4

RuleCondition

七层转发规则条件信息

被如下接口引用:CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule。

名称 类型 必选 描述
RuleConditionType String

七层转发规则条件类型

枚举值:

  • Path: Path

注意:此字段可能返回 null,表示取不到有效值。
示例值:Path
RuleConditionValue Array of String

七层转发规则条件值

参数格式:格式必须满足正则表达:^[a-zA-Z0-9_.-/]{1,80}$

数组长度不能超过1。


注意:此字段可能返回 null,表示取不到有效值。
示例值:["/a"]

Tag

标签键值对

被如下接口引用:CreateGlobalAccelerator, DescribeGlobalAccelerators。

名称 类型 必选 描述
Key String 标签键
示例值:tag-key
Value String 标签值
示例值:tag-value