AccessConfiguration
通道组加速地域列表，包括加速地域，以及该加速地域对应的带宽和并发配置。
被如下接口引用：CreateProxyGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AccessRegion | String | 是 | 加速地域。 示例值：EastChina |
| Bandwidth | Integer | 是 | 通道带宽上限，单位：Mbps。 示例值：10 |
| Concurrent | Integer | 是 | 通道并发量上限，表示同时在线的连接数，单位：万。 示例值：2 |
| NetworkType | String | 否 | 网络类型，可取值：normal、cn2，默认值为normal 示例值：normal |
AccessRegionDetial
根据源站查询的可用加速区域信息及对应的可选带宽和并发量。
被如下接口引用：DescribeAccessRegionsByDestRegion。
| 名称 | 类型 | 描述 |
|---|---|---|
| RegionId | String | 区域ID 示例值：NorthChina |
| RegionName | String | 区域的中文或英文名称 示例值：中国大陆-华东 |
| ConcurrentList | Array of Integer | 可选的并发量取值数组 示例值：[2, 5, 10, 20, 30] |
| BandwidthList | Array of Integer | 可选的带宽取值数组 示例值：[10, 20, 50, 100, 200, 500, 1000] |
| RegionArea | String | 机房所属大区 示例值：NorthChina |
| RegionAreaName | String | 机房所属大区名 示例值：中国大陆-华北 |
| IDCType | String | 机房类型, dc表示DataCenter数据中心, ec表示EdgeComputing边缘节点 示例值：dc |
| FeatureBitmap | Integer | 特性位图，每个bit位代表一种特性，其中： 0，表示不支持该特性； 1，表示支持该特性。 特性位图含义如下（从右往左）： 第1个bit，支持4层加速； 第2个bit，支持7层加速； 第3个bit，支持Http3接入； 第4个bit，支持IPv6； 第5个bit，支持精品BGP接入； 第6个bit，支持三网接入； 第7个bit，支持接入段Qos加速。 示例值：3 |
AccessRegionDomainConf
域名就近接入配置
被如下接口引用：ModifyGroupDomainConfig。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RegionId | String | 是 | 地域ID。 示例值：ap-guangzhou |
| NationCountryInnerList | Array of String | 否 | 就近接入区域国家内部编码，编码列表可通过DescribeCountryAreaMapping接口获取。 示例值：["101001", "101002"] |
BandwidthPriceGradient
带宽梯度价格
被如下接口引用：DescribeRegionAndPrice, InquiryPriceCreateProxy。
| 名称 | 类型 | 描述 |
|---|---|---|
| BandwidthRange | Array of Integer | 带宽范围。 示例值：[0,20] |
| BandwidthUnitPrice | Float | 在对应带宽范围内的单宽单价，单位：元/Mbps/天。 示例值：130 |
| DiscountBandwidthUnitPrice | Float | 带宽折扣价，单位：元/Mbps/天。 示例值：130 |
BindRealServer
已绑定的源站信息
被如下接口引用：DescribeListenerRealServers, DescribeRuleRealServers, DescribeRules, DescribeRulesByRuleIds, DescribeTCPListeners, DescribeUDPListeners。
| 名称 | 类型 | 描述 |
|---|---|---|
| RealServerId | String | 源站ID 示例值：rs-123456 |
| RealServerIP | String | 源站IP或者域名 示例值：192.168.1.1 |
| RealServerWeight | Integer | 该源站所占权重 示例值：1 |
| RealServerStatus | Integer | 源站健康检查状态，其中： 0表示正常； 1表示异常。 未开启健康检查状态时，该状态始终为正常。 示例值：1 |
| RealServerPort | Integer | 源站的端口号 示例值：443 |
| DownIPList | Array of String | 当源站为域名时，域名被解析成一个或者多个IP，该字段表示其中异常的IP列表。状态异常，但该字段为空时，表示域名解析异常。 示例值：["127.0.0.1"] |
| RealServerFailoverRole | String | 源站主备角色：master表示主，slave表示备，该参数必须在监听器打开了源站主备模式。 示例值：master |
BindRealServerInfo
添加源站的源站信息返回值
被如下接口引用：DescribeRealServers。
| 名称 | 类型 | 描述 |
|---|---|---|
| RealServerIP | String | 源站的IP或域名 示例值：192.168.1.2 |
| RealServerId | String | 源站ID 示例值：rs-1234abcd |
| RealServerName | String | 源站名称 示例值：rs_name |
| ProjectId | Integer | 项目ID 示例值：0 |
| TagSet | Array of TagPair | 标签列表 示例值：[{TagKey: "test-john-22", TagValue: "test46-01"}] |
Certificate
服务器证书
被如下接口引用：DescribeCertificates。
| 名称 | 类型 | 描述 |
|---|---|---|
| CertificateId | String | 证书ID 示例值：cert-qk6jviq9 |
| CertificateName | String | 证书名称（旧参数，请使用CertificateAlias）。 示例值：cert_name |
| CertificateType | Integer | 证书类型。 示例值：2 |
| CertificateAlias | String | 证书名称。 示例值：cert-name |
| CreateTime | Integer | 证书创建时间，采用Unix时间戳的方式，表示从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数。 示例值：1729242858 |
| BeginTime | Integer | 证书生效起始时间，采用Unix时间戳的方式，表示从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数。 示例值：1565637579 |
| EndTime | Integer | 证书过期时间，采用Unix时间戳的方式，表示从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数。 示例值：1880997579 |
| IssuerCN | String | 证书签发者通用名称。 示例值：issuer-cn |
| SubjectCN | String | 证书主题通用名称。 示例值：server ssl |
CertificateAliasInfo
证书别名信息
被如下接口引用：DescribeHTTPSListeners, DescribeRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| CertificateId | String | 证书ID 示例值：cert-qk6jviq9 |
| CertificateAlias | String | 证书别名 示例值：alias_name |
CertificateDetail
证书详情，包括证书ID， 证书名字，证书类型，证书内容以及密钥内容。
被如下接口引用：DescribeCertificateDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| CertificateId | String | 证书ID。 示例值：cert-qk6jviq9 |
| CertificateType | Integer | 证书类型。 示例值：2 |
| CertificateAlias | String | 证书名字。 示例值：cert-alias |
| CertificateContent | String | 证书内容。 示例值：Cert-Content |
| CertificateKey | String | 密钥内容。仅当证书类型为SSL证书时，返回该字段。 示例值：Cert-Key |
| CreateTime | Integer | 创建时间，采用Unix时间戳的方式，表示从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数。 示例值：1729242858 |
| BeginTime | Integer | 证书生效起始时间，采用Unix时间戳的方式，表示从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数。 示例值：1565637579 |
| EndTime | Integer | 证书过期时间，采用Unix时间戳的方式，表示从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数。 示例值：1880997579 |
| IssuerCN | String | 证书签发者通用名称。 示例值：cn-name |
| SubjectCN | String | 证书主题通用名称。 示例值：server ssl |
CountryAreaMap
国家地区映射关系（名称和编码）
被如下接口引用：DescribeCountryAreaMapping, DescribeGlobalDomainDns。
| 名称 | 类型 | 描述 |
|---|---|---|
| NationCountryName | String | 国家名称。 示例值：华北地区 |
| NationCountryInnerCode | String | 国家编码。 示例值：101001 |
| GeographicalZoneName | String | 地区名称。 示例值：东亚 |
| GeographicalZoneInnerCode | String | 地区编码。 示例值：101000 |
| ContinentName | String | 大洲名称。 示例值：亚洲 |
| ContinentInnerCode | String | 大洲编码。 示例值：100000 |
| Remark | String | 标注信息 示例值：华北地区（包括北京、天津、河北、山西、内蒙古） |
Domain
统一域名信息
被如下接口引用：DescribeGlobalDomains。
| 名称 | 类型 | 描述 |
|---|---|---|
| DomainId | String | 域名ID 示例值：dm-12345 |
| FullDomain | String | 完整域名记录 示例值：www.test.com |
| Alias | String | 别名 示例值：domai-alias |
| Type | String | 类型 示例值：IP |
| Status | Integer | 状态，1表示关闭，0表示开启，2表示关闭中，3表示开启中 示例值：1 |
| ProjectId | Integer | 所属项目 示例值：0 |
| DefaultValue | String | 默认入口 示例值：127.0.0.1 |
| ProxyCount | Integer | 通道数量 示例值：2 |
| CreateTime | Integer | 创建时间，使用UNIX时间戳 示例值：1716065151 |
| UpdateTime | Integer | 更新时间，使用UNIX时间戳 注意：此字段可能返回 null，表示取不到有效值。 示例值：1716065151 |
| TagSet | Array of TagPair | 标签列表 示例值：[{"TagKey":"tag-key", "TagValue":"tag-value"}] |
| BanStatus | String | 封禁解封状态：BANNED表示已封禁，RECOVER表示已解封或未封禁，BANNING表示封禁中，RECOVERING表示解封中，BAN_FAILED表示封禁失败，RECOVER_FAILED表示解封失败。 示例值：RECOVER |
DomainAccessRegionDict
域名解析就近访问配置详情
被如下接口引用：DescribeGroupDomainConfig。
| 名称 | 类型 | 描述 |
|---|---|---|
| NationCountryInnerList | Array of NationCountryInnerInfo | 就近接入区域 示例值：["101001"] |
| ProxyList | Array of ProxyIdDict | 加速区域通道列表 示例值：[{"ProxyId": "link-f24qdw21"}] |
| RegionId | String | 加速区域ID 示例值：ap-beijing |
| GeographicalZoneInnerCode | String | 加速区域内部编码 示例值：101000 |
| ContinentInnerCode | String | 加速区域所属大洲内部编码 示例值：100000 |
| RegionName | String | 加速区域别名 示例值：中国大陆-华北 |
DomainErrorPageInfo
域名的定制错误响应配置
被如下接口引用：DescribeDomainErrorPageInfo, DescribeDomainErrorPageInfoByIds。
| 名称 | 类型 | 描述 |
|---|---|---|
| ErrorPageId | String | 错误定制响应的配置ID 示例值：errorPage-849daqt3 |
| ListenerId | String | 监听器ID 示例值：listener-p0cp5ier |
| Domain | String | 域名 示例值：borisautotestdomaincerts001.com |
| ErrorNos | Array of Integer | 原始错误码 示例值：501|404 |
| NewErrorNo | Integer | 新的错误码 示例值：560 |
| ClearHeaders | Array of String | 需要清理的响应头 示例值：{"Response": {"test res Body"}} |
| SetHeaders | Array of HttpHeaderParam | 需要设置的响应头 示例值：{"X-TEST": "test"} |
| Body | String | 设置的响应体(不包括 HTTP头) 示例值：["X-TEST", "Content-Length"] |
| Status | Integer | 规则状态,0为成功 示例值：0 |
DomainRuleSet
按照域名分类的7层监听器转发规则信息
被如下接口引用：DescribeRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| Domain | String | 转发规则域名。 示例值：www.domain.com |
| RuleSet | Array of RuleInfo | 该域名对应的转发规则列表。 |
| CertificateId | String | 该域名对应的服务器证书ID，值为default时，表示使用默认证书（监听器配置的证书）。 示例值：cert-12345 |
| CertificateAlias | String | 该域名对应服务器证书名称。 示例值：cert-alias |
| ClientCertificateId | String | 该域名对应的客户端证书ID，值为default时，表示使用默认证书（监听器配置的证书）。 示例值：cert-54321 |
| ClientCertificateAlias | String | 该域名对应客户端证书名称。 示例值：cert-alias |
| BasicAuthConfId | String | 该域名对应基础认证配置ID。 示例值：base-auth |
| BasicAuth | Integer | 基础认证开关，其中： 0，表示未开启； 1，表示已开启。 示例值：0 |
| BasicAuthConfAlias | String | 该域名对应基础认证配置名称。 示例值：base-alias |
| RealServerCertificateId | String | 该域名对应源站认证证书ID。 示例值：cert-12345 |
| RealServerAuth | Integer | 源站认证开关，其中： 0，表示未开启； 1，表示已开启。 示例值：0 |
| RealServerCertificateAlias | String | 该域名对应源站认证证书名称。 示例值：cert-12345 |
| GaapCertificateId | String | 该域名对应通道认证证书ID。 示例值：cert-12345 |
| GaapAuth | Integer | 通道认证开关，其中： 0，表示未开启； 1，表示已开启。 示例值：0 |
| GaapCertificateAlias | String | 该域名对应通道认证证书名称。 示例值：cert-alias |
| RealServerCertificateDomain | String | 源站认证域名。 示例值：www.domain.com |
| PolyClientCertificateAliasInfo | Array of CertificateAliasInfo | 多客户端证书时，返回多个证书的id和别名 |
| PolyRealServerCertificateAliasInfo | Array of CertificateAliasInfo | 多源站证书时，返回多个证书的id和别名 |
| DomainStatus | Integer | 域名的状态。 0表示运行中， 1表示变更中， 2表示删除中。 示例值：0 |
| BanStatus | String | 封禁解封状态：BANNED表示已封禁，RECOVER表示已解封或未封禁，BANNING表示封禁中，RECOVERING表示解封中，BAN_FAILED表示封禁失败，RECOVER_FAILED表示解封失败。 示例值：RECOVER |
| Http3Supported | Integer | Http3特性标识，其中： 0表示关闭； 1表示启用。 示例值：0 |
| IsDefaultServer | Boolean | 是否为默认域名 示例值：true |
| TLSCiphers | String | TLS套件包 示例值：GAAP_TLS_CIPHERS_WIDE |
| TLSSupportVersion | Array of String | TLS版本 示例值：["TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3"] |
Filter
过滤条件
被如下接口引用：DescribeGlobalDomains, DescribeProxies, DescribeProxyGroupList, DescribeRealServers。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤条件 示例值：name |
| Values | Array of String | 是 | 过滤值 示例值：value |
GlobalDns
统一域名解析的DNS记录
被如下接口引用：DescribeGlobalDomainDns。
| 名称 | 类型 | 描述 |
|---|---|---|
| DnsRecordId | Integer | 解析记录ID 示例值：1 |
| CountryAreaList | Array of CountryAreaMap | 域名就近接入地域信息列表 示例值：[] |
| AccessList | Array of ProxyAccessInfo | 域名解析对应的通道接入点信息列表 示例值：[] |
| Status | Integer | 解析状态：1表示运行中，2表示创建中，3表示修改中，4表示删除中 示例值：1 |
GroupStatisticsInfo
可以显示统计数据的通道组和对应通道信息
被如下接口引用：DescribeGroupAndStatisticsProxy。
| 名称 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 通道组ID 示例值：lg-2sczm0nv |
| GroupName | String | 通道组名称 示例值：group_name |
| ProxySet | Array of ProxySimpleInfo | 通道组下通道列表 示例值：[{"ProxyId": "link-12sw13an", "ProxyName": "test", "ListenerList": [{"ListenerId": "listener-21xqe24q"."ListenerName": "test", "Port": "7070", "Protocol": "TCP"}]}] |
HTTPListener
HTTP类型监听器信息
被如下接口引用：DescribeHTTPListeners。
| 名称 | 类型 | 描述 |
|---|---|---|
| ListenerId | String | 监听器ID 示例值：listener-015erzbt |
| ListenerName | String | 监听器名称 示例值：listener1 |
| Port | Integer | 监听器端口 示例值：80 |
| CreateTime | Integer | 监听器创建时间，Unix时间戳 示例值：1658235563 |
| Protocol | String | 监听器协议， HTTP表示HTTP，HTTPS表示HTTPS，此结构取值HTTP 示例值：HTTP |
| ListenerStatus | Integer | 监听器状态，其中： 0表示运行中； 1表示创建中； 2表示销毁中； 3表示源站调整中； 4表示配置变更中。 示例值：0 |
| ProxyId | String | 监听器的通道ID，如果监听器属于通道组，则为null 示例值：link-bjkpdum1 |
| GroupId | String | 监听器的通道组ID，如果监听器属于通道，则为null 注意：此字段可能返回 null，表示取不到有效值。 示例值：lg-qz6ntod5 |
HTTPSListener
HTTPS类型监听器信息
被如下接口引用：DescribeHTTPSListeners。
| 名称 | 类型 | 描述 |
|---|---|---|
| ListenerId | String | 监听器ID 示例值：listener-xxxx |
| ListenerName | String | 监听器名称 示例值：listener-name |
| Port | Integer | 监听器端口 示例值：443 |
| Protocol | String | 监听器协议， HTTP表示HTTP，HTTPS表示HTTPS，此结构取值HTTPS 示例值：HTTPS |
| ListenerStatus | Integer | 监听器状态，其中： 0表示运行中； 1表示创建中； 2表示销毁中； 3表示源站调整中； 4表示配置变更中。 示例值：0 |
| CertificateId | String | 监听器服务器SSL证书ID 示例值：cert-xxxx |
| ForwardProtocol | String | 监听器后端转发源站协议 示例值：HTTPS |
| CreateTime | Integer | 监听器创建时间，Unix时间戳 示例值：1661788772 |
| CertificateAlias | String | 服务器SSL证书的别名 示例值：testcert |
| ClientCertificateId | String | 监听器客户端CA证书ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cert-xxxx |
| AuthType | Integer | 监听器认证方式。其中， 0表示单向认证； 1表示双向认证。 示例值：0 |
| ClientCertificateAlias | String | 客户端CA证书别名 注意：此字段可能返回 null，表示取不到有效值。 示例值：testcert |
| PolyClientCertificateAliasInfo | Array of CertificateAliasInfo | 多客户端CA证书别名信息 示例值：null |
| Http3Supported | Integer | 是否支持Http3，其中： 0，不支持Http3接入； 1，持Http3接入。 注意：如果支持了Http3的功能，那么该监听器会占用对应的UDP接入端口，不可再创建相同端口的UDP监听器。 示例值：1 |
| ProxyId | String | 监听器的通道ID，如果监听器属于通道组，则为null 示例值：link-bjkpdum1 |
| GroupId | String | 监听器的通道组ID，如果监听器属于通道，则为null 注意：此字段可能返回 null，表示取不到有效值。 示例值：lg-qz6ntod5 |
| TLSSupportVersion | Array of String | 支持的TLS版本 示例值：['TLSv1.0', 'TLSv1.1'] |
| TLSCiphers | String | 支持的TLS密码套件 示例值：GAAP_TLS_CIPHERS_WIDE |
HttpHeaderParam
描述HTTP的包头参数
被如下接口引用：CreateCustomHeader, CreateDomainErrorPageInfo, DescribeCustomHeader, DescribeDomainErrorPageInfo, DescribeDomainErrorPageInfoByIds。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| HeaderName | String | 是 | HTTP头名 示例值：X-HTTP-TEST-HEADER |
| HeaderValue | String | 是 | HTTP头值 示例值：X-HTTP-TEST-VALUE |
IPDetail
ip信息详情
被如下接口引用：DescribeGlobalDomainDns, DescribeProxies, DescribeProxyDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IP | String | 是 | IP字符串 示例值："1.1.1.1" |
| Provider | String | 是 | 供应商，BGP表示默认，CMCC表示中国移动，CUCC表示中国联通，CTCC表示中国电信 示例值："CMCC" |
| Bandwidth | Integer | 是 | 带宽 示例值：3 |
ListenerInfo
内部接口使用，返回可以查询统计数据的监听器信息
被如下接口引用：DescribeProxyAndStatisticsListeners。
| 名称 | 类型 | 描述 |
|---|---|---|
| ListenerId | String | 监听器ID 示例值：listener-1sd42afc |
| ListenerName | String | 监听器名称 示例值：listener_name |
| Port | Integer | 监听器监听端口 示例值：8080 |
| Protocol | String | 监听器协议类型 示例值：TCP |
MetricStatisticsInfo
单指标的统计数据
被如下接口引用：DescribeListenerStatistics, DescribeProxyGroupStatistics, DescribeProxyStatistics, DescribeRealServerStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| MetricName | String | 指标名称 示例值：InBandwidth |
| MetricData | Array of StatisticsDataInfo | 指标统计数据 示例值：{ "MetricName": "InBandwidth", "MetricData": [ { "Time": 1735056000, "Data": 0 } ] } |
NationCountryInnerInfo
就近接入的国家地区详情
被如下接口引用：DescribeGroupDomainConfig。
| 名称 | 类型 | 描述 |
|---|---|---|
| NationCountryName | String | 国家名 示例值：中国大陆-华北 |
| NationCountryInnerCode | String | 国家内部编码 示例值：101001 |
NewRealServer
新添加源站信息
被如下接口引用：AddRealServers。
| 名称 | 类型 | 描述 |
|---|---|---|
| RealServerId | String | 源站ID 示例值：rs-nd046035 |
| RealServerIP | String | 源站ip或域名 示例值：192.168.1.2 |
ProxyAccessInfo
加速通道接入点详细信息(包含id、地域、ip等）
被如下接口引用：DescribeGlobalDomainDns。
| 名称 | 类型 | 描述 |
|---|---|---|
| RegionId | String | 地域ID 示例值："NorthChina" |
| RegionName | String | 地域名称 示例值："NorthChina" |
| ProxyId | String | 通道ID 示例值："link-xxxxx" |
| Vip | String | 通道接入ip 示例值："1.1.1.1" |
| VipList | Array of IPDetail | 三网通道VIP列表 |
| SourceRegionIdcType | String | 接入点IDC类型。ec或dc 示例值："DC" |
ProxyGroupDetail
通道组详情信息
被如下接口引用：DescribeProxyGroupDetails。
| 名称 | 类型 | 描述 |
|---|---|---|
| CreateTime | Integer | 创建时间 示例值：1735182500 |
| ProjectId | Integer | 项目ID 示例值：1000 |
| ProxyNum | Integer | 通道组中通道数量 示例值：1 |
| Status | Integer | 通道组状态： 0表示正常运行； 1表示创建中； 4表示销毁中； 11表示迁移中； 12表示部分部署中。 示例值：1 |
| OwnerUin | String | 归属Uin 示例值：100100 |
| CreateUin | String | 创建Uin 示例值：100100 |
| GroupName | String | 通道名称 示例值：Test |
| DnsDefaultIp | String | 通道组域名解析默认IP 示例值：1.1.1.1 |
| Domain | String | 通道组域名 注意：此字段可能返回 null，表示取不到有效值。 示例值：link-test.gaapqcloud.com |
| RealServerRegionInfo | RegionDetail | 目标地域 示例值：EastChina |
| IsOldGroup | Boolean | 是否老通道组，2018-08-03之前创建的通道组为老通道组 示例值：false |
| GroupId | String | 通道组ID 示例值：lg-123456 |
| TagSet | Array of TagPair | 标签列表 示例值：[{"TagKey":"tag_key"}, {"TagValue":"tag_value"}] |
| PolicyId | String | 安全策略ID，当设置了安全策略时，存在该字段。 示例值：gsp-123456 |
| Version | String | 通道组版本 示例值："1.0" |
| ClientIPMethod | Array of Integer | 通道获取客户端IP的方式，0表示TOA，1表示Proxy Protocol 示例值：1 |
| IPAddressVersion | String | IP版本，可取值：IPv4、IPv6，默认值IPv4 示例值：IPv4 |
| PackageType | String | 通道组套餐类型：Thunder表示标准通道组，Accelerator表示银牌加速通道组，CrossBorder表示跨境通道组。 示例值：Thunder |
| Http3Supported | Integer | 支持Http3特性的标识，其中： 0表示关闭； 1表示启用。 示例值：0 |
| FeatureBitmap | Integer | 特性位图，每个bit位代表一种特性，其中： 0，表示不支持该特性； 1，表示支持该特性。 特性位图含义如下（从右往左）： 第1个bit，支持4层加速； 第2个bit，支持7层加速； 第3个bit，支持Http3接入； 第4个bit，支持IPv6； 第5个bit，支持精品BGP接入； 第6个bit，支持三网接入； 第7个bit，支持接入段Qos加速。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| IsSupportTLSChoice | Integer | 是否支持设置TLS设置 0表示不支持； 1表示支持。 示例值：0 |
ProxyGroupInfo
通道组详情列表
被如下接口引用：DescribeProxyGroupList。
| 名称 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 通道组id 示例值：lg-xx |
| Domain | String | 通道组域名 注意：此字段可能返回 null，表示取不到有效值。 示例值：lg-xx.com |
| GroupName | String | 通道组名称 示例值："group-name" |
| ProjectId | Integer | 项目ID 示例值：10000 |
| RealServerRegionInfo | RegionDetail | 目标地域 |
| Status | String | 通道组状态。 其中， RUNNING表示运行中； CREATING表示创建中； DESTROYING表示销毁中； MOVING表示通道迁移中； CLOSED表示已关闭； CHANGING表示部分部署中。 示例值：0 |
| TagSet | Array of TagPair | 标签列表。 |
| Version | String | 通道组版本 示例值：1.0 |
| CreateTime | Integer | 创建时间 示例值：1716065151 |
| ProxyType | Integer | 通道组是否包含微软通道 示例值：1 |
| Http3Supported | Integer | 支持Http3特性的标识，其中： 0表示关闭； 1表示启用。 示例值：0 |
| FeatureBitmap | Integer | 特性位图，每个bit位代表一种特性，其中： 0，表示不支持该特性； 1，表示支持该特性。 特性位图含义如下（从右往左）： 第1个bit，支持4层加速； 第2个bit，支持7层加速； 第3个bit，支持Http3接入； 第4个bit，支持IPv6； 第5个bit，支持精品BGP接入； 第6个bit，支持三网接入； 第7个bit，支持接入段Qos加速。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
ProxyIdDict
通道ID
被如下接口引用：DescribeGroupDomainConfig。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ProxyId | String | 是 | 通道ID 示例值：link-qr31dfs1 |
ProxyInfo
通道信息
被如下接口引用：DescribeProxies, DescribeProxyDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | （旧参数，请使用ProxyId）通道实例ID。 示例值："link-12345" |
| CreateTime | Integer | 创建时间，采用Unix时间戳的方式，表示从1970年1月1日（UTC/GMT的午夜）开始所经过的秒数。 示例值：1619166542 |
| ProjectId | Integer | 项目ID。 示例值：0 |
| ProxyName | String | 通道名称。 示例值："test" |
| AccessRegion | String | 接入地域。 示例值："EastChina" |
| RealServerRegion | String | 源站地域。 示例值："SouthChina" |
| Bandwidth | Integer | 带宽，单位：Mbps。 示例值：10 |
| Concurrent | Integer | 并发，单位：万个/秒。 示例值：2 |
| Status | String | 通道状态。其中： RUNNING表示运行中； CREATING表示创建中； DESTROYING表示销毁中； OPENING表示开启中； CLOSING表示关闭中； CLOSED表示已关闭； ADJUSTING表示配置变更中； ISOLATING表示隔离中； ISOLATED表示已隔离； CLONING表示复制中； RECOVERING表示通道维护中； MOVING表示迁移中。 示例值："RUNNING" |
| Domain | String | 接入域名。 示例值："link-xxx.gaapqcloud.com" |
| IP | String | 接入IP。 示例值：159.75.1.1 |
| Version | String | 通道版本号：1.0，2.0，3.0。 示例值："3.0" |
| ProxyId | String | （新参数）通道实例ID。 示例值："link-xxx" |
| Scalarable | Integer | 1，该通道可缩扩容；0，该通道无法缩扩容。 示例值：1 |
| SupportProtocols | Array of String | 支持的协议类型。 示例值：["TCP","UDP"] |
| GroupId | String | 通道组ID，当通道归属于某一通道组时，存在该字段。 注意：此字段可能返回 null，表示取不到有效值。 示例值："lg-123456" |
| PolicyId | String | 安全策略ID，当设置了安全策略时，存在该字段。 注意：此字段可能返回 null，表示取不到有效值。 示例值："sp-xxx" |
| AccessRegionInfo | RegionDetail | 接入地域详细信息，包括地域ID和地域名。 示例值：{"RegionId":"NorthChina"}"} |
| RealServerRegionInfo | RegionDetail | 源站地域详细信息，包括地域ID和地域名。 示例值：{"RegionId":"SouthChina"}"} |
| ForwardIP | String | 通道转发IP 示例值：”1.1.1.1;1.1.1.2" |
| TagSet | Array of TagPair | 标签列表，不存在标签时，该字段为空列表。 |
| SupportSecurity | Integer | 是否支持安全组配置 示例值：1 |
| BillingType | Integer | 计费类型: 0表示按带宽计费 1表示按流量计费。 示例值：0 |
| RelatedGlobalDomains | Array of String | 关联了解析的域名列表 示例值：www.test.com |
| ModifyConfigTime | Integer | 配置变更时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1617265920 |
| ProxyType | Integer | 通道类型，100表示THUNDER通道，103表示微软合作通道 示例值：100 |
| ClientIPMethod | Array of Integer | 通道获取客户端IP的方式，0表示TOA，1表示Proxy Protocol 示例值：0 |
| IPAddressVersion | String | IP版本：IPv4、IPv6 示例值："IPV4" |
| NetworkType | String | 网络类型：normal表示常规BGP，cn2表示精品BGP，triple表示三网，secure_eip表示定制安全EIP 示例值："normal" |
| PackageType | String | 通道套餐类型：Thunder表示标准通道，Accelerator表示银牌加速通道， CrossBorder表示跨境通道。 示例值：Thunder |
| BanStatus | String | 封禁解封状态：BANNED表示已封禁，RECOVER表示已解封或未封禁，BANNING表示封禁中，RECOVERING表示解封中，BAN_FAILED表示封禁失败，RECOVER_FAILED表示解封失败。 示例值：RECOVER |
| IPList | Array of IPDetail | IP列表 示例值：[{"ip": "1.2.3.4"}] |
| Http3Supported | Integer | 支持Http3协议的标识，其中： 0表示关闭； 1表示启用。 示例值：0 |
| InBanBlacklist | Integer | 是否在封禁黑名单中，其中：0表示不在黑名单中，1表示在黑名单中。 示例值：0 |
| FeatureBitmap | Integer | 特性位图，每个bit位代表一种特性，其中： 0，表示不支持该特性； 1，表示支持该特性。 特性位图含义如下（从右往左）： 第1个bit，支持4层加速； 第2个bit，支持7层加速； 第3个bit，支持Http3接入； 第4个bit，支持IPv6； 第5个bit，支持精品BGP接入； 第6个bit，支持三网接入； 第7个bit，支持接入段Qos加速。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| IsAutoScaleProxy | Integer | 是否是开启了auto scale的通道，0表示否，1表示是。 示例值：0 |
| IsSupportTLSChoice | Integer | 是否允许设置TLS配置 0表示不支持； 1表示支持。 示例值：0 |
ProxySimpleInfo
内部接口使用，返回可以查询统计数据的通道和对应的监听器信息
被如下接口引用：DescribeGroupAndStatisticsProxy, DescribeProxyAndStatisticsListeners。
| 名称 | 类型 | 描述 |
|---|---|---|
| ProxyId | String | 通道ID 示例值：link-1mfs42fq |
| ProxyName | String | 通道名称 示例值：proxy_name |
| ListenerList | Array of ListenerInfo | 监听器列表 示例值：[{"ProxyId": "link-12sw13an", "ProxyName": "test", "ListenerList": [{"ListenerId": "listener-21xqe24q"."ListenerName": "test", "Port": "7070", "Protocol": "TCP"}]}] |
ProxyStatus
通道状态信息
被如下接口引用：DescribeProxiesStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 通道实例ID。 示例值：link-4ftf12sb |
| Status | String | 通道状态。 其中： RUNNING表示运行中； CREATING表示创建中； DESTROYING表示销毁中； OPENING表示开启中； CLOSING表示关闭中； CLOSED表示已关闭； ADJUSTING表示配置变更中； ISOLATING表示隔离中； ISOLATED表示已隔离； MOVING表示迁移中。 示例值：RUNNING |
RealServer
查询监听器或者规则相关的源站信息，不包括tag信息
被如下接口引用：DescribeListenerRealServers, DescribeRuleRealServers。
| 名称 | 类型 | 描述 |
|---|---|---|
| RealServerIP | String | 源站的IP或域名 示例值：1.1.1.1 |
| RealServerId | String | 源站ID 示例值：rs-0d7gb1dr |
| RealServerName | String | 源站名称 示例值：server-name |
| ProjectId | Integer | 项目ID 示例值：0 |
| InBanBlacklist | Integer | 是否在封禁黑名单中，其中：0表示不在黑名单中，1表示在黑名单中。 示例值：0 |
RealServerBindSetReq
绑定的源站信息
被如下接口引用：BindListenerRealServers, BindRuleRealServers。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| RealServerId | String | 是 | 源站id 示例值：rs-123456 |
| RealServerPort | Integer | 是 | 源站端口 示例值：443 |
| RealServerIP | String | 是 | 源站IP 示例值：192.168.1.1 |
| RealServerWeight | Integer | 否 | 源站权重 示例值：1 |
| RealServerFailoverRole | String | 否 | 源站主备角色：master表示主，slave表示备，该参数必须在监听器打开了源站主备模式。 示例值：master |
RealServerStatus
源站绑定信息查询，BindStatus， 0: 未被绑定 1：被规则或者监听器绑定
被如下接口引用：DescribeRealServersStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| RealServerId | String | 源站ID。 示例值：rs-123456 |
| BindStatus | Integer | 0表示未被绑定 1表示被规则或者监听器绑定。 示例值：0 |
| ProxyId | String | 绑定此源站的通道ID，没有绑定时为空字符串。 示例值：link-123456 |
| GroupId | String | 绑定此源站的通道组ID，没有绑定时为空字符串。 注意：此字段可能返回 null，表示取不到有效值。 示例值：lg-123456 |
RegionDetail
区域信息详情
被如下接口引用：DescribeAccessRegions, DescribeDestRegions, DescribeProxies, DescribeProxyDetail, DescribeProxyGroupDetails, DescribeProxyGroupList, DescribeRegionAndPrice。
| 名称 | 类型 | 描述 |
|---|---|---|
| RegionId | String | 区域ID 示例值：NorthChina |
| RegionName | String | 区域英文名或中文名 示例值：中国大陆-华北 |
| RegionArea | String | 机房所属大区 示例值：NorthChina |
| RegionAreaName | String | 机房所属大区名 示例值：中国大陆-华北 |
| IDCType | String | 机房类型, dc表示DataCenter数据中心, ec表示EdgeComputing边缘节点 示例值：dc |
| FeatureBitmap | Integer | 特性位图，每个bit位代表一种特性，其中： 0，表示不支持该特性； 1，表示支持该特性。 特性位图含义如下（从右往左）： 第1个bit，支持4层加速； 第2个bit，支持7层加速； 第3个bit，支持Http3接入； 第4个bit，支持IPv6； 第5个bit，支持精品BGP接入； 第6个bit，支持三网接入； 第7个bit，支持接入段Qos加速。 示例值：3 |
| SupportFeature | SupportFeature | 接入区域支持的能力 注意：此字段可能返回 null，表示取不到有效值。 示例值：["normal", "cn2"] |
RuleCheckParams
7层监听器转发规则健康检查相关参数
被如下接口引用：CreateRule, DescribeRules, DescribeRulesByRuleIds, ModifyRuleAttribute。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DelayLoop | Integer | 是 | 健康检查的时间间隔 示例值：30 |
| ConnectTimeout | Integer | 是 | 健康检查的响应超时时间 示例值：2 |
| Path | String | 是 | 健康检查的检查路径 示例值："/" |
| Method | String | 是 | 健康检查的方法，GET/HEAD 示例值："HEAD" |
| StatusCode | Array of Integer | 是 | 确认源站正常的返回码，可选范围[100, 200, 300, 400, 500] 示例值：[100, 200, 300, 400, 500] |
| Domain | String | 否 | 健康检查的检查域名。 当调用ModifyRuleAttribute时，不支持修改该参数。 示例值："www.qq.com" |
| FailedCountInter | Integer | 否 | 源站服务失败统计频率 示例值：60 |
| FailedThreshold | Integer | 否 | 源站健康性检查阀值，超过该阀值会屏蔽服务 示例值：5 |
| BlockInter | Integer | 否 | 源站健康性检测超出阀值后，屏蔽的时间 示例值：600 |
RuleInfo
7层监听器转发规则信息
被如下接口引用：DescribeRules, DescribeRulesByRuleIds。
| 名称 | 类型 | 描述 |
|---|---|---|
| RuleId | String | 规则信息 示例值：rule-00miz243 |
| ListenerId | String | 监听器信息 示例值：listener-b3qpz69j |
| Domain | String | 规则域名 示例值：www.test.com |
| Path | String | 规则路径 示例值：/index.html |
| RealServerType | String | 源站类型 示例值：IP |
| Scheduler | String | 监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。 示例值：RR |
| HealthCheck | Integer | 是否开启健康检查标志，1表示开启，0表示关闭 示例值：1 |
| RuleStatus | Integer | 规则状态，0表示运行中，1表示创建中，2表示销毁中，3表示绑定解绑源站中，4表示配置更新中 示例值：1 |
| CheckParams | RuleCheckParams | 健康检查相关参数 |
| RealServerSet | Array of BindRealServer | 已绑定的源站相关信息 |
| BindStatus | Integer | 源站的服务状态，0表示异常，1表示正常。 未开启健康检查时，该状态始终为正常。 只要有一个源站健康状态为异常时，该状态为异常，具体源站的状态请查看RealServerSet。 示例值：1 |
| ForwardHost | String | 通道转发到源站的请求所携带的host，其中default表示直接转发接收到的host。 示例值：www.host.com |
| ServerNameIndicationSwitch | String | 服务器名称指示（ServerNameIndication，简称SNI）开关。ON表示开启，OFF表示关闭。 注意：此字段可能返回 null，表示取不到有效值。 示例值：OFF |
| ServerNameIndication | String | 服务器名称指示（ServerNameIndication，简称SNI），当SNI开关打开时，该字段必填。 注意：此字段可能返回 null，表示取不到有效值。 示例值：SNI |
| ForcedRedirect | String | 强转HTTPS指示，当传递值为https:时表示强转为https 注意：此字段可能返回 null，表示取不到有效值。 示例值：https: |
| ForwardProtocol | String | 七层转发规则的回源协议类型 示例值：HTTP |
SecurityPolicyRuleIn
安全策略规则（入参）
被如下接口引用：CreateSecurityRules。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceCidr | String | 是 | 请求来源IP或IP段。 示例值：113.16.26.77 |
| Action | String | 是 | 策略：允许（ACCEPT）或拒绝（DROP） 示例值：DROP |
| AliasName | String | 否 | 规则别名 示例值：policy_name |
| Protocol | String | 否 | 协议：TCP或UDP，ALL表示所有协议 示例值：TCP |
| DestPortRange | String | 否 | 目标端口，填写格式举例： 单个端口: 80 多个端口: 80,443 连续端口: 3306-20000 所有端口: ALL 示例值：9300 |
SecurityPolicyRuleOut
安全策略规则（出参）
被如下接口引用：DescribeSecurityPolicyDetail, DescribeSecurityRules。
| 名称 | 类型 | 描述 |
|---|---|---|
| Action | String | 策略：允许（ACCEPT）或拒绝（DROP） 示例值：DROP |
| SourceCidr | String | 请求来源Ip或Ip段 示例值：113.16.26.77 |
| AliasName | String | 规则别名 示例值：测试规则 |
| DestPortRange | String | 目标端口范围 示例值：9300 |
| RuleId | String | 规则ID 示例值：sr-ruia8hnh |
| Protocol | String | 要匹配的协议类型（TCP/UDP） 示例值：TCP |
| PolicyId | String | 安全策略ID 示例值：sp-lar36ifx |
StatisticsDataInfo
统计数据信息
被如下接口引用：DescribeListenerStatistics, DescribeProxyGroupStatistics, DescribeProxyStatistics, DescribeRealServerStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Time | Integer | 对应的时间点 示例值：0 |
| Data | Float | 统计数据值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1 |
SupportFeature
加速区域支持的能力，包括支持的网络类型等等。
被如下接口引用：DescribeAccessRegions, DescribeDestRegions, DescribeProxies, DescribeProxyDetail, DescribeRegionAndPrice。
| 名称 | 类型 | 描述 |
|---|---|---|
| NetworkType | Array of String | 接入区域支持的网络类型列表，normal表示支持常规BGP，cn2表示精品BGP，triple表示三网，secure_eip表示定制安全eip。 示例值：["normal", "cn2"] |
TCPListener
TCP类型监听器信息
被如下接口引用：DescribeTCPListeners。
| 名称 | 类型 | 描述 |
|---|---|---|
| ListenerId | String | 监听器ID 示例值：link-bjkpdum1 |
| ListenerName | String | 监听器名称 示例值：listener-name |
| Port | Integer | 监听器端口 示例值：443 |
| RealServerPort | Integer | 监听器转发源站端口，仅对版本为1.0的通道有效 注意：此字段可能返回 null，表示取不到有效值。 示例值：332 |
| RealServerType | String | 监听器绑定源站类型 示例值：IP |
| Protocol | String | 监听器协议， TCP 示例值：TCP |
| ListenerStatus | Integer | 监听器状态，其中： 0表示运行中； 1表示创建中； 2表示销毁中； 3表示源站调整中； 4表示配置变更中。 示例值：1 |
| Scheduler | String | 监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。 示例值：rr |
| ConnectTimeout | Integer | 源站健康检查响应超时时间，单位：秒 示例值：2 |
| DelayLoop | Integer | 源站健康检查时间间隔，单位：秒 示例值：5 |
| HealthCheck | Integer | 监听器是否开启健康检查，其中： 0表示关闭； 1表示开启 示例值：1 |
| BindStatus | Integer | 监听器绑定的源站状态， 其中： 0表示异常； 1表示正常。 示例值：1 |
| RealServerSet | Array of BindRealServer | 监听器绑定的源站信息 示例值：{"RealServerId":"rs-123456"} |
| CreateTime | Integer | 监听器创建时间，Unix时间戳 示例值：1607071157 |
| ClientIPMethod | Integer | 监听器获取客户端 IP 的方式，0表示TOA, 1表示Proxy Protocol 示例值：0 |
| HealthyThreshold | Integer | 健康阈值，表示连续检查成功多少次后认定源站健康。范围为1到10 示例值：5 |
| UnhealthyThreshold | Integer | 不健康阈值，表示连续检查失败多少次数后认为源站不健康。范围为1到10 示例值：1 |
| FailoverSwitch | Integer | 源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启 示例值：0 |
| SessionPersist | Integer | 是否开启会话保持选项：0关闭， 非0开启，非0值为会话保持时间 示例值：0 |
| ProxyId | String | 监听器的通道ID，如果监听器属于通道组，则为null 示例值：link-bjkpdum1 |
| GroupId | String | 监听器的通道组ID，如果监听器属于通道，则为null 注意：此字段可能返回 null，表示取不到有效值。 示例值：lg-qz6ntod5 |
TagPair
标签键值对
被如下接口引用：AddRealServers, CreateGlobalDomain, CreateProxy, CreateProxyGroup, DescribeGlobalDomains, DescribeProxies, DescribeProxyDetail, DescribeProxyGroupDetails, DescribeProxyGroupList, DescribeRealServers。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签键 示例值：key |
| TagValue | String | 是 | 标签值 示例值：value |
TagResourceInfo
标签对应资源信息
被如下接口引用：DescribeResourcesByTag。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResourceType | String | 资源类型，其中： Proxy表示通道， ProxyGroup表示通道组， RealServer表示源站 示例值：domain |
| ResourceId | String | 资源ID 示例值：dm-kbwkcklz |
UDPListener
UDP类型监听器信息
被如下接口引用：DescribeUDPListeners。
| 名称 | 类型 | 描述 |
|---|---|---|
| ListenerId | String | 监听器ID 示例值：lg-h8fpr1vh |
| ListenerName | String | 监听器名称 示例值：listener-name |
| Port | Integer | 监听器端口 示例值：80 |
| RealServerPort | Integer | 监听器转发源站端口，仅V1版本通道或通道组监听器有效 示例值：80 |
| RealServerType | String | 监听器绑定源站类型 示例值：IP |
| Protocol | String | 监听器协议， UDP 示例值：TCP |
| ListenerStatus | Integer | 监听器状态，其中： 0表示运行中； 1表示创建中； 2表示销毁中； 3表示源站调整中； 4表示配置变更中。 示例值：0 |
| Scheduler | String | 监听器源站访问策略，其中：rr表示轮询；wrr表示加权轮询；lc表示最小连接数；lrtt表示最小时延。 示例值：rr |
| BindStatus | Integer | 监听器绑定源站状态， 0表示正常，1表示IP异常，2表示域名解析异常 示例值：0 |
| RealServerSet | Array of BindRealServer | 监听器绑定的源站信息 示例值：{"RealServerId":"rs-123456"} |
| CreateTime | Integer | 监听器创建时间，Unix时间戳 示例值：0 |
| SessionPersist | Integer | 是否开启会话保持选项：0关闭， 非0开启，非0值为会话保持时间 示例值：0 |
| DelayLoop | Integer | 源站健康检查时间间隔，单位：秒。时间间隔取值在[5，300]之间。 示例值：20 |
| ConnectTimeout | Integer | 源站健康检查响应超时时间，单位：秒。超时时间取值在[2，60]之间。超时时间应小于健康检查时间间隔DelayLoop。 示例值：20 |
| HealthyThreshold | Integer | 健康阈值，表示连续检查成功多少次后认定源站健康。范围为1到10 示例值：5 |
| UnhealthyThreshold | Integer | 不健康阈值，表示连续检查失败多少次数后认为源站不健康。范围为1到10 示例值：1 |
| FailoverSwitch | Integer | 源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启 示例值：0 |
| HealthCheck | Integer | 源站是否开启健康检查：1开启，0关闭。 示例值：1 |
| CheckType | String | UDP源站健康类型。PORT表示检查端口，PING表示PING。 示例值：PING |
| CheckPort | Integer | UDP源站健康检查探测端口。 示例值：8888 |
| ContextType | String | UDP源站健康检查端口探测报文类型：TEXT表示文本。仅在健康检查类型为PORT时使用。 示例值：TEXT |
| SendContext | String | UDP源站健康检查端口探测发送报文。仅在健康检查类型为PORT时使用。 示例值：helloworld |
| RecvContext | String | UDP源站健康检查端口探测接收报文。仅在健康检查类型为PORT时使用。 示例值：helloworld |
| ProxyId | String | 监听器的通道ID，如果监听器属于通道组，则为null 示例值：link-bjkpdum1 |
| GroupId | String | 监听器的通道组ID，如果监听器属于通道，则为null 示例值：lg-qz6ntod5 |
