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 upper limit in Mbps. |
Concurrent | Integer | Yes | Concurrent connection upper limit in 10,000 connections, which indicates the allowed number of concurrently online connections. |
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 |
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. |
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. |
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. |
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. |
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. |
Certificate alias information.
Used by actions: DescribeHTTPSListeners, DescribeRules.
Name | Type | Description |
---|---|---|
CertificateId | String | Certificate ID. |
CertificateAlias | String | Certificate alias. |
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 | 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'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. |
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. |
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 |
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. |
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. |
Filter conditions
Used by actions: DescribeProxies, DescribeProxyGroupList, DescribeRealServers.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filter conditions |
Values | Array of String | Yes | Filter values |
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 |
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. |
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. |
Parameter describing an HTTP packet header
Used by actions: CreateDomainErrorPageInfo, DescribeDomainErrorPageInfo, DescribeDomainErrorPageInfoByIds.
Name | Type | Required | Description |
---|---|---|---|
HeaderName | String | Yes | HTTP header name |
HeaderValue | String | Yes | HTTP header value |
Used by internal APIs. It returns the information of listeners whose statistics can be queried.
Used by actions: DescribeGroupAndStatisticsProxy, DescribeProxyAndStatisticsListeners.
Name | Type | Description |
---|---|---|
ListenerId | String | Listener ID |
ListenerName | String | Listener name |
Port | Integer | Listening port |
Protocol | String | Listener protocol type |
One-metric statistics
Used by actions: DescribeListenerStatistics, DescribeProxyGroupStatistics, DescribeProxyStatistics, DescribeRealServerStatistics.
Name | Type | Description |
---|---|---|
MetricName | String | Metric name |
MetricData | Array of StatisticsDataInfo | Metric statistics |
Nearest access country/region details
Used by actions: DescribeGroupDomainConfig.
Name | Type | Description |
---|---|---|
NationCountryName | String | Country name |
NationCountryInnerCode | String | Country internal code |
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 |
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; |
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. |
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: 0: running; 1: creating; 4: terminating; 11: connection migrating. |
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. |
Connection ID
Used by actions: DescribeGroupDomainConfig.
Name | Type | Required | Description |
---|---|---|---|
ProxyId | String | Yes | Connection ID |
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: requests/second. |
Status | String | Connection status: RUNNING: running; CREATING: creating; DESTROYING: terminating; OPENING: enabling; CLOSING: disabling; CLOSED: disabled; ADJUSTING: adjusting configuration ISOLATING: isolating (it's triggered when the account is in arrears); ISOLATED: isolated (it's triggered when the account is in arrears); UNKNOWN: unknown status. |
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. 104: SILVER connection. 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. |
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 |
Connection status information
Used by actions: DescribeProxiesStatus.
Name | Type | Description |
---|---|---|
InstanceId | String | Connection instance ID. |
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; UNKNOWN: unknown status. |
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 |
RealServerBindSetReq
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 |
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. |
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 |
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. |
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 | Forwarding policy of the origin server |
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. |
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 |
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 |
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. |
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. Valid values: 0: running; 1: creating; 2: terminating; 3: adjusting origin server; 4: adjusting configuration. |
Scheduler | String | Origin server access policy of listener. Valid values: rr: round robin; wrr: weighted round robin; lc: least connection. |
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 health check is enabled for listener. Valid values: 0: disabled; 1: enabled |
BindStatus | Integer | Status of origin server bound to listener. Valid values: 0: exceptional; 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; using 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. |
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 |
Resource information of the tag
Used by actions: DescribeResourcesByTag.
Name | Type | Description |
---|---|---|
ResourceType | String | Resource types:Proxy : connections;ProxyGroup : connection groups;RealServer : origin servers. |
ResourceId | String | Resource ID |
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. Valid values: 0: running; 1: creating; 2: terminating; 3: adjusting origin server; 4: adjusting configuration. |
Scheduler | String | Origin server access policy of listeners |
BindStatus | Integer | Status of origin server bound to listener. 0: normal, 1: exceptional IP, 2: exceptional domain name resolution |
RealServerSet | Array of BindRealServer | Information of the origin server bound to listeners |
CreateTime | Integer | Listener creation time; using UNIX timestamp. |
Was this page helpful?