tencent cloud

APIs

文档APIsGlobal Accelerator 2.0Data Types

Data Types

下载
聚焦模式
字号
最后更新时间： 2026-09-14 21:13:33

AcceleratorAreas

Acceleration region information

Used by actions: CreateAccelerateAreas, DescribeAccelerateAreas, ModifyAccelerateAreas.

Name Type Required Description
AccelerateRegion String Yes

Acceleration region.
Bandwidth Integer No

Bandwidth.
IspType String No

Supports 'BGP', 'QUALITY_BGP', and 'STATIC_IP'. Default: BGP.

Enumeration values:

  • BGP: BGP
  • STATIC_IP: triple-network
  • QUALITY_BGP: dedicated BGP
IpVersion String No

Only IPv4 is supported, and IPv4 is selected by default.
AcceleratorAreaId String No

Acceleration region ID.
IpAddress Array of String No

IP.
IpAddressInfoSet Array of IpAddressInfoSet No

IP information.

AcceleratorRegionSet

Acceleration region info

Used by actions: DescribeAccelerateRegions.

Name Type Description
Name String

Chinese Name of Region.
IsAvailable Integer

Whether available; 0: unavailable, 1: available.
Region String

Regional information.
AreaName String

Zone name.
IsChinaMainland Integer

Whether it is a China region.
SupportIspType Array of String

Support the IspType type.
IsTencentRegion Integer

Whether it is a Tencent region.

AclEntries

Acl information

Used by actions: CreateGlobalAcceleratorAclRule.

Name Type Required Description
Protocol String Yes

Protocol.

Input limits: supports configuration of 'TCP', 'UDP', 'ALL';
Port String Yes

Port.
SourceCidrBlock String Yes

IP range.
Policy String Yes

Execute action.

Input parameter limit: can be configured with 'ACCEPT' and 'DROP';
Description String No

Description. Maximum length cannot exceed 100 bytes.

EndpointConfigurations

Terminal node configuration

Used by actions: CreateEndpointGroup, DescribeEndpointGroups, ModifyEndpointGroup.

Name Type Required Description
EndpointType String Yes

Domain type. Available values: 'Domain', 'PublicIp'.
EndpointService String Yes

Domain name.
Weight Integer Yes

Weight.
HealthCheckStatus String No

Health check status; HEALTH: healthy; UNHEALTH: unhealthy.

EndpointGroupConfiguration

Terminal node group configuration

Used by actions: CreateEndpointGroup.

Name Type Required Description
Name String Yes

Terminal node group name.

Parameter format: starting with a letter or Chinese characters, 2–128 characters in length, supporting letters, digits, Chinese characters, . - _
EndpointGroupRegion String Yes

Region of the terminal node group.
EndpointConfigurations Array of EndpointConfigurations Yes

Terminal node configuration.
CheckType String No

Check protocol. Supports configuration of 'TCP', 'HTTP', 'PING', and 'CUSTOM'.

Enumeration values:

  • TCP: When the CLB listener protocol where the terminal node group resides is TCP, choose TCP as the check protocol.
  • HTTP: When the CLB listener protocol where the terminal node group resides is HTTP or HTTPS, choose HTTP as the check protocol.
  • PING: When the CLB listener protocol where the terminal node group resides is UDP, choose PING as the check protocol.
  • CUSTOM: When the CLB listener protocol where the terminal node group resides is UDP or TCP, choose CUSTOM as the check protocol.

This field is required when health check is enabled.
Description String No

Description.

Default value: empty by default, representing no configuration description.

Maximum length: 100 bytes.
CheckPort String No

Check port.

Input limit: range 1-65535.

This field is required when CheckType is CUSTOM.
ContextType String No

Check content. Supports configuration 'TEXT'.

Enumeration values:

  • TEXT: Text content.

This field is required when CheckType is CUSTOM.
CheckSendContext String No

Check request.

Input parameter limit: The byte length must be within 1-500.

This field is required when CheckType is CUSTOM.
CheckRecvContext String No

Check returned results.

Input parameter limit: The byte length must be within 1-500.

When CheckType is CUSTOM, this field is required.
EnableHealthCheck Boolean No

Whether to enable health check.

Default value: False
ConnectTimeout Integer No

Response timeout.

Value range: [1, 100]

Default value: 2

This field is required when health check is enabled.
HealthCheckInterval Integer No

Health check interval.

Value range: [5, 300].

Default value: 30.

This field is required when health check is enabled.
UnhealthyThreshold Integer No

Unhealthy threshold.

Value range: [1, 10]

Default value: 3

This field is required when health check is enabled.
HealthyThreshold Integer No

Health threshold.

Value range: [1, 10]

Default value: 3

This field is required when health check is enabled.
ForwardProtocol String No

Origin-pull protocol. HTTP and HTTPS can be configured.

Enumeration values:

  • HTTP: HTTP origin-pull. HTTP can be configured when the listener protocol where the terminal node group resides is HTTP or HTTPS.
  • HTTPS: HTTPS origin-pull. HTTPS can be configured when the listener protocol where the terminal node group resides is HTTPS.

This field is required when the listener protocol where the terminal node group resides is HTTP or HTTPS.
CheckDomain String No

Check domain name.

Input parameter limit: The byte length range is 3-80.

This field is required when CheckType is HTTP.
CheckPath String No

Check the URL.

Parameter format: must match the regular expression: ^[a-zA-Z0-9_.-/]{1,80}$

This field is required when CheckType is HTTP.
CheckMethod String No

Request method. Supports configuration of 'GET' and 'HEAD'.

Enumeration values:

  • GET: The request method is GET.
  • HEAD: The request method is HEAD.

When CheckType is HTTP, this field is required.
StatusMask Array of String No

Status check code. Supports configuring 'http_2xx', 'http_3xx', 'http_4xx', 'http_5xx'.

Enumeration values:

  • http_2xx: HTTP codes beginning with 2.
  • http_3xx: HTTP codes beginning with 3.
  • http_4xx: HTTP codes beginning with 4.
  • http_5xx: HTTP codes beginning with 5.

This field is required when CheckType is HTTP.
PortOverrides Array of PortOverride No

Port mapping.

Input limits: Layer 7 supports 1 port mapping, and Layer 4 supports up to 30 port mappings.
IspType String No

Operator type. Supports configuration 'CMCC', 'CTCC', 'CUCC'.

Enumeration values:

  • CMCC: China Mobile
  • CUCC: China Unicom
  • CTCC: China Telecom

This field is required when the terminal node group region is a triple-network region.
CipherPolicyId String No

HPPTS encryption algorithm suite; supports configuration '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';

Enumeration values:

  • tls_policy_1.0-2: encryption algorithm suite.
  • tls_policy_1.1-2: encryption algorithm suite.
  • tls_policy_1.2: encryption algorithm suite.
  • tls_policy_1.2_strict: encryption algorithm suite.
  • tls_policy_1.2_strict-1.3: encryption algorithm suite.

This field is required when the origin-pull protocol is HTTPS.
HttpVersion String No

Origin-pull protocol. Supports configuration of 'HTTP/1.1' and 'HTTP/2'.

Enumeration values:

  • HTTP/1.1: version HTTP/1.1
  • HTTP/2: version HTTP/2

This field is required when the origin-pull protocol is HTTPS.

EndpointGroupConfigurationSet

Terminal node group information

Used by actions: DescribeEndpointGroups.

Name Type Description
GlobalAcceleratorId String

Global acceleration instance ID.
ListenerId String

Listener instance ID.
EndpointGroupId String

Terminal node group ID.
Name String

Name.
EndpointGroupRegion String

Region.
Description String

Description.
EndpointConfigurations Array of EndpointConfigurations

Endpoint information.
EnableHealthCheck Boolean

Whether to enable health check.
ConnectTimeout Integer

Response timeout.
HealthCheckInterval Integer

Health check interval.
UnhealthyThreshold Integer

Unhealthy threshold.
HealthyThreshold Integer

Health threshold.
CheckType String

Select the protocol.
CheckPort Integer

Check port.
ContextType String

Check content.
CheckSendContext String

Check request.
CheckRecvContext String

Check returned results.
CheckDomain String

Check domain name.
CheckPath String

Check the URL.
CheckMethod String

Request method.
StatusMask Array of String

Status check code.
EndpointGroupType String

Terminal node group type.
ForwardProtocol String

Origin-pull protocol.
PortOverrides Array of PortOverride

Port mapping info.
VirtualExistForwardingRuleFlag Boolean

Whether the custom endpoint group is bound to a Layer 7 forwarding rule.
OriginPublicIps Array of String

Public IP address of the egress terminal node group.
IspType String

Operator type. China Mobile (CMCC), China Unicom (CUCC), China Telecom (CTCC).
CipherPolicyId String

HPPTS encryption algorithm kit
HttpVersion String

Only the HTTPS back-to-source protocol supports selecting ['HTTP/1.1', 'HTTP/2']

Enumeration values:

  • HTTP/1.1: Version HTTP/1.1
  • HTTP/2: Version HTTP/2

Filter

Filter.

Used by actions: DescribeAccelerateAreas, DescribeEndpointGroups, DescribeGlobalAcceleratorAccessLog, DescribeGlobalAccelerators, DescribeListeners.

Name Type Required Description
Name String Yes Attribute name. If more than one Filter exists, the logical relation between these Filters is AND.
Values Array of String Yes Attribute value. If a filter has multiple values, the relationship among the values under the same filter is logical OR (OR). When the value type is boolean, it can be directly set to the string "TRUE" or "FALSE".

ForwardingPolicySet

Layer-7 forwarding policy information

Used by actions: DescribeForwardingPolicy.

Name Type Description
GlobalAcceleratorId String Global acceleration instance ID.
ListenerId String Listener ID.
ForwardingPolicyId String Policy ID.
Host String Domain name.
DefaultHostFlag Boolean Whether it is the default domain name.

ForwardingRuleSet

Layer-7 forwarding rule information

Used by actions: DescribeForwardingRule.

Name Type Description
RuleCondition Array of RuleCondition

Conditional information of Layer 7 forwarding rules.
RuleAction Array of RuleAction

Behavior information of the Layer 7 forwarding rule.
EnableOriginSni Boolean

Whether to enable origin-pull Sni.
OriginSni String

Origin-pull Sni.
OriginHeaders Array of OriginHeader

Origin-pull Header information.
OriginHost String

Origin-pull Host.
GlobalAcceleratorId String

Global acceleration instance ID.
ListenerId String

Listener ID.
ForwardingPolicyId String

Layer-7 forwarding policy ID.
ForwardingRuleId String

Layer 7 forwarding rule ID.
HideResponseHeaders Array of HideResponseHeaders

Origin server response header
ResponseHeaders Array of ResponseHeaders

Delete origin server response headers

GlobalAcceleratorAccessLog

GA access log

Used by actions: DescribeGlobalAcceleratorAccessLog.

Name Type Description
LogPushTaskId String

Log Unique Id
GlobalAcceleratorId String

Unique Id of the GA instance.
ListenerId String

Unique Id of the listener
EndpointGroupId String

Unique Id of the terminal node group
FlowLogDescription String

Log task description
CloudRegion String

Region where the logs are located.
CloudLogId String

Log topic Id
CloudLogSetId String

Log Set Id
FieldKeys Array of String

Select log data collection field
Status String

Log task status

Enumeration values:

  • active: Running
  • stopped: Suspended

GlobalAcceleratorAclPolicies

Access control policy

Used by actions: DescribeGlobalAcceleratorAclPolicies.

Name Type Description
GlobalAcceleratorAclPolicyId String Access control policy ID.
DefaultAction String Default action.
Status String Status.

GlobalAcceleratorAclRuleSet

Acl rule information

Used by actions: DescribeGlobalAcceleratorAclRules.

Name Type Description
GlobalAcceleratorPolicyId String Access control policy ID.
GlobalAcceleratorAclRuleId String Acl rule ID.
Protocol String Protocol.
Port String Port.
SourceCidrBlock String IP range.
Policy String Action.
Description String Description.

GlobalAcceleratorSet

Global acceleration instance information

Used by actions: DescribeGlobalAccelerators.

Name Type Description
GlobalAcceleratorId String

Global acceleration instance ID.
Name String

Global acceleration instance name.
Description String

Global acceleration instance description.
CreateTime String

Instance creation time of the global acceleration instance.
State String

Global acceleration instance status.
InstanceChargeType String

Billing type of a global acceleration instance.
DdosId String

DDoS ID of the global acceleration instance.
ListenerCounts Integer

Number of listeners of the associated acceleration instance.
AcceleratorAreaCounts Integer

Count of acceleration regions belonging to the acceleration instance.
Status String

Global acceleration instance status.
Cname String

Domain name.
CrossBorderType String

Cross-border type; HighQuality (high-quality cross-border), Unicom (China Unicom cross-border), NotAvailable (not enabled).
TagSet Array of Tag

Tag information.

HideResponseHeaders

Hide Header

Used by actions: CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule.

Name Type Required Description
Key String Yes

key

Parameter format: 1. The string only contain printable ASCII characters. 2. Cannot contain these characters ()<>@,;:"/[ ]?={ }

Input limit: Length 1-40.
Value String Yes

value

Currently only support inputting an empty string ""

IpAddressInfoSet

Public IP information in the acceleration region

Used by actions: CreateAccelerateAreas, DescribeAccelerateAreas, ModifyAccelerateAreas.

Name Type Required Description
IpAddress String No

IP address.
IspType String No

IP type.
DdosProtectionType String No

Ddos type

ListenerSet

Listener information

Used by actions: DescribeListeners.

Name Type Description
GlobalAcceleratorId String Global acceleration instance ID.
ListenerId String Listener ID.
Name String Listener name.
Description String Listener description.
Protocol String Protocol.
PortRanges PortRanges Port range.
XForwardedForRealIp Boolean Whether to enable layer-7 access to source IP mode.
ClientAffinity String Enable session persistence.
ClientAffinityTime Integer Session persistence time.
CertificationType String SSL decryption method.
ServerCertificates Array of String Server certificate.
ClientCaCertificates Array of String Client certificate.
CipherPolicyId String TLS password suite package.
HttpVersion String HTTP version.
RequestTimeout Integer Request timeout.
CreateTime String Creation time.
ListenerType String Listener routing type.
Status String Listener status.
EndpointGroupCounts Integer Number of terminal node groups belonging to the listener.
GetRealIpType String Method for obtaining the source IP at Layer 4.
IdleTimeout Integer Connection timeout.

OriginHeader

Origin-pull Header information

Used by actions: CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule.

Name Type Required Description
Key String Yes

Key.

Parameter format: 1. The string literal only contains printable ASCII characters. 2. Cannot contain these characters ()<>@,;:"/[ ]?={ }

Input parameter limitation: length 1-40.
Value String Yes

Value.

Input parameter limit: length cannot exceed 128.

If the string contains $, you can only configure '$remote_addr', '$remote_port'; otherwise, it is not supported.

PortOverride

Port mapping

Used by actions: CreateEndpointGroup, DescribeEndpointGroups, ModifyEndpointGroup.

Name Type Required Description
ListenerPort Integer Yes Listening port.
EndpointPort Integer Yes Mapping port.

PortRanges

Port range

Used by actions: CreateListener, DescribeListeners.

Name Type Required Description
FromPort Integer Yes Start port.
ToPort Integer Yes Destination port.

ResponseHeaders

Header

Used by actions: CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule.

Name Type Required Description
Key String Yes

key

Parameter format: 1. The string only contain printable ASCII characters. 2. Cannot contain these characters ()<>@,;:"/[ ]?={ }

Input limit: Length 1-40.
Value String Yes

value

Input limit: length cannot exceed 128

If the string contains $, you can only configure '$remote_addr' and '$remote_port'. Otherwise, it is not supported.

RuleAction

Behavior information of Layer 7 forwarding rules

Used by actions: CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule.

Name Type Required Description
RuleActionType String Yes

Behavior type of the Layer 7 forwarding rule

Enumeration values:

  • ForwardGroup: The forwarding policy forwards to a terminal node group.
  • Drop: The forwarding policy drops the request.
RuleActionValue String No

Layer 7 forwarding rule action value

This field is not required to input when RuleActionType is Drop. This field is required when RuleActionType is ForwardGroup, which requires filling in the custom terminal node group ID. The default terminal node group cannot be configured.

RuleCondition

Conditional information of Layer 7 forwarding rules

Used by actions: CreateForwardingRule, DescribeForwardingRule, ModifyForwardingRule.

Name Type Required Description
RuleConditionType String Yes

Condition type of Layer 7 forwarding rule

Enumeration values:

  • Path: Path
RuleConditionValue Array of String Yes

Layer 7 forwarding rule condition value

Parameter format: The format must match the regular expression: ^[a-zA-Z0-9_.-/]{1,80}$

The array length cannot exceed 1.

Tag

Tag key-value pair.

Used by actions: CreateGlobalAccelerator, DescribeGlobalAccelerators.

Name Type Required Description
Key String Yes Tag key.
Value String Yes Tag value.
上一篇: DescribeListeners下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈

搜索
    请输入关键词搜索文档