tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Global Application Acceleration Platform
    Documentation
    Download PDF

    Data Types

    Last updated: 2023-07-13 15:25:43
    Download PDF

    AccessConfiguration

    List of acceleration regions in a connection group, including acceleration regions and their bandwidth and concurrence configuration.

    Used by actions: CreateProxyGroup.

    Name Type Required Description
    AccessRegion String Yes Acceleration region.
    Bandwidth Integer Yes Connection bandwidth cap. Unit: Mbps.
    Concurrent Integer Yes Connection concurrence cap, which indicates the maximum number of simultaneous online connections. Unit: 10,000 connections.
    NetworkType String No Network type. Valid values: normal (default), cn2

    AccessRegionDetial

    Query the available acceleration region information, the corresponding bandwidth options, and the concurrence based on origin servers.

    Used by actions: DescribeAccessRegionsByDestRegion.

    Name Type Description
    RegionId String Region ID
    RegionName String Region name in Chinese or English
    ConcurrentList Array of Integer Value array of the available concurrence
    BandwidthList Array of Integer Value array of the available bandwidth
    RegionArea String Region where the data center locates
    RegionAreaName String Name of the region where the data center locates
    IDCType String Data center type. dc: data center; ec: edge server.
    FeatureBitmap Integer Feature bitmap. Valid values:
    0: disable the feature;
    1: enable the feature.
    Each bit in the bitmap represents a feature:
    1st bit: layer-4 acceleration;
    2nd bit: layer-7 acceleration;
    3rd bit: HTTP3 access;
    4th bit: IPv6;
    5th bit: dedicated BGP access;
    6th bit: non-BGP access;
    7th bit: QoS acceleration.
    Note: this field may return null, indicating that no valid values can be obtained.

    AccessRegionDomainConf

    Domain name nearest access configuration

    Used by actions: ModifyGroupDomainConfig.

    Name Type Required Description
    RegionId String Yes Region ID.
    NationCountryInnerList Array of String No Region/country code for the nearest access, which can be obtained via the DescribeCountryAreaMapping API.

    BandwidthPriceGradient

    Bandwidth price gradient

    Used by actions: DescribeRegionAndPrice, InquiryPriceCreateProxy.

    Name Type Description
    BandwidthRange Array of Integer Bandwidth range.
    BandwidthUnitPrice Float Bandwidth unit price within the bandwidth range. Unit: CNY/Mbps/day.
    DiscountBandwidthUnitPrice Float Discounted bandwidth price in CNY/Mbps/day.

    BindRealServer

    Bound origin server information

    Used by actions: DescribeListenerRealServers, DescribeRuleRealServers, DescribeRules, DescribeRulesByRuleIds, DescribeTCPListeners, DescribeUDPListeners.

    Name Type Description
    RealServerId String Origin server ID
    RealServerIP String Origin server IP or domain name
    RealServerWeight Integer Origin server weight
    RealServerStatus Integer Origin server health check status. Valid values:
    0: normal;
    1: exceptional.
    If health check is not enabled, this status will always be normal.
    Note: this field may return null, indicating that no valid values can be obtained.
    RealServerPort Integer Origin server port number
    Note: This field may return null, indicating that no valid values can be obtained.
    DownIPList Array of String If the origin server is a domain name, the domain name will be resolved to one or multiple IPs. This field indicates the exceptional IP list.
    RealServerFailoverRole String Role of the origin server. Values: master (primary origin server); slave (secondary origin server). This parameter only takes effect when origin failover is enabled for the listener.

    BindRealServerInfo

    The returned value of the added origin server information

    Used by actions: DescribeRealServers.

    Name Type Description
    RealServerIP String Origin server IP or domain name
    RealServerId String Origin server ID
    RealServerName String Origin server name
    ProjectId Integer Project ID
    TagSet Array of TagPair Tag list.
    Note: This field may return null, indicating that no valid values can be obtained.

    Certificate

    Server Certificate

    Used by actions: DescribeCertificates.

    Name Type Description
    CertificateId String Certificate ID
    CertificateName String Certificate name; It's an old parameter, please switch to CertificateAlias.
    CertificateType Integer Certificate type.
    CertificateAlias String Certificate name.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Integer Certificate creation time in the format of UNIX timestamp, indicating the number of seconds that have elapsed since January 1, 1970 (midnight in UTC/GMT).
    BeginTime Integer Certificate effective time in the format of UNIX timestamp, indicating the number of seconds that have elapsed since January 1, 1970 (midnight in UTC/GMT).
    Note: This field may return null, indicating that no valid values can be obtained.
    EndTime Integer Certificate expiration time in the format of UNIX timestamp, indicating the number of seconds that have elapsed since January 1, 1970 (midnight in UTC/GMT).
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuerCN String Common name of the certificate issuer.
    Note: This field may return null, indicating that no valid values can be obtained.
    SubjectCN String Common name of the certificate subject.
    Note: This field may return null, indicating that no valid values can be obtained.

    CertificateAliasInfo

    Certificate alias information.

    Used by actions: DescribeHTTPSListeners, DescribeRules.

    Name Type Description
    CertificateId String Certificate ID.
    CertificateAlias String Certificate alias.

    CertificateDetail

    Certificate details, including the certificate ID, name, type, content, and key content.

    Used by actions: DescribeCertificateDetail.

    Name Type Description
    CertificateId String Certificate ID
    CertificateType Integer Certificate type.
    CertificateAlias String Certificate name.
    Note: This field may return null, indicating that no valid values can be obtained.
    CertificateContent String Certificate content.
    CertificateKey String Key content. This field will be returned if the certificate type is the SSL certificate.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Integer Creation time in the format of UNIX timestamp, indicating the number of seconds that have elapsed since January 1, 1970 (midnight in UTC/GMT).
    Note: This field may return null, indicating that no valid values can be obtained.
    BeginTime Integer Time that the certificate takes effect. Using the UNIX timestamp, indicating the number of seconds that have elapsed since January 1, 1970 (Midnight in UTC/GMT).
    Note: This field may return null, indicating that no valid values can be obtained.
    EndTime Integer Certificate expiration time. Using the UNIX timestamp, indicating the number of seconds that have elapsed since January 1, 1970 (Midnight in UTC/GMT).
    Note: This field may return null, indicating that no valid values can be obtained.
    IssuerCN String Common name of the certificate’s issuer.
    Note: This field may return null, indicating that no valid values can be obtained.
    SubjectCN String Common name of the certificate subject.
    Note: This field may return null, indicating that no valid values can be obtained.

    CountryAreaMap

    Country/region code mapping (name and code)

    Used by actions: DescribeCountryAreaMapping.

    Name Type Description
    NationCountryName String Country name.
    NationCountryInnerCode String Country code.
    GeographicalZoneName String Region name.
    GeographicalZoneInnerCode String Region code.
    ContinentName String Continent name.
    ContinentInnerCode String Continent code.
    Remark String Remark information
    Note: This field may return null, indicating that no valid values can be obtained.

    DomainAccessRegionDict

    Nearest access configuration details of domain name resolution

    Used by actions: DescribeGroupDomainConfig.

    Name Type Description
    NationCountryInnerList Array of NationCountryInnerInfo Nearest access region
    ProxyList Array of ProxyIdDict Acceleration region connection list
    RegionId String Acceleration region ID
    GeographicalZoneInnerCode String Acceleration region internal code
    ContinentInnerCode String Internal code of the continent to which the acceleration region belongs
    RegionName String Acceleration region alias

    DomainErrorPageInfo

    Custom error response configuration of a domain name

    Used by actions: DescribeDomainErrorPageInfo, DescribeDomainErrorPageInfoByIds.

    Name Type Description
    ErrorPageId String Configuration ID of a custom error response
    ListenerId String Listener ID
    Domain String Domain name
    ErrorNos Array of Integer Original error code
    NewErrorNo Integer New error code
    Note: This field may return null, indicating that no valid values can be obtained.
    ClearHeaders Array of String Response header to be cleared
    Note: This field may return null, indicating that no valid values can be obtained.
    SetHeaders Array of HttpHeaderParam Response header to be set
    Note: This field may return null, indicating that no valid values can be obtained.
    Body String Configured response body (excluding HTTP header)
    Note: This field may return null, indicating that no valid values can be obtained.
    Status Integer Rule status. 0: success
    Note: this field may return null, indicating that no valid value is obtained.

    DomainRuleSet

    Forwarding rule information of Layer-7 listeners classified by domain name

    Used by actions: DescribeRules.

    Name Type Description
    Domain String Forwarding rule domain name.
    RuleSet Array of RuleInfo Forwarding rule list of the domain name.
    CertificateId String Server certificate ID of the domain. When it is default, it indicates that the default certificate will be used (i.e., the certificate configured for the listener).
    Note: This field may return null, indicating that no valid values can be obtained.
    CertificateAlias String Server certificate name of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    ClientCertificateId String Client certificate ID of the domain. When it is default, it indicates that the default certificate will be used (i.e., the certificate configured for the listener).
    Note: This field may return null, indicating that no valid values can be obtained.
    ClientCertificateAlias String Client certificate name of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    BasicAuthConfId String Basic authentication configuration ID of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    BasicAuth Integer Basic authentication status:
    0: disabled;
    1: enabled.
    Note: This field may return null, indicating that no valid values can be obtained.
    BasicAuthConfAlias String Basic authentication configuration name of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerCertificateId String Origin server authentication certificate ID of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerAuth Integer Origin server authentication status:
    0: disabled;
    1: enabled.
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerCertificateAlias String Origin server authentication certificate name of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    GaapCertificateId String Connection authentication certificate ID of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    GaapAuth Integer Connection authentication status:
    0: disabled;
    1: enabled.
    Note: This field may return null, indicating that no valid values can be obtained.
    GaapCertificateAlias String Connection authentication certificate name of the domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerCertificateDomain String Origin server authentication domain name.
    Note: This field may return null, indicating that no valid values can be obtained.
    PolyClientCertificateAliasInfo Array of CertificateAliasInfo Returns IDs and aliases of multiple certificates when there are multiple client certificates.
    Note: This field may return null, indicating that no valid values can be obtained.
    PolyRealServerCertificateAliasInfo Array of CertificateAliasInfo Returns IDs and aliases of multiple certificates when there are multiple origin certificates.
    Note: This field may return null, indicating that no valid values can be obtained.
    DomainStatus Integer Domain name status.
    0: running;
    1: changing;
    2: deleting.
    Note: this field may return null, indicating that no valid values can be obtained.
    BanStatus String Blocking-related status of the domain name. BANNED: the domain name is blocked; RECOVER: the domain name is unblocked or normal; BANNING: the domain name is being blocked; RECOVERING: the domain name is being unblocked; BAN_FAILED: the blocking fails; RECOVER_FAILED: the unblocking fails.
    Note: This field may return null, indicating that no valid values can be obtained.
    Http3Supported Integer Specifies whether to enable HTTP3. Valid values:
    0: disable HTTP3;
    1: enable HTTP3.
    Note: This field may return null, indicating that no valid values can be obtained.

    Filter

    Filter conditions

    Used by actions: DescribeProxies, DescribeProxyGroupList, DescribeRealServers.

    Name Type Required Description
    Name String Yes Filter conditions
    Values Array of String Yes Filter values

    GroupStatisticsInfo

    The connection groups from which the statistics can be derived, and the connection information.

    Used by actions: DescribeGroupAndStatisticsProxy.

    Name Type Description
    GroupId String Connection group ID
    GroupName String Connection group name
    ProxySet Array of ProxySimpleInfo List of connections of a connection group

    HTTPListener

    HTTP listener information

    Used by actions: DescribeHTTPListeners.

    Name Type Description
    ListenerId String Listener ID
    ListenerName String Listener name
    Port Integer Listener port
    CreateTime Integer Listener creation time; using UNIX timestamp.
    Protocol String Listener protocol. Valid values: HTTP, HTTPS. The value HTTP is used for this structure
    ListenerStatus Integer Listener status:
    0: running;
    1: creating;
    2: terminating;
    3: adjusting origin server;
    4: modifying configuration.
    ProxyId String Connection ID of the listener. A null value is returned if the listener is associated with the connection group.
    Note: This field may return null, indicating that no valid value can be obtained.
    GroupId String Connection group ID of the listener. A null value is returned if the listener is associated with a specific connection.
    Note: This field may return null, indicating that no valid value can be obtained.

    HTTPSListener

    HTTPS listener information

    Used by actions: DescribeHTTPSListeners.

    Name Type Description
    ListenerId String Listener ID
    ListenerName String Listener name
    Port Integer Listener port
    Protocol String Listener protocol. Valid values: HTTP, HTTPS. The value HTTPS is used for this structure
    ListenerStatus Integer Listener status:
    0: running;
    1: creating;
    2: terminating;
    3: adjusting origin server;
    4: modifying configuration.
    CertificateId String Server SSL certificate ID of the listener
    ForwardProtocol String Protocol used in the forwarding from connections to origin servers
    CreateTime Integer Listener creation time; using UNIX timestamp.
    CertificateAlias String Server SSL certificate alias
    Note: This field may return null, indicating that no valid values can be obtained.
    ClientCertificateId String Client CA certificate ID of the listener
    Note: This field may return null, indicating that no valid values can be obtained.
    AuthType Integer Listener authentication mode. Valid values:
    0: one-way authentication;
    1: mutual authentication.
    Note: this field may return null, indicating that no valid values can be obtained.
    ClientCertificateAlias String Client CA certificate alias
    Note: This field may return null, indicating that no valid values can be obtained.
    PolyClientCertificateAliasInfo Array of CertificateAliasInfo Alias information of multiple client CA certificates.
    Note: This field may return null, indicating that no valid values can be obtained.
    Http3Supported Integer Whether to support HTTP3. Values:
    0: Do not support HTTP3 access;
    1: Support HTTP3 access.
    If HTTP3 is supported for a connection, the listener will use the port that is originally accessed to UDP, and a UDP listener with the same port cannot be created.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProxyId String Connection ID of the listener. A null value is returned if the listener is associated with the connection group.
    Note: This field may return null, indicating that no valid values can be obtained.
    GroupId String Connection group ID of the listener. A null value is returned if the listener is associated with a specific connection.
    Note: This field may return null, indicating that no valid value can be obtained.

    HttpHeaderParam

    Parameter describing an HTTP packet header

    Used by actions: CreateCustomHeader, CreateDomainErrorPageInfo, DescribeCustomHeader, DescribeDomainErrorPageInfo, DescribeDomainErrorPageInfoByIds.

    Name Type Required Description
    HeaderName String Yes HTTP header name
    HeaderValue String Yes HTTP header value

    IPDetail

    IP details

    Used by actions: DescribeProxies, DescribeProxyDetail.

    Name Type Required Description
    IP String Yes IP string
    Provider String Yes Network provider. BGP: Tencent Cloud BGP (default); CMCC: China Mobile; CUCC: China Unicom; CTCC: China Telecom.
    Bandwidth Integer Yes Max bandwidth

    ListenerInfo

    Used by internal APIs. It returns the information of listeners whose statistics can be queried.

    Used by actions: DescribeProxyAndStatisticsListeners.

    Name Type Description
    ListenerId String Listener ID
    ListenerName String Listener name
    Port Integer Listening port
    Protocol String Listener protocol type

    MetricStatisticsInfo

    One-metric statistics

    Used by actions: DescribeListenerStatistics, DescribeProxyGroupStatistics, DescribeProxyStatistics, DescribeRealServerStatistics.

    Name Type Description
    MetricName String Metric name
    MetricData Array of StatisticsDataInfo Metric statistics

    NationCountryInnerInfo

    Nearest access country/region details

    Used by actions: DescribeGroupDomainConfig.

    Name Type Description
    NationCountryName String Country name
    NationCountryInnerCode String Country internal code

    NewRealServer

    Add new origin server information

    Used by actions: AddRealServers.

    Name Type Description
    RealServerId String Origin server ID
    RealServerIP String Origin server IP or domain name

    ProxyGroupDetail

    Connection group details

    Used by actions: DescribeProxyGroupDetails.

    Name Type Description
    CreateTime Integer Creation time
    ProjectId Integer Project ID
    ProxyNum Integer Number of connections in connection group
    Status Integer Connection group status:
    0: Running normally
    1: Creating
    4: Terminating
    11: Migrating
    12: Deploying
    OwnerUin String Owner UIN
    CreateUin String Creation UIN
    GroupName String Connection name
    DnsDefaultIp String Default IP of domain name resolution for connection groups
    Domain String Connection group domain name
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerRegionInfo RegionDetail Target region
    IsOldGroup Boolean Whether it is an old connection group, i.e., those created before August 3, 2018.
    GroupId String Connection group ID
    TagSet Array of TagPair Tag list
    Note: This field may return null, indicating that no valid values can be obtained.
    PolicyId String Security policy ID. This field exists if security policies are set.
    Note: This field may return null, indicating that no valid values can be obtained.
    Version String Connection group version
    Note: This field may return null, indicating that no valid values can be obtained.
    ClientIPMethod Array of Integer Describes how the connection obtains client IPs. 0: TOA; 1: Proxy Protocol.
    Note: This field may return null, indicating that no valid values can be obtained.
    IPAddressVersion String IP version. Valid values: IPv4 (default), IPv6.
    Note: This field may return null, indicating that no valid values can be obtained.
    PackageType String Package type of connection groups. Valid values: Thunder (general connection group), Accelerator (silver connection group), and CrossBorder (cross-MLC-border connection group).
    Note: This field may return null, indicating that no valid values can be obtained.
    Http3Supported Integer Specifies whether to enable HTTP3. Valid values:
    0: Disable
    1: Enable
    Note: This field may return null, indicating that no valid values can be obtained.
    FeatureBitmap Integer Feature bitmap. Valid values:
    0: Feature not supported
    1: Feature supported
    Each bit in the bitmap represents a feature:
    1st bit: Layer-4 acceleration;
    2nd bit: Layer-7 acceleration;
    3rd bit: HTTP3 access;
    4th bit: IPv6;
    5th bit: Dedicated BGP access;
    6th bit: Non-BGP access;
    7th bit: QoS acceleration.
    Note: This field may return null, indicating that no valid values can be obtained.
    Note: This field may return null, indicating that no valid values can be obtained.

    ProxyGroupInfo

    Connection group details list

    Used by actions: DescribeProxyGroupList.

    Name Type Description
    GroupId String Connection group ID
    Domain String Connection group domain name
    Note: This field may return null, indicating that no valid values can be obtained.
    GroupName String Connection group name
    Note: This field may return null, indicating that no valid values can be obtained.
    ProjectId Integer Project ID
    RealServerRegionInfo RegionDetail Target region
    Status String Connection group status.
    Where:
    RUNNING: Running
    CREATING: Creating
    DESTROYING: Terminating
    MOVING: Migrating
    CHANGING: Deploying
    TagSet Array of TagPair Tag list.
    Version String Connection group version
    Note: this field may return null, indicating that no valid values can be obtained.
    CreateTime Integer Creation time
    Note: this field may return null, indicating that no valid values can be obtained.
    ProxyType Integer Whether the connection group contains a Microsoft connection
    Note: this field may return null, indicating that no valid values can be obtained.
    Http3Supported Integer Specifies whether to enable HTTP3. Valid values:
    0: Disable
    1: Enable
    Note: This field may return null, indicating that no valid values can be obtained.
    FeatureBitmap Integer Feature bitmap. Valid values:
    0: Feature not supported
    1: Feature supported
    Each bit in the bitmap represents a feature:
    1st bit: Layer-4 acceleration;
    2nd bit: Layer-7 acceleration;
    3rd bit: HTTP3 access;
    4th bit: IPv6;
    5th bit: Dedicated BGP access;
    6th bit: Non-BGP access;
    7th bit: QoS acceleration.
    Note: this field may return null, indicating that no valid values can be obtained.
    Note: this field may return null, indicating that no valid values can be obtained.

    ProxyIdDict

    Connection ID

    Used by actions: DescribeGroupDomainConfig.

    Name Type Required Description
    ProxyId String Yes Connection ID

    ProxyInfo

    Connection information

    Used by actions: DescribeProxies, DescribeProxyDetail.

    Name Type Description
    InstanceId String Connection instance ID; It's an old parameter, please switch to ProxyId.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Integer Creation time in the format of UNIX timestamp, indicating the number of seconds that have elapsed since January 1, 1970 (midnight in UTC/GMT).
    ProjectId Integer Project ID.
    ProxyName String Connection name.
    AccessRegion String Access region.
    RealServerRegion String Origin server region.
    Bandwidth Integer Bandwidth. Unit: Mbps.
    Concurrent Integer Concurrence. Unit: 10K requests/second.
    Status String Connection status. Valid values:
    RUNNING: Running
    CREATING: Creating
    DESTROYING: Terminating
    OPENING: Enabling
    CLOSING: Disabling
    CLOSED: Disabled
    ADJUSTING: Adjusting configuration
    ISOLATING: Isolating
    ISOLATED: Isolated
    CLONING: Copying
    RECOVERING: Maintaining
    MOVING: Migrating
    Domain String Accessed domain name.
    IP String Accessed IP.
    Version String Connection versions: 1.0, 2.0, 3.0.
    ProxyId String Connection instance ID; It's a new parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    Scalarable Integer 1: this connection is expandable; 0: this connection is not expandable.
    SupportProtocols Array of String Supported protocol types.
    GroupId String Connection group ID. This field exists if a connection belongs to a connection group.
    Note: This field may return null, indicating that no valid values can be obtained.
    PolicyId String Security policy ID. This field exists if security policies are configured.
    Note: This field may return null, indicating that no valid values can be obtained.
    AccessRegionInfo RegionDetail Access region details, including region ID and region name.
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerRegionInfo RegionDetail Origin server region details, including region ID and region name.
    Note: This field may return null, indicating that no valid values can be obtained.
    ForwardIP String Forwarding IP of the connection
    TagSet Array of TagPair Tag list. This field is an empty list if no tags exist.
    Note: This field may return null, indicating that no valid values can be obtained.
    SupportSecurity Integer Whether security groups are supported.
    Note: This field may return null, indicating that no valid values can be obtained.
    BillingType Integer Billing mode. 0: bill-by-bandwidth; 1: bill-by-traffic.
    Note: this field may return null, indicating that no valid values can be obtained.
    RelatedGlobalDomains Array of String List of domain names associated with resolution record
    Note: this field may return null, indicating that no valid values can be obtained.
    ModifyConfigTime Integer Configuration change time
    Note: this field may return null, indicating that no valid values can be obtained.
    ProxyType Integer Connection type. 100: THUNDER connection; 103: Microsoft connection.
    Note: this field may return null, indicating that no valid value can be obtained.
    ClientIPMethod Array of Integer Describes how the connection obtains client IPs. 0: TOA; 1: Proxy Protocol.
    Note: this field may return null, indicating that no valid values can be obtained.
    IPAddressVersion String IP version. Valid values: IPv4, IPv6.
    Note: This field may return null, indicating that no valid values can be obtained.
    NetworkType String Network type. normal: general BGP; cn2: Dedicated BGP; triple: Non-BGP (provided by the top 3 ISPs in the Chinese mainland); secure_eip: Custom security EIP.
    Note: This field may return null, indicating that no valid value can be obtained.
    PackageType String Package type of connections. Valid values: Thunder (general connection), Accelerator (silver connection),
    and CrossBorder (cross-MLC-border connection).
    Note: This field may return null, indicating that no valid value can be obtained.
    BanStatus String Blocking-related status of the domain name. BANNED: the domain name is blocked; RECOVER: the domain name is unblocked or normal; BANNING: the domain name is being blocked; RECOVERING: the domain name is being unblocked; BAN_FAILED: the blocking fails; RECOVER_FAILED: the unblocking fails.
    Note: this field may return null, indicating that no valid value can be obtained.
    IPList Array of IPDetail
    Http3Supported Integer Specifies whether to enable HTTP3. Valid values:
    0: disable HTTP3;
    1: enable HTTP3.
    Note: this field may return null, indicating that no valid value can be obtained.
    InBanBlacklist Integer Indicates whether the origin server IP or domain name is in the blocklist. Valid values: 0 (no) and 1 (yes).
    Note: This field may return null, indicating that no valid value can be obtained.
    FeatureBitmap Integer Feature bitmap. Valid values:
    0: Feature not supported
    1: Feature supported
    Each bit in the bitmap represents a feature:
    1st bit: Layer-4 acceleration;
    2nd bit: Layer-7 acceleration;
    3rd bit: HTTP3 access;
    4th bit: IPv6;
    5th bit: Dedicated BGP access;
    6th bit: Non-BGP access;
    7th bit: QoS acceleration.
    Note: This field may return null, indicating that no valid value can be obtained.
    Note: This field may return null, indicating that no valid value can be obtained.

    ProxySimpleInfo

    Used by internal APIs. It returns connections from which the statistics can be derived, and the listener information.

    Used by actions: DescribeGroupAndStatisticsProxy, DescribeProxyAndStatisticsListeners.

    Name Type Description
    ProxyId String Connection ID
    ProxyName String Connection name
    ListenerList Array of ListenerInfo Listener list

    ProxyStatus

    Connection status information

    Used by actions: DescribeProxiesStatus.

    Name Type Description
    InstanceId String Connection instance ID.
    Status String Connection status.
    Where:
    RUNNING: Running
    CREATING: Creating
    DESTROYING: Terminating
    OPENING: Enabling
    CLOSING: Disabling
    CLOSED: Disabled
    ADJUSTING: Adjusting configuration
    ISOLATING: Isolating
    ISOLATED: Isolated
    MOVING: Migrating

    RealServer

    Query listeners or rules-related origin server information, excluding tag information.

    Used by actions: DescribeListenerRealServers, DescribeRuleRealServers.

    Name Type Description
    RealServerIP String Origin server IP or domain name
    RealServerId String Origin server ID
    RealServerName String Origin server name
    ProjectId Integer Project ID
    InBanBlacklist Integer Indicates whether the origin server IP or domain name is in the blocklist. Valid values: 0 (no) and 1 (yes).

    RealServerBindSetReq

    Information of the bound origin server

    Used by actions: BindListenerRealServers, BindRuleRealServers.

    Name Type Required Description
    RealServerId String Yes Origin server ID
    RealServerPort Integer Yes Origin server port
    RealServerIP String Yes Origin server IP
    RealServerWeight Integer No Origin server weight
    RealServerFailoverRole String No Role of the origin server. Values: master (primary origin server); slave (secondary origin server). This parameter only takes effect when origin failover is enabled for the listener.

    RealServerStatus

    Query the binding status of origin servers. BindStatus: 0 (not bound), 1(bound to rules or listeners).

    Used by actions: DescribeRealServersStatus.

    Name Type Description
    RealServerId String Origin server ID.
    BindStatus Integer 0: Not bound; 1: Bound to rule or listener.
    ProxyId String ID of the connection bound to this origin server. This string is empty if they are not bound.
    GroupId String ID of the connection group bound to this origin server. This string is null if no connection groups are bound.
    Note: This field may return null, indicating that no valid values can be obtained.

    RegionDetail

    Region details

    Used by actions: DescribeAccessRegions, DescribeDestRegions, DescribeProxies, DescribeProxyDetail, DescribeProxyGroupDetails, DescribeProxyGroupList, DescribeRegionAndPrice.

    Name Type Description
    RegionId String Region ID
    RegionName String Region name in Chinese or English
    RegionArea String Region where the data center locates
    RegionAreaName String Name of the region where the data center locates
    IDCType String Data center type. dc: data center; ec: edge server.
    FeatureBitmap Integer Feature bitmap. Valid values:
    0: the feature is not supported;
    1: the feature is supported.
    Each bit in the bitmap represents a feature:
    1st bit: layer-4 acceleration;
    2nd bit: layer-7 acceleration;
    3rd bit: HTTP3 access;
    4th bit: IPv6;
    5th bit: dedicated BGP access;
    6th bit: non-BGP access;
    7th bit: QoS acceleration.
    Note: this field may return null, indicating that no valid values can be obtained.
    SupportFeature SupportFeature Network support
    Note: This field may return null, indicating that no valid values can be obtained.

    RuleCheckParams

    Health check parameters of the layer-7 listeners' forwarding rules

    Used by actions: CreateRule, DescribeRules, DescribeRulesByRuleIds, ModifyRuleAttribute.

    Name Type Required Description
    DelayLoop Integer Yes Time interval of health check
    ConnectTimeout Integer Yes Response timeout of health check
    Path String Yes Check path of health check
    Method String Yes Health check method: GET/HEAD
    StatusCode Array of Integer Yes Return code indicting normal origin servers. Value range: [100, 200, 300, 400, 500]
    Domain String No Domain name to be performed health check
    You cannot modify this parameter when calling ModifyRuleAttribute API.
    FailedCountInter Integer No Origin server failure check frequency
    Note: this field may return null, indicating that no valid values can be obtained.
    FailedThreshold Integer No Origin server health check threshold. All requests to the origin server will be blocked once the threshold is exceeded.
    Note: this field may return null, indicating that no valid values can be obtained.
    BlockInter Integer No Duration to block requests targeting the origin server after a failed health check
    Note: this field may return null, indicating that no valid values can be obtained.

    RuleInfo

    Forwarding rule of layer-7 listeners

    Used by actions: DescribeRules, DescribeRulesByRuleIds.

    Name Type Description
    RuleId String Rule information
    ListenerId String Listener information
    Domain String Rule domain name
    Path String Rule path
    RealServerType String Origin server type
    Scheduler String The strategy used by the listener to access the origin server. Values: rr (round-robin), wrr (weighted round-robin), lc (the least-connections strategy), lrtt (the least-response-time strategy).
    HealthCheck Integer Whether health check is enabled. 1: enabled, 0: disabled
    RuleStatus Integer Rule status. 0: running, 1: creating, 2: terminating, 3: binding/unbinding origin server, 4: updating configuration
    CheckParams RuleCheckParams Health check parameters
    RealServerSet Array of BindRealServer Bound origin server information
    BindStatus Integer Origin server service status. 0: exceptional, 1: normal
    If health check is not enabled, this status will always be normal.
    As long as one origin server is exceptional, this status will be exceptional. Please view RealServerSet for the status of specific origin servers.
    ForwardHost String The host carried in the request forwarded from the connection to the origin server. default indicates directly forwarding the received 'host'.
    Note: This field may return null, indicating that no valid values can be obtained.
    ServerNameIndicationSwitch String Specifies whether to enable Server Name Indication (SNI). Valid values: ON (enable) and OFF (disable).
    Note: This field may return null, indicating that no valid value can be obtained.
    Note: This field may return null, indicating that no valid value can be obtained.
    ServerNameIndication String Server Name Indication (SNI). This field is required when ServerNameIndicationSwitch is ON.
    Note: This field may return null, indicating that no valid value can be obtained.
    Note: This field may return null, indicating that no valid value can be obtained.
    ForcedRedirect String Forces requests to redirect to HTTPS. When https: is passed in, all requests are redirected to HTTPS.
    Note: This field may return null, indicating that no valid values can be obtained.

    SecurityPolicyRuleIn

    Security policy rule (input parameter)

    Used by actions: CreateSecurityRules.

    Name Type Required Description
    SourceCidr String Yes Source IP or IP range of the request.
    Action String Yes Policy: Allow (ACCEPT) or reject (DROP).
    AliasName String No Rule alias
    Protocol String No Protocol: TCP or UDP. ALL indicates all protocols.
    DestPortRange String No Target port. Formatting examples:
    Single port: 80
    Multiple ports: 80, 443
    Consecutive ports: 3306-20000
    All ports: ALL

    SecurityPolicyRuleOut

    Security policy rule (output parameter)

    Used by actions: DescribeSecurityPolicyDetail, DescribeSecurityRules.

    Name Type Description
    Action String Policy: Allow (ACCEPT) or reject (DROP).
    SourceCidr String Source IP or IP range of the request.
    AliasName String Rule alias
    DestPortRange String Target port range
    Note: This field may return null, indicating that no valid values can be obtained.
    RuleId String Rule ID
    Protocol String Protocol type to be matched (TCP/UDP)
    Note: This field may return null, indicating that no valid values can be obtained.
    PolicyId String Security policy ID
    Note: This field may return null, indicating that no valid values can be obtained.

    StatisticsDataInfo

    Statistics information

    Used by actions: DescribeListenerStatistics, DescribeProxyGroupStatistics, DescribeProxyStatistics, DescribeRealServerStatistics.

    Name Type Description
    Time Integer Corresponding time point
    Data Float Statistics value
    Note: This field may return null, indicating that no valid values can be obtained.

    SupportFeature

    Network support

    Used by actions: DescribeAccessRegions, DescribeDestRegions, DescribeProxies, DescribeProxyDetail, DescribeRegionAndPrice.

    Name Type Description
    NetworkType Array of String Supported network types. normal: General BGP; cn2: Dedicated BGP; triple: Non-BGP (provided by the top 3 ISPs in the Chinese mainland); secure_eip: Custom security EIPs.

    TCPListener

    TCP listener information

    Used by actions: DescribeTCPListeners.

    Name Type Description
    ListenerId String Listener ID
    ListenerName String Listener name
    Port Integer Listener port
    RealServerPort Integer Origin server port, which is only valid for the connections of version 1.0.
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerType String Type of the origin server bound to listeners
    Protocol String Listener protocol: TCP.
    ListenerStatus Integer Listener status:
    0: Running
    1: Creating
    2: Terminating
    3: Adjusting origin server
    4: Adjusting configuration
    Scheduler String The strategy used by the listener to access the origin server. Values: rr (round-robin), wrr (weighted round-robin), lc (the least-connections strategy), lrtt (the least-response-time strategy).
    ConnectTimeout Integer Response timeout of origin server health check (unit: seconds).
    DelayLoop Integer Time interval of origin server health check (unit: seconds).
    HealthCheck Integer Whether to enable the listener health check:
    0: Disable
    1: Enable
    BindStatus Integer Status of the origin server bound to listeners:
    0: Abnormal
    1: Normal
    RealServerSet Array of BindRealServer Information of the origin server bound to listeners
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Integer Listener creation time in the format of UNIX timestamp
    ClientIPMethod Integer Describes how the listener obtains client IPs. 0: TOA; 1: Proxy Protocol.
    Note: This field may return null, indicating that no valid values can be obtained.
    HealthyThreshold Integer Healthy threshold. The number of consecutive successful health checks required before considering an origin server healthy. Value range: 1 - 10.
    Note: This field may return null, indicating that no valid values can be obtained.
    UnhealthyThreshold Integer Unhealthy threshold. The number of consecutive failed health checks required before considering an origin server unhealthy. Value range: 1 - 10.
    Note: This field may return null, indicating that no valid values can be obtained.
    FailoverSwitch Integer Whether to enable the primary/secondary origin server mode for failover. Values: 1 (enabled); 0 (disabled). It’s not available if the origin type is DOMAIN.
    Note: This field may return null, indicating that no valid values can be obtained.
    SessionPersist Integer Specifies whether to enable session persistence. Values: 0 (disable), 1 (enable)
    Note: This field may return null, indicating that no valid values can be obtained.
    ProxyId String Connection ID of the listener. A null value is returned if the listener is associated with the connection group.
    Note: This field may return null, indicating that no valid value can be obtained.
    GroupId String Connection group ID of the listener. A null value is returned if the listener is associated with a specific connection.
    Note: This field may return null, indicating that no valid value can be obtained.

    TagPair

    Tag key-value pair

    Used by actions: AddRealServers, CreateProxy, CreateProxyGroup, DescribeProxies, DescribeProxyDetail, DescribeProxyGroupDetails, DescribeProxyGroupList, DescribeRealServers.

    Name Type Required Description
    TagKey String Yes Tag key
    TagValue String Yes Tag value

    TagResourceInfo

    Resource information of the tag

    Used by actions: DescribeResourcesByTag.

    Name Type Description
    ResourceType String Resource types:
    Proxy: Connection
    ProxyGroup: Connection group
    RealServer: Origin server
    ResourceId String Instance ID

    UDPListener

    UDP listener information

    Used by actions: DescribeUDPListeners.

    Name Type Description
    ListenerId String Listener ID
    ListenerName String Listener name
    Port Integer Listener port
    RealServerPort Integer Origin server port, which is only valid for the connections or connection groups of version 1.0.
    Note: This field may return null, indicating that no valid values can be obtained.
    RealServerType String Type of the origin server bound to listeners
    Protocol String Listener protocol: UDP.
    ListenerStatus Integer Listener status:
    0: Running
    1: Creating
    2: Terminating
    3: Adjusting origin server
    4: Adjusting configuration
    Scheduler String The strategy used by the listener to access the origin server. Values: rr (round-robin), wrr (weighted round-robin), lc (the least-connections strategy), lrtt (the least-response-time strategy).
    BindStatus Integer Origin server binding status of listeners. 0: Normal; 1: IP exception; 2: Domain name resolution exception.
    RealServerSet Array of BindRealServer Information of the origin server bound to listeners
    CreateTime Integer Listener creation time in the format of UNIX timestamp
    SessionPersist Integer Specifies whether to enable session persistence. Values: 0 (disable), 1 (enable)
    Note: This field may return null, indicating that no valid values can be obtained.
    DelayLoop Integer Time interval of origin server health check (unit: seconds). Value range: [5, 300].
    Note: This field may return null, indicating that no valid value can be obtained.
    ConnectTimeout Integer Response timeout of origin server health check (unit: seconds). Value range: [2, 60]. The timeout value shall be less than the time interval for health check DelayLoop.
    Note: This field may return null, indicating that no valid value can be obtained.
    HealthyThreshold Integer Healthy threshold. The number of consecutive successful health checks required before considering an origin server healthy. Value range: 1 - 10.
    Note: This field may return null, indicating that no valid values can be obtained.
    UnhealthyThreshold Integer Unhealthy threshold. The number of consecutive failed health checks required before considering an origin server unhealthy. Value range: 1 - 10.
    Note: This field may return null, indicating that no valid value can be obtained.
    FailoverSwitch Integer Whether to enable the primary/secondary origin server mode for failover. Values: 1 (enabled); 0 (disabled). It’s not available if the origin type is DOMAIN.
    Note: This field may return null, indicating that no valid value can be obtained.
    HealthCheck Integer Whether the health check is enabled for the origin server. Values: 1 (enabled); 0 (disabled).
    Note: This field may return null, indicating that no valid value can be obtained.
    CheckType String The health check type. Values: PORT (port); PING (ping).
    Note: This field may return null, indicating that no valid value can be obtained.
    CheckPort Integer The health probe port.
    Note: This field may return null, indicating that no valid value can be obtained.
    ContextType String The UDP message type. Values: TEXT (text). This parameter is used only when CheckType = PORT.
    Note: This field may return null, indicating that no valid value can be obtained.
    SendContext String The UDP message sent by the health probe port. This parameter is used only when CheckType = PORT.
    Note: This field may return null, indicating that no valid value can be obtained.
    RecvContext String The UDP message received by the health probe port. This parameter is used only when CheckType = PORT.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProxyId String Connection ID of the listener. A null value is returned if the listener is associated with the connection group.
    Note: this field may return null, indicating that no valid values can be obtained.
    GroupId String Connection group ID of the listener. A null value is returned if the listener is associated with a specific connection.
    Note: This field may return null, indicating that no valid value can be obtained.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy