Tencent Cloud EdgeOne

Tencent Cloud EdgeOne
API Documentation
Product Documentation©2013-2022 Tencent Cloud. All rights reserved.

Page 1 of 760

Tencent Cloud EdgeOne

Copyright Notice©2013-2024 Tencent Cloud. All rights reserved.
Copyright in this document is exclusively owned by Tencent Cloud. You must not reproduce, modify, copy or distributein any way, in whole or in part, the contents of this document without Tencent Cloud's the prior written consent.
Trademark Notice

All trademarks associated with Tencent Cloud and its services are owned by Tencent Cloud Computing (Beijing)
Company Limited and its affiliated companies. Trademarks of third parties referred to in this document are owned bytheir respective proprietors.
Service Statement
This document is intended to provide users with general information about Tencent Cloud's products and services
only and does not form part of Tencent Cloud's terms and conditions. Tencent Cloud's products or services are
subject to change. Specific products and services and the standards applicable to them are exclusively provided for in
Tencent Cloud's applicable terms and conditions.

©2013-2022 Tencent Cloud. All rights reserved.

Page 2 of 760

Tencent Cloud EdgeOne

Contents
API Documentation
History
Introduction
API Category
Making API Requests
Request Structure
Common Params
Signature v3
Signature
Responses
Site APIs
CreateZone
DescribeIdentifications
ModifyZone
DeleteZone
ModifyZoneStatus
CheckCnameStatus
IdentifyZone
DescribeZones
VerifyOwnership
Acceleration Domain Management APIs
CreateAccelerationDomain
DescribeAccelerationDomains
ModifyAccelerationDomain
ModifyAccelerationDomainStatuses
DeleteAccelerationDomains
CreateSharedCNAME
BindSharedCNAME
DeleteSharedCNAME
Site Acceleration Configuration APIs
CreateRule
DeleteRules
DescribeHostsSetting
DescribeRules
DescribeRulesSetting©2013-2022 Tencent Cloud. All rights reserved.

Page 3 of 760

Tencent Cloud EdgeOne

DescribeZoneSetting
ModifyRule
ModifyZoneSetting
Alias Domain APIs
CreateAliasDomain
DescribeAliasDomains
ModifyAliasDomain
ModifyAliasDomainStatus
DeleteAliasDomain
Security Configuration APIs
CreateSecurityIPGroup
DescribeSecurityIPGroup
ModifySecurityIPGroup
DeleteSecurityIPGroup
DescribeOriginProtection
DescribeSecurityTemplateBindings
ModifySecurityPolicy
BindSecurityTemplateToEntity
DescribeSecurityIPGroupInfo
Layer 4 Application Proxy APIs
CreateL4Proxy
ModifyL4Proxy
ModifyL4ProxyStatus
DescribeL4Proxy
DeleteL4Proxy
CreateL4ProxyRules
ModifyL4ProxyRules
ModifyL4ProxyRulesStatus
DescribeL4ProxyRules
DeleteL4ProxyRules
CreateApplicationProxy
ModifyApplicationProxy
ModifyApplicationProxyStatus
DescribeApplicationProxies
DeleteApplicationProxy
CreateApplicationProxyRule
ModifyApplicationProxyRule
ModifyApplicationProxyRuleStatus©2013-2022 Tencent Cloud. All rights reserved.

Page 4 of 760

Tencent Cloud EdgeOne

DeleteApplicationProxyRule
Content Management APIs
CreatePurgeTask
DescribePurgeTasks
CreatePrefetchTask
DescribePrefetchTasks
DescribeContentQuota
Data Analysis APIs
DescribeDDoSAttackData
DescribeDDoSAttackEvent
DescribeDDoSAttackTopData
DescribeOverviewL7Data
DescribeTimingL4Data
DescribeTimingL7AnalysisData
DescribeTopL7AnalysisData
DescribeTimingL7CacheData
DescribeTopL7CacheData
Log Service APIs
DownloadL7Logs
DownloadL4Logs
CreateCLSIndex
CreateRealtimeLogDeliveryTask
ModifyRealtimeLogDeliveryTask
DeleteRealtimeLogDeliveryTask
DescribeRealtimeLogDeliveryTasks
Billing APIs
CreatePlan
UpgradePlan
RenewPlan
ModifyPlan
IncreasePlanQuota
DestroyPlan
CreatePlanForZone
BindZoneToPlan
DescribeBillingData
DescribeAvailablePlans
Certificate APIs
DescribeDefaultCertificates©2013-2022 Tencent Cloud. All rights reserved.

Page 5 of 760

Tencent Cloud EdgeOne

ModifyHostsCertificate
Load Balancing APIs
CreateOriginGroup
ModifyOriginGroup
DeleteOriginGroup
DescribeOriginGroup
Custom Response Page APIs
CreateCustomizeErrorPage
DescribeCustomErrorPages
ModifyCustomErrorPage
DeleteCustomErrorPage
Diagnostic Tool APIs
DescribeIPRegion
Version Management APIs
CreateConfigGroupVersion
DeployConfigGroupVersion
DescribeConfigGroupVersionDetail
DescribeConfigGroupVersions
DescribeDeployHistory
DescribeEnvironments
Data Types
Error Codes©2013-2022 Tencent Cloud. All rights reserved.

Page 6 of 760

Tencent Cloud EdgeOne

API Documentation
History：

Last updated 2024-06-13 17:03:24

Release 27
Release time: 2024-06-13 17:03:02
Release updates:
Improvement to existing documentation.
New APIs:
CreateCustomizeErrorPage
DeleteCustomErrorPage
DescribeCustomErrorPages
ModifyCustomErrorPage
New data structures:
CustomErrorPage
ErrorPageReference

Release 26
Release time: 2024-06-06 11:04:53
Release updates:
Improvement to existing documentation.
Modified data structures:
RateLimitTemplateDetail
Modified members: ID, Action, PunishTime, Threshold, Period

Release 25©2013-2022 Tencent Cloud. All rights reserved.

Page 7 of 760

Tencent Cloud EdgeOne

Release time: 2024-06-05 17:20:11
Release updates:
Improvement to existing documentation.
Modified data structures:
Rule
Modified members: Actions

Release 24
Release time: 2024-06-05 14:40:47
Release updates:
Improvement to existing documentation.
New APIs:
DescribeSecurityIPGroup
Modified APIs:
CreatePurgeTask
New input parameters:CacheTag
New data structures:
CacheTag

Release 23
Release time: 2024-05-29 14:55:16
Release updates:
Improvement to existing documentation.
New APIs:
CreatePlan
DestroyPlan
IncreasePlanQuota©2013-2022 Tencent Cloud. All rights reserved.

Page 8 of 760

Tencent Cloud EdgeOne

ModifyPlan
RenewPlan
UpgradePlan
Modified APIs:
CreateRealtimeLogDeliveryTask
New input parameters:LogFormat
ModifyRealtimeLogDeliveryTask
New input parameters:LogFormat
New data structures:
LogFormat
PrepaidPlanParam
RenewFlag
Modified data structures:
RealtimeLogDeliveryTask
New members:LogFormat
Task
New members:Method

Release 22
Release time: 2024-04-09 10:24:26
Release updates:
Improvement to existing documentation.
New APIs:
DescribeSecurityIPGroupInfo

Release 21
Release time: 2024-03-21 16:42:49
Release updates:©2013-2022 Tencent Cloud. All rights reserved.

Page 9 of 760

Tencent Cloud EdgeOne

Improvement to existing documentation.
New APIs:
CreateCLSIndex
CreateRealtimeLogDeliveryTask
DeleteRealtimeLogDeliveryTask
DescribeRealtimeLogDeliveryTasks
ModifyRealtimeLogDeliveryTask
New data structures:
CLSTopic
CustomEndpoint
CustomField
DeliveryCondition
RealtimeLogDeliveryTask
S3
Modified data structures:
L4ProxyRule
New members:BuId

Release 20
Release time: 2024-02-20 16:06:00
Release updates:
Improvement to existing documentation.
New APIs:
CreateL4Proxy
CreateL4ProxyRules
DeleteL4Proxy
DeleteL4ProxyRules
DescribeBillingData
DescribeIPRegion
DescribeL4Proxy
DescribeL4ProxyRules©2013-2022 Tencent Cloud. All rights reserved.

Page 10 of 760

Tencent Cloud EdgeOne

ModifyL4Proxy
ModifyL4ProxyRules
ModifyL4ProxyRulesStatus
ModifyL4ProxyStatus
Modified APIs:
DescribeApplicationProxies
New input parameters:ZoneId
DescribeDefaultCertificates
New input parameters:ZoneId
Modified input parameters: Filters
New data structures:BillingData
BillingDataFilter
DDosProtectionConfig
IPRegionInfo
L4Proxy
L4ProxyRule
Modified data structures:
OriginDetail
New members:VodeoSubAppId, VodeoDistributionRange, VodeoBucketId
Modified members: OriginType, Origin, BackupOrigin, OriginGroupName, BackOriginGroupName,
PrivateAccess, PrivateParameters
OriginInfo
New members:VodeoSubAppId, VodeoDistributionRange, VodeoBucketId
Resource
New members:Type

Release 19
Release time: 2023-12-01 16:40:01
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 11 of 760

Tencent Cloud EdgeOne

Modified data structures:
Resource
Modified members: Group, ZoneNumber

Release 18
Release time: 2023-12-01 15:15:45
Release updates:
Improvement to existing documentation.
New APIs:
CreateConfigGroupVersion
DeployConfigGroupVersion
DescribeConfigGroupVersionDetail
DescribeConfigGroupVersions
DescribeDeployHistory
DescribeEnvironments
New data structures:
ConfigGroupVersionInfo
DeployRecord
EnvInfo

Release 17
Release time: 2023-11-24 11:38:10
Release updates:
Improvement to existing documentation.
Modified APIs:
DescribePrefetchTasks
New input parameters:ZoneId©2013-2022 Tencent Cloud. All rights reserved.

Page 12 of 760

Tencent Cloud EdgeOne

Release 16
Release time: 2023-11-17 16:59:52
Release updates:
Improvement to existing documentation.
New APIs:
BindSecurityTemplateToEntity
DescribeSecurityTemplateBindings
Modified APIs:
CreateOriginGroupNew input parameters:Name, Type, Records
Deleted input parameters: OriginType, OriginGroupName, ConfigurationType, OriginRecords
DeleteOriginGroupNew input parameters:GroupId
Deleted input parameters: OriginGroupId
DescribeOriginGroupNew input parameters:ZoneId
Modified input parameters: Offset, Limit
ModifyAccelerationDomain
New input parameters:OriginProtocol, HttpOriginPort, HttpsOriginPort, IPv6Status
Modified input parameters: OriginInfo
ModifyOriginGroupNew input parameters:GroupId, Name, Type, Records
Deleted input parameters: OriginGroupId, OriginType, OriginGroupName, ConfigurationType, OriginRecords
New data structures:
EntityStatus
SecurityTemplateBinding
TemplateScope
Modified data structures:
AclUserRule
New members:CustomResponseId
BotUserRule©2013-2022 Tencent Cloud. All rights reserved.

Page 13 of 760

Tencent Cloud EdgeOne

New members:Name, CustomResponseId, ResponseCode, RedirectUrl
DropPageDetail
New members:CustomResponseId
OriginRecord
New members:Type
Deleted members: Port, Proto, Area
RateLimitUserRule
New members:Name, CustomResponseId, ResponseCode, RedirectUrl

Release 15
Release time: 2023-11-08 16:08:57
Release updates:
Improvement to existing documentation.
New APIs:
BindSharedCNAME
DeleteSharedCNAME
New data structures:
BindSharedCNAMEMap
OriginGroupReference
Modified data structures:
OriginGroupNew members:GroupId, Name, Type, Records, References, CreateTime
Deleted members: ZoneId, ZoneName, OriginGroupId, OriginType, OriginGroupName, ConfigurationType,
OriginRecords

Release 14
Release time: 2023-10-31 13:05:24
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 14 of 760

Tencent Cloud EdgeOne

New APIs:
VerifyOwnership
Modified APIs:
CreateAccelerationDomain
New input parameters:OriginProtocol, HttpOriginPort, HttpsOriginPort, IPv6Status
CreateZone
New input parameters:Area, PlanId
Deprecate input parameters: AllowDuplicates, JumpStart
New output parameters:OwnershipVerification
ModifyHostsCertificate
New input parameters:Mode
Deprecate input parameters: ApplyType
New data structures:
AccelerationDomainCertificate
CertificateInfo
Modified data structures:
AccelerationDomain
New members:OriginProtocol, HttpOriginPort, HttpsOriginPort, IPv6Status, OwnershipVerification, Certificate
Modified members: ZoneId, DomainName, DomainStatus, OriginDetail, Cname, IdentificationStatus,
CreatedOn, ModifiedOn
RuleCondition
Deprecate members: IgnoreNameCase
Zone
New members:OwnershipVerification
Modified members: LockStatus

Release 13
Release time: 2023-10-30 16:45:20
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 15 of 760

Tencent Cloud EdgeOne

New APIs:
CreateSharedCNAME
Modified APIs:
CreateAccelerationDomain
New output parameters:OwnershipVerification
New data structures:
DnsVerification
FileVerification
NsVerification
OwnershipVerification

Release 12
Release time: 2023-09-18 18:09:23
Release updates:
Improvement to existing documentation.
Modified APIs:
CreateApplicationProxyRule
New input parameters:RuleTag
ModifyApplicationProxyRule
New input parameters:RuleTag
Modified data structures:
ApplicationProxyRule
New members:RuleTag
L4OfflineLog
New members:LogStartTime, LogEndTime
L7OfflineLog
New members:LogStartTime, LogEndTime

Release 11©2013-2022 Tencent Cloud. All rights reserved.

Page 16 of 760

Tencent Cloud EdgeOne

Release time: 2023-08-03 14:49:53
Release updates:
Improvement to existing documentation.
New APIs:
CheckCnameStatus
Modified APIs:
CreateApplicationProxyRule
New input parameters:SessionPersistTime
CreateZone
Modified input parameters: ZoneName
ModifyApplicationProxyRule
New input parameters:SessionPersistTime
ModifyZone
New input parameters:Area, ZoneName
New data structures:
CnameStatus
Modified data structures:
ApplicationProxyRule
New members:SessionPersistTime
Cache
Deprecate members: IgnoreCacheControl
Resource
New members:Group, ZoneNumber
Sv
New members:Pack, InstanceId, ProtectionSpecs

Release 10
Release time: 2023-08-02 09:38:38
Release updates:
Improvement to existing documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 17 of 760

Tencent Cloud EdgeOne

New APIs:
CreateSecurityIPGroup
DeleteSecurityIPGroup
ModifySecurityIPGroup
Deleted APIs:
CheckCertificate
CreateCredential
CreateReplayTask
CreateSpeedTesting
DescribeAddableEntityList
DescribeClientRuleList
DescribeDnsData
DescribeLogSets
DescribeLogTopicTasks
DescribeSingleL7AnalysisData
DescribeSpeedTestingDetails
DescribeSpeedTestingMetricData
DescribeSpeedTestingQuota
DescribeTimingL7SourceData
DescribeWebManagedRulesData
DescribeWebManagedRulesHitRuleDetail
DescribeWebManagedRulesLog
DescribeWebProtectionClientIpList
DescribeWebProtectionData
DescribeWebProtectionHitRuleDetail
DescribeWebProtectionTopData
ModifyDefaultCertificate
ModifyRulePriority
ModifySecurityWafGroupPolicy
ReclaimAliasDomain
ReclaimZone
UpdateOriginProtectionIPWhitelist
Modified APIs:
CreateApplicationProxy
New input parameters:AccelerateMainland©2013-2022 Tencent Cloud. All rights reserved.

Page 18 of 760

Tencent Cloud EdgeOne

CreatePurgeTask
New input parameters:Method
Deprecate input parameters: EncodeUrl
ModifyApplicationProxy
New input parameters:AccelerateMainland
ModifyZoneSetting
New input parameters:ImageOptimize, StandardDebug
New data structures:
IPGroupStandardDebug
Deleted data structures:
ClientRule
ClsLogTopicInfo
DistrictStatistics
DnsData
LogSetInfo
OptimizeAction
SecClientIp
SecHitRuleInfo
SecRuleRelatedInfo
SingleDataRecord
SingleTypeValue
SpeedTestingConfig
SpeedTestingDetailData
SpeedTestingInfo
SpeedTestingMetricData
SpeedTestingQuota
SpeedTestingStatistics
SpeedTestingStatus
WafGroup
WebLogs
Modified data structures:
ApplicationProxy
New members:AccelerateMainland©2013-2022 Tencent Cloud. All rights reserved.

Page 19 of 760

Tencent Cloud EdgeOne

Modified members: ProxyId
Zone
New members:LockStatus
ZoneSetting
New members:StandardDebug
Modified members: AccelerateMainland

Release 9
Release time: 2023-05-25 17:11:57
Release updates:
Improvement to existing documentation.
New APIs:
DescribeDDoSAttackEvent
Modified APIs:
IdentifyZone
New input parameters:Domain
New data structures:
AccelerateMainland
AlgDetectJS
AlgDetectResult
AlgDetectRule
AlgDetectSession
BotExtendAction
BotUserRule
DDoSAttackEvent
DDoSBlockData
ImageOptimize
Modified data structures:
BotConfig
New members:BotUserRules, AlgDetectRule, Customizes©2013-2022 Tencent Cloud. All rights reserved.

Page 20 of 760

Tencent Cloud EdgeOne

Https
New members:CipherSuite
Identification
New members:Domain
ZoneSetting
New members:ImageOptimize, AccelerateMainland

Release 8
Release time: 2023-03-17 10:39:51
Release updates:
Improvement to existing documentation.
New APIs:
CreateAccelerationDomain
DeleteAccelerationDomains
DescribeAccelerationDomains
DescribeTimingL7SourceData
ModifyAccelerationDomain
ModifyAccelerationDomainStatuses
Modified APIs:
DescribeAddableEntityList
New input parameters:Area
New data structures:
AccelerationDomainFirstPartConfig
OriginDetail
OriginInfo
SlowPostConfig
SlowRateConfig
Modified data structures:
AclConfig©2013-2022 Tencent Cloud. All rights reserved.

Page 21 of 760

Tencent Cloud EdgeOne

New members:Customizes
RateLimitConfig
New members:RateLimitCustomizes
SecurityConfig
New members:SlowPostConfig
Zone
New members:IsFake

Release 7
Release time: 2023-03-09 15:06:19
Release updates:
Improvement to existing documentation.
New APIs:
DescribeDDoSAttackData
DescribeOriginProtection
UpdateOriginProtectionIPWhitelist
New data structures:
DiffIPWhitelist
IPWhitelist
OriginProtectionInfo
Modified data structures:
IpTableRule
New members:Operator, RuleName
Modified members: MatchContent
RateLimitIntelligence
New members:RuleId
SecHitRuleInfo
New members:ZoneId, RuleEnabled, AlarmEnabled, RuleDeleted
SecRuleRelatedInfo
New members:RuleType, RuleEnabled, RuleDeleted, AlarmEnabled
WebLogs
New members:RealClientIp, RealClientIpCountryCode, Area

©2013-2022 Tencent Cloud. All rights reserved.

Page 22 of 760

Tencent Cloud EdgeOne

Release 6
Release time: 2023-01-06 15:20:18
Release updates:
Improvement to existing documentation.
Deleted APIs:
CreateCustomErrorPage
CreateIpTableList
CreateLogSet
CreateLogTopicTask
CreateSecurityDropPage
DeleteLogTopicTask
DescribeBotClientIpList
DescribeBotData
DescribeBotHitRuleDetail
DescribeBotLog
DescribeBotManagedRules
DescribeBotTopData
DescribeDDoSAttackData
DescribeDDoSAttackEvent
DescribeDDoSAttackEventDetail
DescribeDDoSAttackSourceEvent
DescribeDDoSBlockList
DescribeDDoSMajorAttackEvent
DescribeDDoSPolicy
DescribeDistributionL4AccessData
DescribeDnssec
DescribeLogTopicTaskDetail
DescribeRateLimitIntelligenceRule
DescribeSecurityGroupManagedRules
DescribeSecurityPolicy
DescribeSecurityPolicyList
DescribeSecurityPolicyRegions
DescribeSecurityPortraitRules
DescribeSecurityRuleId
DescribeTimingL4AccessData©2013-2022 Tencent Cloud. All rights reserved.

Page 23 of 760

Tencent Cloud EdgeOne

DescribeWebProtectionAttackEvents
DescribeZoneDDoSPolicy
ModifyAlarmConfig
ModifyAlarmDefaultThreshold
ModifyDDoSPolicy
ModifyDDoSPolicyHost
ModifyDnssec
ModifyLogTopicTask
ModifyZoneCnameSpeedUp
SwitchLogTopicTask
Deleted data structures:
BotLog
BotManagedRuleDetail
CCInterceptEvent
DDoSAclDDoSAclRule
DDoSAllowBlockDDoSAllowBlockRule
DDoSAntiPly
DDoSAttackEvent
DDoSAttackEventDetailData
DDoSAttackSourceEvent
DDoSBlockData
DDoSFeaturesFilter
DDoSGeoIp
DDoSHost
DDoSMajorAttackEvent
DDoSPacketFilter
DDoSRule
DDoSSpeedLimit
DDoSStatusInfo
DnssecInfo
GeoIp
LogTopicDetailInfo
PortraitManagedRuleDetail
RateLimitIntelligenceRuleDetail©2013-2022 Tencent Cloud. All rights reserved.

Page 24 of 760

Tencent Cloud EdgeOne

SecurityEntity
ShieldArea
WafGroupDetail
WafGroupInfo
WafGroupRule

Release 5
Release time: 2022-12-29 17:18:30
Release updates:
Improvement to existing documentation.
New APIs:
DescribeDistributionL4AccessData
DescribeTimingL4AccessData
Deleted APIs:
CreateDnsRecord
CreateLoadBalancing
DeleteDnsRecords
DeleteLoadBalancing
DescribeDnsRecords
DescribeLoadBalancing
ModifyDnsRecord
ModifyLoadBalancing
ModifyLoadBalancingStatus
Modified APIs:
ModifyZoneSetting
New input parameters:Grpc
New data structures:
Grpc
Deleted data structures:©2013-2022 Tencent Cloud. All rights reserved.

Page 25 of 760

Tencent Cloud EdgeOne

AdvancedOriginGroup
DnsRecord
LoadBalancing
OriginGroupCondition
Modified data structures:
FollowOrigin
New members:DefaultCacheStrategy
ZoneSetting
New members:Grpc

Release 4
Release time: 2022-12-09 15:47:09
Release updates:
Improvement to existing documentation.
Modified APIs:
CreateSecurityDropPage
New input parameters:TemplateId

Release 3
Release time: 2022-11-28 16:46:20
Release updates:
Improvement to existing documentation.
New APIs:
BindZoneToPlan
CreateAliasDomain
DeleteAliasDomain
DescribeAliasDomains
ModifyAliasDomain
ModifyAliasDomainStatus
ReclaimAliasDomain©2013-2022 Tencent Cloud. All rights reserved.

Page 26 of 760

Tencent Cloud EdgeOne

Deleted APIs:
DescribeBillingData
Modified APIs:
CreateApplicationProxyRule
New input parameters:OriginPort
CreateRule
New input parameters:Tags
CreateZone
New input parameters:AllowDuplicates, AliasZoneName
DescribeBotManagedRules
New input parameters:TemplateId
Modified input parameters: ZoneId, Entity
DescribeSecurityGroupManagedRules
New input parameters:TemplateId
Modified input parameters: ZoneId, Entity
DescribeSecurityPolicy
New input parameters:TemplateId
Modified input parameters: ZoneId, Entity
DescribeSecurityPortraitRules
New input parameters:TemplateId
Modified input parameters: ZoneId, Entity
DescribeZones
New input parameters:Order, Direction
ModifyApplicationProxyRule
New input parameters:OriginPort
ModifyHostsCertificate
New input parameters:ApplyType
ModifyRule
New input parameters:Tags
ModifySecurityPolicy
New input parameters:TemplateId
Modified input parameters: Entity
ModifySecurityWafGroupPolicy
New input parameters:TemplateId
Modified input parameters: ZoneId, Entity
ModifyZone©2013-2022 Tencent Cloud. All rights reserved.

Page 27 of 760

Tencent Cloud EdgeOne

New input parameters:AliasZoneName
New data structures:
AliasDomain
SubRuleSubRuleItem
TemplateConfig
Deleted data structures:BillingDataFilter
Modified data structures:
ApplicationProxyRule
New members:OriginPort
FollowOrigin
New members:DefaultCacheTime, DefaultCache
Https
New members:ApplyType
IpTableRule
New members:Status
RateLimitUserRule
New members:FreqScope
Rule
New members:SubRules
RuleCondition
New members:IgnoreCase, Name, IgnoreNameCase
Modified members: Values
RuleItem
New members:Tags
SecHitRuleInfo
New members:BotLabel
SecRuleRelatedInfo
New members:AttackContent
SecurityConfig
New members:TemplateConfig
ServerCertInfo
New members:CommonName©2013-2022 Tencent Cloud. All rights reserved.

Page 28 of 760

Tencent Cloud EdgeOne

Zone
New members:ActiveStatus, AliasZoneName

Release 2
Release time: 2022-10-19 17:46:28
Release updates:
Improvement to existing documentation.
New APIs:
CreateApplicationProxy
CreateApplicationProxyRule
CreateCustomErrorPage
CreateIpTableList
CreateLoadBalancing
CreateOriginGroup
CreateSecurityDropPage
CreateSpeedTesting
DeleteApplicationProxy
DeleteApplicationProxyRule
DeleteLoadBalancing
DeleteOriginGroup
DescribeApplicationProxies
DescribeBotManagedRules
DescribeDDoSPolicy
DescribeLoadBalancing
DescribeOriginGroup
DescribeRateLimitIntelligenceRule
DescribeSecurityGroupManagedRules
DescribeSecurityPolicy
DescribeSecurityPolicyList
DescribeSecurityPolicyRegions
DescribeSecurityPortraitRules
DescribeSecurityRuleId
DescribeSpeedTestingDetails
DescribeSpeedTestingMetricData©2013-2022 Tencent Cloud. All rights reserved.

Page 29 of 760

Tencent Cloud EdgeOne

DescribeSpeedTestingQuota
DescribeZoneDDoSPolicy
ModifyAlarmConfig
ModifyAlarmDefaultThreshold
ModifyApplicationProxy
ModifyApplicationProxyRule
ModifyApplicationProxyRuleStatus
ModifyApplicationProxyStatus
ModifyDDoSPolicy
ModifyDDoSPolicyHost
ModifyLoadBalancing
ModifyLoadBalancingStatus
ModifyOriginGroup
ModifySecurityPolicy
ModifySecurityWafGroupPolicy
New data structures:
AclCondition
AclConfig
AclUserRule
AdvancedOriginGroup
AiRuleApplicationProxy
ApplicationProxyRule
BotConfig
BotManagedRule
BotManagedRuleDetail
BotPortraitRule
DDoSAclDDoSAclRule
DDoSAllowBlockDDoSAllowBlockRule
DDoSAntiPly
DDoSFeaturesFilter
DDoSGeoIp
DDoSHost
DDoSPacketFilter©2013-2022 Tencent Cloud. All rights reserved.

Page 30 of 760

Tencent Cloud EdgeOne

DDoSRule
DDoSSpeedLimit
DDoSStatusInfo
DistrictStatistics
DropPageConfig
DropPageDetail
ExceptConfig
ExceptUserRule
ExceptUserRuleCondition
ExceptUserRuleScope
GeoIpIntelligenceRuleIntelligenceRuleItem
IpTableConfig
IpTableRule
LoadBalancing
OptimizeAction
OriginGroup
OriginGroupCondition
OriginRecord
PartialModule
PortraitManagedRuleDetail
PrivateParameter
RateLimitConfig
RateLimitIntelligence
RateLimitIntelligenceRuleDetail
RateLimitTemplate
RateLimitTemplateDetail
RateLimitUserRule
SecurityConfig
SecurityEntity
ShieldArea
SkipCondition
SpeedTestingConfig
SpeedTestingDetailData
SpeedTestingInfo
SpeedTestingMetricData
SpeedTestingQuota©2013-2022 Tencent Cloud. All rights reserved.

Page 31 of 760

Tencent Cloud EdgeOne

SpeedTestingStatistics
SpeedTestingStatus
SwitchConfig
WafConfig
WafGroup
WafGroupDetail
WafGroupInfo
WafGroupRule
WafRuleRelease 1
Release time: 2022-09-28 18:50:08
Release updates:
Improvement to existing documentation.
New APIs:
CheckCertificate
CreateCredential
CreateDnsRecord
CreateLogSet
CreateLogTopicTask
CreatePlanForZone
CreatePrefetchTask
CreatePurgeTask
CreateReplayTask
CreateRule
CreateZone
DeleteDnsRecords
DeleteLogTopicTask
DeleteRules
DeleteZone
DescribeAddableEntityList
DescribeAvailablePlans
DescribeBillingData
DescribeBotClientIpList©2013-2022 Tencent Cloud. All rights reserved.

Page 32 of 760

Tencent Cloud EdgeOne

DescribeBotData
DescribeBotHitRuleDetail
DescribeBotLog
DescribeBotTopData
DescribeClientRuleList
DescribeContentQuota
DescribeDDoSAttackData
DescribeDDoSAttackEvent
DescribeDDoSAttackEventDetail
DescribeDDoSAttackSourceEvent
DescribeDDoSAttackTopData
DescribeDDoSBlockList
DescribeDDoSMajorAttackEvent
DescribeDefaultCertificates
DescribeDnsData
DescribeDnsRecords
DescribeDnssec
DescribeHostsSetting
DescribeIdentifications
DescribeLogSets
DescribeLogTopicTaskDetail
DescribeLogTopicTasks
DescribeOverviewL7Data
DescribePrefetchTasks
DescribePurgeTasks
DescribeRules
DescribeRulesSetting
DescribeSingleL7AnalysisData
DescribeTimingL4Data
DescribeTimingL7AnalysisData
DescribeTimingL7CacheData
DescribeTopL7AnalysisData
DescribeTopL7CacheData
DescribeWebManagedRulesData
DescribeWebManagedRulesHitRuleDetail
DescribeWebManagedRulesLog
DescribeWebProtectionAttackEvents
DescribeWebProtectionClientIpList©2013-2022 Tencent Cloud. All rights reserved.

Page 33 of 760

Tencent Cloud EdgeOne

DescribeWebProtectionData
DescribeWebProtectionHitRuleDetail
DescribeWebProtectionTopData
DescribeZoneSetting
DescribeZones
DownloadL4Logs
DownloadL7Logs
IdentifyZone
ModifyDefaultCertificate
ModifyDnsRecord
ModifyDnssec
ModifyHostsCertificate
ModifyLogTopicTask
ModifyRule
ModifyRulePriority
ModifyZone
ModifyZoneCnameSpeedUp
ModifyZoneSetting
ModifyZoneStatus
ReclaimZone
SwitchLogTopicTask
New data structures:
AccelerateType
ActionAdvancedFilter
AscriptionInfo
BillingDataFilter
BotLogCC
CCInterceptEvent
Cache
CacheConfig
CacheKey
CachePrefresh
ClientIpCountry
ClientIpHeader©2013-2022 Tencent Cloud. All rights reserved.

Page 34 of 760

Tencent Cloud EdgeOne

ClientRule
ClsLogTopicInfo
CodeAction
Compression
DDoS
DDoSAttackEvent
DDoSAttackEventDetailData
DDoSAttackSourceEvent
DDoSBlockData
DDoSMajorAttackEvent
DefaultServerCertInfo
DetailHost
DnsData
DnsRecord
DnssecInfo
FailReason
FileAscriptionInfo
FilterFollowOrigin
ForceRedirect
HeaderHsts
Https
Identification
Ipv6
L4OfflineLog
L7OfflineLog
LogSetInfo
LogTopicDetailInfo
MaxAgeNoCacheNormalAction
OfflineCache
OriginPlanInfo
PostMaxSize
QueryCondition
QueryString©2013-2022 Tencent Cloud. All rights reserved.

Page 35 of 760

Tencent Cloud EdgeOne

Quic
Quota
Resource
RewriteAction
Rule
RuleAndConditions
RuleChoicePropertiesItem
RuleCodeActionParams
RuleCondition
RuleExtraParameter
RuleItem
RuleNormalActionParams
RuleRewriteActionParams
RulesProperties
RulesSettingAction
SecClientIp
SecEntry
SecEntryValue
SecHitRuleInfo
SecRuleRelatedInfo
SecurityType
ServerCertInfo
SingleDataRecord
SingleTypeValue
SmartRouting
Sv
Tag
Task
TimingDataItem
TimingDataRecord
TimingTypeValue
TopDataRecord
TopDetailData
TopEntry
TopEntryValue
UpstreamHttp2
VanityNameServers
VanityNameServersIps©2013-2022 Tencent Cloud. All rights reserved.

Page 36 of 760

Tencent Cloud EdgeOne

Waf
WebLogs
WebSocket
Zone
ZoneSetting©2013-2022 Tencent Cloud. All rights reserved.

Page 37 of 760

Tencent Cloud EdgeOne

Introduction：

Last updated 2024-04-09 10:25:14
Tencent Cloud EdgeOne provides layer-4/7 security protection and acceleration services to the global market. It
safeguards diverse industries such as ecommerce, retail, finance service, content and news, and gaming.

©2013-2022 Tencent Cloud. All rights reserved.

Page 38 of 760

Tencent Cloud EdgeOne

API Category：

Last updated 2024-06-13 17:03:24

Site APIs
API Name

FeatureFrequency Limit (maximum requests per
second)CreateZone

Creates a site

20

DescribeIdentifications

Queries the verification information of a
site.

20

ModifyZone

Modifies a site.

20

DeleteZone

Deletes a site

20

ModifyZoneStatus

Changes the site status

20

CheckCnameStatus

Queries the CNAME status of adomain name20

IdentifyZone

Verifies site ownership

20

DescribeZones

Queries the list of sites

20

VerifyOwnership

Verifies ownership

20

Acceleration Domain Management APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

CreateAccelerationDomain

Connects a domain to EdgeOne

20

DescribeAccelerationDomains

Queries accelerated domain
names

20

ModifyAccelerationDomain
ModifyAccelerationDomainStatuses

Modifies an accelerated domain
nameBatch modifies the status of©2013-2022 Tencent Cloud. All rights reserved.

20
20

Page 39 of 760

Tencent Cloud EdgeOne

accelerated domains.
DeleteAccelerationDomains

Batch remove accelerated domain
names

20

CreateSharedCNAME

Creates a shared CNAME.

20

BindSharedCNAME

Binds with a shared CNAME

20

DeleteSharedCNAME

Deletes a shared CNAME

20

Site Acceleration Configuration APIs
API Name

FeatureFrequency Limit (maximum requests per
second)CreateRule

Creates a rule in the rule engine.

20

DeleteRules

Batch deletes rules from the rule engine.

20

DescribeHostsSetting

Queries detailed domain nameconfiguration

20

DescribeRules

Queries the rules in the rule engine.

20

DescribeRulesSetting

Queries the setting parameters of therule engine.

20

DescribeZoneSetting

Queries the site configuration

20

ModifyRule

Modifies a rule in the rule engine.

20

ModifyZoneSetting

Modifies the site configuration

20

Alias Domain APIs
API Name

FeatureFrequency Limit (maximum requests
per second)

CreateAliasDomain

Creates an alias domain name.

20

DescribeAliasDomains

Queries the information of alias
domain names.

20©2013-2022 Tencent Cloud. All rights reserved.

Page 40 of 760

Tencent Cloud EdgeOne

ModifyAliasDomain

Modifies an alias domain name.

20

ModifyAliasDomainStatus

Modifies the status of an alias domain
name.

20

DeleteAliasDomain

Deletes an alias domain name.

20

Security Configuration APIs
Frequency Limit (maximum

API Name

FeatureCreateSecurityIPGroup

Creates a security IP group20

DescribeSecurityIPGroup

Queries security IP groups

20

ModifySecurityIPGroup

Modifies a security IP group

20

DeleteSecurityIPGroup

Deletes a security IP group20

DescribeOriginProtection

Queries the origin protection
configuration

20

DescribeSecurityTemplateBindings

Queries bindings of a policy template

20

ModifySecurityPolicy

Modifies the web and bot security
configurations

20

BindSecurityTemplateToEntity

Binds/Unbinds a domain name to/froma security policy template

20

DescribeSecurityIPGroupInfo

Queries security IP groups(deprecated)20

requests per second)

Layer 4 Application Proxy APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

CreateL4Proxy

Creates Layer 4 proxy instances

20

ModifyL4Proxy

Modifies a Layer 4 proxy instance20©2013-2022 Tencent Cloud. All rights reserved.

Page 41 of 760

Tencent Cloud EdgeOne

ModifyL4ProxyStatus

Modifies Layer 4 proxy instance20

statusDescribeL4Proxy

Queries a Layer 4 proxy instance list

20

DeleteL4Proxy

Deletes a Layer 4 proxy instance20

CreateL4ProxyRules

Creates Layer 4 proxy forwarding
rules

20

ModifyL4ProxyRules

Modifies Layer 4 proxy forwarding
rules

20

ModifyL4ProxyRulesStatus

Modifies Layer 4 proxy forwarding
rule status

20

DescribeL4ProxyRules

Queries a Layer 4 proxy forwarding
rule list

20

DeleteL4ProxyRules

Deletes Layer 4 proxy forwarding
rules

20

CreateApplicationProxy

Creates an application proxy(legacy)

20

ModifyApplicationProxy

Modifies an application proxy(legacy)

20

ModifyApplicationProxyStatus

Modifies the application proxy status(legacy)

20

DescribeApplicationProxies

Queries the application proxy list
(legacy)

20

DeleteApplicationProxy

Deletes an application proxy(legacy)

20

CreateApplicationProxyRule

Creates an application proxy rule
(legacy)

20

ModifyApplicationProxyRule

Modifies an application proxy rule
(legacy)

20

ModifyApplicationProxyRuleStatus

DeleteApplicationProxyRule

Modifies the status of an application
proxy rule (legacy)
Deletes an application proxy rule
(legacy)©2013-2022 Tencent Cloud. All rights reserved.

20

20

Page 42 of 760

Tencent Cloud EdgeOne

Content Management APIs
API Name

FeatureFrequency Limit (maximum requests
per second)

CreatePurgeTask

This API is used to create a cache purging
task.

20

DescribePurgeTasks

Querying the cache purging history

20

CreatePrefetchTask

This API is used to create a pre-warming
task.

20

DescribePrefetchTasks

This API is used to query the pre-warmingtask status.

20

DescribeContentQuota

This API is used to query content
management quotas.

20

Data Analysis APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

DescribeDDoSAttackData

Queries the time-series data of DDoS
attacks.

100

DescribeDDoSAttackEvent

Queries DDoS attack events.

100

DescribeDDoSAttackTopData

Queries the top-ranked DDoS attack
data.

100

DescribeOverviewL7Data

Query monitoring traffic time sequence
data (to be discarded)

100

DescribeTimingL4Data

Queries the L4 traffic data over time100

DescribeTimingL7AnalysisData

Queries the traffic analysis data over
time

100

DescribeTopL7AnalysisData

Queries the traffic analysis data

100

DescribeTimingL7CacheData

Queries the cache analysis data over
time

100

©2013-2022 Tencent Cloud. All rights reserved.

Page 43 of 760

Tencent Cloud EdgeOne

DescribeTopL7CacheData

Queries the ranked data of caching

100

Log Service APIs
API Name

FeatureFrequency Limit (maximum
requests per second)

DownloadL7Logs

Downloads L7 logs.

100

DownloadL4Logs

Downloads L4 logs

100

CreateCLSIndex

Creates a CLS index

20

CreateRealtimeLogDeliveryTask

Creates a real-time log delivery
task

20

ModifyRealtimeLogDeliveryTask

Modifies a real-time log delivery
task

20

DeleteRealtimeLogDeliveryTask

Deletes a real-time log delivery
task

20

DescribeRealtimeLogDeliveryTasks

Queries the list of real-time log
delivery tasks

20

Billing APIs
API Name

FeatureFrequency Limit (maximum requests per
second)CreatePlan

Creates plan

20

UpgradePlan

Upgrades plan20

RenewPlan

Renews plan

20

ModifyPlan

Modifies plan setting

20

IncreasePlanQuota

Purchases additional plan quota

20

DestroyPlan

Terminates plan

20

CreatePlanForZone

Purchase a plan for a new site

20

©2013-2022 Tencent Cloud. All rights reserved.

Page 44 of 760

Tencent Cloud EdgeOne

BindZoneToPlan

Binds a site to a plan.

20

DescribeBillingData

Queries billing data

50

DescribeAvailablePlans

Queries plan options available forpurchase

20

Certificate APIs
API Name

FeatureFrequency Limit (maximum requests per
second)DescribeDefaultCertificates

Queries the list of default
certificates

20

ModifyHostsCertificate

Configures the certificate

20

Load Balancing APIs
API Name

FeatureFrequency Limit (maximum requests per second)

CreateOriginGroup

Creates an origin group20

ModifyOriginGroup

Modifies an origin group

20

DeleteOriginGroup

Deletes an origin group20

DescribeOriginGroup

Obtains a list of origin groups.

20

Diagnostic Tool APIs
API Name

FeatureFrequency Limit (maximum requests per second)

DescribeIPRegion

Queries IP location information

20

Custom Response Page APIs
API Name

Feature©2013-2022 Tencent Cloud. All rights reserved.

Frequency Limit (maximum requests per

Page 45 of 760

Tencent Cloud EdgeOne

second)CreateCustomizeErrorPage

Creates a custom response page20

DescribeCustomErrorPages

Queries the custom response
page list

20

ModifyCustomErrorPage

Modifies a custom response
page

20

DeleteCustomErrorPage

Deletes a custom response page

20

Version Management APIs
Frequency Limit (maximum requests

API Name

FeatureCreateConfigGroupVersion

Create Configuration Group
Version

20

DeployConfigGroupVersion

Release Configuration Group
Version20

DescribeConfigGroupVersionDetail

Query Configuration Group
Version Details

20

DescribeConfigGroupVersions

Query Configuration Group
Version List

20

DescribeDeployHistory

Query Version Release History

20

DescribeEnvironments

Query Environment Information

20©2013-2022 Tencent Cloud. All rights reserved.

per second)

Page 46 of 760

Tencent Cloud EdgeOne

Making API Requests
Request Structure：

Last updated 2024-04-09 10:25:15

1. Service Address
The API supports access from either a nearby region (at teo.tencentcloudapi.com) or a specified region (at teo.apguangzhou.tencentcloudapi.com for Guangzhou, for example).
We recommend using the domain name to access the nearest server. When you call an API, the request is
automatically resolved to a server in the region nearest to the location where the API is initiated. For example, when
you initiate an API request in Guangzhou, this domain name is automatically resolved to a Guangzhou server, theresult is the same as that of specifying the region in the domain like "teo.ap-guangzhou.tencentcloudapi.com".
Note: For latency-sensitive businesses, we recommend that you specify the region in the domain name.
Tencent Cloud currently supports the following regions:
Hosted region

Domain nameLocal access region (recommended, only for non-financial availability
zones)

teo.tencentcloudapi.com

South China (Guangzhou)

teo.apguangzhou.tencentcloudapi.com

East China (Shanghai)

teo.ap-shanghai.tencentcloudapi.com

North China (Beijing)teo.ap-beijing.tencentcloudapi.com

Southwest China (Chengdu)

teo.ap-chengdu.tencentcloudapi.com

Southwest China (Chongqing)teo.apchongqing.tencentcloudapi.com

Hong Kong, Macao, Taiwan (Hong Kong, China)

teo.aphongkong.tencentcloudapi.com

Southeast Asia (Singapore)teo.apsingapore.tencentcloudapi.com

Southeast Asia (Bangkok)

teo.ap-bangkok.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 47 of 760

Tencent Cloud EdgeOne

South Asia (Mumbai)

teo.ap-mumbai.tencentcloudapi.com

Northeast Asia (Seoul)teo.ap-seoul.tencentcloudapi.com

Northeast Asia (Tokyo)

teo.ap-tokyo.tencentcloudapi.com

U.S. East Coast (Virginia)

teo.na-ashburn.tencentcloudapi.com

U.S. West Coast (Silicon Valley)teo.nasiliconvalley.tencentcloudapi.com

North America (Toronto)

teo.na-toronto.tencentcloudapi.com

Europe (Frankfurt)

teo.eu-frankfurt.tencentcloudapi.com

2. Communications Protocol
All the Tencent Cloud APIs communicate via HTTPS, providing highly secure communication tunnels.

3. Request Methods
Supported HTTP request methods:
POST (recommended)GETThe Content-Type types supported by POST requests:
application/json (recommended). The TC3-HMAC-SHA256 signature algorithm must be used.
application/x-www-form-urlencoded. The HmacSHA1 or HmacSHA256 signature algorithm must be used.
multipart/form-data (only supported by certain APIs). You must use TC3-HMAC-SHA256 to calculate the signature.
The size of a GET request packet is up to 32 KB. The size of a POST request is up to 1 MB when the HmacSHA1 or
HmacSHA256 signature algorithm is used, and up to 10 MB when TC3-HMAC-SHA256 is used.

4. Character Encoding
Only UTF-8 encoding is used.

©2013-2022 Tencent Cloud. All rights reserved.

Page 48 of 760

Tencent Cloud EdgeOne

Common Params：

Last updated 2024-04-09 10:25:16
Common parameters are used for all APIs authenticating requestors. Common parameters must be included in all API
requests, and they will not be described in individual API documents.
The exact contents of the common parameters will vary depending on the version of the signature method you use.

Common parameters for Signature Algorithm v3
When the TC3-HMAC-SHA256 algorithm is used, the common parameters should be uniformly placed in the HTTP
request header, as shown below:
Parameter
Name

Type

Required

Description
The name of the API for the desired operation. For the specific value, see

X-TC-Action

X-TCRegion

X-TCTimestamp

StringStringYes

Yes

description of common parameter Action in the input parameters in r
documentation. For example, the API for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which the data ywork with belongs. For values supported for an API, see the description oparameter Region in the input parameters in related API documentati
parameter is not required for some APIs (which will be indicated in related
documentation), and will not take effect even it is passed.

Integer

X-TCVersion

StringAuthorization

StringYes

Yes

The current UNIX timestamp that records the time when the API request w
for example, 1529223702. Note: If the difference between the UNIX times
server time is greater than 5 minutes, a signature expiration error may occ
API version of the action. For the valid values, see the description of the cparameter Version in the API documentation. For example, the versi
2017-03-12.

Yes

The HTTP authentication request header, for example:
TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/Date/service/tc3_requ
SignedHeaders=content-type;host,Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc96317
Here:- TC3-HMAC-SHA256: Signature method, currently fixed as this value;- Credential: Signature credential; AKIDEXAMPLE is the SecretId; Date is
UTC time, and this value must match the value of X-TC-Timestamp (a co©2013-2022 Tencent Cloud. All rights reserved.

Page 49 of 760

Tencent Cloud EdgeOne

parameter) in UTC time format; service is the name of the product/service
generally a domain name prefix. For example, a domain name cvm.tencen
refers to the CVM product and the value would be cvm;
- SignedHeaders: The headers that contains the authentication informatio
type and host are the required headers;- Signature: Signature digest.

X-TC-Token

String

No

The token used for a temporary certificate. It must be used with a tempora
can obtain the temporary key and token by calling a CAM API. No token ia long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Limit=10&Offset=0
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE/20
18-10-09/cvm/tc3_request, SignedHeaders=content-type;host, Signature=5da7a33f6993
f0614b047e5df4582db9e9bf4672ba50567dba16c6ccf174c474
Content-Type: application/x-www-form-urlencoded
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1539084154
X-TC-Region: ap-guangzhou
The following example shows you how to structure an HTTP POST (application/json) request:
https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: application/json
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou{"Offset":0,"Limit":10}
Example of an HTTP POST (multipart/form-data) request structure (only supported by specific APIs):©2013-2022 Tencent Cloud. All rights reserved.

Page 50 of 760

Tencent Cloud EdgeOne

https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/2018-05-30/cvm/tc3_request,
SignedHeaders=content-type;host, Signature=582c400e06b5924a6f2b5d7d672d79c15b1316
2d9279b0855cfba6789a8edb4c
Content-Type: multipart/form-data; boundary=58731222010402
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1527672334
X-TC-Region: ap-guangzhou--58731222010402
Content-Disposition: form-data; name="Offset"
0--58731222010402
Content-Disposition: form-data; name="Limit"
10--58731222010402--

Common parameters for Signature Algorithm v1
To adopt the HmacSHA1 and HmacSHA256 signature methods, common parameters must be put into the request
string, as shown below:
Parameter NameType

Required

Description
The name of the API for the desired operation. For the specificvalue, see the description of common parameter Action in the

ActionStringYes

input parameters in related API documentation. For example, theAPI for querying the CVM instance list is
DescribeInstances .
Region parameter, which is used to identify the region to which
the data you want to work with belongs. For values supported for
an API, see the description of common parameter Region in

RegionStringYes

the input parameters in related API documentation. Note: Thisparameter is not required for some APIs (which will be indicated inrelated API documentation), and will not take effect even if it ispassed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 51 of 760

Tencent Cloud EdgeOne

Timestamp

IntegerYes

The current UNIX timestamp that records the time when the API
request was initiated, for example, 1529223702. If the difference
between the value and the current system time is too large, asignature expiration error may occur.
A random positive integer used along with Timestamp to

Nonce

Integer

Yes

SecretId

StringYes

The identifying SecretId obtained on the Cloud API Key page. A
SecretId corresponds to a unique SecretKey which is used togenerate the request signature (Signature).

Yes

Request signature used to verify the validity of this request. This iscalculated based on the actual input parameters. For more
information about how this is calculated, see the API
authentication documentation.

Signature

VersionStringStringYes

prevent replay attacks.

API version of the action. For the valid values, see the descriptionof the common input parameter Version in the API
documentation. For example, the version of CVM is 2017-03-12.

SignatureMethod

StringNo

Signature method. Currently, only HmacSHA256 and HmacSHA1
are supported. The HmacSHA256 algorithm is used to verify thesignature only when this parameter is specified as HmacSHA256.
In other cases, the signature is verified with HmacSHA1.

Token

String

No

The token used for a temporary certificate. It must be used with atemporary key. You can obtain the temporary key and token bycalling a CAM API. No token is required for a long-term key.

Assuming you want to query the list of Cloud Virtual Machine instances in the Guangzhou region, the request structurein the form of request URL, request header and request body may be as follows:
Example of an HTTP GET request structure:https://cvm.tencentcloudapi.com/?Action=DescribeInstances&Version=2017-03-12&Sign
atureMethod=HmacSHA256&Timestamp=1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb45
9b1bbee224158d66e7ae5fcadb70b2d181d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Example of an HTTP POST request structure:©2013-2022 Tencent Cloud. All rights reserved.

Page 52 of 760

Tencent Cloud EdgeOne

https://cvm.tencentcloudapi.com/
Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
Action=DescribeInstances&Version=2017-03-12&SignatureMethod=HmacSHA256&Timestamp=
1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb459b1bbee224158d66e7ae5fcadb70b2d18
1d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKIDEXAMPLE

Region List
The supported Region field values for all APIs in this product are listed as below. For any API that does not support
any of the following regions, this field will be described additionally in the relevant API document.
RegionValue

Southwest China (Chongqing)

ap-chongqing

South China (Guangzhou)

ap-guangzhou

Southeast Asia (Singapore)

ap-singapore©2013-2022 Tencent Cloud. All rights reserved.

Page 53 of 760

Tencent Cloud EdgeOne

Signature v3：

Last updated 2024-04-09 10:25:17
TencentCloud API authenticates every single request, i.e., the request must be signed using the security credentials inthe designated steps. Each request has to contain the signature information (Signature) in the common request
parameters and be sent in the specified way and format.

Applying for Security Credentials
The security credential used in this document is a key, which includes a SecretId and a SecretKey. Each user canhave up to two pairs of keys.
SecretId: Used to identify the API caller, which is just like a username.
SecretKey: Used to authenticate the API caller, which is just like a password.
You must keep your security credentials private and avoid disclosure; otherwise, your assets may becompromised. If they are disclosed, please disable them as soon as possible.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key console page.
3. On the TencentCloud API Key page, click Create to create a SecretId/SecretKey pair.

Using the Resources for Developers
TencentCloud API comes with SDKs for seven commonly used programming languages, including Python, Java,
PHP, Go, NodeJS and .NET. In addition, it provides API Explorer which enables online call, signature verification, andSDK code generation. If you have any troubles calculating a signature, consult these resources.

TC3-HMAC-SHA256 Signature Algorithm
Compatible with the previous HmacSHA1 and HmacSHA256 signature algorithms, the TC3-HMAC-SHA256
signature algorithm is more secure and supports larger requests and JSON format with better performance. We
recommend using TC3-HMAC-SHA256 to calculate the signature.
TencentCloud API supports both GET and POST requests. For the GET method, only the Content-Type:application/x-www-form-urlencoded protocol format is supported. For the POST method, two protocol formats,©2013-2022 Tencent Cloud. All rights reserved.

Page 54 of 760

Tencent Cloud EdgeOne

Content-Type: application/json and Content-Type: multipart/form-data, are supported. The JSON format is supported
by default for all business APIs, and the multipart format is supported only for specific business APIs. In this case, theAPI cannot be called in JSON format. See the specific business API documentation for more information. The POST
method is recommended, as there is no difference in the results of both the methods, but the GET method only
supports request packets up to 32 KB.
The following uses querying the list of CVM instances in the Guangzhou region as an example to describe the steps ofsignature splicing. We chose this API because:
1. CVM is activated by default, and this API is often used;
2. It is read-only and does not change the status of existing resources;
3. It covers many types of parameters, which allows it to be used to demonstrate how to use arrays containing data
structures.
In the example, we try to choose common parameters and API parameters that are prone to mistakes. When you
actually call an API, please use parameters based on the actual conditions. The parameters vary by API. Do not copy
the parameters and values in this example.
Assuming that your SecretId and SecretKey are AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* andGu5t9xGARNpq86cd98joQYCN3******* , respectively, if you want to view the status of the instance in the
Guangzhou region whose CVM instance name is "unnamed" and have only one data entry returned, then the request
may be:curl -X POST https://cvm.tencentcloudapi.com \-H "Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e4
1437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff" \-H "Content-Type: application/json; charset=utf-8" \-H "Host: cvm.tencentcloudapi.com" \-H "X-TC-Action: DescribeInstances" \-H "X-TC-Timestamp: 1551113065" \-H "X-TC-Version: 2017-03-12" \-H "X-TC-Region: ap-guangzhou" \-d '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'The signature calculation process is explained in detail below.

1. Concatenating the CanonicalRequest String
Concatenate the canonical request string (CanonicalRequest) in the following pseudocode format:
CanonicalRequest =HTTPRequestMethod + '\n' +CanonicalURI + '\n' +©2013-2022 Tencent Cloud. All rights reserved.

Page 55 of 760

Tencent Cloud EdgeOne

CanonicalQueryString + '\n' +CanonicalHeaders + '\n' +SignedHeaders + '\n' +HashedRequestPayload
Field Name

Explanation

HTTPRequestMethod

HTTP request method (GET or POST). This example uses POST .

CanonicalURI

URI parameter. Slash ("/") is used for API 3.0.
The query string in the URL of the originating HTTP request. This is always an empty st“” for POST requests, and is the string after the question mark (?) for GET requests. Fo

CanonicalQueryString。

example: Limit=10&Offset=0
Note: CanonicalQueryString must be URL-encoded, referencing RFC3986, theUTF8 character set. We recommend using the programming language library. All specia
characters must be encoded and capitalized.
Header information for signature calculation, including at least two headers of host
content-type . Custom headers can be added to participate in the signature proce
improve the uniqueness and security of the request.
Concatenation rules:
1. Both the key and value of the header should be converted to lowercase with the lead

CanonicalHeaders

and trailing spaces removed, so they are concatenated in the format of key:value\nformat;2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase).
The calculation result in this example is content-type:application/json;
charset=utf-8\nhost:cvm.tencentcloudapi.com\n .
Note: content-type must match the actually sent content. In some programming
languages, a charset value would be added even if it is not specified. In this case, therequest sent is different from the one signed, and the sever will return an error indicating
signature verification failed.
Header information for signature calculation, indicating which headers of the request
participate in the signature process (they must each individually correspond to the headin CanonicalHeaders). Content-type and host are required headers.

SignedHeaders

Concatenation rules:
1. Both the key and value of the header should be converted to lowercase;
2. If there are multiple headers, they should be sorted in ASCII ascending order by theheader keys (lowercase) and separated by semicolons (;).
The value in this example is content-type;hostHashedRequestPayload

Hash value of the request payload (i.e., the body, such as {"Limit": 1, "Filter©2013-2022 Tencent Cloud. All rights reserved.

Page 56 of 760

Tencent Cloud EdgeOne[{"Values": ["unnamed"], "Name": "instance-name"}]} in this example
The pseudocode for calculation is
Lowercase(HexEncode(Hash.SHA256(RequestPayload))) by SHA256 hashing the payof the HTTP request, performing hexadecimal encoding, and finally converting the enco
string to lowercase letters. For GET requests, RequestPayload is always an empt
string. The calculation result in this example is
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b49

According to the rules above, the CanonicalRequest string obtained in the example is as follows:

POST/
content-type:application/json; charset=utf-8
host:cvm.tencentcloudapi.com
content-type;host
99d58dfbc6745f6747f36bfca17dee5e6881dc0428a0a36f96199342bc5b4907

2. Concatenating the String to Be Signed
The string to sign is concatenated as follows:
StringToSign =Algorithm + \n +RequestTimestamp + \n +CredentialScope + \n +HashedCanonicalRequest
Field Name

Explanation

Algorithm

Signature algorithm, which is currently always TC3-HMAC-SHA256 .
Request timestamp, i.e., the value of the common parameter X-TC-Timestamp in

RequestTimestamp

request header, which is the UNIX timestamp of the current time in seconds, such as1551113065 in this example.
Scope of the credential in the format of Date/service/tc3_request , including
date, requested service and termination string (tc3_request). Date is a date in UT

CredentialScopetime, whose value should match the UTC date converted by the common
parameter X-TC-Timestamp ; service is the product name, which should mthe domain name of the product called. The calculation result in this example is 201
25/cvm/tc3_request .

©2013-2022 Tencent Cloud. All rights reserved.

Page 57 of 760

Tencent Cloud EdgeOne

HashedCanonicalRequest

Hash value of the CanonicalRequest string concatenated in the steps above. The
pseudocode for calculation is Lowercase(HexEncode(Hash.SHA256(CanonicalRequ
The calculation result in this example is2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3ad

Note:

1. Date has to be calculated from the timestamp "X-TC-Timestamp" and the time zone is UTC+0. If you add
the system's local time zone information (such as UTC+8), calls can succeed both day and night but willdefinitely fail at 00:00. For example, if the timestamp is 1551113065 and the time in UTC+8 is 2019-02-26
00:44:25, the UTC+0 date in the calculated Date value should be 2019-02-25 instead of 2019-02-26.
2. Timestamp must be the same as your current system time, and your system time and standard time must be
synced; if the difference between Timestamp and your current system time is larger than five minutes, therequest will fail. If your system time is out of sync with the standard time for a while, the request will fail andreturn a signature expiration error.

According to the preceding rules, the string to be signed obtained in the example is as follows:
TC3-HMAC-SHA256
1551113065
2019-02-25/cvm/tc3_request
2815843035062fffda5fd6f2a44ea8a34818b0dc46f024b8b3786976a3adda7a

3. Calculating the Signature
1. Calculate the derived signature key with the following pseudocode:

SecretKey = "Gu5t9xGARNpq86cd98joQYCN3*******"
SecretDate = HMAC_SHA256("TC3" + SecretKey, Date)
SecretService = HMAC_SHA256(SecretDate, Service)
SecretSigning = HMAC_SHA256(SecretService, "tc3_request")
Field Name

Explanation

SecretKey

The original SecretKey, i.e., Gu5t9xGARNpq86cd98joQYCN3******* .

Date

The Date field information in Credential , such as 2019-02-25 in this example.

©2013-2022 Tencent Cloud. All rights reserved.

Page 58 of 760

Tencent Cloud EdgeOne

Service

Value in the Service field in Credential , such as cvm in this example.

2. Calculate the signature with the following pseudocode:

Signature = HexEncode(HMAC_SHA256(SecretSigning, StringToSign))

4. Concatenating the Authorization
The Authorization is concatenated as follows:

Authorization =Algorithm + ' ' +'Credential=' + SecretId + '/' + CredentialScope + ', ' +'SignedHeaders=' + SignedHeaders + ', ' +'Signature=' + Signature
Field Name

Explanation

Algorithm

Signature algorithm, which is always TC3-HMAC-SHA256 .

SecretId

The SecretId in the key pair, i.e., AKIDz8krbsJ5yKBZQpn74WFkmLPx3******* .

CredentialScope

SignedHeadersSignature

Credential scope (see above). The calculation result in this example is 2019-0225/cvm/tc3_request .
Header information for signature calculation (see above), such as content-type;hostin this example.
Signature value. The calculation result in this example isc492e8e41437e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff .

According to the rules above, the value obtained in the example is:TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/2019-02-25/cvm/tc
3_request, SignedHeaders=content-type;host, Signature=c492e8e41437e97a620b728c301
bb8d17e7dc0c17eeabce80c20cd70fc3a78ff
The following example shows a finished authorization header:
POST https://cvm.tencentcloudapi.com/
Authorization: TC3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******/20
19-02-25/cvm/tc3_request, SignedHeaders=content-type;host, Signature=c492e8e41437
e97a620b728c301bb8d17e7dc0c17eeabce80c20cd70fc3a78ff©2013-2022 Tencent Cloud. All rights reserved.

Page 59 of 760

Tencent Cloud EdgeOne

Content-Type: application/json; charset=utf-8
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1551113065
X-TC-Region: ap-guangzhou{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=EliP9YW3pW28FpsEdkXt%2F%2B
WcGeI%3D&Timestamp=1465185768&Version=2017-03-12.
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.
Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 60 of 760

Tencent Cloud EdgeOne

Java
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPITC3Demo {private final static Charset UTF8 = StandardCharsets.UTF_8;
private final static String SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
private final static String SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
private final static String CT_JSON = "application/json; charset=utf-8";
public static byte[] hmac256(byte[] key, String msg) throws Exception {Mac mac = Mac.getInstance("HmacSHA256");
SecretKeySpec secretKeySpec = new SecretKeySpec(key, mac.getAlgorithm());
mac.init(secretKeySpec);
return mac.doFinal(msg.getBytes(UTF8));}
public static String sha256Hex(String s) throws Exception {MessageDigest md = MessageDigest.getInstance("SHA-256");
byte[] d = md.digest(s.getBytes(UTF8));
return DatatypeConverter.printHexBinary(d).toLowerCase();}public static void main(String[] args) throws Exception {String service = "cvm";
String host = "cvm.tencentcloudapi.com";
String region = "ap-guangzhou";String action = "DescribeInstances";
String version = "2017-03-12";
String algorithm = "TC3-HMAC-SHA256";
String timestamp = "1551113065";//String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");// Pay attention to the time zone; otherwise, errors may occur
sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
String date = sdf.format(new Date(Long.valueOf(timestamp + "000")));// ************* Step 1: Concatenate the CanonicalRequest string *************©2013-2022 Tencent Cloud. All rights reserved.

Page 61 of 760

Tencent Cloud EdgeOne

String httpRequestMethod = "POST";
String canonicalUri = "/";
String canonicalQueryString = "";String canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + host + "\n";String signedHeaders = "content-type;host";
String payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
String hashedRequestPayload = sha256Hex(payload);
String canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;
System.out.println(canonicalRequest);// ************* Step 2: Concatenate the string to sign *************
String credentialScope = date + "/" + service + "/" + "tc3_request";
String hashedCanonicalRequest = sha256Hex(canonicalRequest);
String stringToSign = algorithm + "\n" + timestamp + "\n" + credentialScope +"\n" + hashedCanonicalRequest;
System.out.println(stringToSign);// ************* Step 3: Calculate the signature *************
byte[] secretDate = hmac256(("TC3" + SECRET_KEY).getBytes(UTF8), date);byte[] secretService = hmac256(secretDate, service);byte[] secretSigning = hmac256(secretService, "tc3_request");String signature = DatatypeConverter.printHexBinary(hmac256(secretSigning, string
ToSign)).toLowerCase();
System.out.println(signature);// ************* Step 4: Concatenate the Authorization *************
String authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;
System.out.println(authorization);
TreeMap<String, String> headers = new TreeMap<String, String>();headers.put("Authorization", authorization);headers.put("Content-Type", CT_JSON);headers.put("Host", host);
headers.put("X-TC-Action", action);headers.put("X-TC-Timestamp", timestamp);
headers.put("X-TC-Version", version);headers.put("X-TC-Region", region);
StringBuilder sb = new StringBuilder();sb.append("curl -X POST https://").append(host)©2013-2022 Tencent Cloud. All rights reserved.

Page 62 of 760

Tencent Cloud EdgeOne.append(" -H \"Authorization: ").append(authorization).append("\"").append(" -H \"Content-Type: application/json; charset=utf-8\"").append(" -H \"Host: ").append(host).append("\"").append(" -H \"X-TC-Action: ").append(action).append("\"").append(" -H \"X-TC-Timestamp: ").append(timestamp).append("\"").append(" -H \"X-TC-Version: ").append(version).append("\"").append(" -H \"X-TC-Region: ").append(region).append("\"").append(" -d '").append(payload).append("'");
System.out.println(sb.toString());}}

Python# -*- coding: utf-8 -*import hashlib, hmac, json, os, sys, timefrom datetime import datetime# Key Parameters
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
service = "cvm"host = "cvm.tencentcloudapi.com"
endpoint = "https://" + hostregion = "ap-guangzhou"
action = "DescribeInstances"version = "2017-03-12"
algorithm = "TC3-HMAC-SHA256"#timestamp = int(time.time())
timestamp = 1551113065
date = datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%d")params = {"Limit": 1, "Filters": [{"Name": "instance-name", "Values": ["unnamed"]}]}# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = "POST"
canonical_uri = "/"canonical_querystring = ""ct = "application/json; charset=utf-8"
payload = json.dumps(params)
canonical_headers = "content-type:%s\nhost:%s\n" % (ct, host)signed_headers = "content-type;host"hashed_request_payload = hashlib.sha256(payload.encode("utf-8")).hexdigest()
canonical_request = (http_request_method + "\n" +canonical_uri + "\n" +©2013-2022 Tencent Cloud. All rights reserved.

Page 63 of 760

Tencent Cloud EdgeOne

canonical_querystring + "\n" +canonical_headers + "\n" +signed_headers + "\n" +hashed_request_payload)
print(canonical_request)# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + "/" + service + "/" + "tc3_request"
hashed_canonical_request = hashlib.sha256(canonical_request.encode("utf-8")).hexd
igest()
string_to_sign = (algorithm + "\n" +str(timestamp) + "\n" +credential_scope + "\n" +hashed_canonical_request)
print(string_to_sign)# ************* Step 3: Calculate the Signature *************# Function for computing signature digest
def sign(key, msg):
return hmac.new(key, msg.encode("utf-8"), hashlib.sha256).digest()
secret_date = sign(("TC3" + secret_key).encode("utf-8"), date)secret_service = sign(secret_date, service)secret_signing = sign(secret_service, "tc3_request")
signature = hmac.new(secret_signing, string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
print(signature)# ************* Step 4: Concatenate the Authorization *************
authorization = (algorithm + " " +"Credential=" + secret_id + "/" + credential_scope + ", " +"SignedHeaders=" + signed_headers + ", " +"Signature=" + signature)
print(authorization)
print('curl -X POST ' + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + host + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + str(timestamp) + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'")

Golang©2013-2022 Tencent Cloud. All rights reserved.

Page 64 of 760

Tencent Cloud EdgeOne

package main
import ("crypto/hmac""crypto/sha256""encoding/hex""fmt""time")
func sha256hex(s string) string {b := sha256.Sum256([]byte(s))
return hex.EncodeToString(b[:])}func hmacsha256(s, key string) string {hashed := hmac.New(sha256.New, []byte(key))hashed.Write([]byte(s))
return string(hashed.Sum(nil))}func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"
host := "cvm.tencentcloudapi.com"
algorithm := "TC3-HMAC-SHA256"
service := "cvm"version := "2017-03-12"
action := "DescribeInstances"
region := "ap-guangzhou"//var timestamp int64 = time.Now().Unix()
var timestamp int64 = 1551113065// step 1: build canonical request string
httpRequestMethod := "POST"
canonicalURI := "/"canonicalQueryString := ""canonicalHeaders := "content-type:application/json; charset=utf-8\n" + "host:" +host + "\n"signedHeaders := "content-type;host"
payload := `{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}`
hashedRequestPayload := sha256hex(payload)
canonicalRequest := fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n%s",
httpRequestMethod,
canonicalURI,©2013-2022 Tencent Cloud. All rights reserved.

Page 65 of 760

Tencent Cloud EdgeOne

canonicalQueryString,canonicalHeaders,signedHeaders,hashedRequestPayload)
fmt.Println(canonicalRequest)// step 2: build string to sign
date := time.Unix(timestamp, 0).UTC().Format("2006-01-02")
credentialScope := fmt.Sprintf("%s/%s/tc3_request", date, service)hashedCanonicalRequest := sha256hex(canonicalRequest)
string2sign := fmt.Sprintf("%s\n%d\n%s\n%s",
algorithm,
timestamp,
credentialScope,
hashedCanonicalRequest)
fmt.Println(string2sign)// step 3: sign string
secretDate := hmacsha256(date, "TC3"+secretKey)
secretService := hmacsha256(service, secretDate)secretSigning := hmacsha256("tc3_request", secretService)signature := hex.EncodeToString([]byte(hmacsha256(string2sign, secretSigning)))
fmt.Println(signature)// step 4: build authorization
authorization := fmt.Sprintf("%s Credential=%s/%s, SignedHeaders=%s, Signature=%s",algorithm,
secretId,
credentialScope,
signedHeaders,signature)
fmt.Println(authorization)
curl := fmt.Sprintf(`curl -X POST https://%s\-H "Authorization: %s"\
-H "Content-Type: application/json; charset=utf-8"\-H "Host: %s" -H "X-TC-Action: %s"\
-H "X-TC-Timestamp: %d"\
-H "X-TC-Version: %s"\
-H "X-TC-Region: %s"\-d '%s'`, host, authorization, host, action, timestamp, version, region, payload)
fmt.Println(curl)}

PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 66 of 760

Tencent Cloud EdgeOne<?php$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$host = "cvm.tencentcloudapi.com";$service = "cvm";$version = "2017-03-12";$action = "DescribeInstances";$region = "ap-guangzhou";// $timestamp = time();$timestamp = 1551113065;$algorithm = "TC3-HMAC-SHA256";// step 1: build canonical request string$httpRequestMethod = "POST";$canonicalUri = "/";
$canonicalQueryString = "";$canonicalHeaders = "content-type:application/json; charset=utf-8\n"."host:".$host."\n";$signedHeaders = "content-type;host";$payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}';$hashedRequestPayload = hash("SHA256", $payload);$canonicalRequest = $httpRequestMethod."\n".$canonicalUri."\n".$canonicalQueryString."\n".$canonicalHeaders."\n".$signedHeaders."\n".$hashedRequestPayload;
echo $canonicalRequest.PHP_EOL;// step 2: build string to sign
$date = gmdate("Y-m-d", $timestamp);$credentialScope = $date."/".$service."/tc3_request";$hashedCanonicalRequest = hash("SHA256", $canonicalRequest);$stringToSign = $algorithm."\n".$timestamp."\n".$credentialScope."\n".$hashedCanonicalRequest;
echo $stringToSign.PHP_EOL;// step 3: sign string$secretDate = hash_hmac("SHA256", $date, "TC3".$secretKey, true);$secretService = hash_hmac("SHA256", $service, $secretDate, true);$secretSigning = hash_hmac("SHA256", "tc3_request", $secretService, true);$signature = hash_hmac("SHA256", $stringToSign, $secretSigning);
echo $signature.PHP_EOL;©2013-2022 Tencent Cloud. All rights reserved.

Page 67 of 760

Tencent Cloud EdgeOne// step 4: build authorization$authorization = $algorithm." Credential=".$secretId."/".$credentialScope.", SignedHeaders=content-type;host, Signature=".$signature;echo $authorization.PHP_EOL;$curl = "curl -X POST https://".$host.' -H "Authorization: '.$authorization.'"'.' -H "Content-Type: application/json; charset=utf-8"'.' -H "Host: '.$host.'"'.' -H "X-TC-Action: '.$action.'"'.' -H "X-TC-Timestamp: '.$timestamp.'"'.' -H "X-TC-Version: '.$version.'"'.' -H "X-TC-Region: '.$region.'"'." -d '".$payload."'";
echo $curl.PHP_EOL;

Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'digest'
require 'json'
require 'time'require 'openssl'# Key Parameters
secret_id = 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******'
secret_key = 'Gu5t9xGARNpq86cd98joQYCN3*******'
service = 'cvm'
host = 'cvm.tencentcloudapi.com'
endpoint = 'https://' + hostregion = 'ap-guangzhou'
action = 'DescribeInstances'version = '2017-03-12'
algorithm = 'TC3-HMAC-SHA256'# timestamp = Time.now.to_i
timestamp = 1551113065
date = Time.at(timestamp).utc.strftime('%Y-%m-%d')# ************* Step 1: Concatenate the CanonicalRequest string *************
http_request_method = 'POST'
canonical_uri = '/'canonical_querystring = ''©2013-2022 Tencent Cloud. All rights reserved.

Page 68 of 760

Tencent Cloud EdgeOne

canonical_headers = "content-type:application/json; charset=utf-8\nhost:#{host}\n"signed_headers = 'content-type;host'# params = { 'Limit' => 1, 'Filters' => [{ 'Name' => 'instance-name', 'Values' =>['unnamed'] }] }# payload = JSON.generate(params, { 'ascii_only' => true, 'space' => ' ' })# json will generate in random order, to get specified result in example, we hard-code it here.
payload = '{"Limit": 1, "Filters": [{"Values": ["unnamed"], "Name": "instance-name"}]}'
hashed_request_payload = Digest::SHA256.hexdigest(payload)
canonical_request = [http_request_method,
canonical_uri,canonical_querystring,canonical_headers,signed_headers,hashed_request_payload,].join("\n")puts canonical_request# ************* Step 2: Concatenate the string to sign *************
credential_scope = date + '/' + service + '/' + 'tc3_request'
hashed_request_payload = Digest::SHA256.hexdigest(canonical_request)
string_to_sign = [algorithm,
timestamp.to_s,
credential_scope,
hashed_request_payload,].join("\n")puts string_to_sign# ************* Step 3: Calculate the Signature *************
digest = OpenSSL::Digest.new('sha256')secret_date = OpenSSL::HMAC.digest(digest, 'TC3' + secret_key, date)secret_service = OpenSSL::HMAC.digest(digest, secret_date, service)secret_signing = OpenSSL::HMAC.digest(digest, secret_service, 'tc3_request')
signature = OpenSSL::HMAC.hexdigest(digest, secret_signing, string_to_sign)
puts signature# ************* Step 4: Concatenate the Authorization *************
authorization = "#{algorithm} Credential=#{secret_id}/#{credential_scope}, Signed
Headers=#{signed_headers}, Signature=#{signature}"puts authorization
puts 'curl -X POST ' + endpoint \©2013-2022 Tencent Cloud. All rights reserved.

Page 69 of 760

Tencent Cloud EdgeOne+ ' -H "Authorization: ' + authorization + '"' \+ ' -H "Content-Type: application/json; charset=utf-8"' \+ ' -H "Host: ' + host + '"' \+ ' -H "X-TC-Action: ' + action + '"' \+ ' -H "X-TC-Timestamp: ' + timestamp.to_s + '"' \+ ' -H "X-TC-Version: ' + version + '"' \+ ' -H "X-TC-Region: ' + region + '"' \+ " -d '" + payload + "'"DotNetusing System;
using System.Collections.Generic;using System.Security.Cryptography;
using System.Text;
public class Application{
public static string SHA256Hex(string s){
using (SHA256 algo = SHA256.Create()){
byte[] hashbytes = algo.ComputeHash(Encoding.UTF8.GetBytes(s));
StringBuilder builder = new StringBuilder();for (int i = 0; i < hashbytes.Length; ++i){
builder.Append(hashbytes[i].ToString("x2"));}
return builder.ToString();}}
public static byte[] HmacSHA256(byte[] key, byte[] msg){
using (HMACSHA256 mac = new HMACSHA256(key)){
return mac.ComputeHash(msg);}}
public static Dictionary<String, String> BuildHeaders(string secretid,
string secretkey, string service, string endpoint, string region,
string action, string version, DateTime date, string requestPayload){
string datestr = date.ToString("yyyy-MM-dd");
DateTime startTime = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
long requestTimestamp = (long)Math.Round((date - startTime).TotalMilliseconds, Mi©2013-2022 Tencent Cloud. All rights reserved.

Page 70 of 760

Tencent Cloud EdgeOne

dpointRounding.AwayFromZero) / 1000;// ************* Step 1: Concatenate the CanonicalRequest string *************
string algorithm = "TC3-HMAC-SHA256";
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string contentType = "application/json";string canonicalHeaders = "content-type:" + contentType + "; charset=utf-8\n" +"host:" + endpoint + "\n";string signedHeaders = "content-type;host";
string hashedRequestPayload = SHA256Hex(requestPayload);string canonicalRequest = httpRequestMethod + "\n"+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload;
Console.WriteLine(canonicalRequest);
Console.WriteLine("----------------------------------");// ************ Step 2: Concatenate the string to sign *************
string credentialScope = datestr + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = SHA256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + requestTimestamp.ToString() + "\n" + cre
dentialScope + "\n" + hashedCanonicalRequest;
Console.WriteLine(stringToSign);
Console.WriteLine("----------------------------------");// ************* Step 3: Calculate the signature *************
byte[] tc3SecretKey = Encoding.UTF8.GetBytes("TC3" + secretkey);byte[] secretDate = HmacSHA256(tc3SecretKey, Encoding.UTF8.GetBytes(datestr));byte[] secretService = HmacSHA256(secretDate, Encoding.UTF8.GetBytes(service));byte[] secretSigning = HmacSHA256(secretService, Encoding.UTF8.GetBytes("tc3_request"));
byte[] signatureBytes = HmacSHA256(secretSigning, Encoding.UTF8.GetBytes(stringTo
Sign));
string signature = BitConverter.ToString(signatureBytes).Replace("-", "").ToLower();
Console.WriteLine(signature);
Console.WriteLine("----------------------------------");// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " "+ "Credential=" + secretid + "/" + credentialScope + ", "+ "SignedHeaders=" + signedHeaders + ", "+ "Signature=" + signature;
Console.WriteLine(authorization);©2013-2022 Tencent Cloud. All rights reserved.

Page 71 of 760

Tencent Cloud EdgeOne

Console.WriteLine("----------------------------------");
Dictionary<string, string> headers = new Dictionary<string, string>();headers.Add("Authorization", authorization);headers.Add("Host", endpoint);
headers.Add("Content-Type", contentType + "; charset=utf-8");
headers.Add("X-TC-Timestamp", requestTimestamp.ToString());
headers.Add("X-TC-Version", version);headers.Add("X-TC-Action", action);headers.Add("X-TC-Region", region);
return headers;}public static void Main(string[] args){// SecretID and SecretKey
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";// The timestamp `2019-02-26 00:44:25` used here is only for reference. In a proj
ect, use the following parameter:// DateTime date = DateTime.UtcNow;// Enter the correct time zone. We recommend using UTC timestamp to avoid errors.
DateTime date = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc).AddSeconds(1551113065);
string requestPayload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"\\u672a\\u5
47d\\u540d\"], \"Name\": \"instance-name\"}]}";
Dictionary<string, string> headers = BuildHeaders(SECRET_ID, SECRET_KEY, service, endpoint, region, action, version, date, requestPayload);
Console.WriteLine("POST https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine();Console.WriteLine(requestPayload);}}©2013-2022 Tencent Cloud. All rights reserved.

Page 72 of 760

Tencent Cloud EdgeOne

NodeJS
const crypto = require('crypto');function sha256(message, secret = '', encoding) {const hmac = crypto.createHmac('sha256', secret)return hmac.update(message).digest(encoding)}
function getHash(message, encoding = 'hex') {const hash = crypto.createHash('sha256')
return hash.update(message).digest(encoding)}
function getDate(timestamp) {const date = new Date(timestamp * 1000)
const year = date.getUTCFullYear()const month = ('0' + (date.getUTCMonth() + 1)).slice(-2)
const day = ('0' + date.getUTCDate()).slice(-2)
return `${year}-${month}-${day}`}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const service = "cvm"
const region = "ap-guangzhou"
const action = "DescribeInstances"
const version = "2017-03-12"//const timestamp = getTime()
const timestamp = 1551113065
const date = getDate(timestamp)// ************* Step 1: Concatenate the CanonicalRequest string *************
const signedHeaders = "content-type;host"const payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}"
const hashedRequestPayload = getHash(payload);
const httpRequestMethod = "POST"
const canonicalUri = "/"const canonicalQueryString = ""const canonicalHeaders = "content-type:application/json; charset=utf-8\n" + "host:" + endpoint + "\n"const canonicalRequest = httpRequestMethod + "\n"©2013-2022 Tencent Cloud. All rights reserved.

Page 73 of 760

Tencent Cloud EdgeOne+ canonicalUri + "\n"+ canonicalQueryString + "\n"+ canonicalHeaders + "\n"+ signedHeaders + "\n"+ hashedRequestPayload
console.log(canonicalRequest)
console.log("----------------------------")// ************* Step 2: Concatenate the string to sign *************
const algorithm = "TC3-HMAC-SHA256"
const hashedCanonicalRequest = getHash(canonicalRequest);
const credentialScope = date + "/" + service + "/" + "tc3_request"
const stringToSign = algorithm + "\n" +timestamp + "\n" +credentialScope + "\n" +hashedCanonicalRequest
console.log(stringToSign)
console.log("----------------------------")// ************* Step 3: Calculate the signature *************
const kDate = sha256(date, 'TC3' + SECRET_KEY)
const kService = sha256(service, kDate)
const kSigning = sha256('tc3_request', kService)
const signature = sha256(stringToSign, kSigning, 'hex')
console.log(signature)
console.log("----------------------------")// ************* Step 4: Concatenate the Authorization *************
const authorization = algorithm + " " +"Credential=" + SECRET_ID + "/" + credentialScope + ", " +"SignedHeaders=" + signedHeaders + ", " +"Signature=" + signature
console.log(authorization)
console.log("----------------------------")
const Call_Information = 'curl -X POST ' + "https://" + endpoint+ ' -H "Authorization: ' + authorization + '"'+ ' -H "Content-Type: application/json; charset=utf-8"'+ ' -H "Host: ' + endpoint + '"'+ ' -H "X-TC-Action: ' + action + '"'+ ' -H "X-TC-Timestamp: ' + timestamp.toString() + '"'+ ' -H "X-TC-Version: ' + version + '"'+ ' -H "X-TC-Region: ' + region + '"'+ " -d '" + payload + "'"console.log(Call_Information)}main()©2013-2022 Tencent Cloud. All rights reserved.

Page 74 of 760

Tencent Cloud EdgeOne

C++#include <iostream>#include <iomanip>#include <sstream>#include <string>#include <stdio.h>#include <time.h>#include <openssl/sha.h>#include <openssl/hmac.h>using namespace std;
string get_data(int64_t &timestamp){
string utcDate;char buff[20] = {0};// time_t timenow;
struct tm sttime;
sttime = *gmtime(&timestamp);
strftime(buff, sizeof(buff), "%Y-%m-%d", &sttime);
utcDate = string(buff);
return utcDate;}string int2str(int64_t n){
std::stringstream ss;
ss << n;return ss.str();}string sha256Hex(const string &str){
char buf[3];unsigned char hash[SHA256_DIGEST_LENGTH];
SHA256_CTX sha256;
SHA256_Init(&sha256);
SHA256_Update(&sha256, str.c_str(), str.size());
SHA256_Final(hash, &sha256);
std::string NewString = "";for(int i = 0; i < SHA256_DIGEST_LENGTH; i++){snprintf(buf, sizeof(buf), "%02x", hash[i]);NewString = NewString + buf;}
return NewString;©2013-2022 Tencent Cloud. All rights reserved.

Page 75 of 760

Tencent Cloud EdgeOne}
string HmacSha256(const string &key, const string &input){
unsigned char hash[32];
HMAC_CTX *h;#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX hmac;
HMAC_CTX_init(&hmac);h = &hmac;#else
h = HMAC_CTX_new();#endif
HMAC_Init_ex(h, &key[0], key.length(), EVP_sha256(), NULL);
HMAC_Update(h, ( unsigned char* )&input[0], input.length());
unsigned int len = 32;
HMAC_Final(h, hash, &len);#if OPENSSL_VERSION_NUMBER < 0x10100000L
HMAC_CTX_cleanup(h);#else
HMAC_CTX_free(h);#endif
std::stringstream ss;
ss << std::setfill('0');for (int i = 0; i < len; i++){ss << hash[i];}return (ss.str());}
string HexEncode(const string &input){
static const char* const lut = "0123456789abcdef";
size_t len = input.length();string output;
output.reserve(2 * len);for (size_t i = 0; i < len; ++i){
const unsigned char c = input[i];output.push_back(lut[c >> 4]);
output.push_back(lut[c & 15]);}©2013-2022 Tencent Cloud. All rights reserved.

Page 76 of 760

Tencent Cloud EdgeOne

return output;}
int main(){string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string service = "cvm";
string host = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
int64_t timestamp = 1551113065;
string date = get_data(timestamp);// ************* Step 1: Concatenate the CanonicalRequest string *************
string httpRequestMethod = "POST";
string canonicalUri = "/";
string canonicalQueryString = "";string canonicalHeaders = "content-type:application/json; charset=utf-8\nhost:" +host + "\n";string signedHeaders = "content-type;host";
string payload = "{\"Limit\": 1, \"Filters\": [{\"Values\": [\"unnamed\"], \"Name\": \"instance-name\"}]}";
string hashedRequestPayload = sha256Hex(payload);string canonicalRequest = httpRequestMethod + "\n" + canonicalUri + "\n" + canoni
calQueryString + "\n"+ canonicalHeaders + "\n" + signedHeaders + "\n" + hashedRequestPayload;cout << canonicalRequest << endl;
cout << "-----------------------" << endl;// ************* Step 2: Concatenate the string to sign *************
string algorithm = "TC3-HMAC-SHA256";
string RequestTimestamp = int2str(timestamp);
string credentialScope = date + "/" + service + "/" + "tc3_request";
string hashedCanonicalRequest = sha256Hex(canonicalRequest);
string stringToSign = algorithm + "\n" + RequestTimestamp + "\n" + credentialScop
e + "\n" + hashedCanonicalRequest;
cout << stringToSign << endl;
cout << "-----------------------" << endl;// ************* Step 3: Calculate the signature ***************
string kKey = "TC3" + SECRET_KEY;
string kDate = HmacSha256(kKey, date);
string kService = HmacSha256(kDate, service);
string kSigning = HmacSha256(kService, "tc3_request");©2013-2022 Tencent Cloud. All rights reserved.

Page 77 of 760

Tencent Cloud EdgeOne

string signature = HexEncode(HmacSha256(kSigning, stringToSign));cout << signature << endl;
cout << "-----------------------" << endl;// ************* Step 4: Concatenate the Authorization *************
string authorization = algorithm + " " + "Credential=" + SECRET_ID + "/" + creden
tialScope + ", "+ "SignedHeaders=" + signedHeaders + ", " + "Signature=" + signature;cout << authorization << endl;
cout << "------------------------" << endl;
string headers = "curl -X POST https://" + host + "\n"+ " -H \"Authorization: " + authorization + "\n"+ " -H \"Content-Type: application/json; charset=utf-8\"" + "\n"+ " -H \"Host: " + host + "\n"+ " -H \"X-TC-Action: " + action + "\n"+ " -H \"X-TC-Timestamp: " + RequestTimestamp + "\n"+ " -H \"X-TC-Version: " + version + "\n"+ " -H \"X-TC-Region: " + region + "\n"+ " -d '" + payload;cout << headers << endl;
return 0;};

Signature Failure
The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error CodeDescription

AuthFailure.SignatureExpire

Signature expired. Timestamp and server time cannot differ by more than fiveminutes.

AuthFailure.SecretIdNotFoundThe key does not exist. Please go to the console to check whether it isdisabled or you copied fewer or more characters.

AuthFailure.SignatureFailure

Signature error. It is possible that the signature was calculated incorrectly, thesignature does not match the content actually sent, or the SecretKey isincorrect.

AuthFailure.TokenFailure

Temporary certificate token error.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

©2013-2022 Tencent Cloud. All rights reserved.

Page 78 of 760

Tencent Cloud EdgeOne

Signature：

Last updated 2024-04-09 10:25:18
Tencent Cloud API authenticates each access request, i.e. each request needs to include authentication information(Signature) in the common parameters to verify the identity of the requester.
The Signature is generated by the security credentials which include SecretId and SecretKey. If you don't have thesecurity credentials yet, go to the TencentCloud API Key page to apply for them; otherwise, you cannot invoke theTencentCloud API.

1. Applying for Security Credentials
Before using the TencentCloud API for the first time, go to the TencentCloud API Key page to apply for security
credentials.
Security credentials consist of SecretId and SecretKey:
SecretId is used to identify the API requester.
SecretKey is used to encrypt the signature string and verify it on the server.
You must keep your security credentials private and avoid disclosure.
You can apply for the security credentials through the following steps:
1. Log in to the Tencent Cloud Console.
2. Go to the TencentCloud API Key page.
3. On the API Key Management page, click Create Key to create a SecretId/SecretKey pair.
Note: Each account can have up to two pairs of SecretId/SecretKey.

2. Generating a SignatureWith the SecretId and SecretKey, a signature can be generated. The following describes how to generate a signature:
Assume that the SecretId and SecretKey are:SecretId: AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******
SecretKey: Gu5t9xGARNpq86cd98joQYCN3*******
Note: This is just an example. For actual operations, please use your own SecretId and SecretKey.

©2013-2022 Tencent Cloud. All rights reserved.

Page 79 of 760

Tencent Cloud EdgeOne

Take the Cloud Virtual Machine's request to view the instance list (DescribeInstances) as an example. When you
invoke this API, the request parameters may be as follows:
Parameter
nameDescription

Parameter value

Action

Method name

DescribeInstances

SecretId

Key ID

AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******

Timestamp

Current timestamp

1465185768

Nonce

Random positive integer

11886

RegionRegion where the instance islocatedap-guangzhou

InstanceIds.0

ID of the instance to query

ins-09dx96dg

OffsetOffset0

Limit

Allowed maximum output

20

VersionAPI version number

2017-03-12

2.1. Sorting Parameters
First, sort all the request parameters in an ascending lexicographical order (ASCII code) by their names. Notes: (1)Parameters are sorted by their names instead of their values; (2) The parameters are sorted based on ASCII code, notin an alphabetical order or by values. For example, InstanceIds.2 should be arranged after InstanceIds.12. You cancomplete the sorting process using a sorting function in a programming language, such as the ksort function in PHP.
The parameters in the example are sorted as follows:{'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******','Timestamp' : 1465185768,'Version': '2017-03-12',}©2013-2022 Tencent Cloud. All rights reserved.

Page 80 of 760

Tencent Cloud EdgeOne

When developing in another programming language, you can sort these sample parameters and it will work as long as
you obtain the same results.

2.2. Concatenating a Request String
This step generates a request string.
Format the request parameters sorted in the previous step into the form of "parameter name"="parameter value". For
example, for the Action parameter, its parameter name is "Action" and its parameter value is "DescribeInstances", so it
will become Action=DescribeInstances after formatted.
Note: The "parameter value" is the original value but not the value after URL encoding.
Then, concatenate the formatted parameters with "&". The resulting request string is as follows:

Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Timestamp=1465
185768&Version=2017-03-12

2.3. Concatenating the Signature Original String
This step generates a signature original string.
The signature original string consists of the following parameters:
1. HTTP method: POST and GET modes are supported, and GET is used here for the request. Please note that themethod name should be in all capital letters.
2. Request server: the domain name of the request to view the list of instances (DescribeInstances) is
cvm.tencentcloudapi.com. The actual request domain name varies by the module to which the API belongs. For
more information, see the instructions of the specific API.
3. Request path: The request path in the current version of TencentCloud API is fixed to /.
4. Request string: the request string generated in the previous step.
The concatenation rule of the signature original string is: Request method + request host + request path + ? + request
string
The concatenation result of the example is:
GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&L
imit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WF
kmLPx3*******&Timestamp=1465185768&Version=2017-03-12

2.4. Generating a Signature String
This step generates a signature string.
First, use the HMAC-SHA1 algorithm to sign the signature original string obtained in the previous step, and then©2013-2022 Tencent Cloud. All rights reserved.

Page 81 of 760

Tencent Cloud EdgeOne

encode the generated signature using Base64 to obtain the final signature.
The specific code is as follows with the PHP language being used as an example:$secretKey = 'Gu5t9xGARNpq86cd98joQYCN3*******';$srcStr = 'GETcvm.tencentcloudapi.com/?Action=DescribeInstances&InstanceIds.0=ins-09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=ap-guangzhou&SecretId=AKIDz8krbsJ5
yKBZQpn74WFkmLPx3*******&Timestamp=1465185768&Version=2017-03-12';$signStr = base64_encode(hash_hmac('sha1', $srcStr, $secretKey, true));echo $signStr;
The final signature is:zmmjn35mikh6pM3V7sUEuX4wyYM=
When developing in another programming language, you can sign and verify the original in the example above and it
works as long as you get the same results.

3. Encoding a Signature String
The generated signature string cannot be directly used as a request parameter and must be URL encoded.
For example, if the signature string generated in the previous step is zmmjn35mikh6pM3V7sUEuX4wyYM=, the final
signature string request parameter (Signature) is zmmjn35mikh6pM3V7sUEuX4wyYM%3D, which will be used togenerate the final request URL.
Note: If your request method is GET, or the request method is POST and the Content-Type isapplication/x-www-form-urlencoded, then all the request parameter values need to be URL encoded(except the parameter key and the symbol of =) when sending the request. Non-ASCII characters need to
be encoded with UTF-8 before URL encoding.
Note: The network libraries of some programming languages automatically URL encode all parameters, inwhich case there is no need to URL encode the signature string; otherwise, two rounds of URL encoding
will cause the signature to fail.
Note: Other parameter values also need to be encoded using RFC 3986. Use %XY in percent-encoding forspecial characters such as Chinese characters, where "X" and "Y" are hexadecimal characters (0-9 anduppercase A-F), and using lowercase will cause an error.

4. Signature Failure©2013-2022 Tencent Cloud. All rights reserved.

Page 82 of 760

Tencent Cloud EdgeOne

The following situational error codes for signature failure may occur. Please resolve the errors accordingly.
Error code

Error description

AuthFailure.SignatureExpire

The signature is expired

AuthFailure.SecretIdNotFoundThe key does not exist

AuthFailure.SignatureFailure

Signature error

AuthFailure.TokenFailure

Token error

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type)

5. Signature Demo
When calling API 3.0, you are recommended to use the corresponding Tencent Cloud SDK 3.0 which encapsulates
the signature process, enabling you to focus on only the specific APIs provided by the product when developing. See
SDK Center for more information. Currently, the following programming languages are supported:
PythonJava
PHP
Go
NodeJS.NET
To further explain the signing process, we will use a programming language to implement the process describedabove. The request domain name, API and parameter values in the sample are used here. This goal of this example isonly to provide additional clarification for the signature process, please see the SDK for actual usage.
The final output URL might be: https://cvm.tencentcloudapi.com/?
Action=DescribeInstances&InstanceIds.0=ins09dx96dg&Limit=20&Nonce=11886&Offset=0&Region=apguangzhou&SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******&Signature=zmmjn35mikh6pM3V7s
UEuX4wyYM%3D&Timestamp=1465185768&Version=2017-03-12 .
Note: The key in the example is fictitious, and the timestamp is not the current time of the system, so if this URL is
opened in the browser or called using commands such as curl, an authentication error will be returned: Signature
expired. In order to get a URL that can work properly, you need to replace the SecretId and SecretKey in the example
with your real credentials and use the current time of the system as the Timestamp.

©2013-2022 Tencent Cloud. All rights reserved.

Page 83 of 760

Tencent Cloud EdgeOne

Note: In the example below, even if you use the same programming language, the order of the parameters in the URL
may be different for each execution. However, the order does not matter, as long as all the parameters are included in
the URL and the signature is calculated correctly.
Note: The following code is only applicable to API 3.0. It cannot be directly used in other signature processes. Even
with an older API, signature calculation errors may occur due to the differences in details. Please refer to thecorresponding documentation.

Java
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;import java.util.Random;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
public class TencentCloudAPIDemo {private final static String CHARSET = "UTF-8";
public static String sign(String s, String key, String method) throws Exception {Mac mac = Mac.getInstance(method);
SecretKeySpec secretKeySpec = new SecretKeySpec(key.getBytes(CHARSET), mac.getAlg
orithm());
mac.init(secretKeySpec);
byte[] hash = mac.doFinal(s.getBytes(CHARSET));
return DatatypeConverter.printBase64Binary(hash);}public static String getStringToSign(TreeMap<String, Object> params) {StringBuilder s2s = new StringBuilder("GETcvm.tencentcloudapi.com/?");// When signing, the parameters need to be sorted in lexicographical order. TreeM
ap is used here to guarantee the correct order.
for (String k : params.keySet()) {s2s.append(k).append("=").append(params.get(k).toString()).append("&");}
return s2s.toString().substring(0, s2s.length() - 1);}
public static String getUrl(TreeMap<String, Object> params) throws UnsupportedEnc
odingException {StringBuilder url = new StringBuilder("https://cvm.tencentcloudapi.com/?");// There is no requirement for the order of the parameters in the actual request
URL.
for (String k : params.keySet()) {©2013-2022 Tencent Cloud. All rights reserved.

Page 84 of 760

Tencent Cloud EdgeOne// The request string needs to be URL encoded. As the Key is all in English letters, only the value is URL encoded here.
url.append(k).append("=").append(URLEncoder.encode(params.get(k).toString(), CHAR
SET)).append("&");}
return url.toString().substring(0, url.length() - 1);}
public static void main(String[] args) throws Exception {TreeMap<String, Object> params = new TreeMap<String, Object>(); // TreeMap enable
s automatic sorting// A random number should be used when actually calling, for example: params.put("Nonce", new Random().nextInt(java.lang.Integer.MAX_VALUE));params.put("Nonce", 11886); // Common parameter// The current time of the system should be used when actually calling, for examp
le: params.put("Timestamp", System.currentTimeMillis() / 1000);params.put("Timestamp", 1465185768); // Common parameterparams.put("SecretId", "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"); // Common parameterparams.put("Action", "DescribeInstances"); // Common parameterparams.put("Version", "2017-03-12"); // Common parameterparams.put("Region", "ap-guangzhou"); // Common parameterparams.put("Limit", 20); // Business parameterparams.put("Offset", 0); // Business parameterparams.put("InstanceIds.0", "ins-09dx96dg"); // Business parameterparams.put("Signature", sign(getStringToSign(params), "Gu5t9xGARNpq86cd98joQYCN3*******", "HmacSHA1")); // Common parameter
System.out.println(getUrl(params));}}

PythonNote: If running in a Python 2 environment, the following requests dependency package must be installed first: pip
install requests .

# -*- coding: utf8 -*import base64
import hashlib
import hmac
import time
import requests
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"©2013-2022 Tencent Cloud. All rights reserved.

Page 85 of 760

Tencent Cloud EdgeOne

def get_string_to_sign(method, endpoint, params):
s = method + endpoint + "/?"
query_str = "&".join("%s=%s" % (k, params[k]) for k in sorted(params))
return s + query_str
def sign_str(key, s, method):
hmac_str = hmac.new(key.encode("utf8"), s.encode("utf8"), method).digest()
return base64.b64encode(hmac_str)
if __name__ == '__main__':endpoint = "cvm.tencentcloudapi.com"
data = {'Action' : 'DescribeInstances','InstanceIds.0' : 'ins-09dx96dg','Limit' : 20,'Nonce' : 11886,'Offset' : 0,
'Region' : 'ap-guangzhou','SecretId' : secret_id,'Timestamp' : 1465185768, # int(time.time())'Version': '2017-03-12'}
s = get_string_to_sign("GET", endpoint, data)
data["Signature"] = sign_str(secret_key, s, hashlib.sha1)
print(data["Signature"])# An actual invocation would occur here, which may incur fees after success# resp = requests.get("https://" + endpoint, params=data)# print(resp.url)

Golangpackage main
import ("bytes""crypto/hmac""crypto/sha1""encoding/base64""fmt""sort")
func main() {secretId := "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secretKey := "Gu5t9xGARNpq86cd98joQYCN3*******"©2013-2022 Tencent Cloud. All rights reserved.

Page 86 of 760

Tencent Cloud EdgeOne

params := map[string]string{"Nonce": "11886","Timestamp": "1465185768","Region": "ap-guangzhou","SecretId": secretId,"Version": "2017-03-12","Action": "DescribeInstances","InstanceIds.0": "ins-09dx96dg","Limit": "20","Offset": "0",}var buf bytes.Buffer
buf.WriteString("GET")
buf.WriteString("cvm.tencentcloudapi.com")buf.WriteString("/")
buf.WriteString("?")// sort keys by ascii asc orderkeys := make([]string, 0, len(params))
for k, _ := range params {keys = append(keys, k)}sort.Strings(keys)
for i := range keys {k := keys[i]buf.WriteString(k)buf.WriteString("=")
buf.WriteString(params[k])buf.WriteString("&")}
buf.Truncate(buf.Len() - 1)hashed := hmac.New(sha1.New, []byte(secretKey))hashed.Write(buf.Bytes())
fmt.Println(base64.StdEncoding.EncodeToString(hashed.Sum(nil)))
}

PHP
<?php
$secretId = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";$secretKey = "Gu5t9xGARNpq86cd98joQYCN3*******";$param["Nonce"] = 11886;//rand();©2013-2022 Tencent Cloud. All rights reserved.

Page 87 of 760

Tencent Cloud EdgeOne$param["Timestamp"] = 1465185768;//time();$param["Region"] = "ap-guangzhou";$param["SecretId"] = $secretId;$param["Version"] = "2017-03-12";$param["Action"] = "DescribeInstances";$param["InstanceIds.0"] = "ins-09dx96dg";$param["Limit"] = 20;$param["Offset"] = 0;
ksort($param);$signStr = "GETcvm.tencentcloudapi.com/?";foreach ( $param as $key => $value ) {$signStr = $signStr . $key . "=" . $value . "&";}
$signStr = substr($signStr, 0, -1);
$signature = base64_encode(hash_hmac("sha1", $signStr, $secretKey, true));echo $signature.PHP_EOL;// need to install and enable curl extension in php.ini// $param["Signature"] = $signature;// $url = "https://cvm.tencentcloudapi.com/?".http_build_query($param);// echo $url.PHP_EOL;// $ch = curl_init();// curl_setopt($ch, CURLOPT_URL, $url);// $output = curl_exec($ch);// curl_close($ch);// echo json_decode($output);Ruby# -*- coding: UTF-8 -*# require ruby>=2.3.0
require 'time'require 'openssl'
require 'base64'
secret_id = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
secret_key = "Gu5t9xGARNpq86cd98joQYCN3*******"
method = 'GET'
endpoint = 'cvm.tencentcloudapi.com'
data = {'Action' => 'DescribeInstances','InstanceIds.0' => 'ins-09dx96dg','Limit' => 20,©2013-2022 Tencent Cloud. All rights reserved.

Page 88 of 760

Tencent Cloud EdgeOne'Nonce' => 11886,'Offset' => 0,'Region' => 'ap-guangzhou','SecretId' => secret_id,'Timestamp' => 1465185768, # Time.now.to_i'Version' => '2017-03-12',}
sign = method + endpoint + '/?'
params = []data.sort.each do |item|
params << "#{item[0]}=#{item[1]}"endsign += params.join('&')
digest = OpenSSL::Digest.new('sha1')
data['Signature'] = Base64.encode64(OpenSSL::HMAC.digest(digest, secret_key, sign))puts data['Signature']# require 'net/http'# uri = URI('https://' + endpoint)# uri.query = URI.encode_www_form(data)# p uri# res = Net::HTTP.get_response(uri)# puts res.body

DotNetusing System;
using System.Collections.Generic;using System.Net;
using System.Security.Cryptography;
using System.Text;
public class Application {public static string Sign(string signKey, string secret){string signRet = string.Empty;
using (HMACSHA1 mac = new HMACSHA1(Encoding.UTF8.GetBytes(signKey))){byte[] hash = mac.ComputeHash(Encoding.UTF8.GetBytes(secret));signRet = Convert.ToBase64String(hash);}return signRet;}
public static string MakeSignPlainText(SortedDictionary<string, string> requestParams, string requestMethod, string requestHost, string requestPath)©2013-2022 Tencent Cloud. All rights reserved.

Page 89 of 760

Tencent Cloud EdgeOne{
string retStr = "";retStr += requestMethod;
retStr += requestHost;
retStr += requestPath;
retStr += "?";
string v = "";foreach (string key in requestParams.Keys){v += string.Format("{0}={1}&", key, requestParams[key]);}
retStr += v.TrimEnd('&');
return retStr;}
public static void Main(string[] args){
string SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******";
string SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******";
string endpoint = "cvm.tencentcloudapi.com";string region = "ap-guangzhou";string action = "DescribeInstances";
string version = "2017-03-12";
double RequestTimestamp = 1465185768;// long timestamp = ToTimestamp() / 1000;// string requestTimestamp = timestamp.ToString();
Dictionary<string, string> param = new Dictionary<string, string>();param.Add("Limit", "20");param.Add("Offset", "0");param.Add("InstanceIds.0", "ins-09dx96dg");
param.Add("Action", action);param.Add("Nonce", "11886");// param.Add("Nonce", Math.Abs(new Random().Next()).ToString());
param.Add("Timestamp", RequestTimestamp.ToString());
param.Add("Version", version);param.Add("SecretId", SECRET_ID);
param.Add("Region", region);
SortedDictionary<string, string> headers = new SortedDictionary<string, string>(param, StringComparer.Ordinal);
string sigInParam = MakeSignPlainText(headers, "GET", endpoint, "/");
Console.WriteLine(sigInParam);
string sigOutParam = Sign(SECRET_KEY, sigInParam);©2013-2022 Tencent Cloud. All rights reserved.

Page 90 of 760

Tencent Cloud EdgeOne

Console.WriteLine("GET https://cvm.tencentcloudapi.com");foreach (KeyValuePair<string, string> kv in headers){Console.WriteLine(kv.Key + ": " + kv.Value);}
Console.WriteLine("Signature" + ": " + WebUtility.UrlEncode(sigOutParam));
Console.WriteLine();string result = "https://cvm.tencentcloudapi.com/?";foreach (KeyValuePair<string, string> kv in headers){
result += WebUtility.UrlEncode(kv.Key) + "=" + WebUtility.UrlEncode(kv.Value) +"&";}result += WebUtility.UrlEncode("Signature") + "=" + WebUtility.UrlEncode(sigOutPa
ram);
Console.WriteLine("GET " + result);}}

NodeJS
const crypto = require('crypto');function get_req_url(params, endpoint){
params['Signature'] = escape(params['Signature']);const url_strParam = sort_params(params)
return "https://" + endpoint + "/?" + url_strParam.slice(1);}function formatSignString(reqMethod, endpoint, path, strParam){
let strSign = reqMethod + endpoint + path + "?" + strParam.slice(1);return strSign;}function sha1(secretKey, strsign){
let signMethodMap = {'HmacSHA1': "sha1"};
let hmac = crypto.createHmac(signMethodMap['HmacSHA1'], secretKey || "");
return hmac.update(Buffer.from(strsign, 'utf8')).digest('base64')}function sort_params(params){
let strParam = "";let keys = Object.keys(params);
keys.sort();for (let k in keys) {//k = k.replace(/_/g, '.');©2013-2022 Tencent Cloud. All rights reserved.

Page 91 of 760

Tencent Cloud EdgeOne

strParam += ("&" + keys[k] + "=" + params[keys[k]]);}return strParam}function main(){const SECRET_ID = "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******"
const SECRET_KEY = "Gu5t9xGARNpq86cd98joQYCN3*******"
const endpoint = "cvm.tencentcloudapi.com"
const Region = "ap-guangzhou"
const Version = "2017-03-12"
const Action = "DescribeInstances"
const Timestamp = 1465185768// const Timestamp = Math.round(Date.now() / 1000)
const Nonce = 11886//const nonce = Math.round(Math.random() * 65535)
let params = {};params['Action'] = Action;
params['InstanceIds.0'] = 'ins-09dx96dg';
params['Limit'] = 20;
params['Offset'] = 0;params['Nonce'] = Nonce;params['Region'] = Region;
params['SecretId'] = SECRET_ID;
params['Timestamp'] = Timestamp;
params['Version'] = Version;
strParam = sort_params(params)
const reqMethod = "GET";
const path = "/";
strSign = formatSignString(reqMethod, endpoint, path, strParam)
console.log(strSign)
console.log("-----------------------")
params['Signature'] = sha1(SECRET_KEY, strSign)
console.log(params['Signature'])console.log("-----------------------")
const req_url = get_req_url(params, endpoint)
console.log(params['Signature'])console.log("-----------------------")
console.log(req_url)}
main()©2013-2022 Tencent Cloud. All rights reserved.

Page 92 of 760

Tencent Cloud EdgeOne©2013-2022 Tencent Cloud. All rights reserved.

Page 93 of 760

Tencent Cloud EdgeOne

Responses：

Last updated 2024-04-09 10:25:19

Response for Successful Requests
For example, when calling CAM API (version: 2017-03-12) to view the status of instances (DescribeInstancesStatus),
if the request has succeeded, you may see the response as shown below:{"Response": {"TotalCount": 0,"InstanceStatusSet": [],"RequestId": "b5b41468-520d-4192-b42f-595cc34b6c1c"}}
The API will return Response , which contains RequestId , as long as it processes the request. It does notmatter if the request is successful or not.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.
Except for the fixed fields, all fields are action-specified. For the definitions of action-specified fields, see thecorresponding API documentation. In this example, TotalCount and InstanceStatusSet are the fields
specified by the API DescribeInstancesStatus . 0 TotalCount means that the requester owns 0 CVM
instance so the InstanceStatusSet is empty.

Response for Failed Requests
If the request has failed, you may see the response as shown below:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please ensure your signature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 94 of 760

Tencent Cloud EdgeOne

The presence of the Error field indicates that the request has failed. A response for a failed request will include
Error , Code and Message fields.
Code is the code of the error that helps you identify the cause and solution. There are two types of error codes
so you may find the code in either common error codes or API-specified error codes.
Message explains the cause of the error. Note that the returned messages are subject to service updates. The
information the messages provide may not be up-to-date and should not be the only source of reference.
RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.

Common Error Codes
If there is an Error field in the response, it means that the API call failed. The Code field in Error indicates the error
code. The following table lists the common error codes that all actions can return.
Error CodeDescription

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.

AuthFailure.SecretIdNotFoundThe key does not exist.

AuthFailure.SignatureExpire

Signature expired.

AuthFailure.SignatureFailure

Signature error.

AuthFailure.TokenFailure

Token error.

AuthFailure.UnauthorizedOperation

The request does not have CAM authorization.

DryRunOperation

DryRun Operation. It means that the request would have succeeded, but
the DryRun parameter was used.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

©2013-2022 Tencent Cloud. All rights reserved.

Page 95 of 760

Tencent Cloud EdgeOne

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

UnsupportedProtocol

HTTPS request method error. Only GET and POST requests aresupported.

UnsupportedRegion

API does not support the requested region.

©2013-2022 Tencent Cloud. All rights reserved.

Page 96 of 760

Tencent Cloud EdgeOne

Site APIs
CreateZone：

Last updated 2024-04-09 10:25:36

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a site. After you create the site, you can connect it to EdgeOne via the CNAME or NS (seeQuick Start), or connect it without a domain name (see Quick Access to L4 Proxy Service).
If there are already EdgeOne plans under the current account, it is recommended to pass in the PlanId to bind thesite with the plan directly. If PlanId is not passed in, the created site is not activated. You need to call
BindZoneToPlan to bind the site with a plan. To purchase a plan, please go to the EdgeOne console.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreateZone.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

Type

No

StringSite access types. Options include:
partial : (Default) Access through a CNAME record

Namefull : Access through a name server
noDomainAccess : Access without using a domain name©2013-2022 Tencent Cloud. All rights reserved.

Page 97 of 760

Tencent Cloud EdgeOne

Site name. For sites connected via CNAME/NS, pass in the
ZoneName

No

Stringsecondary domain name (example.com). Leave it blank if the site isconnected without a domain name.
The acceleration area of the L7 domain name when Type ispartial or full . When Type is noDomainAccess ,

Area

No

Stringplease leave it blank.
global : Global AZs
mainland : AZs in the Chinese mainland
overseas : (Default) AZs outside the Chinese mainland

PlanIdNo

StringID of the plan to which you want to bind the site. If you don't have an
EdgeOne plan, purchase one in the EdgeOne console.
The site alias. It allows up to 20 characters, including [0-9], [a-z], [A-AliasZoneName

Tags.NNo

String

No

Array
of

Z] and [-_]. For details, see Glossary. If you don't want to use it, justleave it blank.

Tags of the site. To create tags, go to the Tag Console.

Tag

3. Output Parameters
Parameter NameType

Description

ZoneIdStringSite ID.

OwnershipVerification

OwnershipVerification

Site ownership verification information. After the site is
created, you need to complete the ownership verification
before the site can serve normally.
If Type=partial , add TXT records to your DNS
provider or add files to the root DNS server, and then call
VerifyOwnership to complete verification. For more
information, see Ownership Verification.
If Type = full , switch the DNS server as instructedby Modifying DNS Server. Then call VerifyOwnership tocheck the result.
If Type = noDomainAccess , leave it blank. No action
is required.

©2013-2022 Tencent Cloud. All rights reserved.

Page 98 of 760

Tencent Cloud EdgeOne

Note: This field may return·null, indicating that no valid
values can be obtained.
The unique request ID, generated by the server, will be
RequestId

Stringreturned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a site with the NS access modeu200cConnect the site example.com to EdgeOne via the NS. Set the service area to Chinese mainland, and bindit with the plan edgeone-37q0w6qali10 . The information of DNS provider is returned. You need to go to thedomain name registrar to modify the configuration. For more information, see Modifying DNS Server.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateZone<Common request parameters>{"Type": "full","ZoneName": "example.com","Area": "mainland","PlanId": "edgeone-37q0w6qali10"}

Output Example{"Response": {"ZoneId": "zone-27q0p0bali16","OwnershipVerification": {"DnsVerification": null,"FileVerification": null,"NsVerification": {"NameServers": ["ns1.teodns.com","ns2.teodns.com"©2013-2022 Tencent Cloud. All rights reserved.

Page 99 of 760

Tencent Cloud EdgeOne]}},"RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"}}

Example2 Creating a site without specifying the domain nameCreate a site without specifying the domain name, and bind it with the plan edgeone-37q0w6qali10 . The site ID
is returned. For information, see Quick access to L4 proxy service.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateZone<Common request parameters>{"Type": "noDomainAccess","PlanId": "edgeone-37q0w6qali10"}

Output Example{"Response": {"ZoneId": "zone-27q0p0bali16","RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"}}

Example3 Creating a site with the CNAME access mode
Connect the site example.com to EdgeOne via the CNAME. Set the service area to Global, and bind it with theplan edgeone-37q0w6qali10 . This API returns the site ID and site ownership verification information. To verify
your ownership of a site, see Ownership Verification.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 100 of 760

Tencent Cloud EdgeOne

Content-Type: application/json
X-TC-Action: CreateZone<Common request parameters>{"Type": "partial","ZoneName": "example.com","Area": "global","PlanId": "edgeone-37q0w6qali10"}

Output Example{"Response": {"ZoneId": "zone-27q0p0bali16","OwnershipVerification": {"DnsVerification": {"Subdomain": "edgeonereclaim","RecordType": "TXT","RecordValue": "reclaim-a24aba2420cf4ce8b7bff7c8be6d337f"},"FileVerification": {"Path": "/.well-known/teo-verification/vd4ewuqa9n.txt","Content": "88v24mnnljwbhaohrpfx80f63duhdnjx"},"NsVerification": null},
"RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 101 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

DryRunOperation

DryRun operation, which means the DryRunparameter is passed in yet the request will still be
successful.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback
address.

InvalidParameter.LengthExceedsLimit

Maximum parameter length exceeded.

InvalidParameter.PlanNotFoundThe plan doesn’t exist.

InvalidParameter.ZoneHasBeenBoundThe site is already bound.

InvalidParameterValue

Invalid parameter value.

InvalidParameterValue.AccessBlacklist

The domain name for this zone has been banned.

InvalidParameterValue.InvalidTagValue

The tag value contains invalid characters.

InvalidParameterValue.TopLevelDomainNotSupport

The current domain suffix is not supported foraccess. Please contact us if you need to use it.

InvalidParameterValue.ZoneNameInvalid

The zone name format is incorrect. Please input acorrectly formed domain name.

InvalidParameterValue.ZoneNameNotSupportPunyCode

Punycode access is not supported at present.

InvalidParameterValue.ZoneNameNotSupportSubDomain

The zone does not support subdomain access.
Please use second-level domains for zone access.

InvalidParameterValue.ZoneSameAsName

The site alias already exists.

©2013-2022 Tencent Cloud. All rights reserved.

Page 102 of 760

Tencent Cloud EdgeOne

LimitExceeded.ZoneBindPlan

Reached the upper limit of sites of the plan

OperationDenied

Operation denied.

OperationDenied.DomainIsBlocked

Unable to use the domain name when it’s blocked.

OperationDenied.RecordIsForbidden

The DNS record cannot be added.

ResourceInUse

The resource is occupied.

ResourceInUse.AliasDomain

Resources occupied by the alias domain names
under this account.

ResourceInUse.Cname

Resources occupied by this account via CNAME.

ResourceInUse.Dns

DNS resources occupied.

ResourceInUse.GenericHost

ResourceInUse.Host
ResourceInUse.NS
ResourceInUse.Others

Resources occupied by the wildcard domain
name.
Resources occupied by the subdomain names
under this account.
Resources occupied by this account via NS.
The resource has been connected to EdgeOne byanother user.

ResourceInUse.OthersAliasDomain

Resources occupied by the alias domain names
under other accounts.

ResourceInUse.OthersCname

Resources occupied by other accounts via
CNAME.

ResourceInUse.OthersHost
ResourceInUse.OthersNS
ResourceInUse.SelfAndOthersCname

Resources occupied by the subdomain names
under other accounts.
Resources occupied by other accounts via NS.
Resources occupied by this account and others
via CNAME.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for theoperation. Please get permissions first.

©2013-2022 Tencent Cloud. All rights reserved.

Page 103 of 760

Tencent Cloud EdgeOne

UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

An unknown error occurred in the backend server.

Page 104 of 760

Tencent Cloud EdgeOne

DescribeIdentifications：

Last updated 2024-04-09 10:25:34

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the verification information of a site.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeIdentifications.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

Filters.N

Yes

Array ofFilterOffsetNo

Integer

The page offset. Default value: 0

Limit

No

Integer

The paginated query limit. Default value: 20. Maximum value: 1000.

Filter conditions. The maximum value for Filters.Values is 20. The
detailed conditions are as follows:zone-name: Filter by site name.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 105 of 760

Tencent Cloud EdgeOne

Parameter
Name

Type

Description

TotalCount

IntegerNumber of eligible sites.

Identifications

Array ofIdentification

The site verification information.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the verification status of a site
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIdentifications<Common request parameters>{"Limit": 20,"Filters": [{"Values": ["example.com"],"Name": "zone-name"}],"Offset": 0}

Output Example{"Response": {"Identifications": [{"ZoneName": "example.com",©2013-2022 Tencent Cloud. All rights reserved.

Page 106 of 760

Tencent Cloud EdgeOne"Status": "pending","Ascription": {"Subdomain": "edgeonereclaim","RecordType": "TXT","RecordValue": "reclaim-a24aba2420cf4ce8b7bff7c8be6d337f"},"OriginalNameServers": ["ns1.example.com","ns2.example.com"],"FileAscription": {"IdentifyContent": "88v24mnnljwbhaohrpfx80f63duhdnjx","IdentifyPath": "/.well-known/teo-verification/vd4ewuqa9n.txt"}}],"TotalCount": 1,"RequestId": "8gs50b24-7df5-47f4-96ae-95825d53er3c"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 107 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeOperationDenied.DomainInShareCnameGroup

Description
Switch failed: There are domain names in the shared CNAME
group.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled. Please enable itand try again.

OperationDenied.ResourceLockedTemporary

This operation conflicts with concurrent operations. Try again
later.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

©2013-2022 Tencent Cloud. All rights reserved.

Page 108 of 760

Tencent Cloud EdgeOne

ModifyZone：

Last updated 2024-04-09 10:25:32

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify a site.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringRegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

Common Params. The value used for this API:
ModifyZone.
Common Params. The value used for this API:2022-09-01.

Access mode of the site. Values:
full : Access through a name server.
partial : Access through a CNAME
Type

No

Stringrecord. A site using domainless access can only
switch to CNAME access.
The original configuration applies if this field is not
specified.

VanityNameServers

No

VanityNameServers©2013-2022 Tencent Cloud. All rights reserved.

The custom name servers. The original

Page 109 of 760

Tencent Cloud EdgeOne

configuration applies if this field is not specified. It
is not allowed to pass this field when a site isconnected without using a domain name.
The site alias. It can be up to 20 characters
AliasZoneName

No

Stringconsisting of digits, letters, hyphens (-) andunderscores (_).
The region where the site requests access.
Values:global : Global coverage

Area

No

Stringmainland : Chinese mainland
overseas : Outside the Chinese mainland
It is not allowed to pass this field when a site isconnected without using a domain name.

ZoneName

No

StringName of the site. This field takes effect only when
the site switches from domainless access to
CNAME access.

3. Output Parameters
Parameter
Name

Type

RequestId

StringDescription
The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying a site
This example shows you how to modify a site.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZone<Common request parameters>©2013-2022 Tencent Cloud. All rights reserved.

Page 110 of 760

Tencent Cloud EdgeOne{"VanityNameServers": {"Switch": "on","Servers": ["ns1.example.com","ns2.example.com"]},"Type": "full","ZoneId": "zone-27q0p0bali16","AliasZoneName": "zone-example"}

Output Example{"Response": {"RequestId": "4ac50b24-7dc2-47f4-92ce-9fd25d53gt2f"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 111 of 760

Tencent Cloud EdgeOne

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription
DryRun operation, which means the

DryRunOperation

DryRun parameter is passed in yet
the request will still be successful.

FailedOperation
InternalError.ConfigLocked

InvalidParameter.InvalidOriginIp
InvalidParameter.InvalidWebSocketTimeout
InvalidParameter.LengthExceedsLimit

InvalidParameter.ZoneNameIsRequired

Operation failed.
The configuration is locked. Please
unlock and try again.
The origin cannot be a private IP or
loopback address.
Invalid WebSocket.
Maximum parameter length
exceeded.
To switch a site from connecting
without a domain name to connecting
via the CNAME, the site name isrequired.

InvalidParameterValue

Invalid parameter value.

InvalidParameterValue.ZoneSameAsName

The site alias already exists.

OperationDenied

Operation denied.

OperationDenied.DisableZoneNotCompleted

OperationDenied.DomainInShareCnameGroupOperationDenied.DomainNumberIsNotZero

The EdgeOne service of the site is
being disabled. Please try again later.
Switch failed: There are domainnames in the shared CNAME group.
Unable to modify the service area:
There are domain names under thesite.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site isdisabled. Please enable it and try©2013-2022 Tencent Cloud. All rights reserved.

Page 112 of 760

Tencent Cloud EdgeOne

again.
OperationDenied.MultipleCnameZone

OperationDenied.NSNotAllowTrafficStrategy

Unable to switch to NS for multiple
sites using CNAME.
Domain traffic scheduling is notsupported in NS access mode.
You can only switch a site connected

OperationDenied.NoDomainAccessZoneOnlyAllowModifiedToCNAME

OperationDenied.NoDomainAccessZoneOnlySupportModifyType

OperationDenied.PlanNotSupportModifyZoneArea

without a domain name to connecting
via the CNAME
You can only switch a site connectedwithout a domain name to connecting
via the CNAME. Other operations are
not allowed.
The specified plan does not supportchanging the service area of the site.
This operation conflicts withOperationDenied.ResourceLockedTemporary

ResourceInUse.Cname
ResourceInUse.Dns
ResourceInUse.GenericHost

ResourceInUse.NS

ResourceInUse.Others

ResourceInUse.OthersAliasDomain

ResourceInUse.OthersCname

concurrent operations. Try again
later.
Resources occupied by this account
via CNAME.
DNS resources occupied.
Resources occupied by the wildcard
domain name.
Resources occupied by this accountvia NS.
The resource has been connected to
EdgeOne by another user.
Resources occupied by the alias
domain names under other accounts.
Resources occupied by otheraccounts via CNAME.

ResourceInUse.OthersNS

Resources occupied by otheraccounts via NS.

ResourceInUse.SelfAndOthersCname

Resources occupied by this account©2013-2022 Tencent Cloud. All rights reserved.

Page 113 of 760

Tencent Cloud EdgeOne

and others via CNAME.
ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.
The sub-account is not authorized for

UnauthorizedOperation.NoPermission©2013-2022 Tencent Cloud. All rights reserved.

the operation. Please get permissions
first.

Page 114 of 760

Tencent Cloud EdgeOne

DeleteZone：

Last updated 2024-04-09 10:25:35

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete a site.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteZone.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 115 of 760

Tencent Cloud EdgeOne

4. Example
Example1 Deleting a site
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteZone<Common request parameters>{"ZoneId": "zone-27q0p0bali16"}

Output Example{"Response": {"RequestId": "2ac50bka-7dc5-4fq4-96ce-89825d53jkl1"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 116 of 760

Tencent Cloud EdgeOne

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

OperationDenied

Operation denied.

OperationDenied.DeleteZonePreCheckFailed

The pre-check failed during site deletion.

OperationDenied.DisableZoneNotCompleted

The EdgeOne service of the site is being disabled.
Please try again later.

OperationDenied.ZoneIsBindingSharedCNAME

OperationDenied.ZoneIsReferenceCustomErrorPage

The shared CNAME has been bound to another site.
Please unbind first.
Error found in the associated custom error page.
Please unbind it first.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 117 of 760

Tencent Cloud EdgeOne

ModifyZoneStatus：

Last updated 2024-04-09 10:25:32

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to change the site status.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyZoneStatus.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

Name

The site status. Values:
PausedYes

Booleanfalse : Disabledtrue : Enabled

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 118 of 760

Tencent Cloud EdgeOne

Parameter
Name

Type

Description

The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Changes the site status
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneStatus<Common request parameters>{"Paused": true,"ZoneId": "zone-27q0p0bali16"}

Output Example{"Response": {"RequestId": "7sd20b24-7dc5-98f4-96ce-95825dcd34sa"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 119 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

OperationDenied

Operation denied.

OperationDenied.ConfigLocked

The configuration is locked. Please unlock and try again.

OperationDenied.DisableZoneNotCompleted

OperationDenied.L4ProxyInProgressStatus

OperationDenied.L4ProxyInStoppingStatus

OperationDenied.L7HostInProcessStatus

OperationDenied.ResourceLockedTemporary

OperationDenied.VersionControlIsGraying

The EdgeOne service of the site is being disabled. Please try
again later.
The EdgeOne service cannot be disabled for the site: A L4
proxy instance is being deployed.
Unable to disable the site: There are L4 proxy instances
disabled.
The EdgeOne service cannot be disabled for the site: An
accelerated domain name is being deployed.
This operation conflicts with concurrent operations. Try again
later.
There is a test version in use. Please release the test version
to the live environment, or roll back the test version and try
again.

ResourceInUse

The resource is occupied.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

©2013-2022 Tencent Cloud. All rights reserved.

Page 120 of 760

Tencent Cloud EdgeOne

UnauthorizedOperation.CamUnauthorized©2013-2022 Tencent Cloud. All rights reserved.

CAM is not authorized.

Page 121 of 760

Tencent Cloud EdgeOne

CheckCnameStatus：

Last updated 2024-04-09 10:25:36

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the CNAME status of a domain name.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID.

RecordNames.N

Yes

Array of
StringList of accelerated domain names.

Description
Common Params. The value used for this API:
CheckCnameStatus.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 122 of 760

Tencent Cloud EdgeOne

Name
CnameStatus

Array of
CnameStatus

RequestId

String

CNAME status of accelerated domain names.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the CNAME status of a domain name
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckCnameStatus<Common request parameters>{"RecordNames": ["example.qq.com"],"ZoneId": "zone-20hyebgyfsko"}

Output Example{"Response": {"CnameStatus": [{"RecordName": "test.qq.com","Cname": "test.qq.com.acc.tyxcdn.com","Status": "active"}],"RequestId": "d08bed0d-15bf-4d65-ab56-906aee0c845"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 123 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Please getpermissions first.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 124 of 760

Tencent Cloud EdgeOne

IdentifyZone：

Last updated 2024-04-09 10:25:33

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to verify ownership of the site.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: IdentifyZone.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneName

Yes

String

The site name.

DomainNo

StringA subdomain name under the site. Specify this field if you want to verify
the ownership of a subdomain name. Otherwise you can leave it blank.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 125 of 760

Tencent Cloud EdgeOne

Ascription

AscriptionInfo

Details of the DNS record.

FileAscription

FileAscriptionInfo

Details of the verification file.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Verifying site ownership
The following example shows how to verify your ownership of the site.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IdentifyZone<Common request parameters>{"ZoneName": "example.com"}

Output Example{"Response": {"Ascription": {"Subdomain": "edgeonereclaim","RecordType": "TXT","RecordValue": "reclaim-a24aba2420cf4ce8b7bff7c8be6d337f"},"FileAscription": {"IdentifyPath": "/.well-known/teo-verification/vd4ewuqa9n.txt","IdentifyContent": "88v24mnnljwbhaohrpfx80f63duhdnjx"},"RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 126 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 127 of 760

Tencent Cloud EdgeOne

DescribeZones：

Last updated 2024-04-09 10:25:34

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the information of sites that you have access to. You can filter sites based on different query
criteria.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeZones.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

OffsetNo

Integer

The page offset. Default value: 0

Limit

No

Integer

Filters.N

No

Array ofFilter conditions. Up to 20 values for each filter. If this parameter

AdvancedFilter

is not filled in, the information of all sites under the current
account is returned. Detailed filtering conditions are as follows:

Limit on paginated queries. Default value: 20. Maximum value:100.

zone-name : Site namezone-id : Site ID, such as zone-2noz78a8ev6k©2013-2022 Tencent Cloud. All rights reserved.

Page 128 of 760

Tencent Cloud EdgeOne

status : Site status
tag-key : Tag key
tag-value : Tag value
Only zone-name supports fuzzy query.
Sort the returned results according to this field. Values include:
type : Connection modearea : Acceleration region
Order

No

create-time : Creation time

Stringzone-name : Site nameuse-time : Last used time
active-status Effective status
Default value: create-time
Sort direction. If the field value is a number, sort by the numeric

Direction

No

Stringvalue. If the field value is text, sort by the ascill code. Values
include:asc : From the smallest to largest
desc : From the largest to smallest.
Default value: desc

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

IntegerNumber of eligible sites.

Zones

Array
of

Details of sites.

Zone
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the list of user sites
Query information of the site "example.com".

©2013-2022 Tencent Cloud. All rights reserved.

Page 129 of 760

Tencent Cloud EdgeOne

Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones<Common request parameters>{"Filters": [{"Name": "zone-name","Values": ["example.com"],"Fuzzy": false}]}

Output Example{"Response": {"TotalCount": 1,"Zones": [{"ZoneId": "zone-2noz3g48ev6k","ZoneName": "example.com","ActiveStatus": "inactive","AliasZoneName": "","Area": "global","CnameSpeedUp": "enabled","CnameStatus": "pending","CreatedOn": "2023-09-18T07:41:05Z","IsFake": 0,"LockStatus": "enable","ModifiedOn": "2023-09-18T07:41:50Z","NameServers": ["ns1.teodns.com.","ns2.teodns.com."],"OriginalNameServers": ["ns1.example.com.","ns2.example.com."],©2013-2022 Tencent Cloud. All rights reserved.

Page 130 of 760

Tencent Cloud EdgeOne"Paused": false,"Resources": [{"Area": "global","AutoRenewFlag": 0,"CreateTime": "2023-09-18T07:41:18Z","EnableTime": "2023-09-18T07:41:18Z","ExpireTime": "2099-12-31T15:59:59Z","Group": "plan","Id": "edgeone-2noz3qqkvqth","PayMode": 0,"PlanId": "edgeone-2noz3qqkvqth","Status": "normal","Sv": [{"Key": "sv_edgeone_plan_sec_ent_flatfee_cm","Value": "1","InstanceId": "","Pack": "","ProtectionSpecs": ""}]},{"Area": "global","AutoRenewFlag": 0,"CreateTime": "2023-09-18T07:41:18Z","EnableTime": "2023-09-18T07:41:18Z","ExpireTime": "2099-12-31T15:59:59Z","Group": "pay-as-you-go","Id": "edgeone-2noz3t4be7xw","PayMode": 0,"PlanId": "edgeone-2noz3qqkvqth","Status": "normal","Sv": [{"Key": "sv_edgeone_sec_request_queries_month","Value": "1","InstanceId": "","Pack": "","ProtectionSpecs": ""},{"Key": "sv_edgeone_va_unit_month","Value": "1","InstanceId": "","Pack": "",©2013-2022 Tencent Cloud. All rights reserved.

Page 131 of 760

Tencent Cloud EdgeOne"ProtectionSpecs": ""}]}],"Status": "pending","Tags": [],"Type": "full","VanityNameServers": null,"VanityNameServersIps": []}],"RequestId": "641a08e3-2ef7-407c-9c2f-2a9928741df5"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 132 of 760

Tencent Cloud EdgeOne

InternalError.ProxyServer

An unknown error occurred in the backend server.

OperationDenied

Operation denied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 133 of 760

Tencent Cloud EdgeOne

VerifyOwnership：

Last updated 2024-04-09 10:25:31

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to verify your ownership of a site or domain name. It's required in the CNAME access mode. After asite is verified, you don't need to verify the ownership again for domain names added to it in the future. For details, see
Ownership Verification.
For sites connected via the NS, you can query whether the NS is successfully switched through this API. For details,
see Modifying DNS Servers.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: VerifyOwnership.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

DomainYes

StringSite or acceleration domain name

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 134 of 760

Tencent Cloud EdgeOne

Name
Result of ownership verification
StatusStringsuccess : Verification passed
fail : Verification failed

ResultStringWhen the ownership verification result is fail , this field returns the reason of failure.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Verifying domain ownership (CNAME access)
Verify the ownership of the domain name test.example.com.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyOwnership<Common request parameters>{"Domain": "test.example.com"}

Output Example{"Response": {"Status": "success","Result": "","RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"}}

Example2 Verifying the site ownership (for sites connected with CNAME)
Verify ownership of site example.com (Site ID: zone-xxxxx).

©2013-2022 Tencent Cloud. All rights reserved.

Page 135 of 760

Tencent Cloud EdgeOne

Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyOwnership<Common request parameters>{"Domain": "example.com"}

Output Example{"Response": {"Status": "fail","Result": "Resolve XX and get the xx content xx.\nTried to access http://xxx/.. .
Failed to connect to the resolution xx .","RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"}}

Example3 Verifying whether the DNS server is switched (for sites connected with NS)
This example shows you how to verify whether the DNS of example.com is switched successfully.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyOwnership<Common request parameters>{"Domain": "example.com"}

Output Example{"Response": {"Status": "fail",©2013-2022 Tencent Cloud. All rights reserved.

Page 136 of 760

Tencent Cloud EdgeOne"Result": "The DNS server of the current domain is xxx. It does not match the exp
ected server xxx .","RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.RouteError

The backend routing address is incorrect.

OperationDenied.ResourceLockedTemporary
ResourceNotFound©2013-2022 Tencent Cloud. All rights reserved.

This operation conflicts with concurrent operations. Try again
later.
The resource doesn’t exist.

Page 137 of 760

Tencent Cloud EdgeOne

Acceleration Domain Management APIs
CreateAccelerationDomain：

Last updated 2024-04-09 10:26:27

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create an acceleration domain name.
For sites connected via the CNAME, if you have not verified the ownership of the domain name, the ownershipverification information of the domain name is returned. To verify your ownership of the domain name, see Ownership
Verification.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site related with the acceleration domain name.

DomainName

Yes

StringAcceleration domain name

OriginInfo

Yes

OriginInfo

Details of the origin.

©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
CreateAccelerationDomain.

Page 138 of 760

Tencent Cloud EdgeOne

Origin-pull protocol configuration. Values:
FOLLOW : Follow the protocol of origin
OriginProtocol

No

HTTP : Send requests to the origin over HTTP

StringHTTPS : Send requests to the origin over HTTPSDefault: FOLLOW
Ports for HTTP origin-pull requests. Range: 1-65535. It takes
HttpOriginPort

No

Integer

effect when OriginProtocol=FOLLOW/HTTP . Port 80 isused if it's not specified.
Ports for HTTPS origin-pull requests. Range: 1-65535. It takes

HttpsOriginPort

No

Integer

effect when OriginProtocol=FOLLOW/HTTPS . Port 443 isused if it's not specified.
IPv6 status. Values:
follow : Follow the IPv6 configuration of the site

IPv6Status

No

Stringon : Enable
off : Disable
Default: follow

3. Output Parameters
Parameter NameType

Description
Use the information returned by this parameter to verify theownership of a domain name. For details, see Ownership

OwnershipVerification

OwnershipVerification

Verification.
Note: This field may return·null, indicating that no valid
values can be obtained.

RequestId

String

The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating an acceleration domain name for a domain-name origin serverThis example shows you how to create an acceleration domain name for a domain-name origin server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 139 of 760

Tencent Cloud EdgeOne

Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccelerationDomain<Common request parameters>{"ZoneId": "zone-225qgrnvbi9w","DomainName": "qq.com","OriginInfo": {"OriginType": "ip_domain","Origin": "www.test.com"}}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

Example2 Creating an acceleration domain name for an AWS S3 origin serverThis example shows you how to create an acceleration domain name for an AWS S3 origin server, with private
network access enabled and authentication algorithm set to AWS Signature Version 2.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccelerationDomain<Common request parameters>{"ZoneId": "zone-225qgrnvbi9w","DomainName": "qq.com","OriginInfo": {"OriginType": "AWS_S3","Origin": "test.s3.ap-east-1.amazonaws.com","PrivateAccess": "on",©2013-2022 Tencent Cloud. All rights reserved.

Page 140 of 760

Tencent Cloud EdgeOne"PrivateParameters": [{"Name": "AccessKeyId","Value": "AKIDdDva7VjFk7LQJ0X5WnbKE7mQTest"},{"Name": "SecretAccessKey","Value": "nMirpdWhhT6bxPsaFwYM1SzQrTest"},{"Name": "SignatureVersion","Value": "v2"},{
"Name": "Region","Value": "ap-east-1"}]}}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET

©2013-2022 Tencent Cloud. All rights reserved.

Page 141 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ConfigLocked

The configuration is locked. Please unlock and try
again.

InvalidParameter.ConflictHostOrigin

The origin cannot be the same as the domain name.

InvalidParameter.ErrInvalidActionParam

Invalid operation: Invalid parameter.

InvalidParameter.InvalidAccelerateType

Parameter error.

InvalidParameter.InvalidAwsPrivateAccess

Invalid third-party object storage.

InvalidParameter.InvalidAwsRegion

Invalid region. Please fill in a correct region of the thirdparty object storage service.

InvalidParameter.InvalidClientIpOrigin

Invalid origin for region-specific origin-pull.

InvalidParameter.InvalidIpv6Switch

Invalid IPv6 settings.

InvalidParameter.InvalidOrigin

Invalid origin server.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

InvalidParameter.InvalidPrivateAccessParams

InvalidParameter.InvalidPrivateAccessSwitch

AccessKeyId and SecretAccessKey are required toaccess the third-party object storage.
The value of PrivateAccess should be on oroff .

InvalidParameter.InvalidQuicBilling

The plan does not support QUIC.

InvalidParameter.InvalidServerName

Invalid origin domain.

©2013-2022 Tencent Cloud. All rights reserved.

Page 142 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidStandardDebugClientIp

Invalid client IP or CIDR block.

InvalidParameter.InvalidWebSocketTimeout

Invalid WebSocket.

InvalidParameter.PostMaxSizeLimitExceeded

Maximum upload size exceeded.

InvalidParameter.SpaceNotBindOrigin

Shield Space is not bound with an origin.

InvalidParameter.ZoneIsGrayPublishing

The site is being upgraded. Changing is not supported.
Please try again later.

InvalidParameterValue.ConflictRecord

It conflicts with existing records.

InvalidParameterValue.ConflictWithDNSSEC

DNS records conflict with DNSSEC.

InvalidParameterValue.ConflictWithNSRecord

This DNS record conflicts with NS records.

InvalidParameterValue.ContentSameAsName

The host record cannot be the same as the record
value.

InvalidParameterValue.DomainNotMatchZone

The specified domain name does not match the site.

InvalidParameterValue.InvalidDNSContent

Incorrect DNS record.

InvalidParameterValue.InvalidDNSName

Incorrect DNS record name.

InvalidParameterValue.InvalidDomainName

Invalid accelerated domain name. It can contain [0-9],[A-Z], [a-z] and [-]. It cannot start or end with "-".

InvalidParameterValue.InvalidProxyOrigin

Incorrect DNS proxyInvalidParameterValue.OriginGroupNotExists

The specified origin group does not exist.

OperationDenied

Operation denied.

OperationDenied.AccelerateMainlandDisable

OperationDenied.ConfigLocked

Cross-MLC-border acceleration is in beta. To join thebeta, submit a ticket.
The configuration is locked. Please unlock and try
again.

OperationDenied.DisableZoneNotCompleted

The EdgeOne service of the site is being disabled.
Please try again later.

OperationDenied.DomainNoICPThe domain name doesn't have an ICP filing number.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled. Pleaseenable it and try again.

©2013-2022 Tencent Cloud. All rights reserved.

Page 143 of 760

Tencent Cloud EdgeOne

OperationDenied.InvalidAdvancedDefenseZoneArea

The acceleration regions of the site must be in the
Chinese mainland when you enable the DDoS
Protection.

OperationDenied.LoadBalanceStatusNotInOnline
OperationDenied.RecordIsForbidden
OperationDenied.ResourceLockedTemporary

OperationDenied.VersionControlIsGraying

The affiliated Cloud Load Balancer is not in a runningstate. Operation is forbidden.
The DNS record cannot be added.
This operation conflicts with concurrent operations. Tryagain later.
There is a test version in use. Please release the test
version to the live environment, or roll back the test
version and try again.

ResourceInUse
ResourceInUse.DnsRecord
ResourceNotFound
ResourceUnavailable.DomainAlreadyExists

The resource is occupied.
The domain name is being resolved. If you need toenable acceleration, please go to DNS Records.
The resource doesn’t exist.
The domain name is already connected to EdgeOne byanother account. Please retrieve it first in order to add it.

ResourcesSoldOut.L7LackOfResources
UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation.
Please get permissions first.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 144 of 760

Tencent Cloud EdgeOne

DescribeAccelerationDomains：

Last updated 2024-06-05 14:40:59

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query domain name information of a site, including the acceleration domain name, origin, anddomain name status. You can query the information of all domain names, or specific domain names by specifying
filters information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeAccelerationDomains.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site related with the acceleration domain name.

OffsetNo

Integer

Offset for paginated queries. Default value: 0.

Limit

No

Integer

Filters.N

No

Array ofFilter conditions. The maximum value of Filters.Values is 20. If it

AdvancedFilter

is not specified, all domains related with the specific zone-id are©2013-2022 Tencent Cloud. All rights reserved.

Limit on paginated queries. Default value: 20. Maximum value:
200.

Page 145 of 760

Tencent Cloud EdgeOne

returned.
domain-name: Filtering based on the acceleration domain
nameorigin-type: Filtering based on the type of the origin server
origin: Filtering based on the primary origin server address
backup-origin: Filtering based on the secondary origin server
addressdomain-cname: Filtering based on the CNAME
share-cname: Filtering based on the shared CNAME
vodeo-sub-app-id: Filtering based on [vodeo sub-applicationID]vodeo-distribution-range: Filtering based on [vodeo
distribution range]
vodeo-bucket-id: Filtering based on [vodeo storage bucket
ID];

Order

No

StringSort the returned results according to this field. Values include:
created_on : Creation time of the acceleration domain
namedomain-name : (Default) Acceleration domain name.
Sort direction. If the field value is number, sort by the numericvalue. If the field value is text, sort by the ascill code. Values

Direction

No

Stringinclude:asc : Ascending order.
desc : Descending order.
Default value: asc .
The match mode. Values:

Match

No

Stringall : Return all matches.
any : Return any match.
Default value: all .

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total of matched alias domain names.

AccelerationDomains
RequestId

Array ofAccelerationDomain
StringInformation of all matched acceleration domain names
The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach the©2013-2022 Tencent Cloud. All rights reserved.

Page 146 of 760

Tencent Cloud EdgeOne

server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying information of domain names under a specified site
This example shows you how to query the information of all acceleration domain names with the origin server type of
IP_DOMAIN under the specified zone-id, and sort the results in descending order by creation time.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccelerationDomains<Common request parameters>{"ZoneId": "zone-20hyebgyfsko","Filters": [{"Fuzzy": true,"Values": ["IP_DOMAIN"],"Name": "origin-type"}],"Direction": "desc","Order": "created_on","Match": "all"}Output Example{"Response": {"TotalCount": 1,"AccelerationDomains": [{"ZoneId": "zone-20hyebgyfsko","DomainName": "www.qq.com","DomainStatus": "online",©2013-2022 Tencent Cloud. All rights reserved.

Page 147 of 760

Tencent Cloud EdgeOne"OriginDetail": {"OriginType": "IP_DOMAIN","Origin": "origin.qq.com","BackupOrigin": "","PrivateParameters": [],"PrivateAccess": "","OriginGroupName": "","BackOriginGroupName": ""},"IdentificationStatus": "finished","Cname": "www.qq.com.eo.dnse3.com","CreatedOn": "2020-09-22T00:00:00+00:00","ModifiedOn": "2020-09-22T00:00:00+00:00"}],"RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 148 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter.DomainOnTrafficScheduling

Traffic scheduling is already enabled for the current domain
name.

InvalidParameter.TooManyFilterValues

Too many filter values.

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 149 of 760

Tencent Cloud EdgeOne

ModifyAccelerationDomain：

Last updated 2024-04-09 10:26:23

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify an accelerated domain name.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyAccelerationDomain.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site related with the accelerated domain name.

DomainName

Yes

StringAccelerated domain name

OriginInfo

No

OriginInfo

Details of the origin.

OriginProtocol

No

StringOrigin-pull protocol configuration. Values:
FOLLOW : Follow the protocol of origin
HTTP : Send requests to the origin over HTTPHTTPS : Send requests to the origin over HTTPSThe original configuration applies if this field is not specified.

©2013-2022 Tencent Cloud. All rights reserved.

Page 150 of 760

Tencent Cloud EdgeOne

Ports for HTTP origin-pull requests. Range: 1-65535. It takes
HttpOriginPort

No

Integer

effect when OriginProtocol=FOLLOW/HTTP . The original
configuration is used if it's not specified.

HttpsOriginPort

No

Integer

Ports for HTTPS origin-pull requests. Range: 1-65535. It takes
effect when OriginProtocol=FOLLOW/HTTPS . The
original configuration is used if it's not specified.
IPv6 status. Values:
follow : Follow the IPv6 configuration of the site

IPv6Status

No

Stringon : Enable
off : Disable
The original configuration applies if this field is not specified.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying an accelerated domain name
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAccelerationDomains{"DomainName":"qq.com","ZoneId":"zone-225qgrnvbi9w","OriginInfo":{"OriginType":"ip_domain","Origin":"qq.com"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 151 of 760

Tencent Cloud EdgeOne

Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAccelerationDomain<Common request parameters>{"DomainName": "example.com","ZoneId": "zone-225qgrnvbi9w","OriginInfo": {"OriginType": "ip_domain","Origin": "qq.com","BackupOrigin": ""}}Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 152 of 760

Tencent Cloud EdgeOne

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ConfigLocked

The configuration is locked. Please unlock and try again.

InternalError.SystemError

Internal system error.

InvalidParameter.ConflictHostOrigin

The origin cannot be the same as the domain name.

InvalidParameter.InvalidAwsRegion

Invalid region. Please fill in a correct region of the third-party
object storage service.

InvalidParameter.InvalidAwsSecretKey

Invalid third-party object storage.

InvalidParameter.InvalidClientIpOrigin

Invalid origin for region-specific origin-pull.

InvalidParameter.InvalidHttps

Invalid parameter "https".

InvalidParameter.InvalidOrigin

Invalid origin server.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

InvalidParameter.InvalidPrivateAccessParams

AccessKeyId and SecretAccessKey are required to accessthe third-party object storage.

InvalidParameter.InvalidRangeOriginPull

Invalid Range GETs.

InvalidParameter.InvalidStandardDebugClientIp

Invalid client IP or CIDR block.

InvalidParameter.InvalidWebSocketTimeout

Invalid WebSocket.

InvalidParameter.OriginIsInnerIp

The origin address cannot be a private IP address.

InvalidParameter.SpaceNotBindOrigin

Shield Space is not bound with an origin.

InvalidParameter.ZoneIsGrayPublishing
InvalidParameterValue.ConflictRecord©2013-2022 Tencent Cloud. All rights reserved.

The site is being upgraded. Changing is not supported.
Please try again later.
It conflicts with existing records.

Page 153 of 760

Tencent Cloud EdgeOne

InvalidParameterValue.DomainNotMatchZone

The specified domain name does not match the site.

InvalidParameterValue.InvalidDomainStatus

Invalid domain name. Please check the status.

OperationDenied.DomainNoICPThe domain name doesn't have an ICP filing number.

OperationDenied.ResourceLockedTemporary

OperationDenied.VersionControlIsGraying

This operation conflicts with concurrent operations. Tryagain later.
There is a test version in use. Please release the test version
to the live environment, or roll back the test version and try
again.

ResourceInUse
ResourceInUse.DnsRecord

The resource is occupied.
The domain name is being resolved. If you need to enableacceleration, please go to DNS Records.

ResourceUnavailable.DomainNotFoundThe requested accelerated domain name doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Pleaseget permissions first.

©2013-2022 Tencent Cloud. All rights reserved.

Page 154 of 760

Tencent Cloud EdgeOne

ModifyAccelerationDomainStatuses：

Last updated 2024-04-09 10:26:22

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to batch modify the status of accelerated domains.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site related with the accelerated domain name.

DomainNames.N

Yes

Array of
StringList of accelerated domain names to be modified.

StatusYes

StringDescription
Common Params. The value used for this API:
ModifyAccelerationDomainStatuses.

Status of the accelerated domain name. Values:
online : Enabledoffline : Disabled

Force

No

BooleanWhether to force suspension when the domain name has
associated resources (such as alias domain names and traffic
scheduling policies). Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 155 of 760

Tencent Cloud EdgeOne

true : Suspend the domain name and all associatedresources.
true : Do not suspend the domain name and all
associated resources.
Default value: false .

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Batch modifying the status of accelerated domains
The following example shows how to disable a specified acceleration domain name.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAccelerationDomainStatuses<Common request parameters>{"DomainNames": ["example.com"],"ZoneId": "zone-225qgrnvbi9w","Status": "offline","Force": "false"}

Output Example{"Response": {©2013-2022 Tencent Cloud. All rights reserved.

Page 156 of 760

Tencent Cloud EdgeOne"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.SystemError

Internal system error.

InvalidParameter.ErrInvalidActionParamValue

Invalid action.

InvalidParameter.InvalidErrorPage

Invalid custom error page.

InvalidParameter.InvalidServerName

Invalid origin domain.

InvalidParameter.ZoneIsGrayPublishing

The site is being upgraded. Changing is not supported. Please
try again later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 157 of 760

Tencent Cloud EdgeOne

InvalidParameterValue.DomainNotMatchZone

The specified domain name does not match the site.

OperationDenied

Operation denied.

OperationDenied.ConfigLocked

The configuration is locked. Please unlock and try again.

OperationDenied.ErrZoneIsAlreadyPaused

OperationDenied.ResourceLockedTemporary

OperationDenied.VersionControlIsGraying

The EdgeOne service of the site is disabled. Please enable itand try again.
This operation conflicts with concurrent operations. Try again
later.
There is a test version in use. Please release the test version
to the live environment, or roll back the test version and try
again.

OperationDenied.VersionControlLocked

The operation is not allowed because the version
management mode is applied.

ResourceInUse

The resource is occupied.

ResourceUnavailable.DomainNotFoundThe requested accelerated domain name doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 158 of 760

Tencent Cloud EdgeOne

DeleteAccelerationDomains：

Last updated 2024-04-09 10:26:26

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to batch remove accelerated domain names.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site related with the accelerated domain name.

DomainNames.N

Yes

Array of
StringList of accelerated domain names to be deleted.

Force

No

BooleanWhether to forcibly delete a domain name if it is associated with

Common Params. The value used for this API:
DeleteAccelerationDomains.

resources (such as alias domain names and traffic schedulingpolicies).
true : Delete the domain name and all associatedresources.
false : Do not delete the domain name and all associatedresources.

©2013-2022 Tencent Cloud. All rights reserved.

Page 159 of 760

Tencent Cloud EdgeOne

If it’s not specified, the default value false is used.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Batch removing accelerated domains
The following example shows you how to remove domain names under a specified site.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteAccelerationDomains<Common request parameters>{"DomainNames": ["qq.com"],"ZoneId": "zone-225qgrnvbi9w"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 160 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeInvalidParameter.ZoneIsGrayPublishing

Description
The site is being upgraded. Changing is not supported. Please
try again later.

InvalidParameter.ZoneNotFoundThe site does not exist.

InvalidParameterValue.InvalidDomainStatus

Invalid domain name. Please check the status.

OperationDenied

Operation denied.

OperationDenied.ResourceLockedTemporary

This operation conflicts with concurrent operations. Try again
later.
There is a test version in use. Please release the test version

OperationDenied.VersionControlIsGraying

to the live environment, or roll back the test version and try
again.

ResourceInUse

The resource is occupied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 161 of 760

Tencent Cloud EdgeOne

ResourceUnavailable.DomainNotFoundThe requested accelerated domain name doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 162 of 760

Tencent Cloud EdgeOne

CreateSharedCNAME：

Last updated 2024-04-09 10:26:27

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a shared CNAME. It is now only available to beta users.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreateSharedCNAME.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site to which the shared CNAME belongs.

SharedCNAMEPrefix

Yes

StringShared CNAME prefix. Enter a valid domain name prefix, suchas "test-api" and "test-api.com". A maximum of 50 characters
are allowed.
Complete format of the shared CNAME: '+<A 12-character
random string in ZoneId>+share.dnse[0-5].com'.
For example, if the prefix is example.com, EdgeOne will create
the shared CNAME:
example.com.sai2ig51kaa5.share.dnse2.com.

©2013-2022 Tencent Cloud. All rights reserved.

Page 163 of 760

Tencent Cloud EdgeOne

Description

No

StringDescription. It supports 1-50 characters.

3. Output Parameters
Parameter
Name
SharedCNAME

RequestId

Type

StringStringDescription
Shared CNAME. Format: '+<A 12-character random string in
ZoneId>+share.dnse[0-5].com'.
The unique request ID, generated by the server, will be returned for every request(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a shared CNAME
This example shows you how to create a shared CNAME under the site zone-225qgrnvbi9w with the prefix oftest and description of For Service A .
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSharedCNAME<Common request parameters>{"SharedCNAMEPrefix": "test","ZoneId": "zone-225qgrnvbi9w","Description": "For Service A"}

Output Example{"Response": {"SharedCNAME": "test.225qgrnvbi9w.share.dnse1.com","RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"©2013-2022 Tencent Cloud. All rights reserved.

Page 164 of 760

Tencent Cloud EdgeOne}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameterValue.NotAllowedWildcardSharedCNAME

Wildcard domain CNAMEs are not supported.

InvalidParameterValue.SharedCNAMEPrefixNotMatchEnter a valid shared CNAME prefix of up to 50
characters.

LimitExceeded

The quota limit has been reached.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled.
Please enable it and try again.

ResourceUnavailable.SharedCNAMEAlreadyExists

The shared CNAME is used by others.

©2013-2022 Tencent Cloud. All rights reserved.

Page 165 of 760

Tencent Cloud EdgeOne

BindSharedCNAME：

Last updated 2024-04-09 10:26:28

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to bind/unbind a domain name to/from a shared CNAME. It is now only available to beta users.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used forthis API: BindSharedCNAME.

VersionYes

StringRegionNo

StringZoneIdYesStringCommon Params. The value used forthis API: 2022-09-01.
Common Params. This parameter is
not required.
ID of the site related with theacceleration domain name.
Action type. Values:

BindType

Yes

Stringbind : To bindunbind : To unbind

BindSharedCNAMEMaps.N

Yes©2013-2022 Tencent Cloud. All rights reserved.

Array of

Bindings between domain names

BindSharedCNAMEMap

and a shared CNAME

Page 166 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Binding with a shared CNAME
In this example, we bind the domain names a.qq.com and b.qq.com under the site zone-225qgrnvbi9w
to the shared CNAME qq.com.sai2ig51kaa5.share.dnse5.com , and bind the domain names
api.qq.com and img.qq.com to the shared CNAME
config.qq.com.sai2ig51kaa5.share.dnse5.com .
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BindSharedCNAME<Common request parameters>{"ZoneId": "zone-225qgrnvbi9w","BindType": "bind","BindSharedCNAMEMaps": [{"SharedCNAME": "qq.com.sai2ig51kaa5.share.dnse5.com","DomainNames": ["a.qq.com","b.qq.com"]},{"SharedCNAME": "config.qq.com.sai2ig51kaa5.share.dnse5.com","DomainNames": ["api.qq.com","img.qq.com"]©2013-2022 Tencent Cloud. All rights reserved.

Page 167 of 760

Tencent Cloud EdgeOne}]}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

Example2 Unbinding from a shared CNAME
In this example, we unbind the domain name a.qq.com under the site zone-225qgrnvbi9w from the shared
CNAME qq.com.sai2ig51kaa5.share.dnse5.com .
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BindSharedCNAME<Common request parameters>{"ZoneId": "zone-225qgrnvbi9w","BindType": "unbind","BindSharedCNAMEMaps": [{"SharedCNAME": "qq.com.sai2ig51kaa5.share.dnse5.com","DomainNames": ["a.qq.com"]}]}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-5d3a-ac39-1706cbf8a708"©2013-2022 Tencent Cloud. All rights reserved.

Page 168 of 760

Tencent Cloud EdgeOne}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceInUse

The resource is occupied.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 169 of 760

Tencent Cloud EdgeOne

DeleteSharedCNAME：

Last updated 2024-04-09 10:26:25

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete a shared CNAME. It is now only available to beta users.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DeleteSharedCNAME.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site to which the shared CNAME belongs.

SharedCNAME

Yes

String

The shared CNAME to be deleted

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 170 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting a shared CNAME
This example deletes the share CNAME qq.com.225qgrnvbi9w.share.dnse5.com under the site zone225qgrnvbi9w .
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteSharedCNAME<Common request parameters>{"SharedCNAME": "qq.com.225qgrnvbi9w.share.dnse5.com","ZoneId": "zone-225qgrnvbi9w"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 171 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceInUse.SharedCNAME

Unable to delete the shared CNAME: It is bound to an acceleration domainname. Please remove the binding first.

©2013-2022 Tencent Cloud. All rights reserved.

Page 172 of 760

Tencent Cloud EdgeOne

Site Acceleration Configuration APIs
CreateRule：

Last updated 2024-06-13 17:03:10

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a rule in the rule engine.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreateRule.

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site

RuleName

Yes

String

The rule name (1 to 255 characters)

StringRule status. Values:
enable : Enabled

StatusYesdisable : Disabled
Rules.N

Yes

Array of Rule©2013-2022 Tencent Cloud. All rights reserved.

The rule content.

Page 173 of 760

Tencent Cloud EdgeOne

Tags.N

Array of
StringNo

Tag of the rule.

3. Output Parameters
Parameter
Name
RuleIdType

Description

StringRule ID
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 CreateRule
This example shows you how to create a rule engine.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRule<Common request parameters>{"Status": "disable","Rules": [{"Actions": [{"NormalAction": {"Action": "RangeOriginPull","Parameters": [{"Name": "Switch","Values": ["on"]©2013-2022 Tencent Cloud. All rights reserved.

Page 174 of 760

Tencent Cloud EdgeOne

}
]
}
},
{
"CodeAction": {"Action": "StatusCodeCache","Parameters": [{"Name": "CacheTime","StatusCode": 400,
"Values": [
"20"
]
}
]
}
},
{
"RewriteAction": {"Action": "ResponseHeader","Parameters": [{"Action": "set","Name": "Foo","Values": [
"Bar"
]
},
{
"Action": "add","Name": "Hello","Values": ["World"]},{"Action": "del","Name": "Foo2","Values": []
}
]
}
}
],
"Conditions": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 175 of 760

Tencent Cloud EdgeOne"Conditions": [{"Operator": "equal","Target": "host","Values": ["test.vernayang.com"
]
}
]
}
]
}
],
"RuleName": "new_rule01","ZoneId": "zone-qbjifysd"}

Output Example{"Response": {"RequestId": "811d2583-310c-41f4-b5e7-abe4074047d4","RuleId": "rule-djuqmq"}}

Example2 Changing the origin server type to IP domain name
This example shows you how to change the origin server type to IP domain name using the rule engine.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRule<Common request parameters>{"ZoneId": "zone-2kmrcz5heaw2","RuleName": "test_origin","Status": "enable","Rules": [{"Conditions": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 176 of 760

Tencent Cloud EdgeOne"Conditions": [{"Operator": "equal","Target": "host","IgnoreCase": false,"Values": ["rule.test.cloud"]},{"Operator": "equal","Target": "client_country","IgnoreCase": false,"Values": [
"CN"
]
}
]
}
],
"Actions": [{"NormalAction": {"Action": "Origin","Parameters": [{"Name": "Type","Values": ["IP_DOMAIN"]},{"Name": "DomainName","Values": ["1.1.1.1"]},{"Name": "OriginProtocol","Values": ["follow"]},{"Name": "HttpOriginPort","Values": ["80"©2013-2022 Tencent Cloud. All rights reserved.

Page 177 of 760

Tencent Cloud EdgeOne]},{"Name": "HttpsOriginPort","Values": [
"443"
]
}
]
}
}
],
"SubRules": []}]}Output Example{"Response": {"RuleId": "rule-djuqsx","RequestId": "811d2583-310c-41f4-b5e7-abe4074047d4"}}

Example3 Changing the origin server type to origin server group
This example shows you how to change the origin server type to origin server group using the rule engine.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRule<Common request parameters>{"ZoneId": "zone-2kmrcz5heaw2","RuleName": "test_origin","Status": "enable","Rules": [{"Conditions": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 178 of 760

Tencent Cloud EdgeOne"Conditions": [{"Operator": "equal","Target": "host","IgnoreCase": false,"Values": ["rule.test.cloud"]},{"Operator": "equal","Target": "client_country","IgnoreCase": false,"Values": [
"CN"
]
}
]
}
],
"Actions": [{"NormalAction": {"Action": "Origin","Parameters": [{"Name": "Type","Values": ["OriginGroup"]},{"Name": "OriginGroupId","Values": ["origin-ff7e677b-2c4d-11ee-9687-525400521111"]},{"Name": "OriginProtocol","Values": ["follow"]},{"Name": "HttpOriginPort","Values": ["80"©2013-2022 Tencent Cloud. All rights reserved.

Page 179 of 760

Tencent Cloud EdgeOne]},{"Name": "HttpsOriginPort","Values": [
"443"
]
}
]
}
}
],
"SubRules": []}]}Output Example{"Response": {"RuleId": "rule-djuq9s","RequestId": "811d2583-310c-41f4-b5e7-abe407404sdsd"}}

Example4 Changing the origin server type to load balancing
This example shows you how to change the origin server type to load balancing using the rule engine.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRule<Common request parameters>{"ZoneId": "zone-2kmrcz5heaw2","RuleName": "test_origin","Status": "enable","Rules": [{"Conditions": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 180 of 760

Tencent Cloud EdgeOne"Conditions": [{"Operator": "equal","Target": "host","IgnoreCase": false,"Values": ["rule.test.cloud"]},{"Operator": "equal","Target": "client_country","IgnoreCase": false,"Values": [
"CN"
]
}
]
}
],
"Actions": [{"NormalAction": {"Action": "Origin","Parameters": [{"Name": "Type","Values": ["LoadBalance"]},{"Name": "OriginGroupId","Values": ["lb-ff7e677b-2c4d-11ee-9687"]},{"Name": "OriginProtocol","Values": ["follow"]},{"Name": "HttpOriginPort","Values": ["80"©2013-2022 Tencent Cloud. All rights reserved.

Page 181 of 760

Tencent Cloud EdgeOne]},{"Name": "HttpsOriginPort","Values": [
"443"
]
}
]
}
}
],
"SubRules": []}]}Output Example{"Response": {"RuleId": "rule-djuq91","RequestId": "811d2583-310c-41f4-b5e7-abe407404xs"}}

Example5 Changing the origin server type to S3-compatible object storage
This example shows you how to change the origin server type to S3-compatible object storage using the rule engine.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRule<Common request parameters>{"ZoneId": "zone-2kmrcz5heaw2","RuleName": "test_origin","Status": "enable","Rules": [{"Conditions": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 182 of 760

Tencent Cloud EdgeOne"Conditions": [{"Operator": "equal","Target": "host","IgnoreCase": false,"Values": ["rule.test.cloud"]},{"Operator": "equal","Target": "client_country","IgnoreCase": false,"Values": [
"CN"
]
}
]
}
],
"Actions": [{"NormalAction": {"Action": "Origin","Parameters": [{"Name": "Type","Values": ["AWS_S3"]},{"Name": "ServerName","Values": ["bucke_name.gcp.storage.com"]},{"Name": "PrivateAccess","Values": [
"on"
]
},
{
"Name": "AccessKeyId","Values": ["xxxx******xxxx"©2013-2022 Tencent Cloud. All rights reserved.

Page 183 of 760

Tencent Cloud EdgeOne]},{"Name": "SecretAccessKey","Values": ["xxxx******xxxx"]},{"Name": "SignatureVersion","Values": [
"v4"
]
},
{
"Name": "Region","Values": ["ap-guangzhou"
]
}
]
}
}
],
"SubRules": []}]}Output Example{"Response": {"RuleId": "rule-djuq23","RequestId": "811d2583-310c-41f4-b5e7-abe407404sxsd"}}

Example6 Changing the origin server type to COS
This example shows you how to change the origin server type to COS using the rule engine.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 184 of 760

Tencent Cloud EdgeOne

Content-Type: application/json
X-TC-Action: CreateRule<Common request parameters>{"ZoneId": "zone-2kmrcz5heaw2","RuleName": "test_origin","Status": "enable","Rules": [{"Conditions": [{"Conditions": [{"Operator": "equal","Target": "host","IgnoreCase": false,"Values": ["rule.test.cloud"]},{"Operator": "equal","Target": "client_country","IgnoreCase": false,"Values": [
"CN"
]
}
]
}
],
"Actions": [{"NormalAction": {"Action": "Origin","Parameters": [{"Name": "Type","Values": [
"COS"
]
},
{
"Name": "ServerName","Values": ["bucke_name.gcp.storage.com"©2013-2022 Tencent Cloud. All rights reserved.

Page 185 of 760

Tencent Cloud EdgeOne]},{"Name": "CosPrivateAccess","Values": [
"on"
]
}
]
}
}
],
"SubRules": []}]}Output Example{"Response": {"RuleId": "rule-djuq21","RequestId": "811d2583-310c-41f4-b5e7-abe407404hs"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 186 of 760

Tencent Cloud EdgeOne

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code
FailedOperation

Description
Operation
failed.
The

InternalError.ConfigLocked

configuration
is locked.
Please unlock
and try again.
An unknown

InternalError.ProxyServerInternalError.SystemError

error occurredin the backend
server.
Internal
system error.
The regex isInvalidParameter.AccessRedirectRegexError

InvalidParameter.ActionInProgress

not in thestandard RE2format.
Too many
attempts.
Please try
again later.

InvalidParameter.CertSystemError

Internal error.

InvalidParameter.ErrActionUnsupportTarget

The current
conditions do
not support
the requested
operation.

InvalidParameter.ErrInvalidAction©2013-2022 Tencent Cloud. All rights reserved.

Invalid

Page 187 of 760

Tencent Cloud EdgeOne

operation.
Invalid ruleengineoperation. The
origin server
InvalidParameter.ErrInvalidActionOriginPrivateAddress

IP cannot be a
privatenetwork IP or
loopback
address.

InvalidParameter.ErrInvalidActionParam

Invalid
operation:
Invalidparameter.
Invalid

InvalidParameter.ErrInvalidActionParamAction

InvalidParameter.ErrInvalidActionParamBadValueTypeparameter"action".
Invalid value
type for theparameter"action".

InvalidParameter.ErrInvalidActionParamDuplicateName

Invalidparameter:
Duplicateparameternames.

InvalidParameter.ErrInvalidActionParamName

Invalid value
type for theparameter"action".

InvalidParameter.ErrInvalidActionParamValue
InvalidParameter.ErrInvalidActionType

InvalidParameter.ErrInvalidCondition
InvalidParameter.ErrInvalidConditionCannotOnlyContainHostWhenModifyOriginActionConfigured©2013-2022 Tencent Cloud. All rights reserved.

Invalid action.
Invalid action
type.
Invalid
conditions.
The
operations ofPage 188 of 760

Tencent Cloud EdgeOne

modifying theorigin server
cannot be only
to configure
host matchingtype.

InvalidParameter.ErrInvalidConditionIgnoreCase

Invalid
condition: The
letter case isignored.
Invalid

InvalidParameter.ErrInvalidConditionNameBadName

condition:
Invalidparameter
name.
Invalid

InvalidParameter.ErrInvalidConditionNameTargetNotSupportName

condition: The
match type is
not supportedby thisparameter.

InvalidParameter.ErrInvalidConditionValueBadRegular

InvalidParameter.ErrInvalidConditionValueBadUrl

Invalid
condition:
Invalid regula
expression forthe parametervalue.
Invalidparameter
value "url".

InvalidParameter.ErrInvalidConditionValueBadValue

Invalid
condition: The
parameter
value isinvalid.

InvalidParameter.ErrInvalidConditionValueBadValueContainFileNameExtension

Invalidparameter
value: Fileextension is
not allowed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 189 of 760

Tencent Cloud EdgeOne

InvalidParameter.ErrInvalidConditionValueTooLongValue

Invalid
condition: The
parameter
value exceeds
the limit.

InvalidParameter.ErrInvalidConditionValueTooManyRegular

The condition
has too many
regularexpressions.
Invalid

InvalidParameter.ErrInvalidConditionValueTooManyValues

condition: The
parameter
value exceeds
the limit.

InvalidParameter.ErrInvalidConditionValueTooManyWildcard

Invalid
condition: Toomanywildcards inthe parameter

InvalidParameter.ErrInvalidConditionValueZeroLength

InvalidParameter.ErrNilCondition

Invalid
condition: The
parameter
value is 0.
Empty
condition.
To enable

InvalidParameter.GrpcRequireHttp2

gRPC
support,
HTTP/2
support must
be enabled as
well.

InvalidParameter.HostNotFoundThe domainname does
not exist.

InvalidParameter.InvalidAuthentication

Invalid token
authentication©2013-2022 Tencent Cloud. All rights reserved.

Page 190 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidAuthenticationTypeExpireTime

Invalid token
authentication
expirationtime.

InvalidParameter.InvalidAuthenticationTypeSignParam

Invalid token
authentication
parameter.
Invalid region
Please fill in a

InvalidParameter.InvalidAwsRegion

correct regionof the thirdparty object
storageservice.

InvalidParameter.InvalidBackupServerName

InvalidParameter.InvalidCacheConfigCache

InvalidParameter.InvalidCacheKey

Invalidsecondaryorigin domain
Invalid nodecache.
Invalid cache
key.

InvalidParameter.InvalidCacheKeyQueryStringValue

Invalid query
string.

InvalidParameter.InvalidCacheTime

Invalid nodecache validity

InvalidParameter.InvalidClientIpHeaderName

Invalid client
IP request
header.

InvalidParameter.InvalidDynamicRoutine

Invalid smart
acceleration.
The package

InvalidParameter.InvalidDynamicRoutineBilling

InvalidParameter.InvalidErrorPageRedirectUrl©2013-2022 Tencent Cloud. All rights reserved.

does notsupport Smar
Acceleration.
Invalid custom
error page.

Page 191 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersion

The cipher
suite does notmatch theTLS version.

InvalidParameter.InvalidHttpsHstsMaxAge

Invalid
HTTPS
HSTS.

InvalidParameter.InvalidIpv6Switch

Invalid IPv6
settings.

InvalidParameter.InvalidMaxAgeTime

Invalidbrowsercache.

InvalidParameter.InvalidOrigin

Invalid origin
server.

InvalidParameter.InvalidParameter

Invalidparameter.

InvalidParameter.InvalidPostSizeValue

Invalid POST
request size.

InvalidParameter.InvalidRangeOriginPull

Invalid Range
GETs.
Invalid

InvalidParameter.InvalidRequestHeaderName

InvalidParameter.InvalidRequestHeaderNameXff

requestheader.
Invalidrequestheader xforwarded-for
Invalid

InvalidParameter.InvalidRequestHeaderValue

requestheader.

InvalidParameter.InvalidResponseHeaderName

Invalid
response
header.

InvalidParameter.InvalidResponseHeaderValue

Invalid
response
header.

©2013-2022 Tencent Cloud. All rights reserved.

Page 192 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidRuleEngineAction

Invalid ruleengineoperation.
Invalid rule

InvalidParameter.InvalidRuleEngineTarget

InvalidParameter.InvalidRuleEngineTargetsExtension

enginecondition.
Invalid fileextension in
the rule
enginecondition.

InvalidParameter.InvalidRuleEngineTargetsUrl

Invalid URL in
the rule
enginecondition.

InvalidParameter.InvalidServerName

InvalidParameter.InvalidStandardDebugExpireTimeLimit

Invalid origin
domain.
The expiration
time isexceeded.
Origin-pull
requestInvalidParameter.InvalidUpstreamRequestQueryStringValue

InvalidParameter.InvalidUrlRedirectconfiguration
error: Invalid
query string.
Invalid URL
rewrite.
Invalid target

InvalidParameter.InvalidUrlRedirectHost

InvalidParameter.InvalidUrlRedirectUrlhost in the
URL rewriting
rule.
The target
URL for URL
rewrite isinvalid.

InvalidParameter.InvalidWebSocketTimeout

Invalid
WebSocket.

©2013-2022 Tencent Cloud. All rights reserved.

Page 193 of 760

Tencent Cloud EdgeOne

InvalidParameter.KeyRulesInvalidQueryStringValue

Invalid cachekey.
The Cloud
Load Balance

InvalidParameter.LoadBalanceInstanceIdIsRequired

instance ID isrequired in theoperation ofmodifying theorigin server.

InvalidParameter.NotSupportThisPreset

Unsupported
presetvariables
exist.
The origin

InvalidParameter.OriginOriginGroupIdIsRequired

InvalidParameter.PostMaxSizeLimitExceededgroup ID isrequired.
Maximum
upload size
exceeded.

InvalidParameter.TaskSystemError
InvalidParameterValue.FormatMismatch

Internal error.
Formatmismatch.
Configuration

InvalidParameterValue.GeneralMismatch

InvalidParameterValue.IncludeInvalidValueparameter
formatmismatch.
Contains
invalid value.
Missing

InvalidParameterValue.MissingNecessaryParam

InvalidParameterValue.NotInEnumeration©2013-2022 Tencent Cloud. All rights reserved.

requiredconfiguration
parameters.
The value is
not within therequiredcollection.

Page 194 of 760

Tencent Cloud EdgeOne

InvalidParameterValue.NotWithinRange

The value is
not within thespecified
range.

InvalidParameterValue.RegExMismatch

Does notmatch thespecifiedregularexpression.

InvalidParameterValue.UnrecognizableValue

LimitExceeded

Configuration
item error.
The quota
limit has beenreached.

OperationDenied

Operation
denied.
The existingdomainfeature under

OperationDenied.AccelerateMainlandMultiplyLayerConflictthe current
site conflicts
with theChinesemainlandnetwork
optimization,and cannot be
configured at
the same time

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne
service of thesite isdisabled.
Please enable
it and try
again.

OperationDenied.InvalidAdvancedDefenseSecurityType

The security
service must
be enabled
when you©2013-2022 Tencent Cloud. All rights reserved.

Page 195 of 760

Tencent Cloud EdgeOne

enable the
DDoS
Protection.
ResourceInUse

The resourceis occupied.

UnauthorizedOperation.CamUnauthorized

CAM is not
authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 196 of 760

Tencent Cloud EdgeOne

DeleteRules：

Last updated 2024-04-09 10:25:29

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to batch delete rules from the rule engine.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DeleteRules.

VersionYes

StringRegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site

RuleIds.N

Yes

Array of
StringIDs of the rules to be deleted.

Name

Common Params. The value used for this API: 2022-0901.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 197 of 760

Tencent Cloud EdgeOne

Parameter

Type

Description

Name
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Batch deleting rules from the rule engine
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteIdlFiles<Common request parameters>{"RuleIds": ["rule-66tjz30m","rule-bx3zke8q"],"ZoneId": "zone-26r78x31ny86"}

Output Example{"Response": {"RequestId": "ace05891-744c-40f8-94de-4e1c08d954c2"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 198 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ConfigLocked

The configuration is locked. Please unlock and try
again.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InternalError.SystemError

Internal system error.

InvalidParameter.ActionInProgress

Too many attempts. Please try again later.

InvalidParameter.ErrInvalidActionParam

Invalid operation: Invalid parameter.

InvalidParameter.ErrInvalidActionParamValue

Invalid action.

InvalidParameter.InvalidHttps

Invalid parameter "https".

InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersion

The cipher suite does not match the TLS version.

InvalidParameter.InvalidRangeOriginPull

Invalid Range GETs.

InvalidParameter.InvalidRuleEngineNotFoundThe rule does not exist.

InvalidParameter.NotSupportThisPreset

Unsupported preset variables exist.

InvalidParameter.ZoneNotFoundThe site does not exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 199 of 760

Tencent Cloud EdgeOne

OperationDenied
OperationDenied.DisableZoneNotCompleted

OperationDenied.ErrZoneIsAlreadyPaused

Operation denied.
The EdgeOne service of the site is being disabled.
Please try again later.
The EdgeOne service of the site is disabled. Pleaseenable it and try again.

ResourceInUse

The resource is occupied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 200 of 760

Tencent Cloud EdgeOne

DescribeHostsSetting：

Last updated 2024-04-09 10:25:29

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query detailed domain name configuration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeHostsSetting.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

OffsetNo

Integer

Offset for paginated queries. Default value: 0. Minimum value: 0.

Limit

No

Integer

Limit on paginated queries. Default value: 100. Maximum value: 1000.

No

Array ofFilterFilters.N

Filter conditions. The maximum value for Filters.Values is 20. The
detailed conditions are as follows:©2013-2022 Tencent Cloud. All rights reserved.

host: Filter by domain name.

Page 201 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter

Type

Description

DetailHosts

Array of
DetailHost

List of domain names.

TotalNumber

IntegerNumber of domain names

Name

The unique request ID, generated by the server, will be returned for every
RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request will
not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Query detailed configurations of the domain name
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHostsSetting<Common request parameters>{"ZoneId": "zone-27q0p0bali16"}

Output Example{"Response": {"DetailHosts": [{"Status": "online","Host": "test.example.com","ZoneId": "zone-27q0p0bali16","ZoneName": "example.com","Cname": "test.example.com.acc.edgeonedy1.com.","Id": "edge-ja6yyfjh","InstanceId": "edge-ja6yyfjh",©2013-2022 Tencent Cloud. All rights reserved.

Page 202 of 760

Tencent Cloud EdgeOne"Lock": 0,"Mode": 0,"Area": "mainland","AccelerateType": {"Switch": "on"},"CacheConfig": {"Cache": {"Switch": "on","CacheTime": 0,"IgnoreCacheControl": "abc"},"NoCache": {"Switch": "on"},"FollowOrigin": {"Switch": "on","DefaultCacheTime": 0,"DefaultCache": "abc","DefaultCacheStrategy": "abc"}},"CacheKey": {"FullUrlCache": "on","IgnoreCase": "off","QueryString": {"Action": "includeCustom","Switch": "off","Value": []}},"Compression": {"Algorithms": ["brotli","gzip"],"Switch": "on"},"DDoS": {"Switch": "on"},"ClientIpCountry": {"HeaderName": "","Switch": "off"},"CC": {
"PolicyId": 1996,©2013-2022 Tencent Cloud. All rights reserved.

Page 203 of 760

Tencent Cloud EdgeOne"Switch": "on"},"Waf": {"PolicyId": 1995,"Switch": "on"},"Https": {"CertInfo": [],"Hsts": {"IncludeSubDomains": "off","MaxAge": 1,"Preload": "off","Switch": "on"},"Http2": "on","OcspStapling": "off","TlsVersion": ["TLSv1","TLSv1.1","TLSv1.2","TLSv1.3"],"ApplyType": "abc","CipherSuite": "abc"},"Ipv6": {"Switch": "off"},"Origin": {"BackupOrigins": [],"CosPrivateAccess": "off","OriginPullProtocol": "follow","Origins": ["1.1.1.1:80:100"]},"SecurityType": {"Switch": "on"},"SmartRouting": {"Switch": "off"}}],"RequestId": "9cc50b24-7dc5-44f4-96ce-95825d53ff2f","TotalNumber": 1©2013-2022 Tencent Cloud. All rights reserved.

Page 204 of 760

Tencent Cloud EdgeOne}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

InternalError.RouteError

The backend routing address is incorrect.

InvalidParameter

Parameter error.

OperationDenied

Operation denied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.

Page 205 of 760

Tencent Cloud EdgeOne

UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

An unknown error occurred in the backend server.

Page 206 of 760

Tencent Cloud EdgeOne

DescribeRules：

Last updated 2024-04-09 10:25:28

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the rules in the rule engine.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeRules.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site

Name

Filter conditions. Each filter condition can have up to 20 entries.

Filters.N

No

Array ofFilterSee below for details:
rule-id :Filter by the rule ID
Type: String
Required: No

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 207 of 760

Tencent Cloud EdgeOne

Parameter
Name

Type

Description

ZoneIdStringID of the site

RuleItems

Array of
RuleItem

List of rules. Rules are sorted in order of execution.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 DescribeRules
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRules<Common request parameters>{"ZoneId": "zone-kwsqufps"}

Output Example{"Response": {"RequestId": "5f24d792-050d-439f-a864-353fd7b67e9f","RuleItems": [{"RuleId": "rule-2picazk4qsq9","RuleName": "Unnamed rule","RulePriority": 1,"Rules": [{"Actions": [{"CodeAction": null,"NormalAction": {©2013-2022 Tencent Cloud. All rights reserved.

Page 208 of 760

Tencent Cloud EdgeOne"Action": "Cache","Parameters": [{"Name": "Type","Values": ["Cache"]},{"Name": "Switch","Values": [
"on"
]
},
{
"Name": "IgnoreCacheControl","Values": [
"off"
]
},
{
"Name": "CacheTime","Values": [
"100"
]
}
]
},
"RewriteAction": null}],"Conditions": [{"Conditions": [{"IgnoreCase": false,"IgnoreNameCase": false,"Operator": "equal","Target": "host","Name": "","Values": ["corki.chris-v.com"
]
}
]
}
],

©2013-2022 Tencent Cloud. All rights reserved.

Page 209 of 760

Tencent Cloud EdgeOne"SubRules": []}],"Status": "enable","Tags": []}],"ZoneId": "zone-2p7d5y3b8l8k"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.RouteError

The backend routing address is incorrect.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 210 of 760

Tencent Cloud EdgeOne©2013-2022 Tencent Cloud. All rights reserved.

Page 211 of 760

Tencent Cloud EdgeOne

DescribeRulesSetting：

Last updated 2024-04-09 10:25:27

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to return the list of the settings of the rule engine that can be used for request match and theirdetailed recommended configuration information.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

Description
Common Params. The value used for this API:
DescribeRulesSetting.

3. Output Parameters
Parameter
Name
Actions

Type

Description

Array of

List of the settings of the rule engine that can be used for request match

RulesSettingAction

and their detailed recommended configuration information.

©2013-2022 Tencent Cloud. All rights reserved.

Page 212 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 DescribeRulesSetting
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRulesSetting<Common request parameters>{}

Output Example{"Response": {"RequestId": "811d2583-310c-41f4-b5e7-abe4074047d4","Actions": [{"Action": "ErrorPage","Properties": [{"ChoiceProperties": [],"ChoicesValue": [],"ExtraParameter": {"Choices": ["403","404","404","405","414","416","451","500","501","502",©2013-2022 Tencent Cloud. All rights reserved.

Page 213 of 760

Tencent Cloud EdgeOne"503","504"],"Id": "StatusCode","Type": "CHOICE"},"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "RedirectUrl","Type": "CUSTOM_STRING"}]},{"Action": "Cache","Properties": [{"ChoiceProperties": [{"ChoicesValue": [
"on",
"off"
],
"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "Switch","Type": "TOGGLE"}],"ChoicesValue": [],"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "FollowOrigin","Type": "OBJECT"},{"ChoiceProperties": [{"ChoicesValue": [©2013-2022 Tencent Cloud. All rights reserved.

Page 214 of 760

Tencent Cloud EdgeOne

"on",
"off"
],
"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "Switch","Type": "TOGGLE"},{"ChoicesValue": [],"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "CacheTime","Type": "CUSTOM_NUM"}],"ChoicesValue": [],"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "Cache","Type": "OBJECT"},{"ChoiceProperties": [{"ChoicesValue": [
"on",
"off"
],
"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "Switch","Type": "TOGGLE"}],©2013-2022 Tencent Cloud. All rights reserved.

Page 215 of 760

Tencent Cloud EdgeOne"ChoicesValue": [],"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "NoCache","Type": "OBJECT"}]},{"Action": "MaxAge","Properties": [{"ChoiceProperties": [],"ChoicesValue": [],"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "MaxAgeTime","Type": "CUSTOM_NUM"},{"ChoiceProperties": [],"ChoicesValue": [
"on",
"off"
],
"ExtraParameter": null,"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "FollowOrigin","Type": "TOGGLE"}]},{"Action": "StatusCodeCache","Properties": [{"ChoiceProperties": [],"ChoicesValue": [],©2013-2022 Tencent Cloud. All rights reserved.

Page 216 of 760

Tencent Cloud EdgeOne"ExtraParameter": {"Choices": ["403","404","404","405","414","416","451","500","501","502","503","504"],"Id": "StatusCode","Type": "CHOICE"},"IsAllowEmpty": false,"IsMultiple": false,"Max": 0,"Min": 0,"Name": "CacheTime","Type": "CUSTOM_NUM"
}
]
}
]
}
}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js©2013-2022 Tencent Cloud. All rights reserved.

Page 217 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 218 of 760

Tencent Cloud EdgeOne

DescribeZoneSetting：

Last updated 2024-04-09 10:25:27

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the site configuration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeZoneSetting.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

Name

3. Output Parameters
Parameter
Name
ZoneSetting

Type

Description

ZoneSetting

The site configuration.

©2013-2022 Tencent Cloud. All rights reserved.

Page 219 of 760

Tencent Cloud EdgeOne

Note: This field may return null, indicating that no valid values can be obtained.
The unique request ID, generated by the server, will be returned for every
RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Query zone configuration
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZoneSetting<Common request parameters>{"ZoneId": "zone-21xfqlh4qjee"}

Output Example{"Response": {"RequestId": "88215c08-67de-4c7d-974e-a14461816f5b","ZoneSetting": {"AccelerateMainland": {"Switch": "off"},"Area": "global","CacheConfig": {"Cache": {"CacheTime": 2592000,"Switch": "off"},"FollowOrigin": {"DefaultCache": "on","DefaultCacheStrategy": "on","DefaultCacheTime": 0,"Switch": "on"},"NoCache": {©2013-2022 Tencent Cloud. All rights reserved.

Page 220 of 760

Tencent Cloud EdgeOne"Switch": "off"}},"CacheKey": {"FullUrlCache": "on","IgnoreCase": "off","QueryString": {"Action": "includeCustom","Switch": "off","Value": []}},"CachePrefresh": {"Percent": 90,"Switch": "off"},"ClientIpCountry": {"HeaderName": "","Switch": "off"},"ClientIpHeader": {"HeaderName": "","Switch": "off"},"Compression": {"Algorithms": ["brotli","gzip"],"Switch": "on"},"ForceRedirect": {"RedirectStatusCode": 302,
"Switch": "off"},"Grpc": {"Switch": "off"},"Https": {"ApplyType": "none","CertInfo": [],"CipherSuite": "loose-v2023","Hsts": {"IncludeSubDomains": "off","MaxAge": 0,"Preload": "off","Switch": "off"©2013-2022 Tencent Cloud. All rights reserved.

Page 221 of 760

Tencent Cloud EdgeOne},"Http2": "on","OcspStapling": "off","TlsVersion": ["TLSv1","TLSv1.1","TLSv1.2","TLSv1.3"]},"ImageOptimize": {"Switch": "off"},"Ipv6": {"Switch": "off"},"MaxAge": {"FollowOrigin": "on","MaxAgeTime": 600},"OfflineCache": {"Switch": "on"},"Origin": {"Origins": ["30.12.34.23"],"BackupOrigins": ["30.12.34.11"],"OriginPullProtocol": "follow","CosPrivateAccess": "abc"},"PostMaxSize": {"MaxSize": 524288000,"Switch": "on"},"Quic": {"Switch": "off"},"SmartRouting": {"Switch": "off"},"StandardDebug": {"AllowClientIPList": [],"ExpireTime": "1969-12-31T16:00:00Z","Switch": "off"©2013-2022 Tencent Cloud. All rights reserved.

Page 222 of 760

Tencent Cloud EdgeOne},"UpstreamHttp2": {"Switch": "off"},"WebSocket": {"Switch": "off","Timeout": 30},"ZoneName": "wxlagame.com"}}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.RouteError

The backend routing address is incorrect.

©2013-2022 Tencent Cloud. All rights reserved.

Page 223 of 760

Tencent Cloud EdgeOne

InternalError.SystemError

Internal system error.

InvalidParameter.SettingInvalidParam

Configuration parameter error.

InvalidParameter.ZoneNotFoundThe site does not exist.

OperationDenied

Operation denied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 224 of 760

Tencent Cloud EdgeOne

ModifyRule：

Last updated 2024-06-13 17:03:10

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify a rule in the rule engine.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyRule.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site

RuleName

Yes

StringRules.N

Yes

Array of Rule

The rule content.

RuleIdYesString

The rule ID.

Name

The rule name. It is a string that can contain 1–255
characters.

Rule status. Values:
StatusYes

Stringenable : Enableddisable : Disabled©2013-2022 Tencent Cloud. All rights reserved.

Page 225 of 760

Tencent Cloud EdgeOne

Tags.NNo

Array of
StringTag of the rule.

3. Output Parameters
Parameter

Type

Description

RuleIdStringRule ID

RequestId

StringName

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 ModifyRule
The following example shows common modifications.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRule<Common request parameters>{"Status": "disable","Rules": [{"Actions": [{"NormalAction": {"Action": "RangeOriginPull","Parameters": [{"Name": "Switch","Values": ["on"]©2013-2022 Tencent Cloud. All rights reserved.

Page 226 of 760

Tencent Cloud EdgeOne

}
]
}
},
{
"CodeAction": {"Action": "StatusCodeCache","Parameters": [{"Name": "CacheTime","StatusCode": 200,
"Values": [
"20"
]
}
]
}
},
{
"RewriteAction": {"Action": "ResponseHeader","Parameters": [{"Action": "set","Name": "Foo","Values": [
"Bar"
]
},
{
"Action": "add","Name": "Hello","Values": ["World"]},{"Action": "del","Name": "Foo2","Values": []
}
]
}
}
],
"Conditions": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 227 of 760

Tencent Cloud EdgeOne"Conditions": [{"Operator": "equal","Target": "host","Values": ["www.shawndai.cn"
]
}
]
}
]
}
],
"RuleName": "new_rule02","ZoneId": "zone-26r78x31ny86","RuleId": "rule-djuqmq"}

Output Example{"Response": {"RequestId": "811d2583-310c-41f4-b5e7-abe4074047d4","RuleId": "rule-djuqmq"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 228 of 760

Tencent Cloud EdgeOne

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription
The configuration isInternalError.ConfigLocked

locked. Please
unlock and try again.

InternalError.SystemError

Internal system error.

InvalidParameter.CacheKeyQueryStringTooManyValue

The query string has
too many values.

InvalidParameter.CertSystemError

Internal error.

InvalidParameter.CompressionInvalidAlgorithms

InvalidParameter.ErrActionUnsupportTarget

Invalid compression
algorithm.
The current
conditions do notsupport therequested operation.

InvalidParameter.ErrInvalidAction

Invalid operation.
Invalid operation:

InvalidParameter.ErrInvalidActionDuplicateAction

InvalidParameter.ErrInvalidActionParam

InvalidParameter.ErrInvalidActionParamAction

Duplicate operation
configuration.
Invalid operation:
Invalid parameter.
Invalid parameter"action".
Invalid parameter:

InvalidParameter.ErrInvalidActionParamDuplicateName

Duplicate parameternames.

©2013-2022 Tencent Cloud. All rights reserved.

Page 229 of 760

Tencent Cloud EdgeOne

InvalidParameter.ErrInvalidActionParamName

Invalid value type forthe parameter"action".
Invalid parameter:

InvalidParameter.ErrInvalidActionParamTooManyValues

The parameter has
too many values.

InvalidParameter.ErrInvalidActionParamValue

Invalid action.

InvalidParameter.ErrInvalidActionType

Invalid action type.
You can only

InvalidParameter.ErrInvalidConditionHostTooManyWhenModifyOriginActionConfigured

configure one hostmatching type whenmodifying the origin.

InvalidParameter.ErrInvalidConditionIgnoreCase

Invalid condition: The
letter case is ignored.
Invalid condition:

InvalidParameter.ErrInvalidConditionNameBadName

Invalid parameter
name.

InvalidParameter.ErrInvalidConditionNameTargetNotSupportName

Invalid condition: The
match type is notsupported by thisparameter.
Invalid condition:

InvalidParameter.ErrInvalidConditionValueBadRegular

Invalid regularexpression for theparameter value.

InvalidParameter.ErrInvalidConditionValueBadUrl

InvalidParameter.ErrInvalidConditionValueBadValue

Invalid parametervalue "url".
Invalid condition: The
parameter value isinvalid.
Invalid parameter

InvalidParameter.ErrInvalidConditionValueBadValueContainFileNameExtension

value: File extension
is not allowed.

InvalidParameter.ErrInvalidConditionValueTooLongValue

Invalid condition: The
parameter value
exceeds the limit.

©2013-2022 Tencent Cloud. All rights reserved.

Page 230 of 760

Tencent Cloud EdgeOne

Invalid condition: The
InvalidParameter.ErrInvalidConditionValueTooManyValues

parameter value
exceeds the limit.
Invalid condition: Too

InvalidParameter.ErrInvalidConditionValueTooManyWildcard

many wildcards inthe parameter.

InvalidParameter.ErrInvalidElseWhenModifyOriginActionConfigured

ELSE is notsupported for origin
server modification.

InvalidParameter.ErrNilCondition

Empty condition.
To enable gRPC

InvalidParameter.GrpcRequireHttp2

support, HTTP/2
support must be
enabled as well.

InvalidParameter.HostNotFound

InvalidParameter.InvalidAuthenticationTypeSecretKey

The domain namedoes not exist.
Invalid key for token
authentication.
Invalid token

InvalidParameter.InvalidAuthenticationTypeSignParamauthentication
parameter.

InvalidParameter.InvalidAuthenticationTypeTimeFormat

InvalidParameter.InvalidAuthenticationTypeTimeParam

Invalid authentication
token format.
Invalid authentication
token parameter.
Invalid region. Please

InvalidParameter.InvalidAwsRegion

fill in a correct regionof the third-party
object storage
service.

InvalidParameter.InvalidBackupServerName

Invalid secondary
origin domain.

InvalidParameter.InvalidCacheKey

Invalid cache key.

InvalidParameter.InvalidCacheKeyCookie

Invalid cache key©2013-2022 Tencent Cloud. All rights reserved.

Page 231 of 760

Tencent Cloud EdgeOne

cookie.
InvalidParameter.InvalidCacheKeyIgnoreCase

InvalidParameter.InvalidCacheKeyScheme

InvalidParameter.InvalidCacheTime

InvalidParameter.InvalidClientIpHeaderName

Cases are ignored in
the cache key.
Invalid cache key
scheme.
Invalid node cachevalidity.
Invalid client IP
request header.
Invalid origin-pull
configuration. When
OriginType is

InvalidParameter.InvalidCosDomain

COS orAWS_S3 , theorigin address must
be an object storage
domain name.

InvalidParameter.InvalidErrorPageRedirectUrl

InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersion

Invalid custom error
page.
The cipher suite
does not match the
TLS version.

InvalidParameter.InvalidHttpsHstsMaxAge

Invalid HTTPS
HSTS.

InvalidParameter.InvalidIpv6Switch

Invalid IPv6 settings.

InvalidParameter.InvalidMaxAgeTime

Invalid browser
cache.

InvalidParameter.InvalidOrigin

Invalid origin server.

InvalidParameter.InvalidParameter

Invalid parameter.

InvalidParameter.InvalidRangeOriginPull

Invalid Range GETs.

InvalidParameter.InvalidRequestHeaderName
InvalidParameter.InvalidRequestHeaderNameXff©2013-2022 Tencent Cloud. All rights reserved.

Invalid request
header.
Invalid request

Page 232 of 760

Tencent Cloud EdgeOne

header x-forwardedfor.
InvalidParameter.InvalidRequestHeaderValue

InvalidParameter.InvalidResponseHeaderName

InvalidParameter.InvalidResponseHeaderValue

InvalidParameter.InvalidRuleEngineAction

InvalidParameter.InvalidRuleEngineNotFound

InvalidParameter.InvalidRuleEngineTarget

Invalid request
header.
Invalid response
header.
Invalid response
header.
Invalid rule engine
operation.
The rule does notexist.
Invalid rule engine
condition.
Invalid file extension

InvalidParameter.InvalidRuleEngineTargetsExtension

in the rule engine
condition.

InvalidParameter.InvalidRuleEngineTargetsUrl

Invalid URL in therule engine condition.

InvalidParameter.InvalidServerName

Invalid origin domain.
Origin-pull request

InvalidParameter.InvalidUpstreamRequestQueryStringValue

configuration error:
Invalid query string.

InvalidParameter.InvalidUrlRedirectHost

Invalid target host in
the URL rewriting
rule.
The target URL for

InvalidParameter.InvalidUrlRedirectUrl

URL rewrite isinvalid.

InvalidParameter.KeyRulesInvalidQueryStringValue

Invalid cache key.

InvalidParameter.LoadBalanceInstanceIdIsRequired

The Cloud Load
Balancer instance ID
is required in theoperation of©2013-2022 Tencent Cloud. All rights reserved.

Page 233 of 760

Tencent Cloud EdgeOne

modifying the origin
server.
InvalidParameter.NotSupportThisPreset

InvalidParameter.OriginOriginGroupIdIsRequired

Unsupported preset
variables exist.
The origin group ID
is required.
The return protocol isrequired in theInvalidParameter.OriginPullProtocolIsRequired

operation ofmodifying the origin
server.

InvalidParameter.PostMaxSizeLimitExceeded

InvalidParameter.ResponseHeaderCacheControlNotAllowDelete

InvalidParameter.StatusCodeCacheInvalidStatusCode

Maximum upload
size exceeded.
Invalid response
header.
Invalid status code incache.
TLS version is not

InvalidParameter.TlsVersionNotInSequence

continuous for
HTTPS.

InvalidParameterValue.FormatMismatch

Format mismatch.

InvalidParameterValue.GeneralMismatch

Configuration
parameter format
mismatch.

InvalidParameterValue.IncludeInvalidValue

InvalidParameterValue.MissingNecessaryParamContains invalid
value.
Missing required
configuration
parameters.
The value is not

InvalidParameterValue.NotInEnumeration

within the required
collection.

InvalidParameterValue.NotWithinRange

The value is notwithin the specified
range.

©2013-2022 Tencent Cloud. All rights reserved.

Page 234 of 760

Tencent Cloud EdgeOne

Does not match theInvalidParameterValue.RegExMismatch

InvalidParameterValue.UnrecognizableValue

LimitExceeded
OperationDenied

specified regularexpression.
Configuration item
error.
The quota limit has
been reached.
Operation denied.
The configuration is

OperationDenied.ConfigLocked

locked. Please
unlock and try again.
The EdgeOne

OperationDenied.ErrZoneIsAlreadyPaused

service of the site isdisabled. Pleaseenable it and try
again.

OperationDenied.InvalidAdvancedDefenseSecurityType

The security service
must be enabled
when you enable the
DDoS Protection.

ResourceInUse

UnauthorizedOperation.CamUnauthorized

The resource is
occupied.
CAM is not
authorized.
An unknown error

UnauthorizedOperation.Unknown

occurred in thebackend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 235 of 760

Tencent Cloud EdgeOne

ModifyZoneSetting：

Last updated 2024-04-09 10:25:25

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify the site configuration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID to modify.

Name

Description
Common Params. The value used for this API:
ModifyZoneSetting.

Cache expiration time configuration
CacheConfig

No

CacheConfig

The original configuration will apply if this field is not
specified.
The node cache key configuration.

CacheKeyNo

CacheKeyThe original configuration will apply if this field is not
specified.

©2013-2022 Tencent Cloud. All rights reserved.

Page 236 of 760

Tencent Cloud EdgeOne

MaxAgeNo

MaxAgeThe browser cache configuration.
The original configuration will apply if this field is not
specified.
The offline cache configuration.

OfflineCache

No

OfflineCache

Quic

No

Quic

PostMaxSize

No

PostMaxSize

Compression

No

Compression

The original configuration will apply if this field is not
specified.
QUIC access configuration.
The original configuration will apply if it is not specified.
POST transport configuration.
The original configuration will apply if it is not specified.
The smart compression configuration.
The original configuration will apply if this field is not
specified.

UpstreamHttp2

No

UpstreamHttp2

ForceRedirect

No

ForceRedirect

Https

No

Https

HTTP2 origin-pull configuration.
The original configuration will apply if it is not specified.
Force HTTPS redirect configuration.
The original configuration will apply if it is not specified.
HTTPS acceleration configuration.
The original configuration will apply if it is not specified.
The origin server configuration.

OriginNo

OriginThe original configuration will apply if this field is not
specified.
The smart acceleration configuration.

SmartRouting

No

SmartRouting

The original configuration will apply if this field is not
specified.

WebSocket

No

WebSocket

ClientIpHeader

No

ClientIpHeader

WebSocket configuration.
The original configuration will apply if it is not specified.
Origin-pull client IP header configuration.
The original configuration will apply if it is not specified.
The cache prefresh configuration.

CachePrefreshNo

CachePrefresh

The original configuration will apply if this field is not
specified.

Ipv6

No

Ipv6

©2013-2022 Tencent Cloud. All rights reserved.

Ipv6 access configuration.
The original configuration will apply if it is not specified.

Page 237 of 760

Tencent Cloud EdgeOne

ClientIpCountry

No

ClientIpCountry

Whether to carry the location information of the client IP
during origin-pull.
The original configuration will apply if it is not specified.

Grpc

No

Grpc

ImageOptimize

No

ImageOptimize

StandardDebug

No

StandardDebug

Configuration of gRPC support.
The original configuration will apply if it is not specified.
Image optimization.
It is disabled if this parameter is not specified.
Standard debugging configuration.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the IPv6 access configuration of a site
This example shows you how to modify the IPv6 access configuration of a site.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneSetting<Common request parameters>{"ZoneId": "zone-21xfqlh4qjee","Ipv6": {"Switch": "on"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 238 of 760

Tencent Cloud EdgeOne

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

Example2 Modifying the QUIC access configuration of a site
This example shows you how to modify the QUIC access configuration of a site.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneSetting<Common request parameters>{"ZoneId": "zone-21xfqlh4qjee","Quic": {"Switch": "on"}}Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

Example3 Modifying the cache expiration time of a site
This example shows you how to modify the cache expiration time of a site.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyZoneSetting©2013-2022 Tencent Cloud. All rights reserved.

Page 239 of 760

Tencent Cloud EdgeOne<Common request parameters>{"ZoneId": "zone-21xfqlh4qjee","CacheConfig": {"NoCache": {"Switch": "on"}}}Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 240 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CertificateNotFoundThe certificate does not exist.

InternalError.ConfigLocked

The configuration is locked. Please unlock
and try again.

InternalError.RouteError

The backend routing address is incorrect.

InternalError.SystemError

Internal system error.

InternalError.UnknowError

Unknown error.

InvalidParameter.ActionInProgress

Too many attempts. Please try again later.

InvalidParameter.CacheKeyQueryStringRequiresFullUrlCacheOff

Invalid query string.

InvalidParameter.CacheKeyQueryStringTooManyValue

The query string has too many values.

InvalidParameter.CertSystemError

Internal error.

InvalidParameter.ClientIpCountryConflictsWithIpv6

InvalidParameter.GrpcRequireHttp2
InvalidParameter.InvalidAwsPrivateAccess
InvalidParameter.InvalidCacheConfigFollowOrigin

IPv6 access conflicts with client IP
geographical location.
To enable gRPC support, HTTP/2
support must be enabled as well.
Invalid third-party object storage.
Invalid node cache. The origin behavior isfollowed.

InvalidParameter.InvalidCacheKeyQueryStringValue

Invalid query string.

InvalidParameter.InvalidCacheOnlyOnSwitch

Invalid node cache.

InvalidParameter.InvalidCacheTime

Invalid node cache validity.

InvalidParameter.InvalidClientIpCountryHeaderName

Invalid client IP location configuration.
HeaderName consists of 1-100
alphanumeric characters and cannot startor end with hyphens (-).

InvalidParameter.InvalidClientIpHeaderName©2013-2022 Tencent Cloud. All rights reserved.

Invalid client IP request header.

Page 241 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidDynamicRoutine

Invalid smart acceleration.

InvalidParameter.InvalidDynamicRoutineBilling

The package does not support Smart
Acceleration.

InvalidParameter.InvalidForceRedirectType

Invalid forced HTTPS direction settings

InvalidParameter.InvalidHttps

Invalid parameter "https".

InvalidParameter.InvalidHttpsCertInfo

Invalid HTTPS certificate.

InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersion

The cipher suite does not match the TLS
version.

InvalidParameter.InvalidHttpsHstsMaxAge

Invalid HTTPS HSTS.

InvalidParameter.InvalidHttpsTlsVersion

Invalid HTTPS TLS version.

InvalidParameter.InvalidIpv6Switch

Invalid IPv6 settings.

InvalidParameter.InvalidMaxAgeTime

Invalid browser cache.

InvalidParameter.InvalidOrigin

Invalid origin server.

InvalidParameter.InvalidOriginType

Incorrect origin server type.

InvalidParameter.InvalidParameter

Invalid parameter.

InvalidParameter.InvalidPostMaxSizeBilling

The speciThe plan does not support
limiting the max upload size.

InvalidParameter.InvalidPostSizeValue

Invalid POST request size.

InvalidParameter.InvalidRangeOriginPull

Invalid Range GETs.

InvalidParameter.InvalidRequestHeaderName

Invalid request header.

InvalidParameter.InvalidResourceIdBilling

You have not purchased a plan yet.

InvalidParameter.InvalidStandardDebugClientIp

Invalid client IP or CIDR block.
The AllowClientIPList parameter ismandatory. The IPv4 and IPv6 network

InvalidParameter.InvalidStandardDebugEmptyList

segments are supported. 0.0.0.0/0
indicates that all IPv4 clients can be
debugged, and ::/0 indicates that all IPv6
clients can be debugged.

©2013-2022 Tencent Cloud. All rights reserved.

Page 242 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidStandardDebugExpireTimeLimit

The expiration time is exceeded.

InvalidParameter.InvalidWebSocketTimeout

Invalid WebSocket.

InvalidParameter.MultiplyLayerNotSupportSmartRouting

Smart routing is not supported.
The domain name is configured to forward

InvalidParameter.OCDirectOriginRequiresSmartRouting

requests to the origin directly. iSmart
Acceleration must be enabled.

InvalidParameter.PostMaxSizeLimitExceeded

Maximum upload size exceeded.

InvalidParameter.SettingInvalidParam

Configuration parameter error.

InvalidParameter.ZoneIsGrayPublishing

The site is being upgraded. Changing is
not supported. Please try again later.

InvalidParameter.ZoneNotFoundThe site does not exist.

OperationDenied

Operation denied.

OperationDenied.AccelerateMainlandDisable

Cross-MLC-border acceleration is in beta.
To join the beta, submit a ticket.

OperationDenied.AccelerateMainlandIpv6Conflict

Cross-MLC-border acceleration and IPv6
cannot be configured at the same time.
The existing domain feature under the

OperationDenied.AccelerateMainlandMultiplyLayerConflict

OperationDenied.ConfigLocked

OperationDenied.DisableZoneNotCompleted

OperationDenied.ErrZoneIsAlreadyPaused

current site conflicts with the Chinese
mainland network optimization, andcannot be configured at the same time.
The configuration is locked. Please unlock
and try again.
The EdgeOne service of the site is being
disabled. Please try again later.
The EdgeOne service of the site isdisabled. Please enable it and try again.
The domain name is bound with a shared
CNAME and cannot be changed toOperationDenied.SharedCNAMEUnsupportedAccelerateMainland"Cross-MLC-border acceleration". Pleaseunbind the domain name from the shared
CNAME first.

OperationDenied.SharedCNAMEUnsupportedIPv6©2013-2022 Tencent Cloud. All rights reserved.

The domain name is bound with a shared

Page 243 of 760

Tencent Cloud EdgeOne

CNAME and cannot be changed to "IPv6
access". Please unbind the domain namefrom the shared CNAME first.
ResourceInUse

The resource is occupied.

ResourceNotFoundThe resource doesn’t exist.

ResourceNotFound.PostMaxSizeQuotaNotFound

Maximum upload size is not configured.

ResourceUnavailable.CertNotFound
UnauthorizedOperation.CamUnauthorized
UnauthorizedOperation.NoPermission©2013-2022 Tencent Cloud. All rights reserved.

The certificate does not exist or is not
authorized.
CAM is not authorized.
The sub-account is not authorized for theoperation. Please get permissions first.

Page 244 of 760

Tencent Cloud EdgeOne

Alias Domain APIs
CreateAliasDomain：

Last updated 2024-05-29 14:56:04

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create an alias domain name.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

AliasName

Yes

String

The alias domain name.

TargetName

Yes

String

The target domain name.

CertType

No

String

Certificate configuration. Values:

Name

Description
Common Params. The value used for this API:
CreateAliasDomain.

none : (Default) Do not configure
hosting : Managed SSL certificate©2013-2022 Tencent Cloud. All rights reserved.

Page 245 of 760

Tencent Cloud EdgeOne

CertId.N

No

Array ofThe certificate ID. This field is required whenStringCertType=hosting .

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating an alias domain name
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAliasDomain<Common request parameters>{"TargetName": "aaa.example.com","AliasName": "bbb.test.com","CertType": "none","ZoneId": "zone-28569s6od5na"}

Output Example{"Response": {"RequestId": "4dcgtb24-7dc5-46s2-9q3e-95825d53dcs3a"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 246 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CertificateNotFoundThe certificate does not exist.

InternalError

Internal error.

InternalError.ConfigLocked

The configuration is locked. Please unlock and try again.

InvalidParameter.AliasDomainNotSupportSMCert

InvalidParameter.CertNotMatchDomain

Chinese SM certificates are not supported for alias
domain names.
Mismatch between the HTTPS certificate and thedomain name.

InvalidParameter.InvalidHttpsCertInfo

Invalid HTTPS certificate.

InvalidParameter.InvalidParameter

Invalid parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 247 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidRequestHeaderName

Invalid request header.

InvalidParameterValue

Invalid parameter value.

InvalidParameterValue.InvalidAliasDomainName

The alias domain name is invalid. It must containnumerics, English characters, and hyphens, but hyphen
is not allowed at the beginning or the end.

InvalidParameterValue.InvalidAliasNameSuffix

Invalid alias domain suffix. This domain is for internal
usage and cannot be used as the alias domain.

LimitExceeded

The quota limit has been reached.

OperationDenied

Operation denied.

OperationDenied.ConfigLocked

The configuration is locked. Please unlock and try again.

OperationDenied.DomainIsBlocked

Unable to use the domain name when it’s blocked.

OperationDenied.DomainNoICPThe domain name doesn't have an ICP filing number.

OperationDenied.VersionControlLocked

The operation is not allowed because the version
management mode is applied.

ResourceInUse.AliasName

The alias domain name already exists.

ResourceInUse.DuplicateName

Duplicate alias domain names.

ResourceInUse.Zone

The alias domain name is already added.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable.DomainAlreadyExists

The domain name is already connected to EdgeOne byanother account. Please retrieve it first in order to add it.

UnauthorizedOperation

Unauthorized operation.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnsupportedOperation.TargetNameOriginTypeCos

The origin type of the target domain cannot be COS foran alias domain.

©2013-2022 Tencent Cloud. All rights reserved.

Page 248 of 760

Tencent Cloud EdgeOne

DescribeAliasDomains：

Last updated 2024-05-29 14:56:03

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the information of alias domain names.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

OffsetNo

Integer

The page offset. Default value: 0

Limit

No

Integer

Filters.N

No

Array ofFilter conditions. The maximum value for Filters.Values is 20.

AdvancedFilter

The detailed conditions are as follows:

Name

Description
Common Params. The value used for this API:
DescribeAliasDomains.

The paginated query limit. Default value: 20. Maximum value:
1000.

target-name: Filter by the target domain name;alias-name: Filter by the alias of the domain name.

©2013-2022 Tencent Cloud. All rights reserved.

Page 249 of 760

Tencent Cloud EdgeOne

Fuzzy queries are only supported for the field name alias-name.

3. Output Parameters
Parameter
Name
TotalCount
AliasDomains

Type

Description

Integer

Total eligible alias domain names.

Array of
AliasDomain

Information of the eligible alias domain names.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the list of alias domain names
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAliasDomains<Common request parameters>{"ZoneId": "zone-28569s6od5na","Limit": 20,"Filters": [{"Values": ["bbb.test.com"],"Name": "alias-name"}],"Offset": 0}©2013-2022 Tencent Cloud. All rights reserved.

Page 250 of 760

Tencent Cloud EdgeOne

Output Example{"Response": {"TotalCount": 1,"RequestId": "5ce6ee51-cda5-4e0d-a338-cff57a00bb3a","AliasDomains": [{"Status": "pending","ModifiedOn": "2020-09-22T00:00:00+00:00","TargetName": "aaa.example.com","CreatedOn": "2020-09-22T00:00:00+00:00","ZoneId": "zone-28569s6od5na","AliasName": "bbb.test.com","ForbidMode": 0}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 251 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

InternalError.ProxyServer

An unknown error occurred in the backend server.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 252 of 760

Tencent Cloud EdgeOne

ModifyAliasDomain：

Last updated 2024-05-29 14:56:03

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify an alias domain name.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

AliasName

Yes

String

The alias domain name.

TargetName

Yes

String

The target domain name.

CertType

No

String

Certificate configuration. Values:

Name

Description
Common Params. The value used for this API:
ModifyAliasDomain.

none : Offhosting : Managed SSL certificate
apply : Free certificate
The original configuration will apply if this field is not specified.

©2013-2022 Tencent Cloud. All rights reserved.

Page 253 of 760

Tencent Cloud EdgeOne

CertId.N

No

Array of
String

The certificate ID. This field is required when
CertType=hosting .

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying an alias domain name
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAliasDomain<Common request parameters>{"TargetName": "bbb.example.com","AliasName": "eo.test.com","CertType": "none","ZoneId": "zone-28569s6od5na"}

Output Example{"Response": {"RequestId": "6d1efe51-b951-498e-9b10-755906835e87"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 254 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidParameter.CertNotMatchDomain

Mismatch between the HTTPS certificate and the domain name.

OperationDenied

Operation denied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 255 of 760

Tencent Cloud EdgeOne

ModifyAliasDomainStatus：

Last updated 2024-05-29 14:56:03

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify the status of an alias domain name.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

BooleanStatus of the alias domain name. Values:
false : Enable the alias domain name.

Name

PausedYes

Description
Common Params. The value used for this API:
ModifyAliasDomainStatus.

true : Disable the alias domain name.
AliasNames.N

No

Array of

The alias domain name you want to modify its status. If it is left

Stringempty, the modify operation is not performed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 256 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the status of an alias domain name
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAliasDomainStatus<Common request parameters>{"ZoneId": "zone-28569s6od5na","AliasNames": ["eo.test.com"],"Paused": true}

Output Example{"Response": {"RequestId": "114327ee-463c-4ee4-83f6-82e9a44bd81d"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 257 of 760

Tencent Cloud EdgeOne

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

OperationDenied

Operation denied.

ResourceInUse

The resource is occupied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 258 of 760

Tencent Cloud EdgeOne

DeleteAliasDomain：

Last updated 2024-05-29 14:56:04

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete an alias domain name.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteAliasDomain.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

AliasNames.N

No

Array of

The alias domain name to be deleted. If it is left empty, the delete

Stringoperation is not performed.

Name

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 259 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 S
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteAliasDomain<Common request parameters>{"ZoneId": "zone-28569s6od5na","AliasNames": ["eo.test.com"]}

Output Example{"Response": {"RequestId": "28ec90d3-7af9-460c-bb1a-dd9cf4d8c785"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 260 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

OperationDenied

Operation denied.

ResourceInUse

The resource is occupied.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 261 of 760

Tencent Cloud EdgeOne

Security Configuration APIs
CreateSecurityIPGroup：

Last updated 2024-05-29 14:55:47

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a security IP group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID.

IPGroupYes

IPGroup

IP group information.

Description
Common Params. The value used for this API:
CreateSecurityIPGroup.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 262 of 760

Tencent Cloud EdgeOne

Parameter

Type

Description

GroupId

Integer

IP group ID.

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a

NameRequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a security IP group
This example shows you how to create a security IP group.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSecurityIPGroup<Common request parameters>{"IPGroup": {"GroupId": 0,"Name": "testip","Content": ["2.2.2.2"]},"ZoneId": "zone-j94jf0a1"}

Output Example{"Response": {"RequestId": "09ce3d28-1119-49cd-xxxx-27cb34dac669","GroupId": 128}}©2013-2022 Tencent Cloud. All rights reserved.

Page 263 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameter.Security

Invalid parameter.

OperationDenied

Operation denied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 264 of 760

Tencent Cloud EdgeOne

DescribeSecurityIPGroup：

Last updated 2024-06-05 14:41:07

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the configuration information of a security IP group, including the ID, name, and content of
the security IP group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID, used to specify the scope of the queried site.

Name

Description
Common Params. The value used for this API:
DescribeSecurityIPGroup.

Specifies the ID of a security IP group.
GroupIds.N

No

Array ofInteger

When this parameter is provided, only the configuration of the
security IP group with the specified ID is queried.
When this parameter is not provided, information of all security IPgroups under the site is returned.

©2013-2022 Tencent Cloud. All rights reserved.

Page 265 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name
IPGroups

RequestId

Type

Description

Array of

Detailed configuration information of security IP groups, including the ID, name, andIPGroup

IP/IP range list information of each security IP group.

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the configuration information of security IP groups
This example shows you how to query the configuration information of security IP groups in a specified site.
Input Example
POST / HTTP/1.1
Host: xxx.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances<Common request parameters>{"ZoneId": "zone-nqicqhasui"}

Output Example{"Response": {"IPGroups": [{"GroupId": 123,
"Name": "ExampleIpGroup","Content": ["2.2.2.2","23.23.23.0/24"]}©2013-2022 Tencent Cloud. All rights reserved.

Page 266 of 760

Tencent Cloud EdgeOne],"RequestId": "ddf831fc-cf45-40fe-81b0-2d9cdd4c1bd6"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 267 of 760

Tencent Cloud EdgeOne

ModifySecurityIPGroup：

Last updated 2024-05-29 14:55:46

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify a security IP group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifySecurityIPGroup.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID.

IPGroupYes

IPGroup

IP group configuration.

Name

Operation type. Valid values:
append : Add information of Content to IPGroup ;
Mode

Yes

Stringremove : Delete information of Content from
IPGroup ;update : Replace all information of IPGroup and modify
the IPGroup name.

©2013-2022 Tencent Cloud. All rights reserved.

Page 268 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying a security IP group with the operation "append"
This example shows you how to modify a security IP group with the operation "append".
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityIPGroup<Common request parameters>{"IPGroup": {"GroupId": 67,"Name": "test3","Content": ["1.3.1.1/16","6.6.6.6"]},"Mode": "append","ZoneId": "zone-hduqwh"}

Output Example{"Response": {"RequestId": "728cb059-8595-44c7-b6c6-b4a539ae823f"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 269 of 760

Tencent Cloud EdgeOne

Example2 Modifying a security IP group with the operation "remove"
This example shows you how to modify a security IP group with the operation "remove".
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityIPGroup<Common request parameters>{"IPGroup": {"GroupId": 67,"Name": "test3","Content": ["1.3.1.1/16","6.6.6.6"]},"Mode": "remove","ZoneId": "zone-hduqwh"}

Output Example{"Response": {"RequestId": "5bdc699c-68df-4cb7-9d0a-1c174b0374ad"}}

Example3 Modifying a security IP group with the operation "update"This example shows you how to modify a security IP group with the operation "update".
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityIPGroup<Common request parameters>©2013-2022 Tencent Cloud. All rights reserved.

Page 270 of 760

Tencent Cloud EdgeOne{"IPGroup": {"GroupId": 67,"Name": "test3","Content": ["1.2.1.1/24","3.3.3.3"]},"Mode": "update","ZoneId": "zone-hduqwh"}

Output Example{"Response": {"RequestId": "sh1u8a90-xxxx-49cd-swui-27cb34daa779"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 271 of 760

Tencent Cloud EdgeOne

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter.Security

Invalid parameter.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 272 of 760

Tencent Cloud EdgeOne

DeleteSecurityIPGroup：

Last updated 2024-05-29 14:55:47

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete a specified security IP group. Note that the security IP group cannot be deleted if it isreferenced in a rule.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID.

GroupId

Yes

Integer

IP group ID.

Name

Description
Common Params. The value used for this API:
DeleteSecurityIPGroup.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 273 of 760

Tencent Cloud EdgeOne

Name
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting a security IP group
This example shows you how to delete a security IP group.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteSecurityIPGroup<Common request parameters>{"GroupId": 85,"ZoneId": "zone-qdwibsa"}

Output Example{"Response": {"RequestId": "09ce3d28-1119-49cd-xxxx-27cb34dac669"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 274 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameter.Security

Invalid parameter.

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 275 of 760

Tencent Cloud EdgeOne

DescribeOriginProtection：

Last updated 2024-05-29 14:55:47

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the origin protection configuration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIds.N

No

Filters.N

No

Name

Array of
StringDescription
Common Params. The value used for this API:
DescribeOriginProtection.

Set of site IDs to be queried. This is a required parameter.

Array ofFilter conditions. Each filter condition can have up to 20 entries.

FilterSee below for details:
need-update :Whether the intermediate IP update is needed for thesite.
Type: String
Required: No
Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 276 of 760

Tencent Cloud EdgeOne

true : Update needed.
false : Update not needed.
plan-support :Whether origin protection is supported in the plan.
Type: String
Required: No
Values:true : Origin protection supported.
false : Origin protection not supported.
OffsetNo

Integer

Offset for paginated queries. Default value: 0.

Limit

No

Integer

Limit on paginated queries. Default value: 20. Maximum value:
1000.

3. Output Parameters
Parameter Name

OriginProtectionInfo

Type

Description

Array ofOrigin protection configuration.
Note: This field may return null , indicating that no valid

OriginProtectionInfo

values can be obtained.
The unique request ID, generated by the server, will be returned

RequestId

Stringfor every request (if the request fails to reach the server forother reasons, the request will not obtain a RequestId).
RequestId is required for locating a problem.

4. Example
Example1 The following example shows you how to query the origin protection
configuration.
The following example shows you how to query the origin protection configuration.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOriginProtection<Common request parameters>©2013-2022 Tencent Cloud. All rights reserved.

Page 277 of 760

Tencent Cloud EdgeOne{"ZoneIds": ["zone-276zs184g93m"],"Filters": [{"Values": ["true"],"Name": "need-update"}],"Offset": 0,"Limit": 20}

Output Example{"Response": {"RequestId": "de0a2b4f-df6d-4d2a-ac39-1706cbf8a797","OriginProtectionInfo": [{"ZoneId": "zone-276zs184g93m","Hosts": ["www.qq.com"],"ProxyIds": ["proxy-19389e5dwwxfs"],"CurrentIPWhitelist": {"IPv4": ["11.11.11.11/24"],"IPv6": ["2001:980:7002:6::/64"]},"NeedUpdate": true,"Status": "online","PlanSupport": true,"DiffIPWhitelist": {"LatestIPWhitelist": {"IPv4": ["11.11.11.11/24",©2013-2022 Tencent Cloud. All rights reserved.

Page 278 of 760

Tencent Cloud EdgeOne"22.22.22.22/24"],"IPv6": ["2001:980:7002:6::/64"]},"AddedIPWhitelist": {"IPv4": ["22.22.22.22/24"],"IPv6": []},"RemovedIPWhitelist": {"IPv4": [],"IPv6": []},"NoChangeIPWhitelist": {"IPv4": ["11.11.11.11/24"],"IPv6": ["2001:980:7002:6::/64"
]
}
}
}
]
}
}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET

©2013-2022 Tencent Cloud. All rights reserved.

Page 279 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

InvalidParameter

Parameter error.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 280 of 760

Tencent Cloud EdgeOne

DescribeSecurityTemplateBindings：

Last updated 2024-05-29 14:55:46

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query bindings of a policy template.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site to query

TemplateId.N

Yes

Array of
StringID of the policy template to query.

Description
Common Params. The value used for this API:
DescribeSecurityTemplateBindings.

3. Output Parameters
Parameter Name

Type©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 281 of 760

Tencent Cloud EdgeOne

SecurityTemplate

Array of

Bindings of the specified policy template.

SecurityTemplateBinding
When a domain name of a site is bound with the specified
policy template, TemplateScope includes the
ZoneId of the related site and the bindings of the domain
name.
Note: If the template is not bound with any domain name,and there is not any existing binding, TemplateScope=0
is returned.
In the binding list, the same domain name may appear
repeatedly in the EntityStatus list with different
Status . For example, when a domain name is beingbound to another policy template, it's marked bothonline and pending .

RequestId

String

The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying bindings of a policy template
This API returns all bindings of a policy template.
1. Status=online : The binding is taking effect.
2. Status=pending : The binding is establishing.
Note: A domain name may appear multiple times in the bindings list with different status.
In this example, we query the bindings of the policy template temp-fjsoelx under the site example.com (site ID:zone-fdsjkfsda).
Note: The output contains completed and on-going bindings. The policy template is applied to these two domainnames. abc.example.com is bound to the policy template specified by the request, and the policy runs normally.
The binding status is online . xyz.example.com is being bound to another policy template. The new binding
is not yet completed, and the current policy template is still valid. So it appears in both the online andpending list.
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 282 of 760

Tencent Cloud EdgeOne

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityTemplateBindings<Common request parameters>{"ZoneId": "zone-fdsjjkfsda","TemplateId": ["temp-fjsoelx"]}

Output Example{"Response": {"SecurityTemplate": [{"TemplateId": "temp-fjsoelx","TemplateScope": [{"ZoneId": "zone-fdsjjkfsda","EntityStatus": [{"Entity": "abc.example.com","Status": "online","Message": ""},{"Entity": "xyz.example.com","Status": "online","Message": ""},{"Entity": "xyz.example.com","Status": "pending","Message": ""
}
]
}
]
}
],
"RequestId": "17d437bc-13a9-49bb-a6ac"©2013-2022 Tencent Cloud. All rights reserved.

Page 283 of 760

Tencent Cloud EdgeOne}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 284 of 760

Tencent Cloud EdgeOne

ModifySecurityPolicy：

Last updated 2024-05-29 14:55:45

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify the web and bot security configurations.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

SecurityConfig

Yes

SecurityConfig

Security configuration.

Name

Description
Common Params. The value used for this API:
ModifySecurityPolicy.

Subdomain/application name.

EntityNo

StringNote: When both this parameter and the TemplateId
parameter are specified, this parameter will not take effect.
Do not specify this parameter and the TemplateId parameterat the same time.

©2013-2022 Tencent Cloud. All rights reserved.

Page 285 of 760

Tencent Cloud EdgeOne

TemplateId

No

StringSpecifies the policy template ID, or the site's global policy.
- To configure a policy template, specify the policy templateID.
- To configure the site's global policy, use the@ZoneLevel@Domain parameter value.
Note: When this parameter is used, the Entity parameter will
not take effect. Do not use this parameter and the Entity
parameter at the same time.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the security configuration
This example shows you how to modify the L7 security configuration for the domain name "a.eotest.com".
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityPolicy<Common request parameters>{"Entity": "a.eotest.com","SecurityConfig": {"WafConfig": {"Switch": "on","WafRule": {"Switch": "on","ObserveRuleIDs": [],"BlockRuleIDs": [©2013-2022 Tencent Cloud. All rights reserved.

Page 286 of 760

Tencent Cloud EdgeOne

162502146]},"Mode": "block","Level": "loose"}},"ZoneId": "zone-fa89j239a"}

Output Example{"Response": {"RequestId": "08b32010-ab25-42a4-b923-2e6c481dae23"}}

Example2 Modifying an exception rule to allow specified fields
This example shows you how to skip WAF protection for all keys in the specified HTTP header.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityPolicy<Common request parameters>{"Entity": "*.eotest.com","SecurityConfig": {"ExceptConfig": {"Switch": "on","ExceptUserRules": [{"Action": "skip","ExceptUserRuleConditions": [{"MatchContent": "/skipwaf","MatchFrom": "cgi","MatchParam": "","Operator": "equal"}],©2013-2022 Tencent Cloud. All rights reserved.

Page 287 of 760

Tencent Cloud EdgeOne"ExceptUserRuleScope": {"Type": "partial","PartialModules": [{"Module": "waf","Include": [106247778]}],"SkipConditions": [{"MatchContent": [],"MatchContentType": "","MatchFrom": [],"MatchFromType": "","Selector": "keys","Type": "header_fields"}]},"RuleID": 0,"RuleName": "first_webshell","RulePriority": 0,"RuleStatus": "on","UpdateTime": "2022-09-22T03:00:10Z"}]}},"ZoneId": "zone-fa89j239a"}

Output Example{"Response": {"RequestId": "08b32010-ab25-42a4-b923-2e6c481dae44"}}

Example3 Modifying an exception rule to allow the key in the specified header
This example shows you how to skip WAF protection for the specified HTTP header’s value.
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 288 of 760

Tencent Cloud EdgeOne

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityPolicy<Common request parameters>{"Entity": "*.eotest.com","SecurityConfig": {"ExceptConfig": {"Switch": "on","ExceptUserRules": [{"Action": "skip","ExceptUserRuleConditions": [{"MatchContent": "/skipwaf","MatchFrom": "cgi","MatchParam": "","Operator": "equal"}],"ExceptUserRuleScope": {"Type": "partial","PartialModules": [{"Module": "waf","Include": [106247778]}],"SkipConditions": [{"MatchContent": [],"MatchContentType": "","MatchFrom": ["YourSkipHeader"],"MatchFromType": "equal","Selector": "values","Type": "header_fields"}]},"RuleID": 0,©2013-2022 Tencent Cloud. All rights reserved.

Page 289 of 760

Tencent Cloud EdgeOne"RuleName": "first_webshell","RulePriority": 0,"RuleStatus": "on","UpdateTime": "2022-09-22T03:00:10Z"}]}},"ZoneId": "zone-fa89j239a"}

Output Example{"Response": {"RequestId": "08b32010-ab25-42a4-b923-2e6c481dae66"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 290 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ConfigLocked

The configuration is locked. Please unlock and try again.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InternalError.RouteError

The backend routing address is incorrect.

InvalidParameter.Security

Invalid parameter.

LimitExceeded.Security

Limit exceeded

OperationDenied

Operation denied.

ResourceInUse

The resource is occupied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Please getpermissions first.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 291 of 760

Tencent Cloud EdgeOne

BindSecurityTemplateToEntity：

Last updated 2024-05-29 14:55:48

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to bind/unbind a domain name to/from a specific policy template.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID of the policy template to be bound to or unbound from.

Entities.N

Yes

OperateYes

NameArray of
StringStringDescription
Common Params. The value used for this API:
BindSecurityTemplateToEntity.

List of domain names to bind to/unbind from a policy template
Action options. Values include:bind : Bind the domain names to the specified policy template
unbind-keep-policy : Unbind a domain name from a policy
template and keep the current policy when unbinding
unbind-use-default : Unbind domain names from policy
templates and use default blank policy.

©2013-2022 Tencent Cloud. All rights reserved.

Page 292 of 760

Tencent Cloud EdgeOne

Note: Only one domain name can be unbound at one time. When
Operate is unbind-keep-policy or unbind-usedefault , there can only be one domain name specified in
Entities .
Specifies the ID of the policy template or the site's global policy to bebound or unbound.
- To bind to a policy template, or unbind from it, specify the policy
template ID.
TemplateId

YesString- To bind to the site's global policy, or unbind from it, use the@ZoneLevel@domain parameter value.
Note: After unbinding, the domain name will use an independent policy
and rule quota will be calculated separately. Please make sure there issufficient rule quota before unbinding.
Whether to replace the existing policy template bound with the domainname. Values:

OverWrite

Notrue : Replace the template bound to the domain.

Booleanfalse : Do not replace the template.
Note: In this case, the API returns an error if there is already a policy
template bound to the specified domain name.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Unbinding a domain name from a policy template
In this example, we unbind the domain name a.test.com from the policy template temp-cuwg1hki of thesite zone-2aq0e8rhu6jx . Only one domain name can be unbound at one time. There are two options:
1. unbind-keep-policy : Unbind the domain name from the specified policy and create a new policy for thedomain name with the same configuration as the original one. This takes additional rule quota.

©2013-2022 Tencent Cloud. All rights reserved.

Page 293 of 760

Tencent Cloud EdgeOne

2. unbind-use-default : Unbind the domain name from the specified policy and then bind it with the default
policy with default configurations. Custom rules no longer take effect.
Note: To use unbind-keep-policy , make sure your rule quota is enough. If the remaining quota is insufficient,
the unbinding fails and the domain name remains bound to the current policy template.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OperateSecurityTemplate<Common request parameters>{"ZoneId": "zone-2aq0e8rhu6jx","Entities": ["a.test.com"],"TemplateId": "temp-cuwg1hki","Operate": "unbind-keep-policy"}

Output Example{"Response": {"RequestId": "09ce3d28-1119-49cd-xxxx-27cb34dac669"}}

Example2 Binding domain names to a policy template
In this example, we bind two domain names (a.test.com and b.example.com) to the policy template tempcuwg1hki under the site zone-2aq 0e8rhu6jx .
Note: You need to have permissions to the related sites.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OperateSecurityTemplate©2013-2022 Tencent Cloud. All rights reserved.

Page 294 of 760

Tencent Cloud EdgeOne<Common request parameters>{"ZoneId": "zone-2aq0e8rhu6jx","Entities": ["a.test.com","b.example.com"],"TemplateId": "temp-cuwg1hki","Operate": "bind","OverWrite": true}

Output Example{"Response": {"RequestId": "09ce3d28-1119-49cd-xxxx-27cb34dac669"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 295 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ConfigLocked

The configuration is locked. Please unlock and try again.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter.Security

Invalid parameter.

OperationDenied

Operation denied.

ResourceInUse

The resource is occupied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 296 of 760

Tencent Cloud EdgeOne

DescribeSecurityIPGroupInfo：

Last updated 2024-06-05 14:40:56

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
The API is deprecated and will be discontinued on June 30, 2024. Please use the API DescribeSecurityIPGroup .
This API is used to query the configuration information of an IP group, including the IP group name, IP group content,
and the site the IP group belongs to.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID, used to specify the query scope.

Limit

No

Integer

OffsetNo

Integer

Description
Common Params. The value used for this API:
DescribeSecurityIPGroupInfo.

Maximum number of entries returned in a single response. Default
value: 20. Maximum query entries: 1000.
The starting entry offset for pagination queries. The default value is 0.

©2013-2022 Tencent Cloud. All rights reserved.

Page 297 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name
TotalCount
IPGroups

Type

Description

Integer

The number of IP groups that meet the conditions.

Array of

Detailed configuration information of the IP group, including the ID, name, andIPGroup

IP/network segment list of each IP group.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the configuration information of an IP group
This example shows you how to query the IP group configuration information for the specified site, and return thecontent of the first page with 10 records per page.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityIPGroupInfo<Common request parameters>{"ZoneId": "zone-20hyebgyfsko","Limit": 10,"Offset": 0}

Output Example{"Response": {"TotalCount": 1,"IPGroups": [{"GroupId": 123,©2013-2022 Tencent Cloud. All rights reserved.

Page 298 of 760

Tencent Cloud EdgeOne"Name": "ExampleIpGroup","Content": ["123.123.123.0","23.23.23.0/24"]}],"RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 299 of 760

Tencent Cloud EdgeOne

Layer 4 Application Proxy APIs
CreateL4Proxy：

Last updated 2024-06-05 14:40:57

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create Layer 4 proxy instances.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringRegionNo

StringZoneIdYesStringZone ID.

ProxyName

Yes

StringLayer 4 proxy instance name. You can enter

Common Params. The value used for this
API: CreateL4Proxy.
Common Params. The value used for this
API: 2022-09-01.
Common Params. This parameter is not
required.

1-50 characters. Valid characters are a-z, 09, and hyphens (-). However, hyphens (-)
cannot be used individually or consecutively
and should not be placed at the beginning or©2013-2022 Tencent Cloud. All rights reserved.

Page 300 of 760

Tencent Cloud EdgeOne

end of the name. Modifications are notallowed after creation.
Acceleration zone of the Layer 4 proxyinstance.
mainland: Availability zone in the Chinese
Area

Yes

Stringmainland;overseas: Global availability zone
(excluding the Chinese mainland);global: Global availability zone.
Specifies whether to enable IPv6 access. The
default value off is used if left empty. Thisconfiguration can only be enabled in certain
acceleration zones and security protection

Ipv6

No

Stringconfigurations. For details, see Creating an
L4 Proxy Instance. Valid values:
on: Enable;
off: Disable.

Specifies whether to enable the fixed IP
address. The default value off is used if left
empty. This configuration can only be enabledin certain acceleration zones and security
StaticIp

No

Stringprotection configurations. For details, see
Creating an L4 Proxy Instance. Valid values:
on: Enable;
off: Disable.

Specifies whether to enable network
optimization in the Chinese mainland. The
default value off is used if left empty. Thisconfiguration can only be enabled in certain
AccelerateMainland

No

Stringacceleration zones and security protection
configurations. For details, see Creating an
L4 Proxy Instance. Valid values:
on: Enable;
off: Disable.

DDosProtectionConfig

No

DDosProtectionConfig

Layer 3/Layer 4 DDoS protection. The default
protection option of the platform will be used if
it is left empty. For details, see Exclusive
DDoS Protection Usage.

©2013-2022 Tencent Cloud. All rights reserved.

Page 301 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

Type

Description

ProxyId

StringLayer 4 instance ID.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a Layer 4 proxy instance with the acceleration zone of 'Availability Zone
in the Chinese mainland'This example shows you how to create a Layer 4 instance named 'test', with the acceleration zone of 'Availability zone
in the Chinese mainland', under the zone with ZoneId 'zone-2jc2xy3hr7f7'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateL4Proxy<Common Request Parameters>{"ProxyName": "test","ZoneId": "zone-2jc2xy3hr7f7","Area": "mainland"}

Output Example{"Response": {"ProxyId": "sid-2jc2hl2hr8f7","RequestId": "0se57a54-cc42-11ed-8efb-525401a961b1"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 302 of 760

Tencent Cloud EdgeOne

Example2 Creating a Layer 4 proxy instance with the acceleration zone of 'Global Availability
Zone (excluding Chinese mainland)' and exclusive DDoS protection enabledThis example shows you how to create a Layer 4 instance named 'test', with the acceleration zone of 'Global
availability zone (excluding the Chinese mainland)', and exclusive DDoS protection enabled under the zone with
ZoneId 'zone-2jc2xy3hr7f7', to provide full protection within the acceleration zone.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateL4Proxy<Common Request Parameters>{"ZoneId": "zone-2jc2xy3hr7f7","ProxyName": "test","Area": "overseas","DDosProtectionConfig": {"LevelOverseas": "ANYCAST_ALLIN"}}

Output Example{"Response": {"ProxyId": "sid-2jc2hl2hr8f7","RequestId": "0se57a54-cc42-11ed-8efb-525401a961b1"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 303 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InvalidParameter.ProxyNameDuplicating

The instance name already exists.

OperationDenied

Operation denied.

OperationDenied.AccelerateMainlandDisable

OperationDenied.AccelerateMainlandIpv6Conflict

OperationDenied.ErrZoneIsAlreadyPaused

OperationDenied.Ipv6AdvancedConflict

OperationDenied.Ipv6StaticIpConflict

Cross-MLC-border acceleration is in beta. To join the beta,
submit a ticket.
Cross-MLC-border acceleration and IPv6 cannot be
configured at the same time.
The EdgeOne service of the site is disabled. Please enable
it and try again.
Exclusive DDoS protection conflicts with IPv6. They cannot
be configured at the same time.
The IPv6 feature and static IP cannot be enabled at thesame time.
The layer-4 instance resource sales are skyrocketing andOperationDenied.L4LackOfResources

now the resources are sold out. Replenishing is inprogress. Currently, new layer-4 proxies cannot be added.
Please wait.

OperationDenied.MsgIpv6AdvancedConflict©2013-2022 Tencent Cloud. All rights reserved.

IPv6 cannot be enabled for non-overseas exclusive
protection.

Page 304 of 760

Tencent Cloud EdgeOne

OperationDenied.StaticIpAreaConflict

The static IP cannot be enabled for this instance's region.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 305 of 760

Tencent Cloud EdgeOne

ModifyL4Proxy：

Last updated 2024-04-09 10:25:52

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify the configuration of a Layer 4 proxy instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyL4Proxy.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringApplication ID.

Ipv6

No

StringSpecifies whether to enable IPv6 access. If this parameter is not
filled, this configuration will not be modified. This configuration
can only be enabled in certain acceleration zones and security
protection configurations. For details, see [Creating an L4 Proxy
Instance](https://www.tencentcloud.com/document/product/1552/90025?
from_cn_redirect=1). Valid values:
on: Enable;©2013-2022 Tencent Cloud. All rights reserved.

Page 306 of 760

Tencent Cloud EdgeOne

off: Disable.

Specifies whether to enable network optimization in the Chinese
mainland. If this parameter is not filled, this configuration will not
be modified. This configuration can only be enabled in certain

AccelerateMainland

No

Stringacceleration zones and security protection configurations. For
details, see [Creating an L4 Proxy Instance](https://www.tencentcloud.com/document/product/1552/90025?
from_cn_redirect=1). Valid values:
on: Enable;
off: Disable.

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying IPv6 access configuration
This example shows you how to enable IPv6 access for the Layer 4 proxy instance with ZoneId 'zone-24wjy25v1cwi'
and ProxyId 'sid-2qwk27xf7j9g'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyL4Proxy<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g",©2013-2022 Tencent Cloud. All rights reserved.

Page 307 of 760

Tencent Cloud EdgeOne"Ipv6": "on"}Output Example{"Response": {"RequestId": "fbdb42f0-6a1e-4d397783c36csdf"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

OperationDenied

Operation denied.

OperationDenied.AccelerateMainlandDisable

Cross-MLC-border acceleration is in beta. To join the beta,
submit a ticket.

©2013-2022 Tencent Cloud. All rights reserved.

Page 308 of 760

Tencent Cloud EdgeOne

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled. Please enable itand try again.
The layer-4 instance resource sales are skyrocketing and now

OperationDenied.L4LackOfResources

the resources are sold out. Replenishing is in progress.
Currently, new layer-4 proxies cannot be added. Please wait.

OperationDenied.L4ProxyInOfflineStatus

The Layer 4 channel is closed and rule addition is disallowed.

OperationDenied.L4ProxyInProcessStatus

The instance is currently in deployment and cannot be
operated.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 309 of 760

Tencent Cloud EdgeOne

ModifyL4ProxyStatus：

Last updated 2024-04-09 10:25:50

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to enable or disable a Layer 4 proxy instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringLayer 4 proxy instance ID.

Name

Description
Common Params. The value used for this API:
ModifyL4ProxyStatus.

Layer 4 proxy instance status. Valid values:
StatusYes

Stringonline: Enabled;
offline: Disabled.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 310 of 760

Tencent Cloud EdgeOne

Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Enabling a Layer 4 proxy instanceThis example shows you how to enable the Layer 4 proxy instance with ProxyId 'sid-2qwk27xf7j9g' under the zone
with ZoneId 'zone-24wjy25v1cwi'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyL4ProxyStatus<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g","Status": "online"}

Output Example{"Response": {"RequestId": "6f8h5258-cdda-4f82-b7sc-0aef4a219244"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 311 of 760

Tencent Cloud EdgeOne

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ConfigLocked

The configuration is locked. Please unlock and try again.

InternalError.ProxyServer

An unknown error occurred in the backend server.

OperationDenied

Operation denied.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled. Please enable it andtry again.

OperationDenied.L4ProxyInBannedStatus

Operation failed: The L4 proxy is blocked.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 312 of 760

Tencent Cloud EdgeOne

DescribeL4Proxy：

Last updated 2024-04-09 10:25:56

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query a Layer 4 proxy instance list.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeL4Proxy.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the zone where the Layer 4 proxy instance belongs.

OffsetNo

Integer

Paginated query offset. Defaults to 0 when not specified.

Limit

No

Integer

Paginated query limit. Default value: 20. Maximum value: 1000.

Name

Filter criteria. The upper limit for Filters.Values is 20. If left empty, all
Array
Filters.N

No

of
FilterLayer 4 proxy instance information under the current zone ID is returned.
The detailed filter criteria are as follows:
proxy-id: Filters by Layer 4 proxy instance ID;©2013-2022 Tencent Cloud. All rights reserved.

ddos-protection-type: Filters by security protection type;

Page 313 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

The number of Layer 4 proxy instances.

L4Proxies

Array of
L4Proxy

List of Layer 4 proxy instances.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the list of Layer 4 proxy instances under a zone
This example shows you how to query the list of Layer 4 proxy instances under the zone with ZoneId 'zone24wjy25v1cwi'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeL4Proxy<Common Request Parameters>{"Offset": 1,"Limit": 10,"Filters": [],"ZoneId": "zone-24wjy25v1cwi"}

Output Example{"Response": {"TotalCount": 1,"L4Proxies": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 314 of 760

Tencent Cloud EdgeOne"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g","ProxyName": "test","Area": "mainland","Cname": "test.24wjy25v1cwi.eo.dnse5.com","Ips": [],"Status": "online","Ipv6": "off","StaticIp": "off","AccelerateMainland": "off","UpdateTime": "2023-09-22T15:31:04+00:00"}],"RequestId": "6f8h5258-cdda-4f82-b7sc-0aef4a219244"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 315 of 760

Tencent Cloud EdgeOne

Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 316 of 760

Tencent Cloud EdgeOne

DeleteL4Proxy：

Last updated 2024-04-09 10:25:58

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete a Layer 4 proxy instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteL4Proxy.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringLayer 4 proxy instance ID.

3. Output Parameters
Parameter
Name
RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if the©2013-2022 Tencent Cloud. All rights reserved.

Page 317 of 760

Tencent Cloud EdgeOne

request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting a Layer 4 proxy instanceThis example shows you how to delete a Layer 4 proxy instance with ZoneId as 'zone-24wjy25v1cwi' and ProxyId as'sid-2qwk27xf7j9g'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteL4Proxy<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g"}

Output Example{"Response": {"RequestId": "6f8h5258-cdda-4f82-b7sc-0aef4a219244"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 318 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 319 of 760

Tencent Cloud EdgeOne

CreateL4ProxyRules：

Last updated 2024-04-09 10:26:00

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create Layer 4 proxy instance rules, supporting both individual and batch creation.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreateL4ProxyRules.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringLayer 4 proxy instance ID.

L4ProxyRules.N

Yes

Array of

List of forwarding rules. A single request supports up to 200

L4ProxyRule

forwarding rules.
Note: When L4ProxyRule is used here, Protocol, PortRange,

Name

OriginType, OriginValue, and OriginPortRange are required
fields; ClientIPPassThroughMode, SessionPersist,
SessionPersistTime, and RuleTag are optional fields; do notfill in RuleId and Status.

©2013-2022 Tencent Cloud. All rights reserved.

Page 320 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

L4ProxyRuleIds

Type

Description

Array
of

IDs of newly added forwarding rules, returned as an array.

String
The unique request ID, generated by the server, will be returned for every request
RequestId

String(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a Layer 4 proxy forwarding ruleThis example shows you how to create a forwarding rule in the instance with ProxyId 'sid-2qwk27xf7j9g' under thezone with ZoneId 'zone-24wjy25v1cwi'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateL4ProxyRules<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g","L4ProxyRules": [{"Protocol": "TCP","PortRange": ["80"],"OriginType": "IP_DOMAIN","OriginValue": ["119.23.100.45"],"OriginPortRange": "90",©2013-2022 Tencent Cloud. All rights reserved.

Page 321 of 760

Tencent Cloud EdgeOne"ClientIPPassThroughMode": "TOA","SessionPersist": "on","SessionPersistTime": 3600,"RuleTag": "test"}]}

Output Example{"Response": {"RequestId": "6f8h5358-df6d-4d2a-ac39-1706cbf8a707","L4ProxyRuleIds": ["rule-2qzkbvx3hxl1"]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 322 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

InvalidParameter.InvalidOriginValue

The origin server is incorrect or inexistent.

InvalidParameter.RulePortDuplicating

The rule port already exists.

LimitExceeded.ProxyRulesLimitExceeded

The number of rules imported has exceeded the limit.

OperationDenied

Operation denied.

OperationDenied.L4PortLackOfResources

The sale of Layer 4 port resources is booming and they have beensold out. We are urgently restocking. At present, it is not possible
to add new Layer 4 proxies or rules, and we kindly ask for yourpatience.

ResourceNotFound©2013-2022 Tencent Cloud. All rights reserved.

The resource doesn’t exist.

Page 323 of 760

Tencent Cloud EdgeOne

ModifyL4ProxyRules：

Last updated 2024-04-09 10:25:52

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify Layer 4 proxy forwarding rules, supporting both individual and batch modification.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringLayer 4 proxy instance ID.

L4ProxyRules.N

Yes

Array of

List of forwarding rules. A single request supports up to 200

L4ProxyRule

forwarding rules.

Name

Description
Common Params. The value used for this API:
ModifyL4ProxyRules.

Note: When L4ProxyRule is used here, RuleId is a required
field; Protocol, PortRange, OriginType, OriginValue,
OriginPortRange, ClientIPPassThroughMode,
SessionPersist, SessionPersistTime, and RuleTag are all©2013-2022 Tencent Cloud. All rights reserved.

Page 324 of 760

Tencent Cloud EdgeOne

optional fields. No modification is made when no value isspecified for those fields. Status should not be filled.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying Layer 4 proxy forwarding rules
This example shows you how to modify the RuleTag of the rule with RuleId 'rule-2qzkbvx3hxl7' in ProxyId 'sid2qwk27xf7j9g' of ZoneId 'zone-24wjy25v1cwi' as 'service-1', Protocol as 'TCP', and ClientIPPassThroughMode as'TOA'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyL4ProxyRules<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g","L4ProxyRules": [{"RuleId": "rule-2qzkbvx3hxl7","RuleTag": "service-1","Protocol": "TCP","ClientIPPassThroughMode": "TOA"}]}©2013-2022 Tencent Cloud. All rights reserved.

Page 325 of 760

Tencent Cloud EdgeOne

Output Example{"Response": {"RequestId": "3df3e931-3119-4237-adc7-7604e01e0fa9"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

InvalidParameter.ParameterError
OperationDenied©2013-2022 Tencent Cloud. All rights reserved.

Parameter error: Invalid “End time”. The interval between the startand end time cannot exceed 7 days.
Operation denied.

Page 326 of 760

Tencent Cloud EdgeOne

OperationDenied.L4ProxyInBannedStatus

Operation failed: The L4 proxy is blocked.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 327 of 760

Tencent Cloud EdgeOne

ModifyL4ProxyRulesStatus：

Last updated 2024-04-09 10:25:51

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to start or stop Layer 4 proxy forwarding rules, supporting both individual and batch operation.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringLayer 4 proxy instance ID.

RuleIds.N

Yes

Array of

List of forwarding rule IDs. It supports up to 200 forwarding

Stringrules at a time.

Name

Description
Common Params. The value used for this API:
ModifyL4ProxyRulesStatus.

Status of forwarding rules. Valid values:
StatusYes

String©2013-2022 Tencent Cloud. All rights reserved.

online: Enabled;
offline: Disabled.

Page 328 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying Layer 4 proxy forwarding rule status in batches
This example shows you how to disable all rules with RuleId 'rule-2qzkbvx3hxl7' and 'rule-3pszkbox0hm1' in ProxyId'sid-2qwk27xf7j9g' under the zone with ZoneId 'zone-24wjy25v1cwi'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyL4ProxyRulesStatus<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g","RuleIds": ["rule-2qzkbvx3hxl7","rule-3pszkbox0hm1"],"Status": "offline"}

Output Example{"Response": {"RequestId": "6f8h5358-3159-4337-adc7-7604e01e0fa9"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 329 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

OperationDenied

Operation denied.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled. Please enable it andtry again.

OperationDenied.L4ProxyInBannedStatus

Operation failed: The L4 proxy is blocked.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 330 of 760

Tencent Cloud EdgeOne

DescribeL4ProxyRules：

Last updated 2024-04-09 10:25:56

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the forwarding rule list under a Layer 4 proxy instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DescribeL4ProxyRules.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringLayer 4 proxy instance ID.

OffsetYes

Integer

Paginated query offset. Defaults to 0 when not specified.

Limit

Yes

Integer

Paginated query limit. Default value: 20. Maximum value: 1000.

Filters.N

No

Array

Filter criteria. The upper limit for Filters.Values is 20. All rule informationofunder the current Layer 4 instance will be returned if left empty. The

Filterdetailed filter criteria are as follows:Name©2013-2022 Tencent Cloud. All rights reserved.

Page 331 of 760

Tencent Cloud EdgeOne

rule-tag: Filters rules under the Layer 4 proxy instance according torule tag.

3. Output Parameters
Parameter
Name
TotalCount
L4ProxyRules

Type

Description

Integer

The total count of forwarding rules.

Array of
L4ProxyRule

List of forwarding rules.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying a Layer 4 proxy instance forwarding rule list
This example shows you how to query the list of forwarding rules with ProxyId 'sid-2qwk27xf7j9g' under the zone with
ZoneId 'zone-24wjy25v1cwi'.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeL4ProxyRules<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g","Offset": 1,"Limit": 0}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 332 of 760

Tencent Cloud EdgeOne{"Response": {"TotalCount": 1,"L4ProxyRules": [{"RuleId": "rule-2qzkbvx3hxl1","Protocol": "TCP","PortRange": ["80"],"OriginType": "IP_DOMAIN","OriginValue": ["119.23.100.45"],"OriginPortRange": "90","ClientIPPassThroughMode": "TOA","SessionPersist": "on","SessionPersistTime": 3600,"RuleTag": "test","Status": "online"}],"RequestId": "6f8h5358-cdda-4f82-b7sc-0aef4a219244"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 333 of 760

Tencent Cloud EdgeOne

Tencent Cloud CLI 3.0

6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 334 of 760

Tencent Cloud EdgeOne

DeleteL4ProxyRules：

Last updated 2024-04-09 10:25:58

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete Layer 4 proxy forwarding rules, supporting both individual and batch operation.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

ProxyId

Yes

StringLayer 4 proxy instance ID.

RuleIds.N

Yes

Array of

List of forwarding rule IDs. It supports up to 200 forwarding

Stringrules at a time.

Name

Description
Common Params. The value used for this API:
DeleteL4ProxyRules.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 335 of 760

Tencent Cloud EdgeOne

Parameter

Type

Description

Name
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting Layer 4 proxy forwarding rules in batches
This example shows you how to delete the rules with RuleId 'rule-2qzkbvx3hxl7' and 'rule-3pszkbox0hm1' in ProxyId'sid-2qwk27xf7j9g' under the zone with ZoneId 'zone-24wjy25v1cwi' in batches.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteL4ProxyRules<Common Request Parameters>{"ZoneId": "zone-24wjy25v1cwi","ProxyId": "sid-2qwk27xf7j9g","RuleIds": ["rule-2qzkbvx3hxl7","rule-3pszkbox0hm1"]}

Output Example{"Response": {"RequestId": "6f8h5358-3159-4337-adc7-7604e01e0fa9"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 336 of 760

Tencent Cloud EdgeOne

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 337 of 760

Tencent Cloud EdgeOne

CreateApplicationProxy：

Last updated 2024-04-09 10:26:02

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version [CreateL4Proxy](https://www.tencentcloud.com/document/product/1552/103417?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

ActionYes

String

VersionYes

StringRegionNo

StringZoneIdYesStringDescription
Common Params. The value used for this
API: CreateApplicationProxy.
Common Params. The value used for this
API: 2022-09-01.
Common Params. This parameter is not
required.
Site ID.
Domain name or subdomain name when

ProxyName

Yes

StringProxyType=hostname ;Instance name when
ProxyType=instance .

PlatType

Yes

String©2013-2022 Tencent Cloud. All rights reserved.

The scheduling mode. Values:

Page 338 of 760

Tencent Cloud EdgeOne

ip : Schedule via Anycast IP.
domain : Schedule via CNAME.
Whether to enable security protection.
SecurityType

Yes

Integer

Values:0 : Disable security protection.
1 : Enable security protection.
Whether to enable acceleration. Values:

AccelerateType

Yes

Integer

0 : Disable acceleration.
1 : Enable acceleration.
Layer 4 proxy mode, with value:

ProxyTypeNo

Stringinstance: instance mode.
If not specified, the default value instancewill be used.
The session persistence duration. Value

SessionPersistTime

No

Integerrange: 30-3600 (in seconds).
If not specified, this field uses the default
value 600.

Ipv6

No

ApplicationProxyRules.N

AccelerateMainland

No

No

Ipv6

Array of
ApplicationProxyRule

AccelerateMainland

Ipv6 access configuration.
IPv6 access is disabled if it is not specified.
The rule details.
If this field is not specified, an application
proxy rule will not be created.
Cross-MLC-border acceleration. It isdisabled if this parameter is not specified.

3. Output Parameters
Parameter

Type

Description

ProxyId

String

The L4 application proxy ID.

RequestId

StringName

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 339 of 760

Tencent Cloud EdgeOne

4. Example
Example1 Creating an application proxyThis example shows you how to create an application proxy.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApplicationProxy<Common request parameters>{"ZoneId": "zone-21xfqlh4qjee","ProxyName": "instancd-name","ProxyType": "instance","PlatType": "ip","SecurityType": 1,"AccelerateType": 1,"SessionPersistTime": 3600,"Ipv6": {"Switch": "on"},"ApplicationProxyRules": [{"Proto": "TCP","Port": [
"80",
"90",
"99-110"],"OriginType": "custom","OriginValue": ["1.1.1.1:80"]},{"Proto": "UDP","Port": ["999","888","99-110"],"OriginType": "custom",©2013-2022 Tencent Cloud. All rights reserved.

Page 340 of 760

Tencent Cloud EdgeOne"OriginValue": ["1.1.1.1:80","2.2.2.2:80"]}]}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707","ProxyId": "proxy-537f5b41-162a-11ed-abaa-525400c5da15"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 341 of 760

Tencent Cloud EdgeOne

Error CodeDescription

FailedOperation

Operation failed.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback
address.
Parameter error: Invalid “End time”. The interval

InvalidParameter.ParameterError

between the start and end time cannot exceed 7
days.

InvalidParameter.ProxyNameDuplicating

The instance name already exists.
Instance name can contain 1 to 50 characters.
The allowed characters are a to z, 0 to 9, and -.

InvalidParameter.ProxyNameNotMatched- cannot be registered alone or used
continuously and cannot be placed at the
beginning or the end.

LimitExceeded

The quota limit has been reached.

LimitExceeded.UserQuotaLimited

User instance quantity limitation.

OperationDenied

Operation denied.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled.
Please enable it and try again.
This site is using Anycast IP scheduling mode

OperationDenied.PlatTypeIPAccelerateMainlandNotSupportand does not support Cross-MLC-borderacceleration.

OperationDenied.ZoneNotActive

The zone is disabled.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 342 of 760

Tencent Cloud EdgeOne

ModifyApplicationProxy：

Last updated 2024-04-09 10:25:55

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see[ModifyL4Proxy] (https://www.tencentcloud.com/document/product/1552/103411?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringRegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID.

ProxyId

Yes

StringProxy ID.

Common Params. The value used for this API:
ModifyApplicationProxy.
Common Params. The value used for this API:2022-09-01.

Domain name or subdomain name when
ProxyName

Yes

StringProxyType=hostname ;Instance name when ProxyType=instance .

©2013-2022 Tencent Cloud. All rights reserved.

Page 343 of 760

Tencent Cloud EdgeOne

SessionPersistTime

No

Integer

The session persistence duration. Value range:
30-3600 (in seconds).
The original configuration will apply if this field is
not specified.
L4 proxy mode. Valid values:

ProxyTypeNo

String

Ipv6

No

Ipv6

AccelerateMainlandNo

AccelerateMainland

instance: Instance mode.
If it is not specified, instance is used by default.
IPv6 access configuration. The original
configuration will apply if it is not specified.
Cross-MLC-border acceleration. The original
configuration will apply if it is not specified.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modify Application Proxy
Modify the application proxy.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApplicationProxy<Common request parameters>{"ZoneId": "zone-21xfqlh4qjee","ProxyId": "proxy-537f5b41-162a-11ed-abaa-525400c5da15","ProxyName": "ssss","ProxyType": "instance",©2013-2022 Tencent Cloud. All rights reserved.

Page 344 of 760

Tencent Cloud EdgeOne"SessionPersistTime": 3600,"Ipv6": {"Switch": "on"}}Output Example{"Response": {"RequestId": "b03fe5dd-be04-444c-a2e1-49f1bf2f399a"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 345 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

OperationDenied

Operation denied.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled. Please enable it andtry again.
The layer-4 instance resource sales are skyrocketing and now the

OperationDenied.L4LackOfResources

resources are sold out. Replenishing is in progress. Currently,
new layer-4 proxies cannot be added. Please wait.

OperationDenied.L4ProxyInBannedStatus

Operation failed: The L4 proxy is blocked.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 346 of 760

Tencent Cloud EdgeOne

ModifyApplicationProxyStatus：

Last updated 2024-04-09 10:25:53

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see[ModifyL4ProxyStatus] (https://www.tencentcloud.com/document/product/1552/103408?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

ProxyId

Yes

String

The proxy ID.

Description
Common Params. The value used for this API:
ModifyApplicationProxyStatus.

The proxy status. Values:
StatusYes

Stringoffline : The proxy is disabled.
online : The proxy is enabled.

©2013-2022 Tencent Cloud. All rights reserved.

Page 347 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the status of an application proxy
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApplicationProxyStatus<Common request parameters>{"ZoneId": "zone-276zs184g93m","ProxyId": "proxy-19389e5dwwxfs","Status": "online"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 348 of 760

Tencent Cloud EdgeOne

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ConfigLocked

The configuration is locked. Please unlock and try again.

InternalError.ProxyServer

An unknown error occurred in the backend server.

OperationDenied

Operation denied.

OperationDenied.DisableZoneNotCompleted

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is being disabled. Please try
again later.
The EdgeOne service of the site is disabled. Please enable itand try again.

OperationDenied.L4ProxyInBannedStatus

Operation failed: The L4 proxy is blocked.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 349 of 760

Tencent Cloud EdgeOne

DescribeApplicationProxies：

Last updated 2024-04-09 10:25:57

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. In the latest version, this API
has been split into two APIs: one for querying the Layer 4 proxy instance list and the other for querying Layer 4
forwarding rules. For details, see [DescribeL4Proxy] (https://www.tencentcloud.com/document/product/1552/103413?
from_cn_redirect=1) and [DescribeL4ProxyRules] (https://www.tencentcloud.com/document/product/1552/103412?
from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeApplicationProxies.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdNo

StringZone ID. This parameter is required.

Filters.N

No

Array ofFilters. Each filter can have up to 20 entries. Details:

Filterproxy-id
Filter by the Proxy ID, such as: proxy-ev2sawbwfd .

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 350 of 760

Tencent Cloud EdgeOne

Type: String
Required: No
zone-id
Filter by the Site ID, such as zone-vawer2vadg .
Type: String
Required: No
rule-tag
Filter by the Rule tag, such as rule-service-1 .
Type: String
Required: No
OffsetNo

Integer

Limit

No

Integer

The paginated query offset. Default value: 0
The paginated query limit. Default value: 20. Maximum value:
1000.

3. Output Parameters
Parameter Name
ApplicationProxies
TotalCount

RequestId

Type
Array of
ApplicationProxy
IntegerStringDescription
List of application proxies.
Total number of records.
The unique request ID, generated by the server, will be returned forevery request (if the request fails to reach the server for otherreasons, the request will not obtain a RequestId). RequestId isrequired for locating a problem.

4. Example
Example1 Querying the list of application proxies
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationProxies<Common request parameters>©2013-2022 Tencent Cloud. All rights reserved.

Page 351 of 760

Tencent Cloud EdgeOne{"Offset": 0,"Limit": 10}

Output Example{"Response": {"RequestId": "a84ae15a-aca5-4c24-a4f4-c419cf2c18af","ApplicationProxies": [{"HostId": "","ProxyType": "instance","Area": "mainland","AccelerateType": 1,"SessionPersistTime": 100,
"PlatType": "domain","ProxyId": "proxy-34c74aa7-9a9f-11ec-bcb0-52540015711d","ProxyName": "zone-f835533b8998f","ZoneId": "zone-21xfqlh4qjee","ZoneName": "123.com","ApplicationProxyRules": [{"OriginType": "custom","OriginValue": ["81.69.174.153:80"],"Port": ["80"],"OriginPort": "8080","SessionPersistTime": 100,
"Proto": "TCP","Status": "online","ForwardClientIp": "off","SessionPersist": true,"RuleId": "rule-34c74ab8-9a9f-11ec-bcb0-52540015711d","RuleTag": "rule-for-cgi"},{"OriginType": "custom","OriginValue": ["81.69.174.153:553"],"Port": [©2013-2022 Tencent Cloud. All rights reserved.

Page 352 of 760

Tencent Cloud EdgeOne

"553"
],
"Proto": "UDP","Status": "online","ForwardClientIp": "off","SessionPersist": true,"OriginPort": "8080","SessionPersistTime": 100,
"RuleId": "rule-4bc1d3d6-9aa0-11ec-bcb0-52540015711d","RuleTag": "rule-for-logic"}],"AccelerateMainland": {"Switch": "off"},"ScheduleValue": [],"SecurityType": 1,"Ipv6": {"Switch": "on"},"Status": "progress","BanStatus": "recover","UpdateTime": "2022-03-03T06:06:10Z"}],"TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 353 of 760

Tencent Cloud EdgeOne

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

OperationDenied

Operation denied.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 354 of 760

Tencent Cloud EdgeOne

DeleteApplicationProxy：

Last updated 2024-04-09 10:26:00

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see[DeleteL4Proxy] (https://www.tencentcloud.com/document/product/1552/103415?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

ProxyId

Yes

String

The proxy ID.

Name

Description
Common Params. The value used for this API:
DeleteApplicationProxy.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 355 of 760

Tencent Cloud EdgeOne

Name

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting an application proxy
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteApplicationProxy<Common request parameters>{"ZoneId": "zone-276zs184g93m","ProxyId": "proxy-19389e5dwwxfs"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 356 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 357 of 760

Tencent Cloud EdgeOne

CreateApplicationProxyRule：

Last updated 2024-04-09 10:26:02

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see[CreateL4ProxyRules] (https://www.tencentcloud.com/document/product/1552/103416?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

ProxyId

Yes

String

The proxy ID.

Common Params. The value used for this API:
CreateApplicationProxyRule.

The protocol. Values:
Proto

Yes

String

TCP : TCP protocol
UDP : UDP protocol

Port.N

Yes

Array of

The access port, which can be:

StringA single port, such as 80
A port range, such as 81-90©2013-2022 Tencent Cloud. All rights reserved.

Page 358 of 760

Tencent Cloud EdgeOne

Origin server type. Valid values:
OriginType

Yes

Stringcustom: Manually added;
loadbalancer: Cloud Load Balancer;
origins: Origin server group.
Details of the origin server:
When OriginType is custom, it indicates one or more origin
servers, such as ["8.8.8.8","9.9.9.9"] or OriginValue=

OriginValue.N

Yes

Array of
String["test.com"];
When OriginType is loadbalancer, it indicates a single
Cloud Load Balancer, such as ["lb-xdffsfasdfs"];
When OriginType is origins, it requires one and only one
element, which represents an origin server group ID, such as["origin-537f5b41-162a-11ed-abaa-525400c5da15"].
Passes the client IP. Values:
TOA : Pass the client IP via TOA (available only when
Proto=TCP ).

ForwardClientIp

No

String

PPV1 : Pass the client IP via Proxy Protocol V1(available only when Proto=TCP ).
PPV2 : Pass the client IP via Proxy Protocol V2.
OFF : Not pass the client IP.
Default value: OFF.

SessionPersist

No

BooleanWhether to enable session persistence. Values:
true : Enable.
false : Disable.
Default value: false.

SessionPersistTime

OriginPort

No

No

IntegerStringDuration for the persistent session. The value takes effect only
when SessionPersist = true .
The origin port, which can be:
A single port, such as 80
A port range, such as 81-82

RuleTagNo

StringRule tag. This parameter is left empty by default.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 359 of 760

Tencent Cloud EdgeOne

RuleIdString

The rule ID.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating an application proxy ruleThis example shows you how to create an application proxy rule.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApplicationProxyRule<Common Request Parameters>{"ZoneId": "zone-21xfqlh4qjee","ProxyId": "proxy-19389e5dwwxfs","Proto": "TCP","Port": ["99-110"],"OriginType": "custom","OriginValue": ["1.1.1.1"],"OriginPort": "99-110","ForwardClientIp": "TOA","SessionPersist": false,"RuleTag": "rule-service-1"}

Output Example{"Response": {"RequestId": "3df3e931-3159-4337-adc7-7604e01e0fa9","RuleId": "rule-a8f0d49a-33d7-11ed-9b89-52540005c111"©2013-2022 Tencent Cloud. All rights reserved.

Page 360 of 760

Tencent Cloud EdgeOne}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

InvalidParameter.InvalidRuleProto

Incorrect protocol of the rules. (TCP/UDP).

InvalidParameter.ParameterError
InvalidParameter.RuleOriginFormatError©2013-2022 Tencent Cloud. All rights reserved.

Parameter error: Invalid “End time”. The interval between the startand end time cannot exceed 7 days.
Incorrect origin server information format of the rules.

Page 361 of 760

Tencent Cloud EdgeOne

InvalidParameter.RuleOriginMultiDomain

The origin of the rule does not support multiple domain names.

InvalidParameter.RuleOriginPortInteger

The origin port of the rule must be an integer.

InvalidParameter.RuleOriginValueError

Invalid origin in the rule.

InvalidParameter.RulePortDuplicating

The rule port already exists.

InvalidParameter.RulePortGroup

Incorrect port number segment of the rules.

InvalidParameter.RulePortInteger

The port number of the rules must be an integer.

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 362 of 760

Tencent Cloud EdgeOne

ModifyApplicationProxyRule：

Last updated 2024-04-09 10:25:54

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see[ModifyL4ProxyRules] (https://www.tencentcloud.com/document/product/1552/103410?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

ProxyId

Yes

String

The proxy ID.

RuleIdYesString

The rule ID.

Common Params. The value used for this API:
ModifyApplicationProxyRule.

Origin server type. Valid values:
OriginType

Yes

Stringcustom: Manually added;
origins: Origin server group.

Port.N

Yes

Array of©2013-2022 Tencent Cloud. All rights reserved.

The access port, which can be:

Page 363 of 760

Tencent Cloud EdgeOne

StringA single port, such as 80
A port range, such as 81-90
The protocol. Values:

Proto

No

String

TCP : TCP protocol
UDP : UDP protocol
The original configuration will apply if this field is not specified.
Origin server information:
When OriginType=custom , it indicates one or more

OriginValue.N

No

Array of
Stringorigin servers, such as ["8.8.8.8","9.9.9.9"] or ["test.com"].
When OriginType=origins , it indicates an origingroup ID, such as ["origin-537f5b41-162a-11ed-abaa525400c5da15"].

The original configuration will apply if this field is not specified.
Passes the client IP. Values:
TOA : Pass the client IP via TOA (available only when
Proto=TCP ).
ForwardClientIp

No

String

PPV1 : Pass the client IP via Proxy Protocol V1(available only when Proto=TCP ).
PPV2 : Pass the client IP via Proxy Protocol V2.
OFF : Not pass the client IP.
If not specified, this field uses the default value OFF.
Whether to enable session persistence. Values:

SessionPersist

No

Booleantrue : Enablefalse : Disable
If it is left empty, the default value false is used.

SessionPersistTime

No

Integer

Duration for the persistent session. The value takes effect only
when SessionPersist = true .
The origin port, which can be:

OriginPort

No

StringRuleTagNo

StringA single port, such as 80
A port range, such as 81-82
Rule tag. The original configuration will apply if it is not
specified.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 364 of 760

Tencent Cloud EdgeOne

Parameter
Name

Type

Description

The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying an application proxy ruleThis example shows you how to modify an application proxy rule.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApplicationProxyRule<Common Request Parameters>{"ZoneId": "zone-276zs184g93m","ProxyId": "proxy-19389e5dwwxfs","RuleId": "rule-5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707","Proto": "TCP","Port": ["99-110"],"OriginType": "custom","OriginValue": ["1.1.1.1"],"OriginPort": "99-110","ForwardClientIp": "TOA","SessionPersist": false,"RuleTag": "rule-service-1"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"©2013-2022 Tencent Cloud. All rights reserved.

Page 365 of 760

Tencent Cloud EdgeOne}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

InvalidParameter.ParameterError

Parameter error: Invalid “End time”. The interval between the startand end time cannot exceed 7 days.

OperationDenied

Operation denied.

OperationDenied.L4ProxyInBannedStatus

Operation failed: The L4 proxy is blocked.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 366 of 760

Tencent Cloud EdgeOne

ModifyApplicationProxyRuleStatus：

Last updated 2024-04-09 10:25:54

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see[ModifyL4ProxyRulesStatus] (https://www.tencentcloud.com/document/product/1552/103409?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

ProxyId

Yes

String

The proxy ID.

RuleIdYesString

The rule ID.

StatusYes

String

The rule status. Values:

Description
Common Params. The value used for this API:
ModifyApplicationProxyRuleStatus.

offline : Disabled©2013-2022 Tencent Cloud. All rights reserved.

Page 367 of 760

Tencent Cloud EdgeOne

online : Enabled

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying the status of an application proxy rule
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApplicationProxyRuleStatus<Common request parameters>{"ZoneId": "zone-276zs184g93m","ProxyId": "proxy-19389e5dwwxfs","RuleId": "rule-19389e5a-118b-11ed-9951-525400655ede","Status": "offline"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 368 of 760

Tencent Cloud EdgeOne

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

OperationDenied

Operation denied.

OperationDenied.ErrZoneIsAlreadyPaused

The EdgeOne service of the site is disabled. Please enable it andtry again.

OperationDenied.L4ProxyInBannedStatus

Operation failed: The L4 proxy is blocked.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 369 of 760

Tencent Cloud EdgeOne

DeleteApplicationProxyRule：

Last updated 2024-04-09 10:25:59

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is on an earlier version. If you want to call it, please switch to the latest version. For details, see[DeleteL4ProxyRules] (https://www.tencentcloud.com/document/product/1552/103414?from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesString

The site ID.

ProxyId

Yes

String

The proxy ID.

RuleIdYesString

The rule ID.

Description
Common Params. The value used for this API:
DeleteApplicationProxyRule.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 370 of 760

Tencent Cloud EdgeOne

Parameter

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

Name

RequestId

4. Example
Example1 Deleting an application proxy rule
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteApplicationProxyRule<Common request parameters>{"ZoneId": "zone-276zs184g93m","ProxyId": "proxy-19389e5dwwxfs","RuleId": "rule-19389e5a-118b-11ed-9951-525400655ede"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 371 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnsupportedOperation

Unsupported operation.

©2013-2022 Tencent Cloud. All rights reserved.

Page 372 of 760

Tencent Cloud EdgeOne

Content Management APIs
CreatePurgeTask：

Last updated 2024-06-05 14:40:58

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
When there are resources updated on the origin with the TTL remaining valid, users cannot access the latest
resources. In this case, you can purge the cache using this API. There are two methods:
Delete: This method deletes the node cache without verification and retrieves the latest resources from the origin
when receiving a request.
Invalidate: This method marks the node cache as invalid and sends a request with the If-None-Match and IfModified-Since headers to the origin. If the origin responses with 200, the latest resources are retrieved to be cachedon the node. If a 304 response is returned, the latest resources are not cached on the node.
For more details, see [Cache Purge](https://www.tencentcloud.com/document/product/1552/70759?
from_cn_redirect=1).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreatePurgeTask.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

©2013-2022 Tencent Cloud. All rights reserved.

Page 373 of 760

Tencent Cloud EdgeOne

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site.
Type of cache purging. Values:
purge_url : Purge by the URL
purge_prefix : Purge by the directory

Type

Yes

Stringpurge_host : Purge by the hostname
purge_all : Purge all caches
purge_cache_tag : Purge by the cache-tag
For more details, see Cache Purge.
Node cache purge method, valid for directory, hostname, and allcache refreshes. Valid values:
invalidate: Refreshes only resources that were updated under the

MethodNo

Stringdirectory;
delete: Refreshes all node resources, regardless of whether they
were updated.
Default value: invalidate.
List of resources for which cache is to be purged. Each element
format depends on the cache purge type and you can refer to the API

Targets.N

No

Array of
Stringexamples for details.
The number of tasks that can be submitted at a time is limited by
the quota of a billing package. For details, see [Billing Overview](https://www.tencentcloud.com/document/product/1552/77380?
from_cn_redirect=1).

CacheTagNo

CacheTag

The information attached when the node cache purge type is set topurge_cache_tag.

3. Output Parameters
Parameter

Type

Description

JobId

StringID of the task.

FailedList

Array of
FailReason

List of failed tasks and reasons.
Note: This field may return null, indicating that no valid values can be obtained.

String

The unique request ID, generated by the server, will be returned for every request(if the request fails to reach the server for other reasons, the request will not obtain

Name

RequestIda RequestId). RequestId is required for locating a problem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 374 of 760

Tencent Cloud EdgeOne

4. Example
Example1 Purging by the URL
By using Delete method, resources under a URL that matches the specified hostname are removed.
This example shows you how to purge resources in the directory /a.txt under the site domain www.example.com.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask<Common request parameters>{"Targets": ["http://www.example.com/a.txt"],"Type": "purge_url","ZoneId": "zone-ajj243dwrew"}

Output Example{"Response": {"JobId": "20ga521cpwch","FailedList": [],"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"}}

Example2 Purging by the hostname
By using Invalidate method, resources under a domain name that matches the specified hostname are marked as
invalid.
This example shows you how to purge resources changed under the site domain www.example.com.
Note: Domain names cannot include wildcards (*).
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 375 of 760

Tencent Cloud EdgeOne

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask<Common request parameters>{"Targets": ["www.example.com"],"Type": "purge_host","ZoneId": "zone-ajj243dwrew"}

Output Example{"Response": {"JobId": "20ga521cpwcs","FailedList": [],"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"}}

Example3 Purging by the Cache-Tag
By using Invalidate method, resources under a site are associated with tags in the HTTP response header Cache-Tag
and marked as invalid.
This example shows you how to purge resources that contain tag1, tag2 and tag3 and have changed under the site
example.com.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask<Common request parameters>{"Targets": ["tag1","tag2","tag3"©2013-2022 Tencent Cloud. All rights reserved.

Page 376 of 760

Tencent Cloud EdgeOne],"Type": "purge_cache_tag","ZoneId": "zone-ajj243dwrew"}

Output Example{"Response": {"JobId": "20ga521cpwcs","FailedList": [],"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"}}

Example4 Purging all caches under a site
By using Invalidate method, all cached resources under a site are marked as invalid.
This example shows you how to purge all cached resources changed under the site example.com.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask<Common request parameters>{"Type": "purge_all","ZoneId": "zone-ajj243dwrew"}

Output Example{"Response": {"JobId": "20ga521cpwcs","FailedList": [],"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"}}

Example5 Purging by the directory – Deleting resources in the directory©2013-2022 Tencent Cloud. All rights reserved.

Page 377 of 760

Tencent Cloud EdgeOne

To purge all resources under a directory, pass delete into the Method field.
This example shows you how to purge all resources in the /test directory under www.example.com.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask<Common request parameters>{"Targets": ["http://www.example.com/test/"],"Type": "purge_prefix","Method": "delete","ZoneId": "zone-ajj243dwrew"}

Output Example{"Response": {"JobId": "20ga521cpwck","FailedList": [],"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"}}

Example6 Only purging resources updated in the directory
To purge the resources updated under a directory, pass invalidate into the Method field.
This example shows you how to purge resources changed in the directory /test under the site domainwww.example.com.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask<Common request parameters>©2013-2022 Tencent Cloud. All rights reserved.

Page 378 of 760

Tencent Cloud EdgeOne{"Targets": ["http://www.example.com/test/"],"Type": "purge_prefix","Method": "invalidate","ZoneId": "zone-ajj243dwrew"}

Output Example{"Response": {"JobId": "20ga521cpwcj","FailedList": [],"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 379 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.BackendError

Server error.

InternalError.DomainConfig

Failed to get configuration

InternalError.ProxyServer

An unknown error occurred in the backend server.

InternalError.QuotaSystem

Server error.

InvalidParameter.DomainNotFoundThe domain name does not exist or is not belong to this account.

InvalidParameter.ParameterError

Parameter error: Invalid “End time”. The interval between the startand end time cannot exceed 7 days.

InvalidParameter.Target

Resource error

InvalidParameter.TaskNotGenerated

Failed to create the task

InvalidParameter.UploadUrl

Invalid file upload link.

LimitExceeded.BatchQuota

Reached the upper limit of resource number

LimitExceeded.DailyQuota

Reached the daily upper limit of resource number

LimitExceeded.PackNotAllow

Not supported by the plan.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission
UnauthorizedOperation.Unknown©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.
An unknown error occurred in the backend server.

Page 380 of 760

Tencent Cloud EdgeOne

DescribePurgeTasks：

Last updated 2024-05-29 14:55:56

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
DescribePurgeTasks is used to query the submitted URL refreshing and directory refreshing records and execution
progress. This interface can be used to query the tasks submitted by the CreatePurgeTasks API.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribePurgeTasks.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdNo

StringZoneId. The parameter is required.

StartTimeNo

Timestamp
ISO8601

Start time of the query. Either time or job-id is required.

EndTimeNo

Timestamp
ISO8601

End time of the query. Either time or job-id is required.

OffsetNo

Integer

Offset for paginated queries. Default value: 0 .

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 381 of 760

Tencent Cloud EdgeOne

Limit

No

Integer

Limit on paginated queries. Default value: 20 . Maximum
value: 1000 .
Filtering condition. The maximum value of Filters.Values is 20.
Detailed filtering conditions:job-idFilter based on task ID. job-id format: 1379afjk91u32h. Multiple
values are not supported, Fuzzy search is not supported;
targetFilter based on: target resource information. target format:
http://www.qq.com/1.txt or tag1. Multiple values are notsupported, Fuzzy search is not supported;
domains
Filter based on domain name. domains format: www.qq.com,
Fuzzy search is not supported;

Filters.N

No

Array of
AdvancedFilter

statuses
Filter based on task status, Fuzzy search is not supported.
Options:
processing: Processing
success: Successfailed: Failure
timeout: Timeout
type
Filter based on cleared cache type. Multiple values are notsupported, Fuzzy search is not supported. Options:purge_url: URL
purge_prefix: Prefix
purge_all: All cache content
purge_host: Hostname
purge_cache_tag: CacheTag

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total entries that match the specified query condition.

Tasks

Array
of

List of tasks returned.

Task
RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a©2013-2022 Tencent Cloud. All rights reserved.

Page 382 of 760

Tencent Cloud EdgeOne

RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying Historical Records of Cache Purging
After the refreshing task is submitted by using CreatePurgeTasks, use this API to query the refreshing task records
and execution progress.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePurgeTasks<Common request parameters>{"ZoneId": "zone-wz8m9mgx","StartTime": "2022-02-09T00:00:00+08:00","EndTime": "2022-02-09T23:59:00+08:00","Limit": 1,"Offset": 7}

Output Example{"Response": {"RequestId": "abc-afhhakf-24hkahf-2424","Tasks": [{"JobId": "20g9wz8m9mgx","Status": "success","Target": "http://www.qq.com/a.txt","Type": "purge_url","CreateTime": "2022-02-09T02:28:43Z","UpdateTime": "2022-02-09T02:28:52Z"}],"TotalCount": 8}}©2013-2022 Tencent Cloud. All rights reserved.

Page 383 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

InvalidParameter.ParameterError

Parameter error: Invalid “End time”. The interval between the start and end
time cannot exceed 7 days.

OperationDenied

Operation denied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 384 of 760

Tencent Cloud EdgeOne

CreatePrefetchTask：

Last updated 2024-04-09 10:26:13

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a pre-warming task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreatePrefetchTask.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site.

Name

List of resources to be preheated. Each element format is similar to thefollowing:
http://www.example.com/example.txt. The parameter value is currently
Targets.N

No

Array of
Stringrequired.
Note: The number of tasks that can be submitted is limited by the quota
of a billing package. For details, see [Billing Overview](https://www.tencentcloud.com/document/product/1552/77380?
from_cn_redirect=1).

EncodeUrl

No

BooleanWhether to encode a URL according to RFC3986. Enable this field©2013-2022 Tencent Cloud. All rights reserved.

Page 385 of 760

Tencent Cloud EdgeOne

when the URL contains non-ASCII characters.
Headers.N

No

Array of
HeaderHTTP header information

3. Output Parameters
Parameter
Name

Type

Description

JobId

StringID of the task.

FailedList

Array of
FailReason

List of failed tasks.
Note: This field may return null, indicating that no valid values can be obtained.
The unique request ID, generated by the server, will be returned for every request

RequestId

String(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Pre-warming a URL
The example shows you how to submit a pre-warming task.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrefetchTask<Common request parameters>{"Targets": ["http://www.qq.com/a.txt"],"ZoneId": "zone-ajj243dwrew","EncodeUrl": true}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 386 of 760

Tencent Cloud EdgeOne{"Response": {"JobId": "20ga521cpwch","FailedList": [],"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.BackendError

Server error.

InternalError.DomainConfig

Failed to get configuration

InternalError.FailedToGenerateUrl

Failed to generate an upload link.

InternalError.QuotaSystem

Server error.

©2013-2022 Tencent Cloud. All rights reserved.

Page 387 of 760

Tencent Cloud EdgeOne

InvalidParameter.DomainNotFoundThe domain name does not exist or is not belong to this account.

InvalidParameter.ParameterError

Parameter error: Invalid “End time”. The interval between the startand end time cannot exceed 7 days.

InvalidParameter.Target

Resource error

InvalidParameter.TaskNotGenerated

Failed to create the task

InvalidParameter.UploadUrl

Invalid file upload link.

LimitExceeded.BatchQuota

Reached the upper limit of resource number

LimitExceeded.DailyQuota

Reached the daily upper limit of resource number

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Please getpermissions first.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 388 of 760

Tencent Cloud EdgeOne

DescribePrefetchTasks：

Last updated 2024-05-29 14:55:56

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
DescribePrefetchTasks is used to query the submission history and execution progress of preheating tasks. This
interface can be used to query the tasks submitted by the CreatePrefetchTasks interface.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdNo

StringZoneId. The parameter is required.

StartTimeNo

EndTimeNo

Timestamp
ISO8601

End time of the query. Either time or job-id is required.

OffsetNo

Integer

Offset for paginated queries. Default value: 0 .

Timestamp
ISO8601©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
DescribePrefetchTasks.

Start time of the query. Either time or job-id is required.

Page 389 of 760

Tencent Cloud EdgeOne

Limit

No

Integer

Limit on paginated queries. Default value: 20 . Maximum
value: 1000 .
Filtering condition. The maximum value of Filters.Values is 20.
Detailed filtering conditions:job-idFilter based on task ID. job-id format: 1379afjk91u32h. Multiple
values are not supported, Fuzzy search is not supported.
targetFilter based on target resource information. target format:
http://www.qq.com/1.txt. Multiple values are not supported,

Filters.N

No

Array of
AdvancedFilter

Fuzzy search is not supported.
domains
Filter based on domain name. domains format: www.qq.com.
Fuzzy search is not supported.
statuses
Filter based on task status. Fuzzy search is not supported.
Options:
processing: Processing
success: Successfailed: Failure
timeout: Timeout

3. Output Parameters
Parameter

Type

Description

TotalCount

Integer

Total entries that match the specified query condition.

Tasks

Array
of
Task

List of tasks returned.

Name

The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying Preheating Tasks©2013-2022 Tencent Cloud. All rights reserved.

Page 390 of 760

Tencent Cloud EdgeOne

After the preheating task is submitted by using CreatePrefetchTasks, use this API to query the preheating task
records and execution progress.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrefetchTasks<Common request parameters>{"ZoneId": "zone-z8m9mgx","StartTime": "2022-02-09T00:00:00+08:00","EndTime": "2022-02-09T23:59:00+08:00","Limit": 1,"Offset": 7}

Output Example{"Response": {"RequestId": "abc-afhhakf-24hkahf-2424","Tasks": [{"JobId": "20g9wz8m9mgx","Status": "success","Target": "http://www.qq.com/a.txt","Type": "prefetch_url","CreateTime": "2022-02-09T02:28:43Z","UpdateTime": "2022-02-09T02:28:52Z"}],"TotalCount": 8}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 391 of 760

Tencent Cloud EdgeOne

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

InvalidParameter.ParameterError

Parameter error: Invalid “End time”. The interval between the start andend time cannot exceed 7 days.

OperationDenied

Operation denied.

UnauthorizedOperation.DomainEmpty

Authentication error.

©2013-2022 Tencent Cloud. All rights reserved.

Page 392 of 760

Tencent Cloud EdgeOne

DescribeContentQuota：

Last updated 2024-04-09 10:26:12

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query content management quotas.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site.

Name

Description
Common Params. The value used for this API:
DescribeContentQuota.

3. Output Parameters
Parameter
Name
PurgeQuota

Type

Description

Array

Purging quotas.

©2013-2022 Tencent Cloud. All rights reserved.

Page 393 of 760

Tencent Cloud EdgeOne

ofNote: This field may return null, indicating that no valid values can be obtained.

Quota

PrefetchQuota

Array
of
Quota

Pre-warming quotas.
Note: This field may return null, indicating that no valid values can be obtained.
The unique request ID, generated by the server, will be returned for every request

RequestId

String(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying quota
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeContentQuota<Common request parameters>{"ZoneId": "zone-ajj243dwrew"}

Output Example{"Response": {"RequestId": "abc-ajj243-afjkj245-af","PrefetchQuota": [{"Batch": 2000,"Daily": 10000,"DailyAvailable": 10000,"Type": "prefetch_url"}],"PurgeQuota": [{"Batch": 2000,"Daily": 10000,©2013-2022 Tencent Cloud. All rights reserved.

Page 394 of 760

Tencent Cloud EdgeOne"DailyAvailable": 10000,"Type": "purge_url"},{"Batch": 2000,"Daily": 10000,"DailyAvailable": 10000,"Type": "purge_prefix"},{"Batch": 2000,"Daily": 10000,"DailyAvailable": 10000,"Type": "purge_host"},{"Batch": 2000,"Daily": 10000,"DailyAvailable": 10000,"Type": "purge_all"}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 395 of 760

Tencent Cloud EdgeOne

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Please getpermissions first.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 396 of 760

Tencent Cloud EdgeOne

Data Analysis APIs
DescribeDDoSAttackData：

Last updated 2024-04-09 10:26:10

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the time-series data of DDoS attacks.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

StartTimeYes

EndTimeYes

MetricNames.N

Yes

Timestamp
ISO8601

Description
Common Params. The value used for this API:
DescribeDDoSAttackData.

Start time of the query period.

Timestamp
ISO8601

End time of the query period.

Array of
StringStatistical metrics.
ddos_attackMaxBandwidth : Peak attack
bandwidth;©2013-2022 Tencent Cloud. All rights reserved.

Page 397 of 760

Tencent Cloud EdgeOne

ddos_attackMaxPackageRate : Peak attack
packet rate;
ddos_attackBandwidth : Time-series data of attack
bandwidth;
ddos_attackPackageRate : Time-series data ofattack packet rate.
ZoneIds.N

No

PolicyIds.N

No

Array of
StringZoneId set. This parameter is required.

Array ofIDs of DDoS policies to be queried. All policies will be

Integer

selected if this field is not specified.
The query granularity. Values:
min : 1 minute;5min : 5 minutes;
hour : 1 hour;
day : 1 day

Interval

No

StringIf this field is not specified, the granularity is determinedbased on the query period.
Period ≤ 1 hour: min ;1 hour < Period ≤ 2 days: 5min ;2 days < Period ≤ 7 days: hour ;Period > 7 days: day .
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland

Area

No

Stringmainland : Chinese mainland
global : Global
If this field is not specified, the default value global isused.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of query results.

Data

Array of
SecEntry

List of DDoS attack data.
Note: This field may return null, indicating that no valid values can be obtained.

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a©2013-2022 Tencent Cloud. All rights reserved.

Page 398 of 760

Tencent Cloud EdgeOne

RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the Time-series Data of DDoS Attacks
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDDoSAttackData<Common request parameters>{"MetricNames": ["ddos_attackMaxBandwidth"],"Interval": "min","PolicyIds": [1706],"ZoneIds": ["zone-21xfqlh4qjee"],"StartTime": "2022-08-22T00:00:00+00:00","EndTime": "2022-08-23T00:00:00+00:00","Area": "overseas"}

Output Example{"Response": {"TotalCount": 1,"Data": [{"Value": [{"Max": 100,
"Metric": "ddos_attackMaxBandwidth","Avg": 100.0,"Detail": [{"Value": 100©2013-2022 Tencent Cloud. All rights reserved.

Page 399 of 760

Tencent Cloud EdgeOne}],"Sum": 100.0}],"Key": "ddos_attackMaxBandwidth"}],"RequestId": "a79e60f8-34cc-4ee5-a7f9-a24adb572c68"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ProxyServer

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 400 of 760

Tencent Cloud EdgeOne

LimitExceeded

The quota limit has been reached.

LimitExceeded.QueryTimeLimitExceeded

Query time limit exceeded.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Please getpermissions first.

©2013-2022 Tencent Cloud. All rights reserved.

Page 401 of 760

Tencent Cloud EdgeOne

DescribeDDoSAttackEvent：

Last updated 2024-04-09 10:26:09

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query DDoS attack events.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeDDoSAttackEvent.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

StartTimeYes

EndTimeYes

Timestamp
ISO8601

End time. Time range: 30 days.

PolicyIds.N

No

Array ofInteger

List of DDoS policy IDs. All policies are selected if this field is not
specified.

ZoneIds.N

No

Timestamp
ISO8601

Array of
String©2013-2022 Tencent Cloud. All rights reserved.

Start time. Time range: 30 days.

ZoneId set. This parameter is required.

Page 402 of 760

Tencent Cloud EdgeOne

Limit

No

Integer

Limit on paginated queries. Default value: 20. Maximum value:
1000.

OffsetShowDetailNo

No

Integer

The page offset. Default value: 0.

BooleanParameter to show attack details. If it is configured as false, only
the number of attacks is returned without details. If it is configured
as true, attack details are returned.
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland

Area

No

mainland : Chinese mainland

Stringglobal : Global
If this field is not specified, the default value global is used.
The sorting field. Values:
MaxBandWidth : Peak bandwidth
OrderByNo

StringAttackStartTime Start time of the attack
If this field is not specified, the default value AttackStartTime
is used.

OrderTypeNo

The sorting method. Values:asc : Ascending

Stringdesc : Descending
If this field is not specified, the default value desc is used.

3. Output Parameters
Parameter
Name

Data

TotalCount

RequestId

Type

Array of
DDoSAttackEvent
IntegerStringDescription
List of DDoS attack data.
Note: This field may return null , indicating that no valid value wasfound.
Total number of query results.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

©2013-2022 Tencent Cloud. All rights reserved.

Page 403 of 760

Tencent Cloud EdgeOne

4. Example
Example1 Querying a DDoS attack event
Querying a DDoS attack event
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDDoSAttackEvent<Common request parameters>{"Limit": 1,"Offset": 1,"PolicyIds": [1245],"ZoneIds": ["zone-21xfqlh4qjee"],"StartTime": "2020-09-22T00:00:00+00:00","EndTime": "2020-09-22T00:00:00+00:00","ShowDetail": false,"Area": "overseas"}

Output Example{"Response": {"TotalCount": 0,"Data": [{"EventId": "12214521","AttackPacketMaxRate": 10,"AttackEndTime": 1659595468,"AttackMaxBandWidth": 10,"AttackStartTime": 1659595468,"ZoneId": "zone-21xfqlh4qjee","PolicyId": 1245,"AttackType": "UDPFLOOD","AttackStatus": 1,"Area": "mainland","DDoSBlockData": [©2013-2022 Tencent Cloud. All rights reserved.

Page 404 of 760

Tencent Cloud EdgeOne{"StartTime": 1659595468,"EndTime": 0,"BlockArea": "Access resitricted in some regions."}]}],"RequestId": "c0ce8b7c-a48f-4eed-a0eb-c24177efc430"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ProxyServer

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 405 of 760

Tencent Cloud EdgeOne

LimitExceeded

The quota limit has been reached.

LimitExceeded.QueryTimeLimitExceeded

Query time limit exceeded.

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 406 of 760

Tencent Cloud EdgeOne

DescribeDDoSAttackTopData：

Last updated 2024-04-09 10:26:09

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the top-ranked DDoS attack data.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

StartTimeYes

EndTimeYes

Timestamp
ISO8601

MetricName

Yes

StringTimestamp
ISO8601

Description
Common Params. The value used for this API:
DescribeDDoSAttackTopData.

The start time.

The end time.
The statistical metric. Values:
ddos_attackFlux_protocol : Rank protocols by theattack traffic.
ddos_attackPackageNum_protocol : Rank protocols
by the number of attack packets.

©2013-2022 Tencent Cloud. All rights reserved.

Page 407 of 760

Tencent Cloud EdgeOne

ddos_attackNum_attackType : Rank attack types by
the number of attacks.
ddos_attackNum_sregion : Rank attacker regions by
the number of attacks.
ddos_attackFlux_sip : Rank attacker IPs by the
number of attacks.
ddos_attackFlux_sregion : Rank attacker regions by
the number of attacks.
ZoneIds.N

No

PolicyIds.N

No

Array of
StringArray ofIntegerSite ID set. This parameter is required.
The list of DDoS policy IDs to be specified. All policies will beselected if this field is not specified.
The attack type. Values:
flood : Flood;

AttackType

No

StringicmpFlood : ICMP flood;
all : All attack types.
This field will be set to the default value all if not specified.
The protocol type. Values:
tcp : TCP protocol;

ProtocolType

No

Stringudp : UDP protocol;
all : All protocol types.
This field will be set to the default value all if not specified.

Port

No

Integer

The port number.

Limit

No

Integer

Queries the top n rows of data. Top 10 rows of data will be
queried if this field is not specified.
Data storage region. Values:
overseas : Global (outside the Chinese mainland);

Area

No

Stringmainland : Chinese mainland.
If this field is not specified, the data storage region will be
determined based on the user’s location.

3. Output Parameters
Parameter
Name

Type

Description

Data

Array ofThe list of top-ranked DDoS attack data.

©2013-2022 Tencent Cloud. All rights reserved.

Page 408 of 760

Tencent Cloud EdgeOne

TotalCount

RequestId

TopEntry

Note: This field may return null, indicating that no valid values can be obtained.

Integer

Total number of query results.

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the top-ranked DDoS attack data
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDDoSAttackTopData<Common request parameters>{"AttackType": "UDPFLOOD","MetricName": "ddos_attackFlux_protocol","ProtocolType": "udp","PolicyIds": [1705],"ZoneIds": ["zone-21xfqlh4qjee"],"Limit": 1,"StartTime": "2020-09-22T00:00:00+00:00","EndTime": "2020-09-22T00:00:00+00:00","Port": 22,"Area": "overseas"}

Output Example{"Response": {"TotalCount": 10,"Data": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 409 of 760

Tencent Cloud EdgeOne"Value": [{"Count": 123,
"Name": "udp"}],"Key": "zone-21xfqlh4qjee"}],"RequestId": "3824cf60-c2aa-4f4a-95b7-a4d5e4dee188"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 410 of 760

Tencent Cloud EdgeOne

InternalError.ProxyServer

An unknown error occurred in the backend server.

LimitExceeded.QueryTimeLimitExceeded

Query time limit exceeded.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 411 of 760

Tencent Cloud EdgeOne

DescribeOverviewL7Data：

Last updated 2024-05-29 14:55:55

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the time sequence traffic data of the monitoring category in L7. This API is to be discarded.
Please use the API DescribeTimingL7AnalysisData.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeOverviewL7Data.

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

StartTimeYes

EndTimeYes

MetricNames.N

Yes

Name

Timestamp
ISO8601
Timestamp
ISO8601
Array of String

The start time.

The end time.
The metric to query. Values:
l7Flow_outFlux : Traffic used for EdegOne
responses©2013-2022 Tencent Cloud. All rights reserved.

Page 412 of 760

Tencent Cloud EdgeOne

l7Flow_inFlux : Traffic used for EdegOne
requests
l7Flow_outBandwidth : Bandwidth used for
EdegOne responses
l7Flow_inBandwidth : Bandwidth used for
EdegOne requests
l7Flow_hit_outFlux : Traffic used for cache hit
l7Flow_request : Access requests
l7Flow_flux : Upstream and downstream traffic
used for client accessl7Flow_bandwidth : Upstream and downstream
bandwidth used for client access
ZoneIds.N

No

Array of String

ZoneId set. This parameter is required.

Domains.N

No

Array of String

Queried domain name set. This parameter has been
discarded.
The protocol type. Values:
http : HTTP protocol;
https : HTTPS protocol;

ProtocolNo

Stringhttp2 : HTTP2 protocol;
all : All protocols.
If it's not specified, all is used. This parameter is not
yet available now.
The query granularity. Values:
min : 1 minute;5min : 5 minutes;
hour : 1 hour;
day : One day

Interval

No

StringIf this field is not specified, the granularity will be
determined based on the query period.
Period <= 1 hour: min ;1 hour < Period <= 2 days: 5min ;2 days < period <= 7 days: hour ;Period > 7 days: day .

Filters.N

No

Array ofQueryCondition

Filtering condition. The detailed filtering condition key
values are as follows:
socket: Filter based on HTTP protocol type.
Corresponding value options:
HTTP: HTTP protocol;
HTTPS: HTTPS protocol;
QUIC: QUIC protocol.

©2013-2022 Tencent Cloud. All rights reserved.

Page 413 of 760

Tencent Cloud EdgeOne

domains: Filter based on domain name.
tagKey: Filter based on Tag Key.
tagValue: Filter based on Tag Value.
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland
Area

No

mainland : Chinese mainland

Stringglobal : Global
If this field is not specified, the default value global isused.

3. Output Parameters
Parameter
Name
TotalCount
Data

RequestId

Type

Description

Integer

Total number of query results.

Array ofNote: This field may return 'null', which indicates a failure to obtain a valid

TimingDataRecord

value.

String

The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Querying Time Sequence Traffic Data based on the Tag
Obtain the indicator for the number of requests based on the filtering conditions of tags.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOverviewL7Data<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00",©2013-2022 Tencent Cloud. All rights reserved.

Page 414 of 760

Tencent Cloud EdgeOne"Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Flow_request"],"Filters": [{"Key": "tagKey","Operator": "equals","Value": ["test1"]},{"Key": "tagValue","Operator": "equals","Value": ["a.com","b.com"]}],"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "6cc74d08-c174-413a-976b-abe7b851e0121","Data": [{"TypeKey": "251227260","TypeValue": [{"Avg": 1564,"Detail": [{"Timestamp": 1659139200,"Value": 100},{"Timestamp": 1659225600,©2013-2022 Tencent Cloud. All rights reserved.

Page 415 of 760

Tencent Cloud EdgeOne"Value": 34}],"Max": 8037,"MetricName": "l7Flow_request","Sum": 48511}]}],"TotalCount": 1}}

Example2 Querying L7 Monitoring Time Sequence Traffic Data
Indicator for the number of L7 monitoring data query requests
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOverviewL7Data<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Flow_request"],"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "6cc74d08-c174-413a-976b-abe7b851e010","Data": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 416 of 760

Tencent Cloud EdgeOne"TypeKey": "251227260","TypeValue": [{"Avg": 1564,"Detail": [{"Timestamp": 1659139200,"Value": 0},{"Timestamp": 1659225600,"Value": 0}],"Max": 8037,"MetricName": "l7Flow_request","Sum": 48511}]}],"TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 417 of 760

Tencent Cloud EdgeOne

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.RouteError

The backend routing address is incorrect.

InvalidParameter

Parameter error.

InvalidParameterValue

Invalid parameter value.

LimitExceeded.QueryTimeLimitExceeded

Query time limit exceeded.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 418 of 760

Tencent Cloud EdgeOne

DescribeTimingL4Data：

Last updated 2024-04-09 10:26:07

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the list of L4 traffic data recorded over time.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

StartTime

Yes

Timestamp
ISO8601

The start time.

EndTimeYes

MetricNames.N

Yes

Timestamp
ISO8601
Array of String

Description
Common Params. The value used for this API:
DescribeTimingL4Data.

The end time.
Query indicator. Values:
l4Flow_connections: Number of access connections;l4Flow_flux: Total access traffic;
l4Flow_inFlux: Ingress access traffic;©2013-2022 Tencent Cloud. All rights reserved.

Page 419 of 760

Tencent Cloud EdgeOne

l4Flow_outFlux: Egress access traffic.
ZoneIds.N

No

Array of String

ZoneId set. This parameter is required.

ProxyIds.N

No

Array of String

List of L4 proxy IDs. All L4 proxies will be selected if thisfield is not specified.
The query granularity. Values:
min : 1 minute;5min : 5 minutes;
hour : 1 hour;
day : 1 day.

Interval

No

StringIf this field is not specified, the granularity will be
determined based on the query period.
Period ≤ 1 hour: min ;1 hour < Period ≤ 2 days: 5min ;2 days < period ≤ 7 days: hour ;Period > 7 days: day .

Filters.N

No

Array ofQueryCondition

Filters
ruleIdFilter by the specified forwarding rule ID
proxyId
Filter by the specified L4 agent ID
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland

Area

No

Stringmainland : Chinese mainland
global : Global
If this field is not specified, the default value global isused.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of query results.

Data

Array of
TimingDataRecord

RequestId

String

The list of L4 traffic data recorded over time.
Note: This field may return null, indicating that no valid values can beobtained.
The unique request ID, generated by the server, will be returned for every©2013-2022 Tencent Cloud. All rights reserved.

Page 420 of 760

Tencent Cloud EdgeOne

request (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Querying L4 Time Sequence Traffic Data
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL4Data<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l4Flow_inFlux"],"ZoneIds": ["zone-28kw53cmc6ky"]}

Output Example{"Response": {"RequestId": "e12e0659-ae34-4140-9878-4a61db0c3639","Data": [{"TypeKey": "251227260","TypeValue": [{"Avg": 740563,"Detail": [{"Timestamp": 1659139200,"Value": 0©2013-2022 Tencent Cloud. All rights reserved.

Page 421 of 760

Tencent Cloud EdgeOne},{"Timestamp": 1659225600,"Value": 0}],"Max": 6319079,"MetricName": "l4Flow_inFlux","Sum": 22957455}]}],"TotalCount": 1}}

Example2 Querying L4 Traffic Data based on L4 Proxy ID
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL4Data<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l4Flow_inFlux"],"ZoneIds": ["zone-28kw53cmc6ky"],"Filters": [{"Key": "proxyId","Operator": "equals","Value": ["sid-2c2uug8ubfmn"]}©2013-2022 Tencent Cloud. All rights reserved.

Page 422 of 760

Tencent Cloud EdgeOne]}

Output Example{"Response": {"RequestId": "962792de-3bfe-483d-99a7-3cfde0467495","Data": [{"TypeKey": "zone-28kw53cmc6ky","TypeValue": [{"Avg": 267,
"Detail": [{"Timestamp": 1671669600,"Value": 390},{"Timestamp": 1671669900,"Value": 740},{"Timestamp": 1671670200,"Value": 0},{"Timestamp": 1671670500,"Value": 0},{"Timestamp": 1671670800,"Value": 562},{"Timestamp": 1671671100,"Value": 690},{"Timestamp": 1671671400,"Value": 0},{"Timestamp": 1671671700,"Value": 1353

©2013-2022 Tencent Cloud. All rights reserved.

Page 423 of 760

Tencent Cloud EdgeOne},{"Timestamp": 1671672000,"Value": 1291},{
"Timestamp": 1671672300,"Value": 0},{"Timestamp": 1671672600,"Value": 0},{"Timestamp": 1671672900,"Value": 300},{"Timestamp": 1671673200,"Value": 453},{"Timestamp": 1671673500,"Value": 0},{"Timestamp": 1671673800,"Value": 19},{"Timestamp": 1671674100,"Value": 0},{"Timestamp": 1671674400,"Value": 0},{"Timestamp": 1671674700,"Value": 204},{"Timestamp": 1671675000,"Value": 530},{"Timestamp": 1671675300,©2013-2022 Tencent Cloud. All rights reserved.

Page 424 of 760

Tencent Cloud EdgeOne"Value": 0},{"Timestamp": 1671675600,"Value": 975},{"Timestamp": 1671675900,"Value": 777},{"Timestamp": 1671676200,"Value": 0},{"Timestamp": 1671676500,"Value": 530},{"Timestamp": 1671676800,"Value": 320},{"Timestamp": 1671677100,"Value": 303},{"Timestamp": 1671677400,"Value": 0},{"Timestamp": 1671677700,"Value": 183},{"Timestamp": 1671678000,"Value": 320},{"Timestamp": 1671678300,"Value": 670},{"Timestamp": 1671678600,"Value": 131},{©2013-2022 Tencent Cloud. All rights reserved.

Page 425 of 760

Tencent Cloud EdgeOne"Timestamp": 1671678900,"Value": 804},{"Timestamp": 1671679200,"Value": 131}],"Max": 31540,"MetricName": "l4Flow_outFlux","Sum": 147864}]}],"TotalCount": 1}}

Example3 Querying L4 Traffic Data based on the Forwarding Rule ID
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL4Data<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l4Flow_inFlux"],"ZoneIds": ["zone-28kw53cmc6ky"],"Filters": [{"Key": "ruleId","Operator": "equals","Value": ["rule-033950bf-6fc4-11ed-8ab2-525400a22580"©2013-2022 Tencent Cloud. All rights reserved.

Page 426 of 760

Tencent Cloud EdgeOne

]
}
]
}

Output Example{"Response": {"RequestId": "962792de-3bfe-483d-99a7-3cfde0467495","Data": [{"TypeKey": "zone-28kw53cmc6ky","TypeValue": [{"Avg": 267,
"Detail": [{"Timestamp": 1671669600,"Value": 390},{"Timestamp": 1671669900,"Value": 740},{"Timestamp": 1671670200,"Value": 0},{"Timestamp": 1671670500,"Value": 0},{"Timestamp": 1671670800,"Value": 562},{"Timestamp": 1671671100,"Value": 690},{"Timestamp": 1671671400,"Value": 0},{©2013-2022 Tencent Cloud. All rights reserved.

Page 427 of 760

Tencent Cloud EdgeOne"Timestamp": 1671671700,"Value": 1353},{
"Timestamp": 1671672000,"Value": 1291},{
"Timestamp": 1671672300,"Value": 0},{"Timestamp": 1671672600,"Value": 0},{"Timestamp": 1671672900,"Value": 300},{"Timestamp": 1671673200,"Value": 453},{"Timestamp": 1671673500,"Value": 0},{"Timestamp": 1671673800,"Value": 19},{"Timestamp": 1671674100,"Value": 0},{"Timestamp": 1671674400,"Value": 0},{"Timestamp": 1671674700,"Value": 204},{"Timestamp": 1671675000,"Value": 530},©2013-2022 Tencent Cloud. All rights reserved.

Page 428 of 760

Tencent Cloud EdgeOne{"Timestamp": 1671675300,"Value": 0},{"Timestamp": 1671675600,"Value": 975},{"Timestamp": 1671675900,"Value": 777},{"Timestamp": 1671676200,"Value": 0},{"Timestamp": 1671676500,"Value": 530},{"Timestamp": 1671676800,"Value": 320},{"Timestamp": 1671677100,"Value": 303},{"Timestamp": 1671677400,"Value": 0},{"Timestamp": 1671677700,"Value": 183},{"Timestamp": 1671678000,"Value": 320},{"Timestamp": 1671678300,"Value": 670},{"Timestamp": 1671678600,"Value": 131©2013-2022 Tencent Cloud. All rights reserved.

Page 429 of 760

Tencent Cloud EdgeOne},{"Timestamp": 1671678900,"Value": 804},{"Timestamp": 1671679200,"Value": 131}],"Max": 31540,"MetricName": "l4Flow_outFlux","Sum": 147864}]}],"TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 430 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InternalError.RouteError

The backend routing address is incorrect.

LimitExceeded

The quota limit has been reached.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 431 of 760

Tencent Cloud EdgeOne

DescribeTimingL7AnalysisData：

Last updated 2024-04-09 10:26:06

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the L7 data recorded over time.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeTimingL7AnalysisData.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

StartTime

Yes

Timestamp
ISO8601

The start time.

EndTimeYes

Timestamp
ISO8601

The end time.

MetricNames.N

Yes

Array of String©2013-2022 Tencent Cloud. All rights reserved.

Indicator list. Values:
l7Flow_outFlux: Edgeone response traffic;
l7Flow_inFlux: Edgeone request traffic;
l7Flow_outBandwidth: Edgeone response bandwidth;l7Flow_inBandwidth: Edgeone request bandwidth;

Page 432 of 760

Tencent Cloud EdgeOne

l7Flow_request: Number of access requests;
l7Flow_flux: Uplink + downlink traffic of access requests;<
l7Flow_bandwidth: Uplink + downlink bandwidth of access
ZoneIds.N

No

Array of String

ZoneId set. This parameter is required.
The query granularity. Values:
min : 1 minute;5min : 5 minutes;
hour : 1 hour;
day : 1 day.

Interval

No

StringIf this field is not specified, the granularity will be determined bquery period.
Period ≤ 1 hour: min ;1 hour < Period ≤ 2 days: 5min ;2 days < period ≤ 7 days: hour ;Period > 7 days: day .

Filters.N

No

Array ofFilters

QueryCondition

country
Filter by the Country/Region. The country/region follows ISO
specification.
province
Filter by the specified province name. It’s only available whmainland .
isp: Filter by the specified ISP. It’s only available when Area ismainland .
Values:2 : CTCC;
26 : CUCC;
1046 : CMCC;
3947 : CTT;
38 : CERNET;
43 : GWBN;
0 : Others.
domain: Filter by the specified sub-domain name, such as
test.example.com
url :Filter by the specified URL path (such as /content orcontent/test.jpg ).
If this parameter is specified, the max query period is thdays.

©2013-2022 Tencent Cloud. All rights reserved.

Page 433 of 760

Tencent Cloud EdgeOne

The max data query scope stated in the service packag
specifications of the site (if ZoneIds specified) becom
referer :Filter by the specified Referer header, such as exampl
If this parameter is specified, the max query period is th
days.
Themax data query scope stated in the service package
specifications of the site (if ZoneIds specified) becom
resourceType :Filter by the specified resource file type, such as jpg
Note that if this parameter is specified, the max data quthe last 30 days.
The data query scope stated in the specifications of ser
package related with the ZoneIds becomes invalid.
protocol :Filter by the specified HTTP protocol version
Values:
HTTP/1.0 : HTTP 1.0;
HTTP/1.1 : HTTP 1.1;
HTTP/2.0 : HTTP 2.0;
HTTP/3.0 : HTTP 3.0;
WebSocket : WebSocket.
socket :Filter by the specified HTTP protocol type
Values:HTTP : HTTP protocol;
HTTPS : HTTPS protocol;
QUIC : QUIC protocol.
statusCode
Filter by [strong> Status Code/strong>]. lt;br> If you onl
statusCode parameter, you can query data of nearly 30
most;
If statusCode+Zonelds parameter is filled in at the same
supported query data range is the smaller of ahref="https://www.tencentcloud.com/document/productfrom_cn_redirect=1#edgeone-.E5.A5.97.E9.A4.90"> Max
range of data analysis/a> and 30 days supported by pac
The corresponding Value options are as follows:
1XX: Status code of type 1xx;
100:100 status code;
101:101 status code;
102:102 status code;
2XX: Status code of type 2xx;
200:200 status code;
201:201 status code;©2013-2022 Tencent Cloud. All rights reserved.

Page 434 of 760

Tencent Cloud EdgeOne

202:202 status code;203:203 status code;
204:204 status code;
205:205 status code;
206:206 status code;
207:207 status code;
3XX: Status code of type 3xx;
300:300 status code;
301:301 status code;
302:302 status code;
303:303 status code;
304:304 status code;
305:305 status code;
307:307 status code;
4XX: Status code of type 4xx;
400:400 status code;
401:401 status code;
402:402 status code;
403:403 status code;
404:404 status code;
405:405 status code;
406:406 status code;
407:407 status code;
408:408 status code;
409:409 status code;
410:410 status code;
411:411 status code;
412:412 status code;
412:413 Status Code;414:414 status code;
415:415 status code;
416:416 status code;
417:417 status code;
422:422 status code;
423:423 status code;
424:424 status code;
426:426 status code;
451:451 status code;
5XX: Status code of type 5xx;
500:500 status code;
501:501 status code;
502:502 status code;
503:503 status code;
504:504 status code;
505:505 status code;©2013-2022 Tencent Cloud. All rights reserved.

Page 435 of 760

Tencent Cloud EdgeOne

506:506 status code;
507:507 status code;
510:510 status code;
514:514 status code;
544:544 Status Code.& ltbrowserType :Filter by the specified browser type.
If this parameter is specified, the max query period is thdays.
The max data query scope stated in the service packag
specifications of the site (if ZoneIds specified) becom
Values:Firefox : Firefox browser;
Chrome : Chrome browser;
Safari : Safari browser;
MicrosoftEdge : Microsoft Edge browser;
IE : IE browser;
Opera : Opera browser;
QQBrowser : QQ browser;
LBBrowser : LB browser;
MaxthonBrowser : Maxthon browser;
SouGouBrowser : Sogou browser;
BIDUBrowser : Baidu browser;
TaoBrowser : Tao browser;
UBrowser : UC browser;
Other : Other browsers;
Empty : The browser type is not specified;
Bot : Web crawler.
deviceType :Filter by the device type.
If this parameter is specified, the max query period is thdays.
The max data query scope stated in the service packag
specifications of the site (if ZoneIds specified) becom
Values:TV : TV;
Tablet : Tablet;
Mobile : Mobile phone;
Desktop : Desktop device;
Other : Other device;
Empty : Device type not specified.
operatingSystemType :Filter by the operating system.

©2013-2022 Tencent Cloud. All rights reserved.

Page 436 of 760

Tencent Cloud EdgeOne

If this parameter is specified, the max query period is thdays.
The max data query scope stated in the service packag
specifications of the site (if ZoneIds specified) becom
Values:Linux : Linux OS;
MacOS : Mac OS;
Android : Android OS;
IOS : iOS OS;
Windows : Windows OS;
NetBSD : NetBSD OS;
ChromiumOS : Chromium OS;
Bot : Web crawler:
Other : Other OS;
Empty : The OS is not specified.
tlsVersion :Filter by the TLS version.
If this parameter is specified, the max query period is thdays.
The max data query scope stated in the service packag
specifications of the site (if ZoneIds specified) becom
Values:TLS1.0 : TLS 1.0;
TLS1.1 : TLS 1.1;
TLS1.2 : TLS 1.2;
TLS1.3 : TLS 1.3.
ipVersion
Filter by the specified IP version.
Values:4 : IPv4;
6 : IPv6.
tagKeyFilter by the Tag Key.
tagValue
Filter by the Tag Value.
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland
Area

No

Stringmainland : Chinese mainland
global : Global
If this field is not specified, the default value global is use©2013-2022 Tencent Cloud. All rights reserved.

Page 437 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name
TotalCount

Data

Type

Description

Integer

Total number of query results.

Array ofThe list of L7 traffic data recorded over time.
Note: This field may return null, indicating that no valid values can be

TimingDataRecord

obtained.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Querying Time Sequence Traffic Data Based on the Protocol
Obtain the indicator for the number of requests based on the protocol filtering conditions.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7AnalysisData<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Flow_request"],"Filters": [{"Key": "protocol","Operator": "equals","Value": ["HTTP/1.0",©2013-2022 Tencent Cloud. All rights reserved.

Page 438 of 760

Tencent Cloud EdgeOne"HTTP/1.1"]}],"ZoneIds": ["zone-2o7b38ba1hvr"]}

Output Example{"Response": {"RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609","Data": [{"TypeKey": "251227260","TypeValue": [{"Avg": 803,
"Detail": [{"Timestamp": 1659139200,"Value": 0},{"Timestamp": 1661731200,"Value": 0}],"Max": 7921,"MetricName": "l7Flow_request","Sum": 24918}]}],"TotalCount": 1}}

Example2 Querying Time Sequence Traffic Data based on the Tag
Obtain the indicator for the number of requests based on the filtering conditions of tags.
Input Example©2013-2022 Tencent Cloud. All rights reserved.

Page 439 of 760

Tencent Cloud EdgeOne

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7AnalysisData<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Flow_request"],"Filters": [{"Key": "tagKey","Operator": "equals","Value": ["test1"]},{"Key": "tagValue","Operator": "equals","Value": ["a.com","b.com"]}],"ZoneIds": ["zone-2o7b38ba1hvr"]}

Output Example{"Response": {"RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609","Data": [{"TypeKey": "251227260","TypeValue": [©2013-2022 Tencent Cloud. All rights reserved.

Page 440 of 760

Tencent Cloud EdgeOne{"Avg": 803,
"Detail": [{"Timestamp": 1659139200,"Value": 0},{"Timestamp": 1661731200,"Value": 0}],"Max": 7921,"MetricName": "l7Flow_request","Sum": 24918}]}],"TotalCount": 1}}

Example3 Querying L7 Data Analysis Time Sequence Traffic Data
Query the data of the indicator for the number of L7 traffic requests.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7AnalysisData<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Flow_request"],"ZoneIds": ["zone-2o7b38ba1hvr"©2013-2022 Tencent Cloud. All rights reserved.

Page 441 of 760

Tencent Cloud EdgeOne]}

Output Example{"Response": {"RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609","Data": [{"TypeKey": "251227260","TypeValue": [{"Avg": 803,
"Detail": [{"Timestamp": 1659139200,"Value": 0},{"Timestamp": 1661731200,"Value": 0}],"Max": 7921,"MetricName": "l7Flow_request","Sum": 24918}]}],"TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 442 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter

Parameter error.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

The quota limit has been reached.

LimitExceeded.QueryTimeLimitExceeded

Query time limit exceeded.

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 443 of 760

Tencent Cloud EdgeOne

DescribeTopL7AnalysisData：

Last updated 2024-04-09 10:26:05

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the top-ranked L7 traffic data.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

StartTimeYes

EndTimeYes

Timestamp
ISO8601

MetricName

Yes

StringTimestamp
ISO8601

Description
Common Params. The value used for this API:
DescribeTopL7AnalysisData.

The start time.

The end time.
Metrics to query. Valid values:
l7Flow_outFlux_country : Query traffic bycountry/region;
l7Flow_outFlux_statusCode : Query traffic bystatus code;©2013-2022 Tencent Cloud. All rights reserved.

Page 444 of 760

Tencent Cloud EdgeOne

l7Flow_outFlux_domain : Query traffic by domain;l7Flow_outFlux_url : Query traffic by URL;
l7Flow_outFlux_resourceType : Query traffic byresource type;l7Flow_outFlux_sip : Query traffic by source IP;
l7Flow_outFlux_referers : Query traffic by referinformation;
l7Flow_outFlux_ua_device : Query traffic bydevice;l7Flow_outFlux_ua_browser : Query traffic bybrowser;
l7Flow_outFlux_us_os : Query traffic by OS;
l7Flow_request_country : Query requests bycountry/region;
l7Flow_request_statusCode : Query requests by
status code;
l7Flow_request_domain : Query requests bydomain;l7Flow_request_url : Query requests by URL;
l7Flow_request_resourceType : Query requests
by resource type;l7Flow_request_sip : Query requests by source IP;
l7Flow_request_referer : Query requests by referinformation;
l7Flow_request_ua_device : Query requests bydevice;l7Flow_request_ua_browser : Query requests bybrowser;
l7Flow_request_us_os : Query requests by OS.

ZoneIds.N

No

Array of String

ZoneId set. This parameter is required.

Limit

No

Integer

Queries the top N data entries. Maximum value: 1000. Top 10
data entries will be queried if this field is not specified.

Filters.N

No

Array ofQueryCondition

Filters
country
Filter by the Country/Region. The country/region follows ISO
3166 specification.
province
Filter by the specified province name. It’s only available
when Area is mainland .
isp: Filter by the specified ISP. It’s only available when Area is©2013-2022 Tencent Cloud. All rights reserved.

Page 445 of 760

Tencent Cloud EdgeOne

mainland .
Values:2 : CTCC;
26 : CUCC;
1046 : CMCC;
3947 : CTT;
38 : CERNET;
43 : GWBN;
0 : Others.
domain: Filter by the specified sub-domain name, such as
test.example.com
url :Filter by the specified URL Path (such as /content orcontent/test.jpg .
If this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds
specified) becomes invalid.
referer :Filter by the specified Referer header, such as
example.com .
If this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds
specified) becomes invalid.
resourceType :Filter by the specified resource file type, such as jpg ,css .
If this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds
specified) becomes invalid.
protocol :Filter by the specified HTTP protocol version
Values:
HTTP/1.0 : HTTP 1.0;
HTTP/1.1 : HTTP 1.1;
HTTP/2.0 : HTTP 2.0;
HTTP/3.0 : HTTP 3.0;
WebSocket : WebSocket.

©2013-2022 Tencent Cloud. All rights reserved.

Page 446 of 760

Tencent Cloud EdgeOne

socket :Filter by the specified HTTP protocol type
Values:HTTP : HTTP protocol;
HTTPS : HTTPS protocol;
QUIC : QUIC protocol.
statusCode :Filter by the Status CodeIf this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds
specified) becomes invalid.
Values:1XX: Status code of type 1xx
100: 100 status code
101: 101 status code
102: 102 status code
2XX: Status code of type 2xx
200: 200 status code
201: 201 status code
202: 202 status code203: 203 status code
204: 204 status code
205: 205 status code
206: 206 status code
207: 207 status code
3XX: Status code of type 3xx
300: 300 status code
301: 301 status code
302: 302 status code
303: 303 status code
304: 304 status code
305: 305 status code
307: 307 status code
4XX: Status code of type 4xx
400: 400 status code
401: 401 status code
402: 402 status code
403: 403 status code
404: 404 status code
405: 405 status code
406: 406 status code
407: 407 status code
408: 408 status code

©2013-2022 Tencent Cloud. All rights reserved.

Page 447 of 760

Tencent Cloud EdgeOne

409: 409 status code
410: 410 status code
411: 411 status code
412: 412 status code
412: 413 Status Code414: 414 status code
415: 415 status code
416: 416 status code
417: 417 status code
422: 422 status code
423: 423 status code
424: 424 status code
426: 426 status code
451: 451 status code
5XX: Status code of type 5xx
500: 500 status code
501: 501 status code
502:502 status code
503: 503 status code
504: 504 status code
505: 505 status code
506: 506 status code
507: 507 status code
510: 510 status code
514: 514 status code
544: 544 Status Code.
browserType :Filter by the specified browser type.
If this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds
specified) becomes invalid.
Values:Firefox : Firefox browser;
Chrome : Chrome browser;
Safari : Safari browser;
MicrosoftEdge : Microsoft Edge browser;
IE : IE browser;
Opera : Opera browser;
QQBrowser : QQ browser;
LBBrowser : LB browser;
MaxthonBrowser : Maxthon browser;
SouGouBrowser : Sogou browser;©2013-2022 Tencent Cloud. All rights reserved.

Page 448 of 760

Tencent Cloud EdgeOne

BIDUBrowser : Baidu browser;
TaoBrowser : Tao browser;
UBrowser : UC browser;
Other : Other browsers;
Empty : The browser type is not specified;
Bot : Web crawler.
deviceType :Filter by the device type.
If this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds
specified) becomes invalid.
Values:TV : TV;
Tablet : Tablet;
Mobile : Mobile phone;
Desktop : Desktop device;
Other : Other device;
Empty : Device type not specified.
operatingSystemType :Filter by the operating system.
If this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds
specified) becomes invalid.
Values:Linux : Linux OS;
MacOS : Mac OS;
Android : Android OS;
IOS : iOS OS;
Windows : Windows OS;
NetBSD : NetBSD OS;
ChromiumOS : Chromium OS;
Bot : Web crawler:
Other : Other OS;
Empty : The OS is not specified.
tlsVersion :Filter by the TLS version.
If this parameter is specified, the max query period is
the last 30 days.
The max data query scope stated in the service
package specifications of the site (if ZoneIds©2013-2022 Tencent Cloud. All rights reserved.

Page 449 of 760

Tencent Cloud EdgeOne

specified) becomes invalid.
Values:TLS1.0 : TLS 1.0;
TLS1.1 : TLS 1.1;
TLS1.2 : TLS 1.2;
TLS1.3 : TLS 1.3.
ipVersion
Filter by the specified IP version.
Values:4 : IPv4;
6 : IPv6.
tagKeyFilter by the Tag Key.
tagValue
Filter by the Tag Value.
The query time granularity. Values:
min : 1 minute;5min : 5 minute;hour : 1 hour;
day : 1 day.
Interval

No

StringIf this field is not specified, the granularity will be determinedbased on the interval between the start time and end time asfollows: 1-minute granularity applies for a 1-hour interval, 5minute granularity for a 2-day interval, 1-hour granularity for a
7-day interval, and 1-day granularity for an interval of over 7
days.
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland

Area

No

Stringmainland : Chinese mainland
global : Global
If this field is not specified, the default value global isused.

3. Output Parameters
Parameter

Type

Description

TotalCount

Integer

Total number of query results.

Data

Array ofThe list of top-ranked L7 traffic data.

Name©2013-2022 Tencent Cloud. All rights reserved.

Page 450 of 760

Tencent Cloud EdgeOne

TopDataRecord

Note: This field may return null, indicating that no valid values can beobtained.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the Top Traffic Data with the Specified Protocol
Query L7 data analysis top traffic data.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7AnalysisData<Common request parameters>{"Area": "mainland","Interval": "day","Limit": "1","StartTime": "2022-07-31T00:00:00+08:00","EndTime": "2022-08-29T19:17:59+08:00","MetricName": "l7Flow_outFlux_url","Filters": [{"Key": "protocol","Operator": "equals","Value": ["HTTP/1.0","HTTP/1.1"]}],"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 451 of 760

Tencent Cloud EdgeOne{"Response": {"RequestId": "7c499897-8ad9-4a2d-884e-6154f283d723","Data": [{"DetailData": [{"Key": "/",
"Value": 1210001}],"TypeKey": "251227260"}],"TotalCount": 1}}

Example2 Querying the Top Traffic Data with the Specified Tag
Querying the Top Traffic Data with the Specified Tag
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7AnalysisData<Common request parameters>{"Area": "mainland","Interval": "day","Limit": "1","StartTime": "2022-07-31T00:00:00+08:00","EndTime": "2022-08-29T19:17:59+08:00","MetricName": "l7Flow_outFlux_url","Filters": [{"Key": "tagKey","Operator": "equals","Value": ["test1"]},{©2013-2022 Tencent Cloud. All rights reserved.

Page 452 of 760

Tencent Cloud EdgeOne"Key": "tagValue","Operator": "equals","Value": ["a.com","b.com"]}],"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "7c499897-8ad9-4a2d-884e-6154f283d723","Data": [{"DetailData": [{"Key": "/",
"Value": 1210001}],"TypeKey": "251227260"}],"TotalCount": 1}}

Example3 Query L7 data analysis top traffic data.
Query L7 data analysis top traffic data.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7AnalysisData<Common request parameters>{©2013-2022 Tencent Cloud. All rights reserved.

Page 453 of 760

Tencent Cloud EdgeOne"Area": "mainland","Interval": "day","Limit": "1","StartTime": "2022-07-31T00:00:00+08:00","EndTime": "2022-08-29T19:17:59+08:00","MetricName": "l7Flow_outFlux_url","ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "7c499897-8ad9-4a2d-884e-6154f283d7f6","Data": [{"DetailData": [{"Key": "/",
"Value": 7410001}],"TypeKey": "251227260"}],"TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js©2013-2022 Tencent Cloud. All rights reserved.

Page 454 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter

Parameter error.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

The quota limit has been reached.

LimitExceeded.QueryTimeLimitExceeded

Query time limit exceeded.

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission©2013-2022 Tencent Cloud. All rights reserved.

The sub-account is not authorized for the operation. Please getpermissions first.

Page 455 of 760

Tencent Cloud EdgeOne

DescribeTimingL7CacheData：

Last updated 2024-04-09 10:26:06

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the time-series L7 cached data.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

StartTime

Yes

Timestamp
ISO8601

The start time.

EndTimeYes

MetricNames.N

Yes

Timestamp
ISO8601
Array of String

Description
Common Params. The value used for this API:
DescribeTimingL7CacheData.

The end time.
The query metric. Values:
l7Cache_outFlux : Response traffic.
l7Cache_request : Response requests.
l7Cache_outBandwidth : Response bandwidth.

©2013-2022 Tencent Cloud. All rights reserved.

Page 456 of 760

Tencent Cloud EdgeOne

ZoneIds.N

No

Array of String

ZoneId set. This parameter is required.

Filters.N

No

Array ofQueryCondition

Filter conditions. See below for details:
domainFilter by the sub-domain name, such as
test.example.com
Type: String
Required: No
url
Filter by the URL, such as /content . The query
period cannot exceed 30 days.
Type: String
Required: No
resourceType
Filter by the resource file type, such as jpg ,png . The query period cannot exceed 30 days.
Type: String
Required: No
cacheType
Filter by the cache hit result.
Type: String
Required: No
Values:hit : Cache hit;
dynamic : Resource non-cacheable;
miss : Cache missstatusCode
Filter by the status code. The query period cannot
exceed 30 days.
Type: String
Required: No
Values:1XX : All 1xx status codes;
100 : 100 status code;
101 : 101 status code;
102 : 102 status code;
2XX : All 2xx status codes;
200 : 200 status code;
201 : 201 status code;
202 : 202 status code;
203 : 203 status code;
204 : 204 status code;
205 : 205 status code;
206 : 206 status code;©2013-2022 Tencent Cloud. All rights reserved.

Page 457 of 760

Tencent Cloud EdgeOne

207 : 207 status code;
3XX : All 3xx status codes;
300 : 300 status code;
301 : 301 status code;
302 : 302 status code;
303 : 303 status code;
304 : 304 status code;
305 : 305 status code;
307 : 307 status code;
4XX : All 4xx status codes;
400 : 400 status code;
401 : 401 status code;
402 : 402 status code;
403 : 403 status code;
404 : 404 status code;
405 : 405 status code;
406 : 406 status code;
407 : 407 status code;
408 : 408 status code;
409 : 409 status code;
410 : 410 status code;
411 : 411 status code;
412 : 412 status code;
412 : 413 status code;
414 : 414 status code;
415 : 415 status code;
416 : 416 status code;
417 : 417 status code;
422 : 422 status code;
423 : 423 status code;
424 : 424 status code;
426 : 426 status code;
451 : 451 status code;
5XX : All 5xx status codes;
500 : 500 status code;
501 : 501 status code;
502 : 502 status code;
503 : 503 status code;
504 : 504 status code;
505 : 505 status code;
506 : 506 status code;
507 : 507 status code;
510 : 510 status code;©2013-2022 Tencent Cloud. All rights reserved.

Page 458 of 760

Tencent Cloud EdgeOne

514 : 514 status code;
544 : 544 status code.
tagKey :Filter by the tag key
Type: String
Required: No
tagValue
Filter by the tag value
Type: String
Required: No
The query time granularity. Values:
min : 1 minute;5min : 5 minutes;
hour : 1 hour;
day : 1 day.
Interval

No

StringIf this field is not specified, the granularity will be
determined based on the interval between the start timeand end time as follows: 1-minute granularity applies for a
1-hour interval, 5-minute granularity for a 2-day interval, 1hour granularity for a 7-day interval, and 1-day granularity
for an interval of over 7 days.
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland

Area

No

Stringmainland : Chinese mainland
global : Global
If this field is not specified, the default value global isused.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of query results.

Data

RequestId

Array of
TimingDataRecord
String

The list of cached L7 time-series data.
Note: This field may return null, indicating that no valid values can beobtained.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the©2013-2022 Tencent Cloud. All rights reserved.

Page 459 of 760

Tencent Cloud EdgeOne

request will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Querying the Time Sequence Traffic Data with the Specified Tag
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7CacheData<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Cache_outFlux"],"Filters": [{"Key": "tagKey","Operator": "equals","Value": ["test1"]},{"Key": "tagValue","Operator": "equals","Value": ["a.com","b.com"]}],"ZoneIds": ["zone-2mzegj4vln5f"]}©2013-2022 Tencent Cloud. All rights reserved.

Page 460 of 760

Tencent Cloud EdgeOne

Output Example{"Response": {"RequestId": "6cc74d08-c174-413a-976b-abe7b851e0121","Data": [{"TypeKey": "251227260","TypeValue": [{"Avg": 239058,"Detail": [{"Timestamp": 1659139200,"Value": 8},{"Timestamp": 1661731200,"Value": 1}],"Max": 2363561,"MetricName": "l7Cache_outFlux","Sum": 7410804}]}],"TotalCount": 1}}

Example2 Querying Time Sequence Traffic Data with the Specified Status CodeInput Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7CacheData<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland",©2013-2022 Tencent Cloud. All rights reserved.

Page 461 of 760

Tencent Cloud EdgeOne"StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Cache_outFlux"],"Filters": [{"Key": "statusCode","Operator": "equals","Value": ["1XX","2XX"]}],"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "1c827ba2-7010-45d2-123b-6d0c4d34ihsx","Data": [{"TypeKey": "251227260","TypeValue": [{"Avg": 239058,"Detail": [{"Timestamp": 1659139200,"Value": 10},{"Timestamp": 1661731200,"Value": 10}],"Max": 2363561,"MetricName": "l7Cache_outFlux","Sum": 7410804}]}©2013-2022 Tencent Cloud. All rights reserved.

Page 462 of 760

Tencent Cloud EdgeOne],"TotalCount": 1}}

Example3 Querying L7 Cache Analysis Time Sequence Traffic Data
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7CacheData<Common request parameters>{"EndTime": "2022-08-29T19:17:59+08:00","Interval": "day","Area": "mainland","StartTime": "2022-07-31T00:00:00+08:00","MetricNames": ["l7Cache_outFlux"],"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "1c827ba2-7010-45d2-b16b-6d0c4d68a771","Data": [{"TypeKey": "251227260","TypeValue": [{"Avg": 239058,"Detail": [{"Timestamp": 1659139200,"Value": 0},{©2013-2022 Tencent Cloud. All rights reserved.

Page 463 of 760

Tencent Cloud EdgeOne"Timestamp": 1661731200,"Value": 0}],"Max": 2363561,"MetricName": "l7Cache_outFlux","Sum": 7410804}]}],"TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 464 of 760

Tencent Cloud EdgeOne

FailedOperation

Operation failed.

LimitExceeded

The quota limit has been reached.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 465 of 760

Tencent Cloud EdgeOne

DescribeTopL7CacheData：

Last updated 2024-04-09 10:26:04

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the cached L7 top-ranked data.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeTopL7CacheData.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

StartTime

Yes

Timestamp
ISO8601

The start time.

EndTimeYes

Timestamp
ISO8601

The end time.

MetricName

Yes

String

The query metric. Values:Name

l7Cache_outFlux_domain : Host/Domain name;l7Cache_outFlux_url : URL address;
l7Cache_outFlux_resourceType : Resource type;l7Cache_outFlux_statusCode : Status code.

©2013-2022 Tencent Cloud. All rights reserved.

Page 466 of 760

Tencent Cloud EdgeOne

ZoneIds.N

No

Array of String

ZoneId set. This parameter is required.

Limit

No

Integer

The number of data entries to be queried. The maximum value
is 1000. If it is not specified, the value 10 is used by default,
indicating that the top 10 data entries.

Filters.N

No

Array ofFilter conditions. See below for details:

QueryCondition

domainFilter by the sub-domain name, such as
test.example.com
Type: String
Required: No
url
Filter by the URL, such as /content . The query
period cannot exceed 30 days.
Type: String
Required: No
resourceType
Filter by the resource file type, such as jpg , png .
The query period cannot exceed 30 days.
Type: String
Required: No
cacheType
Filter by the cache hit result.
Type: String
Required: No
Values:hit : Cache hit;
dynamic : Resource non-cacheable;
miss : Cache missstatusCode
Filter by the status code. The query period cannot
exceed 30 days.
Type: String
Required: No
Values:1XX : All 1xx status codes;
100 : 100 status code;
101 : 101 status code;
102 : 102 status code;
2XX : All 2xx status codes;
200 : 200 status code;
201 : 201 status code;
202 : 202 status code;©2013-2022 Tencent Cloud. All rights reserved.

Page 467 of 760

Tencent Cloud EdgeOne

203 : 203 status code;
204 : 204 status code;
205 : 205 status code;
206 : 206 status code;
207 : 207 status code;
3XX : All 3xx status codes;
300 : 300 status code;
301 : 301 status code;
302 : 302 status code;
303 : 303 status code;
304 : 304 status code;
305 : 305 status code;
307 : 307 status code;
4XX : All 4xx status codes;
400 : 400 status code;
401 : 401 status code;
402 : 402 status code;
403 : 403 status code;
404 : 404 status code;
405 : 405 status code;
406 : 406 status code;
407 : 407 status code;
408 : 408 status code;
409 : 409 status code;
410 : 410 status code;
411 : 411 status code;
412 : 412 status code;
412 : 413 status code;
414 : 414 status code;
415 : 415 status code;
416 : 416 status code;
417 : 417 status code;
422 : 422 status code;
423 : 423 status code;
424 : 424 status code;
426 : 426 status code;
451 : 451 status code;
5XX : All 5xx status codes;
500 : 500 status code;
501 : 501 status code;
502 : 502 status code;
503 : 503 status code;
504 : 504 status code;©2013-2022 Tencent Cloud. All rights reserved.

Page 468 of 760

Tencent Cloud EdgeOne

505 : 505 status code;
506 : 506 status code;
507 : 507 status code;
510 : 510 status code;
514 : 514 status code;
544 : 544 status code.
tagKey :Filter by the tag key
Type: String
Required: No
tagValue
Filter by the tag value
Type: String
Required: No
The query time granularity. Values:
min : 1 minute;5min : 5 minutes;
hour : 1 hour;
day : 1 day.
Interval

No

StringIf this field is not specified, the granularity will be determinedbased on the interval between the start time and end time asfollows: 1-minute granularity applies for a 1-hour interval, 5minute granularity for a 2-day interval, 1-hour granularity for a
7-day interval, and 1-day granularity for an interval of over 7
days.
Geolocation scope. Values:
overseas : Regions outside the Chinese mainland

Area

No

Stringmainland : Chinese mainland
global : Global
If this field is not specified, the default value global isused.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of query results.

Data

Array of
TopDataRecord

The list of cached L7 top-ranked traffic data.
Note: This field may return null, indicating that no valid values can be©2013-2022 Tencent Cloud. All rights reserved.

Page 469 of 760

Tencent Cloud EdgeOne

obtained.

RequestId

String

The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Top Traffic Data with the Specified Tag
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7CacheData<Common request parameters>{"Area": "mainland","Interval": "day","Limit": "5","StartTime": "2022-07-31T00:00:00+08:00","EndTime": "2022-08-29T19:17:59+08:00","MetricName": "l7Cache_outFlux_cacheType","Filters": [{"Key": "tagKey","Operator": "equals","Value": ["test1"]},{"Key": "tagValue","Operator": "equals","Value": ["a.com","b.com"]}],"ZoneIds": ["zone-2mzegj4vln5f"©2013-2022 Tencent Cloud. All rights reserved.

Page 470 of 760

Tencent Cloud EdgeOne]}

Output Example{"Response": {"RequestId": "64463c6f-3296-47fa-b168-2040f841eed1","Data": [{"DetailData": [{"Key": "hit","Value": 5810001},{"Key": "miss","Value": 658}],"TypeKey": "251227260"}],"TotalCount": 1}}

Example2 Querying Top Traffic Data with the Specified Status CodeInput Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7CacheData<Common request parameters>{"Area": "mainland","Interval": "day","Limit": "5","StartTime": "2022-07-31T00:00:00+08:00","EndTime": "2022-08-29T19:17:59+08:00","MetricName": "l7Cache_outFlux_cacheType","Filters": [©2013-2022 Tencent Cloud. All rights reserved.

Page 471 of 760

Tencent Cloud EdgeOne{"Key": "statusCode","Operator": "equals","Value": ["2XX","3XX"]}],"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "64463c6f-3296-47fa-b168-2040f841eed1","Data": [{"DetailData": [{"Key": "hit","Value": 5810001},{"Key": "miss","Value": 658}],"TypeKey": "251227260"}],"TotalCount": 1}}

Example3 Querying L7 Cache Analysis Top Traffic Data
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json©2013-2022 Tencent Cloud. All rights reserved.

Page 472 of 760

Tencent Cloud EdgeOne

X-TC-Action: DescribeTopL7CacheData<Common request parameters>{"Area": "mainland","Interval": "day","Limit": "5","StartTime": "2022-07-31T00:00:00+08:00","EndTime": "2022-08-29T19:17:59+08:00","MetricName": "l7Cache_outFlux_cacheType","ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "64463c6f-4c96-47fa-b168-2040f841eed1","Data": [{"DetailData": [{"Key": "hit","Value": 7410001},{"Key": "miss","Value": 803}],"TypeKey": "251227260"}],"TotalCount": 1}}

Example4 Querying Top Traffic Data of Cache Hit and Cache Miss
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com©2013-2022 Tencent Cloud. All rights reserved.

Page 473 of 760

Tencent Cloud EdgeOne

Content-Type: application/json
X-TC-Action: DescribeTopL7CacheData<Common request parameters>{"Area": "mainland","Interval": "day","Limit": "5","StartTime": "2022-07-31T00:00:00+08:00","EndTime": "2022-08-29T19:17:59+08:00","MetricName": "l7Cache_outFlux_cacheType","Filters": [{"Key": "cacheType","Operator": "equals","Value": ["miss",
"hit"
]
}
],
"ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example{"Response": {"RequestId": "64463c6f-3296-47fa-b168-2040f841eed1","Data": [{"DetailData": [{"Key": "hit","Value": 7410001},{"Key": "miss","Value": 803}],"TypeKey": "251227260"}],©2013-2022 Tencent Cloud. All rights reserved.

Page 474 of 760

Tencent Cloud EdgeOne"TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

LimitExceeded.QueryTimeLimitExceeded

Query time limit exceeded.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 475 of 760

Tencent Cloud EdgeOne

Log Service APIs
DownloadL7Logs：

Last updated 2024-04-09 15:55:47

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to download L7 logs.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DownloadL7Logs.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

StartTimeYes

EndTimeYes

ZoneIds.N

No

Array of
StringZoneId set. This parameter is required.

Domains.N

No

Array of

List of subdomain names to be queried. All subdomain names will

Timestamp
ISO8601
Timestamp
ISO8601©2013-2022 Tencent Cloud. All rights reserved.

The start time.

The end time.

Page 476 of 760

Tencent Cloud EdgeOne

Stringbe selected if this field is not specified.

Limit

No

Integer

Limit on paginated queries. Default value: 20. Maximum value:
300.

OffsetNo

Integer

The page offset. Default value: 0.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of query results.

Data

Array of
L7OfflineLog

List of L7 logs.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request will
not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Downloading L7 Offline Logs
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DownloadL7Logs<Common request parameters>{"Offset": 0,"Limit": 10,"StartTime": "2022-05-04T03:27:00+08:00","EndTime": "2022-05-10T23:59:00+08:00","ZoneIds": ["zone-2mzegj4vln5f"]}©2013-2022 Tencent Cloud. All rights reserved.

Page 477 of 760

Tencent Cloud EdgeOne

Output Example{"Response": {"TotalCount": 1,"RequestId": "6f07d593-44d7-4bac-a119-e1923ab5b377","Data": [{"Area": "mainland","Domain": "test-add4.wellsjiang.com","LogPacketName": "20220811-02-test-add4.wellsjiang.com","LogTime": 1660212000,"LogStartTime": "2023-07-26T06:00:00+08:00","LogEndTime": "2023-07-26T07:00:00+08:00","Size": 7539,"Url": "https://log-down07-cn.edgeone.qcloud.com/2022081102-test-add4.wellsjiang.
com.log.gz"},{"Area": "overseas","Domain": "test.codegun.work","LogEndTime": "2023-07-26T07:14:59+08:00","LogPacketName": "20230725-2300-luatest3.codegun.work","LogStartTime": "2023-07-26T07:00:00+08:00","LogTime": 1690326000,"Size": 708,
"Url": "https://log-down07-ov-test.edgeone.qcloud.com/20230725/23/251233206/20230
7252300-test.codegun.work.log.gz"}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go©2013-2022 Tencent Cloud. All rights reserved.

Page 478 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

OperationDenied

Operation denied.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 479 of 760

Tencent Cloud EdgeOne

DownloadL4Logs：

Last updated 2024-04-09 15:56:37

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to download L4 logs.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

StartTime

Yes

Timestamp
ISO8601

The start time.

EndTimeYes

ZoneIds.N

No

Array of String

ZoneId set. This parameter is required.

ProxyIds.N

No

Array of String

List of L4 proxy instance IDs.

Timestamp
ISO8601©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
DownloadL4Logs.

The end time.

Page 480 of 760

Tencent Cloud EdgeOne

Limit

No

Integer

Limit on paginated queries. Default value: 20. Maximum
value: 300.

OffsetNo

Integer

The page offset. Default value: 0.

3. Output Parameters
Parameter
Name
TotalCount
Data

RequestId

Type

Description

Integer

Total number of query results.

Array of
L4OfflineLog

StringList of L4 logs.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request will
not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 L7 Offline Logs
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DownloadL4Logs<Common request parameters>{"Limit": 10,"Offset": 0,"StartTime": "2020-09-22T00:00:00+00:00","EndTime": "2020-09-22T00:00:00+00:00","ZoneIds": ["zone-2mzegj4vln5f"]}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 481 of 760

Tencent Cloud EdgeOne{"Response": {"RequestId": "8b6a2aa9-46ef-46e5-ba87-c0e96326adfe","Data": [{"Area": "mainland","LogPacketName": "20220811-10-proxy-1491-11ed-9792-525400655ede","LogTime": 1660212000,"LogStartTime": "2023-07-26T06:00:00+08:00","LogEndTime": "2023-07-26T07:00:00+08:00","ProxyId": "proxy-1491-11ed-9792-525400655ede","Size": 20761,"Url": "https://log-down04-cn.edgeone.qcloud.com/20220811/2022081110-proxy-1491-1
1ed-9792-52we0655ede.log.gz"}],"TotalCount": 128}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code©2013-2022 Tencent Cloud. All rights reserved.

Page 482 of 760

Tencent Cloud EdgeOne

The following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceUnavailable

The resource is unavailable.

©2013-2022 Tencent Cloud. All rights reserved.

Page 483 of 760

Tencent Cloud EdgeOne

CreateCLSIndex：

Last updated 2024-04-09 15:56:48

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create key-value indexes for relevant delivered log fields in the corresponding Tencent Cloud CLS
log topic for a specified real-time log delivery task (task-id). If such indexes have been created in CLS, this API will
append indexes through merging.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreateCLSIndex.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

TaskIdYesStringThe ID of the real-time log delivery task.

3. Output Parameters
Parameter

Type

DescriptionName©2013-2022 Tencent Cloud. All rights reserved.

Page 484 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a CLS Index
This example shows you how to create a key-value index in the corresponding Tencent Cloud CLS log topic according
to the log field list in the configuration of the real-time log delivery task for a specified task-id under a zone-id.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCLSIndex<Common Request Parameters>{"ZoneId": "zone-2fgd17m19xw","TaskId": "26580056-1187-43ed-b2c7-ecdb5bae0b46"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 485 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CreateClsLogSetFailed

Failed to create the log set. Check whether the log set name alreadyexists.

©2013-2022 Tencent Cloud. All rights reserved.

Page 486 of 760

Tencent Cloud EdgeOne

CreateRealtimeLogDeliveryTask：

Last updated 2024-05-29 14:55:50

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a real-time log delivery task. The following limits apply:
An entity (a Layer 7 domain name or a Layer 4 proxy instance) under the combination of the same data delivery type
(LogType) and data delivery area (Area) can be added to only one real-time log delivery task. It is recommended to
first query the real-time log delivery task list by entity through the DescribeRealtimeLogDeliveryTasks API to check
whether the entity has been added to another real-time log delivery task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreateRealtimeLogDeliveryTask.

VersionYes

StringCommon Params. The value used for this API:2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.
The name of the real-time log delivery task, which is

TaskName

Yes

String©2013-2022 Tencent Cloud. All rights reserved.

a combination of numbers, English letters, - and _,containing up to 200 characters.

Page 487 of 760

Tencent Cloud EdgeOne

TaskType

Yes

String

The type of the real-time log delivery task. Validvalues:cls: Push to Tencent Cloud CLS;
custom_endpoint: Push to a user-defined
HTTP(S) address;
s3: Push to an AWS S3-compatible bucket
address.
The list of entities (Layer 7 domains or Layer 4
proxy instances) corresponding to the real-time log
delivery task. Valid value examples:
Layer 7 domain: domain.example.com;

EntityList.N

Yes

Array of String

Layer 4 proxy instance: sid-2s69eb5wcms7.
Reference for values
DescribeAccelerationDomains
DescribeApplicationProxies
The type of data delivery. Valid values:

LogTypeYesStringdomain: Site acceleration log;
application: Layer 4 proxy log;
web-rateLiming: Rate limit and CC attack
defense log;
web-attack: Managed rule log;
web-rule: Custom rule log;
web-bot: Bot management log.

Area

Yes

StringFields.N

Yes

Array of String

CustomFields.N

No

DeliveryConditions.N

No

SampleNo

Array ofCustomField

The data delivery area. Valid values:
mainland: Within the Chinese mainland;
overseas: Global (excluding the Chinese
mainland).
The list of predefined fields for delivery.
The list of custom fields for delivery, supporting
extracting specified field values from HTTP request
headers, response headers, and cookies. Eachcustom field name must be unique and the
maximum number of fields is 200.

Array ofLog delivery filter conditions. If this field is not filled

DeliveryCondition

in, all logs will be delivered.

Integer

The sampling ratio in permille. Value range: 1 to
1000. For example, 605 represents a sampling ratioof 60.5%. If this field is not filled in, the sampling
ratio is 100%.

©2013-2022 Tencent Cloud. All rights reserved.

Page 488 of 760

Tencent Cloud EdgeOne

Output format for log delivery. If this field is not
specified, the default format is used, which works
as follows:
When TaskType is 'custom_endpoint', thedefault format is an array of JSON objects, with
LogFormat

No

LogFormat

each JSON object representing a log entry;
When TaskType is 's3', the default format is
JSON Lines;
Specifically, when TaskType is 'cls', the only
allowed value for LogFormat.FormatType is 'json',and other parameters in LogFormat will be ignored.
It is recommended not to transfer LogFormat.

CLS

No

CLSTopic

The configuration information of CLS. Thisparameter is required when TaskType is cls.
The configuration information of the custom HTTP

CustomEndpoint

S3

No

No

CustomEndpoint

S3

service. This parameter is required when TaskTypeis custom_endpoint.
The configuration information of the AWS S3compatible bucket. This parameter is required
when TaskType is s3.

3. Output Parameters
Parameter
Name
TaskIdRequestId

Type

Description

StringThe ID of the successfully created task.

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a Log Delivery Task with the Destination Set to Tencent Cloud CLSThis example shows you how to create a log delivery task with the destination set to Tencent Cloud CLS. The delivery
data range includes the site acceleration log generated by domain.example.com in the Chinese mainland. The data©2013-2022 Tencent Cloud. All rights reserved.

Page 489 of 760

Tencent Cloud EdgeOne

includes the RequestID, ClientIP, and RequestTime fields, and field values extracted from the Accept-Language
request header. The configuration sampling ratio is 60.5%.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRealtimeLogDeliveryTask<Common request parameters>{"ZoneId": "zone-xxxxx","TaskName": "test_log_task","TaskType": "cls","EntityList": ["domain.example.com"],"LogType": "domain","Area": "mainland","Fields": ["RequestID","ClientIP","RequestTime"],"CustomFields": [{"Name": "ReqHeader","Value": "Accept-Language","Enabled": true}],
"Sample": 605,
"CLS": {"LogSetId": "1a6efff1-0e40-4d37-a4ed-02c92513406b","TopicId": "0b3a07c0-5cf6-4017-8a75-cd4459aea588","LogSetRegion": "ap-guangzhou"}}

Output Example{"Response": {"TaskId": "26580056-1187-43ed-b2c7-ecdb5bae0b46","RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"©2013-2022 Tencent Cloud. All rights reserved.

Page 490 of 760

Tencent Cloud EdgeOne}}

Example2 Creating a Log Delivery Task with the Destination Set to a Custom HTTP Service
This example shows you how to create a log delivery task with the destination set to a custom HTTP service. The
delivery data range includes the site acceleration log generated by domain.example.com in the Chinese mainland andwith the final security handling method being interception or challenge. The data includes the RequestID, ClientIP, andRequestTime fields. Log sampling is disabled, log delivery compression is enabled, and the custom request header
Vendor with a constant value of EdgeOne is carries during log delivery.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRealtimeLogDeliveryTask<Common request parameters>{"ZoneId": "zone-xxxxx","TaskName": "test_log_task","TaskType": "custom_endpoint","EntityList": ["domain.example.com"],"LogType": "domain","Area": "mainland","Fields": ["RequestID","ClientIP","RequestTime"],"Sample": 1000,"DeliveryConditions": [{"Conditions": [{"Key": "SecurityAction","Operator": "equal","Value": ["Deny","JSChallenge","ManagedChallenge"]©2013-2022 Tencent Cloud. All rights reserved.

Page 491 of 760

Tencent Cloud EdgeOne

}
]
}
],
"CustomEndpoint": {"Url": "http://custom_endpoint/access_log/post","CompressType": "gzip","Headers": [{"Name": "Vendor","Value": "EdgeOne"}]}}

Output Example{"Response": {"TaskId": "26580056-1187-43ed-b2c7-ecdb5bae0b46","RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 492 of 760

Tencent Cloud EdgeOne

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CreateClsLogSetFailed

FailedOperation.CreateClsLogTopicTaskFailed

FailedOperation.CreateLogTopicTaskAuthFailure

Failed to create the log set. Check whether the log set
name already exists.
Failed to create the log topic task. Check whether the log
topic name or task name already exists.
Authentication failed while creating a custom push task.
Check whether the push address is correct.

FailedOperation.RealtimeLogAuthFailure

The real-time log authentication failed.

FailedOperation.RealtimeLogNotFoundThe real-time log push task does not exist.

InvalidParameter

Parameter error.

InvalidParameter.InvalidLogFormatFieldDelimiter

The field separator in the log output format is incorrect.

InvalidParameter.InvalidLogFormatFormatType

The log output format type is incorrect.

InvalidParameter.InvalidLogFormatRecordDelimiter

The log record separator in the log output format isincorrect.

InvalidParameter.RealtimeLogEntityAlreadyCreated

The push instance has been created.

InvalidParameter.RealtimeLogInvalidDeliveryArea

The log push region is invalid.

InvalidParameter.RealtimeLogInvalidLogType

The log push type is invalid.

InvalidParameter.RealtimeLogInvalidTaskType

The real-time log delivery type is invalid.

InvalidParameter.RealtimeLogNumsExceedLimit

The real-time log push task data exceeded the limit.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

The quota limit has been reached.

©2013-2022 Tencent Cloud. All rights reserved.

Page 493 of 760

Tencent Cloud EdgeOne

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable

The resource is unavailable.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation.
Please get permissions first.

©2013-2022 Tencent Cloud. All rights reserved.

Page 494 of 760

Tencent Cloud EdgeOne

ModifyRealtimeLogDeliveryTask：

Last updated 2024-06-05 14:40:56

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify the real-time log delivery task configuration. This API has the following restrictions:
Does not support modifying the destination type of the real-time log delivery task (TaskType);
Does not support modifying the data delivery type (LogType)
Does not support modifying the data delivery area (Area)
Does not support modifying the detailed destination configuration, such as log set and log topic, when thedestination of the original real-time log delivery task is Tencent Cloud CLS.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyRealtimeLogDeliveryTask.

VersionYes

StringRegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

TaskIdYesStringThe ID of the real-time log delivery task.

©2013-2022 Tencent Cloud. All rights reserved.

Common Params. The value used for this API:2022-09-01.

Page 495 of 760

Tencent Cloud EdgeOne

TaskName

No

String

The name of the real-time log delivery task, which is
a combination of numbers, English letters, - and _,containing up to 200 characters. If this field is not
filled in, the original configuration will be retained.
The status of the real-time log delivery task. Validvalues:

DeliveryStatus

No

Stringenabled : Enabled;
disabled : Disabled.
If this field is not filled in, the original configuration
will be retained.
The list of entities (Layer 7 domains or Layer 4
proxy instances) corresponding to the real-time log
delivery task. Valid value examples:
Layer 7 domain: domain.example.com;

EntityList.N

No

Array of String

Layer 4 proxy instance: sid-2s69eb5wcms7.
If this field is not filled in, the original configuration
will be retained.
Reference for values
DescribeAccelerationDomains
DescribeApplicationProxies
The list of predefined fields for delivery. If this field

Fields.N

No

Array of String

is not filled in, the original configuration will be
retained.
The list of custom fields for delivery, supporting

CustomFields.N

No

Array ofCustomField

extracting specified field values from HTTP request
headers, response headers, and cookies. Eachcustom field name must be unique and the
maximum number of fields is 200. If this field is not
filled in, the original configuration will be retained.

DeliveryConditions.N

No

Array of
DeliveryCondition

Log delivery filter conditions. If this field is not filled
in, all logs will be delivered.
The sampling ratio in permille. Value range: 1 to

SampleNo

Integer

LogFormat

No

LogFormat

1000. For example, 605 represents a sampling ratioof 60.5%. If this field is not filled in, the original
configuration will be retained.
Output format for log delivery. If this field is not
specified, the original configuration will be
retained.Specifically, when TaskType is set to cls,
the value of LogFormat.FormatType can only be©2013-2022 Tencent Cloud. All rights reserved.

Page 496 of 760

Tencent Cloud EdgeOnejson, and other parameters in LogFormat will beignored. It is recommended not to input LogFormat.

CustomEndpoint

No

CustomEndpoint

The configuration information of the custom HTTP
service. If this field is not filled in, the original
configuration will be retained.

S3

No

S3

The configuration information of the AWS S3compatible bucket. If this field is not filled in, theoriginal configuration will be retained.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Disabling Log SamplingThis example shows you how to modify the configuration of a successfully created real-time log delivery task anddisable its log sampling feature. Before modification, the log sampling ratio is 60.5%. After modification, log sampling
will no longer be performed, and 100% of the logs will be delivered to the destination.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRealtimeLogDeliveryTask<Common request parameters>{"ZoneId": "zone-2ju9lrnpayol","TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p","Sample": 1000}

©2013-2022 Tencent Cloud. All rights reserved.

Page 497 of 760

Tencent Cloud EdgeOne

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"}}

Example2 Adding Acceleration Domains for Log Delivery
This example shows you how to modify the configuration of a successfully created real-time log delivery task and add
acceleration domains for which logs need to be delivered. Before modification, only the site acceleration log of
domain1.example.com is delivered. After modification, the site acceleration logs of domain1.example.com,
domain2.example.com, and domain3.example.com will be delivered.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRealtimeLogDeliveryTask<Common request parameters>{"ZoneId": "zone-2ju9lrnpayol","TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p","EntityList": ["domain1.example.com","domain2.example.com","domain3.example.com"]}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 498 of 760

Tencent Cloud EdgeOne

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CreateLogTopicTaskAuthFailure

Authentication failed while creating a custom pushtask. Check whether the push address is correct.

InvalidParameter.InvalidLogFormatFieldDelimiter

The field separator in the log output format is incorrect.

InvalidParameter.InvalidLogFormatFormatType

The log output format type is incorrect.

InvalidParameter.InvalidLogFormatRecordDelimiter

LimitExceeded.CustomLogFieldRegexLimitExceeded©2013-2022 Tencent Cloud. All rights reserved.

The log record separator in the log output format isincorrect.
The number of regular expression type fields in realtime log custom fields exceeds the limit.

Page 499 of 760

Tencent Cloud EdgeOne

DeleteRealtimeLogDeliveryTask：

Last updated 2024-04-09 15:57:19

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete a real-time log delivery task.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DeleteRealtimeLogDeliveryTask.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

TaskIdYesStringThe ID of the real-time log delivery task.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 500 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting a Real-time Log Delivery Task
This example shows you how to delete a real-time log delivery task with a specified task-id.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteRealtimeLogDeliveryTask<Common request parameters>{"ZoneId": "zone-2qtwuwmeaaae","TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 501 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

©2013-2022 Tencent Cloud. All rights reserved.

Page 502 of 760

Tencent Cloud EdgeOne

DescribeRealtimeLogDeliveryTasks：

Last updated 2024-05-29 14:55:49

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the real-time log delivery task list.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeRealtimeLogDeliveryTasks.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

OffsetNo

Integer

The offset of paginated query. Default value: 0.

Limit

No

Integer

The limit of paginated query. Default value: 20. Maximum value:
1000.

Filters.N

No

Array of
AdvancedFilter

Filter conditions. The maximum value for Filters.Values is 20. If
this field is not filled in, all the real-time log delivery taskName

information under the current zone-id will be returned. Detailed
filter conditions are as follows:©2013-2022 Tencent Cloud. All rights reserved.

Page 503 of 760

Tencent Cloud EdgeOnetask-id: Filter by real-time log delivery task ID. Fuzzy search
is not supported.
task-name: Filter by real-time log delivery task name. Fuzzy
search is supported, but only one real-time log delivery task
name can be filled in for fuzzy search.
entity-list: Filter by entity corresponding to the real-time log
delivery task. Fuzzy search is not supported. Example values:
domain.example.com or sid-2s69eb5wcms7.
task-type: Filter by real-time log delivery task type. Fuzzy
search is not supported. Optional values:
cls: Push to Tencent Cloud CLS;
custom_endpoint: Push to a user-defined HTTP(S) address;
s3: Push to an AWS S3-compatible bucket address.

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

The number of real-time log delivery tasks whichmatch the query conditions.

RealtimeLogDeliveryTasks

Array ofRealtimeLogDeliveryTask

The list of all real-time log delivery tasks whichmatch the query conditions.
The unique request ID, generated by the server,

RequestId

Stringwill be returned for every request (if the request
fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId isrequired for locating a problem.

4. Example
Example1 Querying All Real-time Log Delivery Task Information for a Specific Site
Query all real-time log delivery task information for a specified zone ID.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealtimeLogDeliveryTasks©2013-2022 Tencent Cloud. All rights reserved.

Page 504 of 760

Tencent Cloud EdgeOne<Common request parameters>{"ZoneId": "zone-2ur49nglp1a2","Offset": 0,"Limit": 1000}

Output Example{"Response": {"RealtimeLogDeliveryTasks": [{"Area": "overseas","CLS": {"LogSetId": "980611e5-3eb2-430f-a0cc-e1c4e84a9e40","LogSetRegion": "ap-guangzhou","TopicId": "d258c060-dc6e-4586-8b7c-6a951667fa7a"},"CreateTime": "2024-03-26T03:00:39+08:00","CustomEndpoint": null,"CustomFields": [],"DeliveryConditions": [],"DeliveryStatus": "enabled","EntityList": ["qqqq.loliyu.com"],"Fields": ["RequestID","ClientIP","ClientRegion","RequestTime","RequestHost","RequestBytes","RequestMethod","RequestUrl","RequestUrlQueryString","RequestUA","RequestRange","RequestReferer","RequestProtocol","RemotePort","EdgeCacheStatus","EdgeResponseStatusCode","EdgeResponseBytes",©2013-2022 Tencent Cloud. All rights reserved.

Page 505 of 760

Tencent Cloud EdgeOne"EdgeResponseTime","EdgeInternalTime","ClientState","ClientISP","EdgeServerID","EdgeServerIP"],"LogFormat": null,"LogType": "domain","S3": null,"Sample": 0,"TaskId": "f0e1686a-1c4e-4f15-967b-5afb2a0803ea","TaskName": "ccc","TaskType": "cls","UpdateTime": "2024-03-26T03:10:13+08:00"}],"RequestId": "05205d07-f582-444d-b558-b338a3f68857","TotalCount": 1}}

Example2 Querying Real-time Log Delivery Task Information by Acceleration Domain Name
Query real-time log delivery task information for a specified acceleration domain name. If TotalCount in returned
output result is '0', it indicates that this acceleration domain name has not been added to any Real-time Log Delivery
Task.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealtimeLogDeliveryTasks<Common request parameters>{"ZoneId": "zone-2o7b38ba1hvr","Offset": 0,"Limit": 20,"Filters": [{"Name": "entity-list","Values": ["domain.example.com"]©2013-2022 Tencent Cloud. All rights reserved.

Page 506 of 760

Tencent Cloud EdgeOne}]}

Output Example{"Response": {"TotalCount": 0,"RealtimeLogDeliveryTasks": [],"RequestId": "f025c1f0-cb83-41b1-bb7d-565af7e28479"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 507 of 760

Tencent Cloud EdgeOne

UnauthorizedOperation.CamUnauthorized©2013-2022 Tencent Cloud. All rights reserved.

CAM is not authorized.

Page 508 of 760

Tencent Cloud EdgeOne

Billing APIs
CreatePlan：

Last updated 2024-05-29 14:56:54

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
If you need to use the EdgeOne product, you must create a billing plan through this interface.

After creating a plan, you need to complete the process of creating a site and binding the plan throughCreateZone, so that the EdgeOne can provide services properly.

A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreatePlan.

VersionYes

StringRegionNo

StringCommon Params. This parameter is not required.

PlanType

Yes

StringType of plan subscribed to. Valid values:
personal: Personal Edition Plan, prepaid;©2013-2022 Tencent Cloud. All rights reserved.

Common Params. The value used for this API:2022-09-01.

Page 509 of 760

Tencent Cloud EdgeOne

basic: Basic Edition Plan, prepaid;
standard: Standard Edition Plan, prepaid;
enterprise: Enterprise Edition Plan, post-paid.
When subscribing to a prepaid plan, ensure there issufficient balance in the account, as insufficientbalance will result in a pending payment order.
For an overview of billing, refer to Billing Overview.
For differences between plans, refer to Comparisonof EdgeOne Plan.
Whether to automatically use a voucher. Validvalues:true: Yes;
AutoUseVoucher

No

Stringfalse: No.
This parameter is valid only when PlanType ispersonal, basic, or standard.
If this field is not specified, the default value 'false'
will be used.
Parameters for subscribing to prepaid plans. When
PlanType is personal, basic, or standard, thisPrepaidPlanParamNo

PrepaidPlanParam

parameter can be optionally set to specify thesubscription duration and whether to enable autorenewal for the plan.
If this field is not specified, the default plan durationis 1 month, with auto-renewal disabled.

3. Output Parameters
Parameter
Name

Type

Description

PlanIdStringPlan ID, formatted as edgeone-2unuvzjmmn2q.

DealName

StringOrder number.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example©2013-2022 Tencent Cloud. All rights reserved.

Page 510 of 760

Tencent Cloud EdgeOne

Example1 Creating Personal Edition Billing Plan
Create a Personal Edition Billing Plan, with a duration of 1 month, and set it not to auto-renew.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePlan<Common request parameters>{"PlanType": "personal","PrepaidPlanParam": {"Period": 1,"RenewFlag": "off"},"AutoUseVoucher": "false"}

Output Example{"Response": {"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461","PlanId": "edgeone-2unuvzjmmn2q","DealName": "20240312347001004723731"}}

Example2 Creating Enterprise Edition Plan
Create an Enterprise Edition Plan.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePlan<Common request parameters>{"PlanType": "enterprise"}©2013-2022 Tencent Cloud. All rights reserved.

Page 511 of 760

Tencent Cloud EdgeOne

Output Example{"Response": {"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461","PlanId": "edgeone-2unuvzjmmn2q","DealName": "20240312347001004723731"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.InsufficientAccountBalance

The account balance is insufficient.

InvalidParameter.InvalidAutoUseVoucher

The format of automatically used vouchers is incorrect.
Enter the correct format.

©2013-2022 Tencent Cloud. All rights reserved.

Page 512 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidPeriod

The plan cycle format is incorrect. Enter the correct
format.

InvalidParameter.InvalidPlanType

The plan type format is incorrect. Enter the correct
format.

InvalidParameter.InvalidRenewFlag

OperationDenied.PleaseContactBusinessPersonnel©2013-2022 Tencent Cloud. All rights reserved.

The auto-renewal flag format is incorrect. Enter thecorrect format.
To create an Enterprise Edition Plan, contact thebusiness personnel.

Page 513 of 760

Tencent Cloud EdgeOne

UpgradePlan：

Last updated 2024-05-29 14:56:50

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
When you need features available only in higher-tier plans, you can upgrade your plan through this interface.
Upgrades are only supported for Personal and Basic Edition Plans.

For differences between EdgeOne billing plans, refer to Comparison of EdgeOne Plans.
For EdgeOne plan upgrade rules and pricing details, refer to EdgeOne Plan Upgrade Guide.
If your plan needs to upgrade to the Enterprise Edition, Contact Us.

A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: UpgradePlan.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

PlanIdYesStringPlan ID, formatted as edgeone-2unuvzjmmn2q.

PlanType

Yes

StringTarget plan version for upgrade. Valid values:
basic: Basic Edition Plan;©2013-2022 Tencent Cloud. All rights reserved.

Page 514 of 760

Tencent Cloud EdgeOne

standard: Standard Edition Plan.

AutoUseVoucher

No

StringWhether to automatically use a voucher. Valid values:
true: Yes;
false: No.
If this field is not specified, the default value 'false' will be used.

3. Output Parameters
Parameter
Name
DealName

RequestId

Type

Description

StringOrder number.

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Upgrading Prepaid Plan to Standard Edition
Upgrade the prepaid plan edgeone-2unuvzjmmn2q to the Standard Edition without using the voucher.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradePlan<Common request parameters>{"PlanId": "edgeone-2unuvzjmmn2q","PlanType": "standard","AutoUseVoucher": "false"}

Output Example{"Response": {©2013-2022 Tencent Cloud. All rights reserved.

Page 515 of 760

Tencent Cloud EdgeOne"DealName": "20240312347001004723731","RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.InsufficientAccountBalance

The account balance is insufficient.

InvalidParameter.InvalidAutoUseVoucher

The format of automatically used vouchers isincorrect. Enter the correct format.

InvalidParameter.InvalidPlanType

The plan type format is incorrect. Enter the correct
format.

InvalidParameter.PlanNotFoundThe plan doesn’t exist.

OperationDenied.EnterprisePlanUpgradeUnsupported

The Enterprise Edition Plan does not support©2013-2022 Tencent Cloud. All rights reserved.

Page 516 of 760

Tencent Cloud EdgeOne

upgrades.
OperationDenied.PlanDowngradeNotAllowed

A plan downgrade is not supported.

OperationDenied.PlanHasBeenExpired

The plan has expired.

OperationDenied.PlanHasBeenIsolated

The plan has been isolated.

OperationDenied.ResourceHasBeenLocked

Billing resources are in operation. Try again later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 517 of 760

Tencent Cloud EdgeOne

RenewPlan：

Last updated 2024-05-29 14:56:50

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
When your plan needs to be extended, you can use this interface to renew it. Plan renewal is only supported for the
Personal, Basic, and Standard Editions.

For cost details, refer to Plan Fees.

A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: RenewPlan.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

PlanIdYesStringPlan ID, formatted as edgeone-2unuvzjmmn2q.

PeriodYes

Integer

AutoUseVoucher

No

StringName©2013-2022 Tencent Cloud. All rights reserved.

Renewal plan duration, unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7,
8, 9, 10, 11, 12, 24, 36.
Whether to automatically use a voucher. Valid values:

Page 518 of 760

Tencent Cloud EdgeOne

true: Yes;
false: No.
If this field is not specified, the default value 'false' will be used.

3. Output Parameters
Parameter
Name
DealName

RequestId

Type

Description

StringOrder number.

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Renewing Plan for Three Months
The plan edgeone-2unuvzjmmn2q is renewed for three months and the voucher will not be automatically used.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewPlan<Common request parameters>{"PlanId": "edgeone-2unuvzjmmn2q","Period": 3,"AutoUseVoucher": "false"}

Output Example{"Response": {"DealName": "20240312347001004723731","RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"©2013-2022 Tencent Cloud. All rights reserved.

Page 519 of 760

Tencent Cloud EdgeOne}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.InsufficientAccountBalance

The account balance is insufficient.

InvalidParameter.InvalidAutoUseVoucher

The format of automatically used vouchers is incorrect.
Enter the correct format.

InvalidParameter.InvalidPeriod

The plan cycle format is incorrect. Enter the correct
format.

InvalidParameter.PlanNotFoundThe plan doesn’t exist.

OperationDenied.EnterprisePlanRenewUnsupported

The Enterprise Edition Plan does not support renewal.

OperationDenied.ResourceHasBeenLocked

Billing resources are in operation. Try again later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 520 of 760

Tencent Cloud EdgeOne©2013-2022 Tencent Cloud. All rights reserved.

Page 521 of 760

Tencent Cloud EdgeOne

ModifyPlan：

Last updated 2024-05-29 14:56:51

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
Modify the plan settings. Currently, only the auto-renewal switch of prepaid plans can be modified.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: ModifyPlan.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

PlanIdYesStringPlan ID, formatted as edgeone-2unuvzjmmn2q.

Name

Auto-renewal configuration item in a prepaid plan. If auto-renewal is
RenewFlag

No

RenewFlag

enabled, the plan will be automatically renewed one day before it
expires. This feature is only available for Personal, Basic, andStandard Edition Plans. If this field is not specified, the original
configuration will be retained.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 522 of 760

Tencent Cloud EdgeOne

Parameter
Name

Type

Description

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying Auto-Renewal Tag for Prepaid Plan
Enable the auto-renewal feature for the prepaid plan edgeone-2unuvzjmmn2q.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPlanRenewFlag<Common request parameters>{"PlanId": "edgeone-2unuvzjmmn2q","RenewFlag": {"Switch": "on"}}Output Example{"Response": {"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 523 of 760

Tencent Cloud EdgeOne

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameter.PlanNotFoundThe plan doesn’t exist.

OperationDenied.EnterprisePlanAutoRenewUnsupported
OperationDenied.PlanHasBeenIsolated©2013-2022 Tencent Cloud. All rights reserved.

The Enterprise Edition Plan does not support autorenewal.
The plan has been isolated.

Page 524 of 760

Tencent Cloud EdgeOne

IncreasePlanQuota：

Last updated 2024-05-29 14:56:52

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
When the number of sites bound to your plan, the number of rules under "Web Protection - Custom Rules - Precision
Matching Policy", or the number of rules under "Web Protection - Rate Limiting - Precision Rate Limiting Module"
reaches the plan's quota, you can use this interface to purchase additional quotas.

This interface only supports the Enterprise Edition Plan.

A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: IncreasePlanQuota.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

PlanIdYesStringPlan ID, formatted as edgeone-2unuvzjmmn2q.

QuotaType

Yes

String

The types of new plan quotas available include:Namesite: Number of sites;©2013-2022 Tencent Cloud. All rights reserved.

Page 525 of 760

Tencent Cloud EdgeOne

precise_access_control_rule: the number of rules under "WebProtection - Custom Rules - Precision Matching Policy";
rate_limiting_rule: the number of rules under "Web Protection Rate Limiting - Precision Rate Limiting Module".
QuotaNumber

Yes

IntegerNumber of new quotas. The maximum number of quotas that can be
added at one time is 100.

3. Output Parameters
Parameter
Name

Type

Description

DealName

StringOrder number.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Adding Site Number Quota to Plan
Add 10 site number quotas for the plan edgeone-2unuvzjmmn2q.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPlanQuota<Common request parameters>{"PlanId": "edgeone-2unuvzjmmn2q","QuotaType": "site","QuotaNumber": 10}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 526 of 760

Tencent Cloud EdgeOne{"Response": {"DealName": "20240312347001004723731","RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"}}

Example2 Adding Custom Rule Quotas to Plan
Add 10 rule quotas for "Web Protection - Custom Rules - Precision Matching Policy" to the plan edgeone2unuvzjmmn2q.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPlanQuota<Common request parameters>{"PlanId": "edgeone-2unuvzjmmn2q","QuotaType": "precise_access_control_rule","QuotaNumber": 10}

Output Example{"Response": {"DealName": "20240312347001004723731","RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to callAPIs.

©2013-2022 Tencent Cloud. All rights reserved.

Page 527 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation.InsufficientAccountBalance

The account balance is insufficient.

InvalidParameter.InvalidQuotaNumber

The quota quantity format is incorrect. Enter thecorrect format.

InvalidParameter.InvalidQuotaType

The quota type format is incorrect. Enter the correct
quota type format.

OperationDenied.PlanHasBeenIsolated

The plan has been isolated.

OperationDenied.PlanIncreasePlanQuotaUnsupported

This plan does not support the purchase of additional
plan quotas.

OperationDenied.ResourceHasBeenLocked

Billing resources are in operation. Try again later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 528 of 760

Tencent Cloud EdgeOne

DestroyPlan：

Last updated 2024-05-29 14:56:53

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
To stop billing for your EdgeOne plan, you can use this interface to terminate the billing plan.

Terminating a billing plan requires the following conditions:
1. The plan has expired (except for the Enterprise Edition Plan);
2. All sites under the plan have been either shut down or deleted.

The site status can be queried through the Query Site List interface.
A site can be deactivated by switching the site to a closed status through the Switch Site Status interface.
A site can be deleted by using the Delete Site interface.

A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DestroyPlan.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

©2013-2022 Tencent Cloud. All rights reserved.

Page 529 of 760

Tencent Cloud EdgeOne

PlanIdYesStringPlan ID, in the format of edgeone-2wdo315m2y4c.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Terminating Billing Plan
Terminate the billing plan edgeone-2wdo315m2y4c.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DestroyPlan<Common request parameters>{"PlanId": "edgeone-2wdo315m2y4c"}

Output Example{"Response": {"RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"}}

5. Developer Resources©2013-2022 Tencent Cloud. All rights reserved.

Page 530 of 760

Tencent Cloud EdgeOne

SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameter.PlanNotFoundThe plan doesn’t exist.

OperationDenied.DisableZoneNotCompleted

The EdgeOne service of the site is being disabled. Please try
again later.

©2013-2022 Tencent Cloud. All rights reserved.

Page 531 of 760

Tencent Cloud EdgeOne

CreatePlanForZone：

Last updated 2024-05-29 14:56:01

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to purchase a plan for a new site.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: CreatePlanForZone.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site.

PlanType

Yes

String

The plan option. Values:sta : Standard plan that supports content delivery network outside
the Chinese mainland.
sta_with_bot : Standard plan that supports content delivery
network outside the Chinese mainland and bot management.
sta_cm : Standard plan that supports content delivery network
inside the Chinese mainland.
sta_cm_with_bot : Standard plan that supports content delivery
network inside the Chinese mainland and bot management.

©2013-2022 Tencent Cloud. All rights reserved.

Page 532 of 760

Tencent Cloud EdgeOne

sta_global : Standard plan that supports content delivery network
over the globe.
sta_global_with_bot : Standard plan that supports content
delivery network over the globe and bot management.
ent : Enterprise plan that supports content delivery network outside
the Chinese mainland.
ent_with_bot : Enterprise plan that supports content delivery
network outside the Chinese mainland and bot management.
ent_cm : Enterprise plan that supports content delivery network
inside the Chinese mainland.
ent_cm_with_bot : Enterprise plan that supports content delivery
network inside the Chinese mainland and bot management.
ent_global : Enterprise plan that supports content delivery
network over the globe.
ent_global_with_bot : Enterprise plan that supports content
delivery network over the globe and bot management.
To get the available plan options for your account, view the output from
DescribeAvailablePlans.

3. Output Parameters
Parameter
Name

ResourceNames

Type

Description

Array
of

List of purchased resources.

StringDealNames

Arrayof
StringList or order numbers.

The unique request ID, generated by the server, will be returned for every request
RequestId

String(if the request fails to reach the server for other reasons, the request will not
obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 CreatePlanForZone
This example shows you how to create a plan for a zone.

©2013-2022 Tencent Cloud. All rights reserved.

Page 533 of 760

Tencent Cloud EdgeOne

Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePlanForZone<Common Request Parameters>{"ZoneId": "zone-25z65bfb4414","PlanType": "sta"}Output Example{"Response": {"RequestId": "a06f52e7-2aab-4510-b2c2-1065bfb4414c","ResourceNames": ["plan_sta"],"DealNames": ["2022080135400110011001"]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++©2013-2022 Tencent Cloud. All rights reserved.

Page 534 of 760

Tencent Cloud EdgeOne

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.InsufficientAccountBalance

The account balance is insufficient.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter.ZoneHasBeenBoundThe site is already bound.

OperationDenied

Operation denied.

OperationDenied.DomainNoICPThe domain name doesn't have an ICP filing number.

©2013-2022 Tencent Cloud. All rights reserved.

Page 535 of 760

Tencent Cloud EdgeOne

BindZoneToPlan：

Last updated 2024-04-09 10:26:18

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to bind a site to a plan.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: BindZoneToPlan.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site to be bound.

PlanIdYesStringID of the target plan.

3. Output Parameters
Parameter
Name
RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if the©2013-2022 Tencent Cloud. All rights reserved.

Page 536 of 760

Tencent Cloud EdgeOne

request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Binding a site to a target plan
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BindZoneToPlan<Common request parameters>{"ZoneId": "zone-xxyyyzzz","PlanId": "edgeone-qqqwwweee"}

Output Example{"Response": {"RequestId": "fd9d86df-b7e8-4469-b928-18cb7fd145641"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js©2013-2022 Tencent Cloud. All rights reserved.

Page 537 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError

Internal error.

InvalidParameter.PlanNotFoundThe plan doesn’t exist.

InvalidParameter.ZoneHasBeenBoundThe site is already bound.

InvalidParameter.ZoneNotFoundThe site does not exist.

InvalidParameterValue

Invalid parameter value.

LimitExceeded

The quota limit has been reached.

OperationDenied

Operation denied.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 538 of 760

Tencent Cloud EdgeOne

DescribeBillingData：

Last updated 2024-04-09 10:26:16

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query billing data.
A maximum of 50 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeBillingData.

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

StartTimeYes

EndTimeYes

Timestamp
ISO8601

End time of the query.

ZoneIds.N

Yes

Array of String

Zone ID set. This parameter is required.

MetricName

Yes

StringIndicator list. Valid values:
acc_flux: Content acceleration traffic, in bytes;

Name

Timestamp
ISO8601©2013-2022 Tencent Cloud. All rights reserved.

Start time of the query.

Page 539 of 760

Tencent Cloud EdgeOne

smt_flux: Smart acceleration traffic, in bytes;
l4_flux: Layer 4 acceleration traffic, in bytes;
sec_flux: Exclusive DDoS mitigation traffic, in bytes;
zxctg_flux: Cross-MLC-border acceleration traffic, inbytes;
acc_bandwidth: Content acceleration bandwidth, inbps;
smt_bandwidth: Smart acceleration bandwidth, in bps;
l4_bandwidth: Layer 4 acceleration bandwidth, in bps;
sec_bandwidth: Exclusive DDoS mitigation bandwidth,
in bps;zxctg_bandwidth: Cross-MLC-border acceleration
bandwidth, in bps;
sec_request_clean: HTTP/HTTPS requests, in count;
smt_request_clean: Smart acceleration requests, incount;
quic_request: QUIC requests, in count;bot_request_clean: Bot requests, in count;
cls_count: Real-time log delivery log counts, in count;ddos_bandwidth: Exclusive DDoS mitigation elastic
bandwidth, in bps.
Query granularity. Valid values:
Interval

Yes

String

5min: 5-minute granularity;
hour: 1-hour granularity;
day: 1-day granularity.
Filter. The detailed filters are as follows:
host: Filter by Domain Name. Example:
test.example.com.
proxy-id: Filter by Layer 4 Proxy Instance ID. Example:
sid-2rugn89bkla9.
region-id: Filter by Billing Region.Options are:Filters.N

No

Array of
BillingDataFilter

CH: Chinese mainland
AF: Africa
AS1: Asia-Pacific Region 1
AS2: Asia-Pacific Region 2
AS3: Asia-Pacific Region 3
EU: Europe
MidEast: Middle East
NA: North America
SA: South America

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 540 of 760

Tencent Cloud EdgeOne

Parameter
Name
Data

RequestId

Type

Description

Array of
BillingData

Note: This field may return null, indicating that no valid values can be obtained.

String

The unique request ID, generated by the server, will be returned for every request(if the request fails to reach the server for other reasons, the request will not obtaina RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying content acceleration traffic in the specified zone and billing region
This example shows you how to query the billing volume of content acceleration traffic with a specific zone ID andregion ID on a daily granularity.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillingData<Common Request Parameters>{"StartTime": "2024-01-01T00:00:00+08:00","EndTime": "2024-01-24T03:20:00+08:00","Interval": "day","MetricName": "acc_flux","Filters": [{"Type": "region-id","Value": "MidEast"}],"ZoneIds": ["zone-2smdfso9dr58"]}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 541 of 760

Tencent Cloud EdgeOne{"Response": {"RequestId": "457e8933-4296-4878-9a7f-fb888559e29e","Data": [{"Time": "2023-12-31T16:00:00Z","Value": 0},{"Time": "2024-01-01T16:00:00Z","Value": 0},{"Time": "2024-01-02T16:00:00Z","Value": 0},{"Time": "2024-01-03T16:00:00Z","Value": 0},{"Time": "2024-01-04T16:00:00Z","Value": 0},{"Time": "2024-01-05T16:00:00Z","Value": 0},{"Time": "2024-01-06T16:00:00Z","Value": 0},{"Time": "2024-01-07T16:00:00Z","Value": 0},{"Time": "2024-01-08T16:00:00Z","Value": 0},{"Time": "2024-01-09T16:00:00Z","Value": 0},{"Time": "2024-01-10T16:00:00Z",©2013-2022 Tencent Cloud. All rights reserved.

Page 542 of 760

Tencent Cloud EdgeOne"Value": 0},{"Time": "2024-01-11T16:00:00Z","Value": 0},{"Time": "2024-01-12T16:00:00Z","Value": 0},{"Time": "2024-01-13T16:00:00Z","Value": 0},{"Time": "2024-01-14T16:00:00Z","Value": 0},{"Time": "2024-01-15T16:00:00Z","Value": 0},{"Time": "2024-01-16T16:00:00Z","Value": 0},{"Time": "2024-01-17T16:00:00Z","Value": 0},{"Time": "2024-01-18T16:00:00Z","Value": 0},{"Time": "2024-01-19T16:00:00Z","Value": 0},{"Time": "2024-01-20T16:00:00Z","Value": 0},{"Time": "2024-01-21T16:00:00Z","Value": 0},{©2013-2022 Tencent Cloud. All rights reserved.

Page 543 of 760

Tencent Cloud EdgeOne"Time": "2024-01-22T16:00:00Z","Value": 0},{"Time": "2024-01-23T16:00:00Z","Value": 0}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

InvalidParameter.InvalidInterval©2013-2022 Tencent Cloud. All rights reserved.

Invalid interval. The value should be either [min 5min hour
day].

Page 544 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidMetricThe query dimension is invalid.

InvalidParameter.ZoneHasNotBeenBoundToPlan

The zone is not bound to a package.

©2013-2022 Tencent Cloud. All rights reserved.

Page 545 of 760

Tencent Cloud EdgeOne

DescribeAvailablePlans：

Last updated 2024-04-09 10:26:16

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query plan options available for purchase.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeAvailablePlans.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

Name

3. Output Parameters
Parameter
Name

Type

Description

PlanInfo

Array of
PlanInfo

Plans available for the current user
Note: This field may return null, indicating that no valid values can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 546 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying available plan options
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAvailablePlans<Common request parameters>{}

Output Example{"Response": {"RequestId": "e9fa0c8b-3c73-9ec2-cb5c-faa4725e0e07","PlanInfo": [{"Area": "overseas","Currency": "CNY","Flux": 3000000000000,"Frequency": "m","PlanType": "sta","Price": 450000,"Request": 50000000,"SiteNumber": 1},{"Area": "overseas","Currency": "CNY","Flux": 3000000000000,"Frequency": "m","PlanType": "sta_with_bot","Price": 1262500,"Request": 50000000,"SiteNumber": 1},©2013-2022 Tencent Cloud. All rights reserved.

Page 547 of 760

Tencent Cloud EdgeOne{"Area": "mainland","Currency": "CNY","Flux": 3000000000000,"Frequency": "m","PlanType": "sta_cm","Price": 380000,"Request": 50000000,"SiteNumber": 1},{"Area": "mainland","Currency": "CNY","Flux": 3000000000000,"Frequency": "m","PlanType": "sta_cm_with_bot","Price": 1192500,"Request": 50000000,"SiteNumber": 1},{"Area": "overseas","Currency": "CNY","Flux": 10000000000000,"Frequency": "m","PlanType": "ent","Price": 10228400,"Request": 80000000,"SiteNumber": 1},{"Area": "overseas","Currency": "CNY","Flux": 10000000000000,"Frequency": "m","PlanType": "ent_with_bot","Price": 11216400,"Request": 80000000,"SiteNumber": 1},{"Area": "mainland","Currency": "CNY","Flux": 10000000000000,"Frequency": "m","PlanType": "ent_cm","Price": 8637300,©2013-2022 Tencent Cloud. All rights reserved.

Page 548 of 760

Tencent Cloud EdgeOne"Request": 80000000,"SiteNumber": 1},{"Area": "mainland","Currency": "CNY","Flux": 10000000000000,"Frequency": "m","PlanType": "ent_cm_with_bot","Price": 9625300,"Request": 80000000,"SiteNumber": 1}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 549 of 760

Tencent Cloud EdgeOne

Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 550 of 760

Tencent Cloud EdgeOne

Certificate APIs
DescribeDefaultCertificates：

Last updated 2024-05-29 14:55:57

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query a list of default certificates.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdNo

StringZone ID.

Description
Common Params. The value used for this API:
DescribeDefaultCertificates.

Filter criteria. Each filter criteria can have up to 5 entries.
Filters.N

OffsetNo

Nozone-id :Array ofFilterFilter by site ID, such as zone-xxx

Integer

Offset for paginated queries. Default value: 0©2013-2022 Tencent Cloud. All rights reserved.

Type: String
Required: No

Page 551 of 760

Tencent Cloud EdgeOne

Limit

No

Integer

Limit on paginated queries. Default value: 20 . Maximum
value: 100 .

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total number of certificates

DefaultServerCertInfo

Array ofDefaultServerCertInfo

List of default certificates

RequestId

String

The unique request ID, generated by the server, will be
returned for every request (if the request fails to reach theserver for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Obtaining the default certificate
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDefaultCertificates<Common Request Parameters>{"Filters": [{"Name": "zone-id","Values": ["zone-fafcasdf"]}]}

Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 552 of 760

Tencent Cloud EdgeOne{"Response": {"TotalCount": 1,"RequestId": "084d5612-67a7-4aca-aac9-827aa3662b2d","DefaultServerCertInfo": [{"Status": "deployed","CertId": "teo-285inl1otbtd","SubjectAltName": ["*.test.com","test.com"],"EffectiveTime": "2020-09-22T00:00:00+00:00","CommonName": "test.com","ExpireTime": "2020-09-22T00:00:00+00:00","Alias": "EdgeOne default","Message": "","Type": "default"}]}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 553 of 760

Tencent Cloud EdgeOne

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.DBError

Database error.

InternalError.ProxyServer

An unknown error occurred in the backend server.

InternalError.RouteError

The backend routing address is incorrect.

InternalError.SystemError

Internal system error.

InvalidParameter.ZoneNotFoundThe site does not exist.

OperationDenied

Operation denied.

ResourceUnavailable.ZoneNotFoundThe site does not exist or is not belong to this account.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Please getpermissions first.

©2013-2022 Tencent Cloud. All rights reserved.

Page 554 of 760

Tencent Cloud EdgeOne

ModifyHostsCertificate：

Last updated 2024-05-29 14:55:57

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to configure the certificate of a site. You can use your own certificate or apply for a free certificate.
To use an external certificate, upload the certificate to SSL Certificates Console first, and then input the certificate ID inthis API. For details, see Deploying Own Certificates to EdgeOne Domains.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyHostsCertificate.

VersionYes

StringCommon Params. The value used for this API: 2022-0901.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringID of the site.

Hosts.N

Yes

Array of String

Domain names that you need to modify the certificate
configuration

Mode

No

String

Certificate configuration mode. Values:Namedisable : (Default) Do not configure the certificate©2013-2022 Tencent Cloud. All rights reserved.

Page 555 of 760

Tencent Cloud EdgeOne

eofreecert : Use a free certificate provided by
EdgeOnesslcert : Configure an SSL certificate.

ServerCertInfo.N

Array ofNo

ServerCertInfo

ID of the SSL certificate. It takes effect whenmode=sslcert . To check the certificate ID, go to the
SSL Certificate console.

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Configuring an SSL certificate
Add the certificate cert-244ffgv 7m17xw to the domain name abc.test.com under the site zone-2fgd
17m17xw .
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyHostsCertificate<Common request parameters>{"ZoneId": "zone-2fgd17m17xw","Hosts": ["abc.test.com"],"Mode": "sslcert","ServerCertInfo": [{"CertId": "cert-244ffgv7m17xw"}©2013-2022 Tencent Cloud. All rights reserved.

Page 556 of 760

Tencent Cloud EdgeOne]}

Output Example{"Response": {"RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"}}

Example2 Configuring a free certificate
Configure a free certificate for the domain name abc.test.com under the site zone-2fgd17m17xw .
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyHostsCertificate<Common request parameters>{"ZoneId": "zone-2fgd17m17xw","Hosts": ["abc.test.com"],"Mode": "eofreecert"}

Output Example{"Response": {"RequestId": "084d5612-67a7-4aca-aac9-827aa3662b2d"}}

5. Developer Resources
SDK©2013-2022 Tencent Cloud. All rights reserved.

Page 557 of 760

Tencent Cloud EdgeOne

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.CertificateHasExpired

Failed to publish: The certificate has expired.

FailedOperation.CertificateNotFoundThe certificate does not exist.

FailedOperation.InvalidZoneStatus

The site status is invalid.

FailedOperation.ModifyFailed

Operation failed.

InternalError.ConfigLocked

The configuration is locked. Please unlock and try
again.

InternalError.GetRoleError

Failed to get the role.

InternalError.ProxyServer

An unknown error occurred in the backend
server.

InternalError.RouteError

The backend routing address is incorrect.

InternalError.SystemError

Internal system error.

©2013-2022 Tencent Cloud. All rights reserved.

Page 558 of 760

Tencent Cloud EdgeOne

InternalError.UnknowError

Unknown error.

InvalidParameter.ActionInProgress

Too many attempts. Please try again later.

InvalidParameter.CertNotMatchDomain

Mismatch between the HTTPS certificate and thedomain name.

InvalidParameter.CertToExpire

The HTTPS certificate is about to expire.

InvalidParameter.CertTooShortKeySize

Certificate error.

InvalidParameter.CnameWildHostNotAllowApplyCertificate

Unable to apply for a wildcard certificate under
CNAME mode.

InvalidParameter.HostStatusNotAllowApplyCertificate

CNAME is not switched or the origin is not routed
to the EdgeOne server.

InvalidParameter.InvalidCertInfo

Incorrect certificate information.

InvalidParameter.InvalidHttpsCertInfo

Invalid HTTPS certificate.

InvalidParameter.InvalidHttpsTlsVersion

Invalid HTTPS TLS version.

InvalidParameter.ZoneIsGrayPublishing

The site is being upgraded. Changing is notsupported. Please try again later.

LimitExceeded.RateLimitExceeded

Reached the API rate limit.

OperationDenied

Operation denied.

OperationDenied.ConfigLocked

The configuration is locked. Please unlock and try
again.

OperationDenied.DisableZoneNotCompleted

OperationDenied.ErrZoneIsAlreadyPaused

OperationDenied.VersionControlIsGraying

The EdgeOne service of the site is being
disabled. Please try again later.
The EdgeOne service of the site is disabled.
Please enable it and try again.
There is a test version in use. Please release thetest version to the live environment, or roll backthe test version and try again.

ResourceInUse

The resource is occupied.

ResourceUnavailable.CertNotFoundThe certificate does not exist or is not authorized.

ResourceUnavailable.HostNotFoundThe domain name does not exist or not use aproxy.

©2013-2022 Tencent Cloud. All rights reserved.

Page 559 of 760

Tencent Cloud EdgeOne

UnauthorizedOperation.CamUnauthorized©2013-2022 Tencent Cloud. All rights reserved.

CAM is not authorized.

Page 560 of 760

Tencent Cloud EdgeOne

Load Balancing APIs
CreateOriginGroup：

Last updated 2024-05-29 14:55:51

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create an origin group for easy management. The created origin server group can be used foradding acceleration domain names and layer-4 proxy configuration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreateOriginGroup.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID

Name

No

StringOrigin group name. It can contain 1 to 200 characters ([a-z], [AZ], [0-9] and [_-]).

Type

No

String(Required) Origin group type. Values:Name©2013-2022 Tencent Cloud. All rights reserved.

Page 561 of 760

Tencent Cloud EdgeOne

GENERAL : General origin groups. It supports IPs anddomain names. It can be referenced by DNS, Rule Engine, Layer
4 Proxy and General LoadBalancer.
HTTP : HTTP-specific origin groups. It supports IPs/domainnames and object storage buckets. It can be referenced byacceleration domain names, rule engines and HTTP
LoadBalancer. It cannot be referenced by L4 proxies.
Records.N

HostHeader

No

No

Array ofOriginRecord

String(Required) Origins in the origin group.
Host header used for origin-pull. It only works when
Type=HTTP . The HostHeader specified in
RuleEngine takes a higher priority over this configuration.

3. Output Parameters
Parameter
Name

Type

Description

OriginGroupId

StringThe ID of the origin group.
The unique request ID, generated by the server, will be returned for every request (ifRequestId

Stringthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating an origin group
This example shows you how to create an HTTP-specific origin groups.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOriginGroup<Common request parameters>{"ZoneId": "zone-2kblak89bkx1",©2013-2022 Tencent Cloud. All rights reserved.

Page 562 of 760

Tencent Cloud EdgeOne"Name": "edgeone-origin","Type": "HTTP","Records": [{"Record": "1.1.1.1","Type": "IP_DOMAIN","Weight": 20},{"Record": "s3.test.tencent.com","Type": "AWS_S3","Weight": 30}]}

Output Example{"Response": {"OriginGroupId": "origin-df19b73e-3a4c-11ee-a68f-5254000a367f","RequestId": "8240f255-241c-4bae-979f-4738d7ea3f84"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 563 of 760

Tencent Cloud EdgeOne

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InternalError.ConfigLocked

The configuration is locked. Please unlock and try
again.

InvalidParameter.HostHeaderInvalid

Host header error

InvalidParameter.InvalidAwsRegion

Invalid region. Please fill in a correct region of the thirdparty object storage service.

InvalidParameter.InvalidOriginGroupType

The origin server group type is incorrect.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback address.

InvalidParameter.OriginNameExists

The origin group name already exists.

InvalidParameter.OriginRecordFormatError

Incorrect origin server format.

InvalidParameter.OriginRecordWeightValue

Weight value range: 0-100.

InvalidParameter.OriginThirdPartyParamFormatError

The key format is incorrect.

LimitExceeded

The quota limit has been reached.

OperationDenied

Operation denied.

OperationDenied.ConfigLocked

The configuration is locked. Please unlock and try
again.

OperationDenied.LoadBalancingZoneIsNotActive

The site status does not support operations on loadbalancers.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation.
Please get permissions first.

©2013-2022 Tencent Cloud. All rights reserved.

Page 564 of 760

Tencent Cloud EdgeOne

ModifyOriginGroup：

Last updated 2024-05-29 14:55:50

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify the configuration of an origin group. The original configuration will be overwritten.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
ModifyOriginGroup.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringSite ID

GroupId

No

String(Required) Origin group ID

Name

Name

No

StringOrigin group name. It can contain 1 to 200 characters ([a-z], [AZ], [0-9] and [_-]). The original configuration applies if this field is
not specified.

Type

No

StringThe origin grouptype. Values:
GENERAL : General origin groups. It supports IPs anddomain names. It can be referenced by DNS, Rule Engine, Layer©2013-2022 Tencent Cloud. All rights reserved.

Page 565 of 760

Tencent Cloud EdgeOne

4 Proxy and General LoadBalancer.
HTTP : HTTP-specific origin groups. It supports IPs/domainnames and object storage buckets. It can be referenced byacceleration domain names, rule engines and HTTP
LoadBalancer. It cannot be referenced by L4 proxies.
The original configuration is used if it's not specified.
Records.N

HostHeader

No

No

Array ofOrigin information. The original configuration is used if it's not

OriginRecord

specified.

StringHost header used for origin-pull. It only works when
Type=HTTP . If it's not specified, no specific Host header isconfigured. The HostHeader specified in RuleEngine
takes a higher priority over this configuration.

3. Output Parameters
Parameter
Name

Type

Description
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Renaming an origin group
This example shows you how to rename an origin group to edgeone-new-origin .
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyOriginGroup<Common request parameters>{"ZoneId": "zone-2kblak89bkx1","GroupId": "origin-df19b73e-3a4c-11ee-a68f-5254000a367f",©2013-2022 Tencent Cloud. All rights reserved.

Page 566 of 760

Tencent Cloud EdgeOne"Name": "edgeone-rename-origin"}

Output Example{"Response": {"RequestId": "c2886bcd-173f-499e-b425-022ceaf636d8"}}

Example2 Modifying an origin group
This example show you how to modify origins in an origin group in an overwriting manner.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyOriginGroup<Common request parameters>{"ZoneId": "zone-2nrle17s0v0r","GroupId": "origin-afbce0e9-6e8a-11ee-8944-52540084caf1","Records": [{"Record": "2.2.2.2","Type": "IP_DOMAIN"},{"Record": "3.3.3.3","Type": "IP_DOMAIN"}]}

Output Example{"Response": {"RequestId": "39f96a44-9a52-4a9f-8b76-4ccc9e496f40"}}©2013-2022 Tencent Cloud. All rights reserved.

Page 567 of 760

Tencent Cloud EdgeOne

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

InvalidParameter.HostHeaderInvalid

Host header error

InvalidParameter.InvalidAwsRegion

Invalid region. Please fill in a correct region of thethird-party object storage service.

InvalidParameter.InvalidOriginIp

The origin cannot be a private IP or loopback
address.

InvalidParameter.OriginL4RecordIPV4MixDomain

The layer-4 proxy strictly prohibits mixing IPs anddomain names.

InvalidParameter.OriginL4RecordMultiDomain

Usage of multi-domain origin server is forbidden forlayer-4 proxy.

©2013-2022 Tencent Cloud. All rights reserved.

Page 568 of 760

Tencent Cloud EdgeOne

InvalidParameter.OriginNameExists

The origin group name already exists.

InvalidParameter.OriginRecordFormatError

Incorrect origin server format.

OperationDenied

Operation denied.

OperationDenied.AccelerationDomainStatusNotInOnline

An L7 DNS service referencing the origin group is
being deployed. Please edit later.

OperationDenied.L4StatusNotInOnline

Unable to operate the L4 instance when it’s notrunning

OperationDenied.LoadBalanceStatusNotInOnline

The affiliated Cloud Load Balancer is not in arunning state. Operation is forbidden.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 569 of 760

Tencent Cloud EdgeOne

DeleteOriginGroup：

Last updated 2024-05-29 14:55:51

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete an origin group. Note that an origin group can not be deleted if it is referenced by services(e.g. L4 Proxy, domain name service, load balancing, rule engines).
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API: DeleteOriginGroup.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

GroupId

No

StringOrigin server group ID. This parameter is required.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 570 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting an origin group
This example shows you how to delete an origin group.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteOriginGroup<Common request parameters>{"ZoneId": "zone-2kblak89bkx1","GroupId": "origin-057c4d82-383c-11ee-8888-525400682e90"}

Output Example{"Response": {"RequestId": "5453af19-f084-4038-915c-88d9c4fe9c4e"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 571 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

OperationDenied

Operation denied.

OperationDenied.OriginGroupAccelerationDomainUsed
OperationDenied.OriginGroupL4Used
OperationDenied.OriginGroupLBUsed

Failed to delete: The acceleration domain name is inuse.
The Layer 4 proxy is in use and cannot be deleted.
The Cloud Load Balancer is in use and cannot bedeleted.

OperationDenied.OriginGroupRuleEngineUsed

The rule engine is in use and cannot be deleted.

ResourceNotFoundThe resource doesn’t exist.

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

©2013-2022 Tencent Cloud. All rights reserved.

Page 572 of 760

Tencent Cloud EdgeOne

DescribeOriginGroup：

Last updated 2024-05-29 14:55:50

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to obtain a list of origin groups.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdNo

String(Required) Site ID

OffsetNo

Integer

The paginated query offset. Default value: 0

Limit

No

Integer

Filters.N

No

Array of
AdvancedFilter

Description
Common Params. The value used for this API:
DescribeOriginGroup.

Limit on paginated queries. Value range: 1-1000. Default value:
20.
Filters. Each filter can have up to 20 entries. See below for
details:
origin-group-id
Filter by the origin group ID. Format: origin-2ccgtb24-©2013-2022 Tencent Cloud. All rights reserved.

Page 573 of 760

Tencent Cloud EdgeOne

7dc5-46s2-9r3e-95825d53dwe3a
Fuzzy query is not supported
origin-group-nameFilter by the origin group name
Fuzzy query is supported. When fuzzy query is used, only one
origin groupsource site group name is supported

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of records.

OriginGroups

RequestId

Array ofOriginGroup

StringOrigin group information.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying the list of origin groups
This example shows you how to query the list of origin groups by a specified ID.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOriginGroup<Common request parameters>{"Filters": [{"Name": "origin-group-id","Values": ["origin-057c4d82-383c-11ee-8888-525400682e90"]©2013-2022 Tencent Cloud. All rights reserved.

Page 574 of 760

Tencent Cloud EdgeOne}]}

Output Example{"Response": {"OriginGroups": [{"CreateTime": "2023-08-11T19:41:33Z","GroupId": "origin-057c4d82-383c-11ee-8888-525400682e90","HostHeader": "","Name": "test_ruichaolin","Records": [{"Private": false,"PrivateParameters": [],"Record": "4.4.4.4","RecordId": "record-3492ee3b-383c-11ee-8888-525400682e90","Type": "IP_DOMAIN","Weight": 40}],"References": [],"Type": "HTTP","UpdateTime": "2023-08-11T19:41:33Z"}],"RequestId": "a2e38df8-5800-4495-bd61-b6761b070d50","TotalCount": 1}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 575 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

UnauthorizedOperation.CamUnauthorized

CAM is not authorized.

UnauthorizedOperation.NoPermission

The sub-account is not authorized for the operation. Please getpermissions first.

UnauthorizedOperation.Unknown

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 576 of 760

Tencent Cloud EdgeOne

Custom Response Page APIs
CreateCustomizeErrorPage：

Last updated 2024-06-13 17:03:28

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a custom response page.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
CreateCustomizeErrorPage.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

Name

Yes

StringCustom response page name. The name must be 2-30 characters
long.

ContentType

Yes

StringCustom response page type, with values:
text/html;
application/json;text/plain;©2013-2022 Tencent Cloud. All rights reserved.

Page 577 of 760

Tencent Cloud EdgeOne

text/xml.
Description

No

StringCustom response page description, not exceeding 60 characters.

Content

No

StringCustom response page content, not exceeding 2 KB.

3. Output Parameters
Parameter
Name

Type

Description

PageIdStringCustom response page ID.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Creating a custom response page
This example shows you how to create a custom response page.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomizeErrorPage<Common request parameters>{"ZoneId": "zone-2kplomhisdcb","Name": "Web Protection Custom Response Page","Description": "web protection custom response page","ContentType": "application/json","Content": "{\"title\":\"Custom Response Page\", \"Content\":\"custom response pa
ge content\"}"}Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 578 of 760

Tencent Cloud EdgeOne{"Response": {"PageId": "p-2kplomhisdcb","RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InvalidParameterValue.ContentTypeNotMatch

The page content does not match the Content-Type.

InvalidParameterValue.PageNameAlreadyExist

The page name already exists.

©2013-2022 Tencent Cloud. All rights reserved.

Page 579 of 760

Tencent Cloud EdgeOne

DescribeCustomErrorPages：

Last updated 2024-06-13 17:03:27

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the custom response page list.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeCustomErrorPages.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.
Filter criteria. The upper limit for Filters.Values is 20. The

Filters.N

No

Array of
AdvancedFilter

detailed filter criteria are as follows:
page-id: Filter by page ID;
name: Filter by page name;description: Filter by page description;
content-type: Filter by page type.

OffsetNo

Integer©2013-2022 Tencent Cloud. All rights reserved.

The offset of paginated query. Default value: 0.

Page 580 of 760

Tencent Cloud EdgeOne

Limit

No

Integer

The limit of paginated query. Default value: 20. Maximum value:
1,000.

3. Output Parameters
Parameter
Name

Type

Description

TotalCount

Integer

Total number of custom response pages.

ErrorPages

RequestId

Array ofCustomErrorPage

StringCustom response page data list.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, therequest will not obtain a RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Querying the custom response page list
This example shows you how to query the custom response page list.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomResponsePages<Common request parameters>{"ZoneId": "zone-2kplomhisdcb","Filters": [{"Name": "name","Values": ["web protection response page"]}],"Offset": 1,©2013-2022 Tencent Cloud. All rights reserved.

Page 581 of 760

Tencent Cloud EdgeOne"Limit": 20}

Output Example{"Response": {"ErrorPages": [{"PageId": "p-2kplomhisdcb","Name": "Web Protection Response Page","ContentType": "application/json","Content": "{\"title\": \"custom response page title\",\"content\": \"custom resp
onse page content\"}","Description": "custom web protection response page"}],"TotalCount": 1,"RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 582 of 760

Tencent Cloud EdgeOne

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.RouteError

The backend routing address is incorrect.

©2013-2022 Tencent Cloud. All rights reserved.

Page 583 of 760

Tencent Cloud EdgeOne

ModifyCustomErrorPage：

Last updated 2024-06-13 17:03:26

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify a custom response page.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

PageIdYesStringCustom response page ID.

ZoneIdYesStringZone ID.

Name

No

StringDescription

No

StringCustom response page description, not exceeding 60 characters.

ContentType

No

StringCustom response page type, with values:
text/html.

©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
ModifyCustomErrorPage.

Custom response page name. The name must be 2-60 characterslong.

Page 584 of 760

Tencent Cloud EdgeOne

application/json.
plain/text.
text/xml.
Content

No

StringCustom response page content, not exceeding 2 KB.

3. Output Parameters
Parameter
Name

RequestId

Type

Description

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Modifying a custom response page
This example shows you how to modify a custom response page.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCustomErrorPage<Common request parameters>{"PageId": "p-2kplomhisdcb","ZoneId": "zone-2kplomhisdcb","Name": "Web Protection Custom Response Page","Description": "web protection custom response page","ContentType": "application/json","Content": "{\"title\": \"custom response page title\",\"content\": \"custom resp
onse page content\"}"}Output Example©2013-2022 Tencent Cloud. All rights reserved.

Page 585 of 760

Tencent Cloud EdgeOne{"Response": {"RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 586 of 760

Tencent Cloud EdgeOne

DeleteCustomErrorPage：

Last updated 2024-06-13 17:08:08

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to delete a custom response page.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DeleteCustomErrorPage.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

PageIdYesStringCustom response page ID.

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 587 of 760

Tencent Cloud EdgeOne

RequestId

String

The unique request ID, generated by the server, will be returned for every request (if therequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Deleting a custom response page
This example shows you how to delete a custom response page.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteCustomErrorPage<Common request parameters>{"PageId": "p-2kplomhisdcb","ZoneId": "zone-2kplomhisdcb"}

Output Example{"Response": {"RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP©2013-2022 Tencent Cloud. All rights reserved.

Page 588 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceInUse

The resource is occupied.

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 589 of 760

Tencent Cloud EdgeOne

Diagnostic Tool APIs
DescribeIPRegion：

Last updated 2024-05-29 14:55:54

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to check if the IP is an EdgeOne IP.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeIPRegion.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

IPs.N

Yes

Array of
StringList of IPs to be queried, supporting IPV4 and IPV6. Up to 100
can be queried.

3. Output Parameters
Parameter

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 590 of 760

Tencent Cloud EdgeOne

Name
IPRegionInfo

Array of
IPRegionInfo

List of IP attribution information.
The unique request ID, generated by the server, will be returned for every

RequestId

Stringrequest (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Querying IP geographic location information
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIPRegion<Common request parameters>{"IPs": ["1.1.1.1","2402:4e00:1403:eb00:0:9440:b55a:39a8"]}

Output Example{"Response": {"RequestId": "bc0bb357-0b72-4abb-ae66-ffffb965aced","IPRegionInfo": [{"IP": "120.226.17.168","IsEdgeOneIP": "yes"},{"IP": "101.33.20.11","IsEdgeOneIP": "yes"},{"IP": "120.222.238.33","IsEdgeOneIP": "yes"},©2013-2022 Tencent Cloud. All rights reserved.

Page 591 of 760

Tencent Cloud EdgeOne{"IP": "120.222.238.33","IsEdgeOneIP": "yes"},{"IP": "120.226.17.167","IsEdgeOneIP": "yes"},{"IP": "120.226.17.168","IsEdgeOneIP": "yes"},{"IP": "43.130.34.95","IsEdgeOneIP": "no"},{"IP": "43.128.224.98","IsEdgeOneIP": "no"}]}}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0©2013-2022 Tencent Cloud. All rights reserved.

Page 592 of 760

Tencent Cloud EdgeOne

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

InternalError.ProxyServer

An unknown error occurred in the backend server.

©2013-2022 Tencent Cloud. All rights reserved.

Page 593 of 760

Tencent Cloud EdgeOne

Version Management APIs
CreateConfigGroupVersion：

Last updated 2024-05-29 14:55:42

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a new version for the specified configuration group in version management mode. The
version management feature is currently undergoing beta testing and is accessible only to users on the whitelist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

GroupId

Yes

StringGroupId of the version to be created.

Description
Common Params. The value used for this API:
CreateConfigGroupVersion.

Configuration content to be imported. It is required to be in JSON format
Content

Yes

Stringand encoded in UTF-8. Please refer to the example below for theconfiguration file content.

©2013-2022 Tencent Cloud. All rights reserved.

Page 594 of 760

Tencent Cloud EdgeOne

Description

No

String

Version description. The maximum length allowed is 50 characters. This
field can be used to provide details about the application scenarios of thisversion.

3. Output Parameters
Parameter
Name
VersionId

Type

Description

String

Version ID.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Create a New Version for the Specified Configuration Group
Create a new version, with ZoneId set to zone-m2kplohsdc4b and GroupId to cg-2p9unsmt54uw.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConfigGroupVersion<Common request parameters>{"ZoneId": "zone-m2kplohsdc4b","GroupId": "cg-2p9unsmt54uw","Description": "created for openday","Content": "{\n \"FormatVersion\": \"1.0\",\n \"ZoneConfig\": {\n \"SmartRouting\": {\n \"Switch\": \"off\"\n },\n \"Cache\": {\n \"CustomTime\": {\n \"Switch\":\"on\",\n \"CacheTime\": 604800\n }\n },\n \"MaxAge\": {\n \"FollowOrigin\": \"on\",\n \"CacheTime\": 600\n },\n \"CacheKey\": {\n \"FullURLCache\": \"off\",\n \"QueryString\": {\n \"Switch\": \"on\",\n \"Action\": \"includeCustom\",\n \"Values\": [\n \"key1\",\n \"key2\"\n ]\n },\n \"IgnoreCase\": \"on\"\n },\n \"CachePre
fresh\": {\n \"Switch\": \"off\",\n \"CacheTimePercent\": 90\n },\n \"OfflineCache\": {\n \"Switch\": \"on\"\n },\n \"Compression\": {\n \"Switch\": \"on\",\n \"Algorithms\": [\n \"brotli\",\n \"gzip\"\n ]\n },\n \"ImageOptimize\": {\n \"Switc©2013-2022 Tencent Cloud. All rights reserved.

Page 595 of 760

Tencent Cloud EdgeOneh\": \"off\"\n },\n \"ForceRedirectHTTPS\": {\n \"Switch\": \"on\",\n \"RedirectS
tatusCode\": 302\n },\n \"HSTS\": {\n \"Switch\": \"on\",\n \"IncludeSubDomains\": \"on\",\n \"Timeout\": 16070400,\n \"Preload\": \"on\"\n },\n \"TLSConfig\": {\n \"CipherSuite\": \"loose-v2023\",\n \"Version\": [\n \"TLSv1\",\n \"TLSv1.1\",\n \"TLSv1.2\",\n \"TLSv1.3\"\n ]\n },\n \"OCSPStapling\": {\n \"Switch\": \"off\"\n },\n \"HTTP2\": {\n \"Switch\": \"on\"\n },\n \"QUIC\": {\n \"Switch\": \"of
f\"\n },\n \"UpstreamHTTP2\": {\n \"Switch\": \"off\"\n },\n \"IPv6\": {\n \"Switch\": \"off\"\n },\n \"WebSocket\": {\n \"Switch\": \"on\",\n \"Timeout\": 30\n},\n \"PostMaxSize\": {\n \"Switch\": \"on\",\n \"MaxSize\": 838860800\n },\n \"ClientIPHeader\": {\n \"Switch\": \"off\",\n \"HeaderName\": \"\"\n },\n \"ClientI
PCountry\": {\n \"Switch\": \"on\",\n \"HeaderName\": \"EO-Client-IPCountry\"\n},\n \"gRPC\": {\n \"Switch\": \"off\"\n },\n \"AccelerateMainland\": {\n \"Switc
h\": \"off\"\n },\n \"StandardDebug\": {\n \"Switch\": \"on\",\n \"AllowClientIPL
ist\": [\n \"1.2.3.4\"\n ],\n \"Expires\": \"2023-11-04T04:46:28Z\"\n }\n },\n \"Rules\": [\n {\n \"RuleName\": \"Unnamed rule\",\n \"Branches\": [\n {\n \"Condit
ion\": \"${http.request.host} matches '.*'\",\n \"Actions\": [\n {\n \"Name\": \"UpstreamURLRewrite\",\n \"Parameters\": {\n \"Type\": \"Path\",\n \"Action\": \"rmvPrefix\",\n \"Value\": \"/prefix\"\n }\n }\n ],\n \"SubRules\": [\n {\n \"Branc
hes\": [\n {\n \"Condition\": \"${http.request.file_extension} in ['.jpg']\",\n\"Actions\": [\n {\n \"Name\": \"PostMaxSize\",\n \"Parameters\": {\n \"Switch\":\"on\",\n \"MaxSize\": 524288000\n }\n }\n ]\n }\n ]\n },\n {\n \"Branches\": [\n{\n \"Condition\": \"${http.request.file_extension} in ['.png']\",\n \"Actions\":[\n {\n \"Name\": \"PostMaxSize\",\n \"Parameters\": {\n \"Switch\": \"on\",\n \"MaxSize\": 209715200\n }\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}"}

Output Example{"Response": {"VersionId": "ver-5ksglmhghsu3","RequestId": "5e0a2b4e-dw6d-4dsa-ac39-1706cbf8a703"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java©2013-2022 Tencent Cloud. All rights reserved.

Page 596 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

FailedOperation

Operation failed.

FailedOperation.ConfigConditionSyntaxError

Syntax error in the condition expression of theconfiguration file.

FailedOperation.ConfigConditionUnknownTarget

Unrecognized condition matching type.

FailedOperation.ConfigConditionValueEmptyError

The value field of the condition expression cannot be
empty in the configuration file.

FailedOperation.ConfigFieldTypeError
FailedOperation.ConfigFormatError
FailedOperation.ConfigMalformedContent

The configuration file contains fields with inconsistent
data types.
Syntax error in the configuration file.
Incorrect format of the configuration file. Parsing
failed.

FailedOperation.ConfigParamValidateErrors

Parameter verification error in the configuration file.

FailedOperation.ConfigUnknownField

The specified field in the configuration file is notrecognized, indicating a possible spelling error orincorrect placement within the file structure.

FailedOperation.ConfigUnsupportedFormatVersion

The current configuration file version is not supported.

FailedOperation.MissingConfigChunk

The content is missing a mandatory configuration
block.

©2013-2022 Tencent Cloud. All rights reserved.

Page 597 of 760

Tencent Cloud EdgeOne

FailedOperation.UnknownConfigGroupType

Unknown configuration group type.

InvalidParameter

Parameter error.

InvalidParameter.DuplicateRule

Duplicate rules.

InvalidParameter.ErrInvalidConditionValueBadValue

Invalid condition: The parameter value is invalid.

InvalidParameter.InvalidCacheKeyQueryStringAction

Invalid query string.

InvalidParameter.InvalidConditions

Invalid conditions.

InvalidParameter.InvalidDynamicRoutine

Invalid smart acceleration.

InvalidParameter.InvalidIpv6Switch

Invalid IPv6 settings.

InvalidParameter.InvalidMaxAgeFollowOrigin

Invalid browser cache.

InvalidParameter.InvalidStandardDebug

Invalid debug configuration for EdgeOne.

InvalidParameter.PostMaxSizeLimitExceeded

Maximum upload size exceeded.

InvalidParameter.StatusCodeCacheInvalidStatusCode

Invalid status code in cache.

InvalidParameterValue

Invalid parameter value.

LimitExceeded.RuleLimitExceeded

The number of rules has reached the limit.

MissingParameter

Missing parameters.

OperationDenied

Operation denied.

OperationDenied.AccelerateMainlandIpv6Conflict

Cross-MLC-border acceleration and IPv6 cannot be
configured at the same time.

OperationDenied.ConfigLocked

The configuration is locked. Please unlock and try
again.

OperationDenied.ErrZoneIsAlreadyPaused

OperationDenied.NotInVersionControlWhiteList

The EdgeOne service of the site is disabled. Pleaseenable it and try again.
The current user is not included in the whitelist forversion management.

OperationDenied.OwnershipVerificationNotPassed

Ownership verification failed. Please complete the site
ownership verification first.

OperationDenied.VersionControlLocked

The operation is not allowed because the version
management mode is applied.

©2013-2022 Tencent Cloud. All rights reserved.

Page 598 of 760

Tencent Cloud EdgeOne

OperationDenied.WorkModeNotInVersionControl

The specified site working mode is not applicable tothe version management mode.

ResourceNotFoundThe resource doesn’t exist.

ResourceUnavailable.FunctionNotFoundThe function does not exist or does not belong to thisaccount.

©2013-2022 Tencent Cloud. All rights reserved.

Page 599 of 760

Tencent Cloud EdgeOne

DeployConfigGroupVersion：

Last updated 2024-05-29 14:55:42

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to release versions in version management mode. Users can deploy the version to either the testing
environment or the production environment by specifying the EnvId parameter. The version management feature iscurrently undergoing beta testing and is accessible only to users on the whitelist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter Name

RequiredType

Description

ActionYes

StringCommon Params. The value used forthis API: DeployConfigGroupVersion.

VersionYes

StringRegionNo

StringCommon Params. This parameter is
not required.

ZoneIdYesStringZone ID.

StringEnvironment ID. Please specify theenvironment ID to which the version

EnvId

Yes

Common Params. The value used forthis API: 2022-09-01.

should be released.
ConfigGroupVersionInfos.N

Yes©2013-2022 Tencent Cloud. All rights reserved.

Array of

Version information required forPage 600 of 760

Tencent Cloud EdgeOne

ConfigGroupVersionInfo

release. Multiple versions of different
configuration groups can be modified
simultaneously, while each group
allows modifying only one version at atime.

Description

Yes

StringChange description. It is used todescribe the content and reasons forthis change. A maximum of 100
characters are supported.

3. Output Parameters
Parameter
Name

Type

Description

RecordId

StringRelease record ID.
The unique request ID, generated by the server, will be returned for every request (if theRequestId

Stringrequest fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Create a Version Deployment Task
Release a specific version with ZoneId set to zone-32qwgrnvbisw, VersionId to ver-2ogs1as803hm, and EnvId to env28jw51ksm9bw.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeployVersionTask<Common request parameters>{"ZoneId": "zone-32qwgrnvbisw","EnvId": "env-28jw51ksm9bw","ConfigGroupVersionInfos": [{©2013-2022 Tencent Cloud. All rights reserved.

Page 601 of 760

Tencent Cloud EdgeOne"VersionId": "ver-2ogs1as803hm"}],"Description": "Add IPv6 and AccelerationMainland configuration"}

Output Example{"Response": {"RequestId": "5e0a2b4e-df6d-4d2a-as19-1706cbf8a902","RecordId": "dr-2nvadq3sa41u"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error Code©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 602 of 760

Tencent Cloud EdgeOne

FailedOperation.ConfigConditionSyntaxError

Syntax error in the condition expression of theconfiguration file.

FailedOperation.ConfigConditionUnknownTarget

Unrecognized condition matching type.

FailedOperation.ConfigConditionValueEmptyError

The value field of the condition expression cannot be
empty in the configuration file.

FailedOperation.ConfigFieldTypeError

The configuration file contains fields with inconsistent
data types.

FailedOperation.ConfigFormatError

Syntax error in the configuration file.

FailedOperation.ConfigMalformedContent

Incorrect format of the configuration file. Parsing failed.

FailedOperation.ConfigParamValidateErrors

Parameter verification error in the configuration file.
The specified field in the configuration file is not

FailedOperation.ConfigUnknownField

recognized, indicating a possible spelling error orincorrect placement within the file structure.

FailedOperation.ConfigUnsupportedFormatVersion

The current configuration file version is not supported.

InvalidParameter.ZoneNotFoundThe site does not exist.

OperationDenied.ConfigLocked

The configuration is locked. Please unlock and try again.

OperationDenied.DomainStatusUnstable

Some domain names on the site are currently
experiencing instability. The stable states for domainnames are "online" and "offline".

OperationDenied.EnvNotReady

The site environment is not ready.

OperationDenied.NotInVersionControlWhiteList

The current user is not included in the whitelist for version
management.

OperationDenied.VersionControlLocked

The operation is not allowed because the version
management mode is applied.

OperationDenied.WorkModeNotInVersionControl

The specified site working mode is not applicable to theversion management mode.

ResourceNotFoundThe resource doesn’t exist.

ResourceNotFound.VersionNotFound©2013-2022 Tencent Cloud. All rights reserved.

The configuration group version does not exist. Pleasecheck and try again.

Page 603 of 760

Tencent Cloud EdgeOne

DescribeConfigGroupVersionDetail：

Last updated 2024-05-29 14:55:42

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to obtain detailed information about a version in version management mode. The response includes
the version ID, description, status, creation time, configuration group information, and the content of the version
configuration file. The version management feature is currently undergoing beta testing and is accessible only to users
on the whitelist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeConfigGroupVersionDetail.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

VersionId

Yes

String

Version ID.

3. Output Parameters©2013-2022 Tencent Cloud. All rights reserved.

Page 604 of 760

Tencent Cloud EdgeOne

Parameter NameType

Description

ConfigGroupVersionInfo

ConfigGroupVersionInfo

Version information.

Content

String

Version file content. It is returned in JSON format.

String

The unique request ID, generated by the server, will be
returned for every request (if the request fails to reachthe server for other reasons, the request will not obtain

RequestIda RequestId). RequestId is required for locating aproblem.

4. Example
Example1 Query Version Details
Query version details with ZoneId set to zone-m2kplohsdc4b and VersionId to ver-5ksglmhghsu3.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigGroupVersionDetail<Common request parameters>{"ZoneId": "zone-m2kplohsdc4b","VersionId": "ver-5ksglmhghsu3"}

Output Example{"Response": {"Content": "{\n \"FormatVersion\": \"1.0\",\n \"ZoneConfig\": {\n \"SmartRouting\": {\n \"Switch\": \"off\"\n },\n \"Cache\": {\n \"CustomTime\": {\n \"Switch\":\"on\",\n \"CacheTime\": 604800\n }\n },\n \"MaxAge\": {\n \"FollowOrigin\": \"on\",\n \"CacheTime\": 600\n },\n \"CacheKey\": {\n \"FullURLCache\": \"off\",\n\"QueryString\": {\n \"Switch\": \"on\",\n \"Action\": \"includeCustom\",\n \"Values\": [\n \"key1\",\n \"key2\"\n ]\n },\n \"IgnoreCase\": \"on\"\n },\n \"CacheP
refresh\": {\n \"Switch\": \"off\",\n \"CacheTimePercent\": 90\n },\n \"OfflineCa
che\": {\n \"Switch\": \"on\"\n },\n \"Compression\": {\n \"Switch\": \"on\",\n\"Algorithms\": [\n \"brotli\",\n \"gzip\"\n ]\n },\n \"ImageOptimize\": {\n \"Sw©2013-2022 Tencent Cloud. All rights reserved.

Page 605 of 760

Tencent Cloud EdgeOne

itch\": \"off\"\n },\n \"ForceRedirectHTTPS\": {\n \"Switch\": \"on\",\n \"Redire
ctStatusCode\": 302\n },\n \"HSTS\": {\n \"Switch\": \"on\",\n \"IncludeSubDomains\": \"on\",\n \"Timeout\": 16070400,\n \"Preload\": \"on\"\n },\n \"TLSConfig\":{\n \"CipherSuite\": \"loose-v2023\",\n \"Version\": [\n \"TLSv1\",\n \"TLSv1.1\",\n \"TLSv1.2\",\n \"TLSv1.3\"\n ]\n },\n \"OCSPStapling\": {\n \"Switch\": \"off\"\n },\n \"HTTP2\": {\n \"Switch\": \"on\"\n },\n \"QUIC\": {\n \"Switch\":\"off\"\n },\n \"UpstreamHTTP2\": {\n \"Switch\": \"off\"\n },\n \"IPv6\": {\n\"Switch\": \"off\"\n },\n \"WebSocket\": {\n \"Switch\": \"on\",\n \"Timeout\":30\n },\n \"PostMaxSize\": {\n \"Switch\": \"on\",\n \"MaxSize\": 838860800\n},\n \"ClientIPHeader\": {\n \"Switch\": \"off\",\n \"HeaderName\": \"\"\n },\n\"ClientIPCountry\": {\n \"Switch\": \"on\",\n \"HeaderName\": \"EO-Client-IPCountry\"\n },\n \"gRPC\": {\n \"Switch\": \"off\"\n },\n \"AccelerateMainland\": {\n\"Switch\": \"off\"\n },\n \"StandardDebug\": {\n \"Switch\": \"on\",\n \"AllowCl
ientIPList\": [\n \"1.2.3.4\"\n ],\n \"Expires\": \"2023-11-04T04:46:28Z\"\n }\n},\n \"Rules\": [\n {\n \"RuleName\": \"Unnamed rule\",\n \"Branches\": [\n {\n\"Condition\": \"${http.request.host} matches '.*'\",\n \"Actions\": [\n {\n \"Name\": \"UpstreamURLRewrite\",\n \"Parameters\": {\n \"Type\": \"Path\",\n \"Action\": \"rmvPrefix\",\n \"Value\": \"/prefix\"\n }\n }\n ],\n \"SubRules\": [\n {\n\"Branches\": [\n {\n \"Condition\": \"${http.request.file_extension} in ['.jpg']\",\n \"Actions\": [\n {\n \"Name\": \"PostMaxSize\",\n \"Parameters\": {\n \"Swi
tch\": \"on\",\n \"MaxSize\": 524288000\n }\n }\n ]\n }\n ]\n },\n {\n \"Branches\": [\n {\n \"Condition\": \"${http.request.file_extension} in ['.png']\",\n \"Actions\": [\n {\n \"Name\": \"PostMaxSize\",\n \"Parameters\": {\n \"Switch\": \"on\",\n \"MaxSize\": 209715200\n }\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}","ConfigGroupVersionInfo": {"CreateTime": "2023-11-06T11:33:12Z","Description": "test","GroupId": "cg-2p9unsmt54uw","GroupType": "l7_acceleration","Status": "inactive","VersionId": "ver-2pn240kqwgti","VersionNumber": "1"},"RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python©2013-2022 Tencent Cloud. All rights reserved.

Page 606 of 760

Tencent Cloud EdgeOne

Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 607 of 760

Tencent Cloud EdgeOne

DescribeConfigGroupVersions：

Last updated 2024-05-29 14:55:41

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the version list for the specified configuration group in version management mode. The
version management feature is currently undergoing beta testing and is accessible only to users on the whitelist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeConfigGroupVersions.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

GroupId

Yes

StringConfiguraration group ID.

Name

Filters.N

No

Array of
AdvancedFilter©2013-2022 Tencent Cloud. All rights reserved.

Filtering condition. The maximum value of Filters.Values is 20. If
this parameter is not specified, all version information for theselected configuration group is returned. Detailed filtering
conditions:version-id: Filter by version ID.

Page 608 of 760

Tencent Cloud EdgeOne

OffsetNo

Integer

Limit

No

Integer

Paging query offset. The default value is 0.
Limited entries in paging queries. The default value is 20 and the
maximum value is 100.

3. Output Parameters
Parameter NameType

Description

TotalCount

Integer

Total versions.

ConfigGroupVersionInfos

RequestId

Array ofConfigGroupVersionInfo

String

Version information list.
The unique request ID, generated by the server, will
be returned for every request (if the request fails toreach the server for other reasons, the request will not
obtain a RequestId). RequestId is required for locatinga problem.

4. Example
Example1 Query Version List
Query version details with ZoneId set to zone-2kpsqmtisdcb, GroupId to cg-27fil26zq2s1, and VersionId to ver2kuq2mhis9c0.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigGroupVersions<Common request parameters>{"ZoneId": "zone-2kpsqmtisdcb","GroupId": "cg-27fil26zq2s1","Filters": [{"Name": "version-id","Values": [©2013-2022 Tencent Cloud. All rights reserved.

Page 609 of 760

Tencent Cloud EdgeOne"ver-2kuq2mhis9c0"]}]}

Output Example{"Response": {"TotalCount": 1,"ConfigGroupVersionInfos": [{"VersionId": "ver-2kuq2mhis9c0","Description": "test","VersionNumber": "1.0","GroupId": "cg-27fil26zq2s1","GroupType": "l7_acceleration","Status": "RELEASED","CreateTime": "2020-09-22T00:00:00+00:00"}],"RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface©2013-2022 Tencent Cloud. All rights reserved.

Page 610 of 760

Tencent Cloud EdgeOne

Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.
Error CodeDescription

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 611 of 760

Tencent Cloud EdgeOne

DescribeDeployHistory：

Last updated 2024-05-29 14:55:41

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the release history of versions in the production or test environment in version management
mode. The version management feature is currently undergoing beta testing and is accessible only to users on thewhitelist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter
Name

RequiredType

ActionYes

String

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

EnvId

Yes

StringEnvironment ID.

Filters.N

No

Array of
AdvancedFilter©2013-2022 Tencent Cloud. All rights reserved.

Description
Common Params. The value used for this API:
DescribeDeployHistory.

Filtering condition. The maximum value of Filters.Values is 20.
Detailed filtering conditions:record-id: Filter by release record ID.

Page 612 of 760

Tencent Cloud EdgeOne

3. Output Parameters
Parameter
Name
TotalCount
Records

RequestId

Type

Description

Integer

Total release records.

Array of
DeployRecord

StringRelease record details.
The unique request ID, generated by the server, will be returned for every
request (if the request fails to reach the server for other reasons, the request
will not obtain a RequestId). RequestId is required for locating a problem.

4. Example
Example1 Query Version Release History
Query the version release history with ZoneId set to zone-3swlomhssdcb and EnvId set to env-2kpeomhisdwb.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomErrorPages<Common request parameters>{"ZoneId": "zone-3swlomhssdcb","EnvId": "env-2kpeomhisdwb"}

Output Example{"Response": {"TotalCount": 1,"Records": [{"ConfigGroupVersionInfos": [{"VersionId": "ver-2kplomhiqdcb",©2013-2022 Tencent Cloud. All rights reserved.

Page 613 of 760

Tencent Cloud EdgeOne"VersionNumber": "1.0","GroupId": "cg-2kplomhisdcb","GroupType": "l7_acceleration","Description": "Test version","Status": "active","CreateTime": "2020-09-22T00:00:00+00:00"}],"RecordId": "dr-2nvehs3fa40u","DeployTime": "2023-09-22T00:00:00+00:00","Status": "success","Message": "Released successfully."}],"RequestId": "9bd9c732-8f9a-4cd3-a3e0-1c2db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error CodeThe following only lists the error codes related to the API business logic. For other error codes, see Common Error
Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 614 of 760

Tencent Cloud EdgeOne

Error CodeDescription

ResourceNotFoundThe resource doesn’t exist.

©2013-2022 Tencent Cloud. All rights reserved.

Page 615 of 760

Tencent Cloud EdgeOne

DescribeEnvironments：

Last updated 2024-05-29 14:55:41

1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query environment information in version management mode. The response includes theenvironment ID, type, and current effective version. The version management feature is currently undergoing beta
testing and is accessible only to users on the whitelist.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try itAPI Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation,
and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For thecomplete common parameter list, see Common Request Parameters.
Parameter

RequiredType

Description

ActionYes

StringCommon Params. The value used for this API:
DescribeEnvironments.

VersionYes

StringCommon Params. The value used for this API: 2022-09-01.

RegionNo

StringCommon Params. This parameter is not required.

ZoneIdYesStringZone ID.

Name

3. Output Parameters
Parameter
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 616 of 760

Tencent Cloud EdgeOne

TotalCount

Integer

Total environments.

EnvInfos

ArrayofEnvironment list.

EnvInfo

RequestId

String

The unique request ID, generated by the server, will be returned for every request (ifthe request fails to reach the server for other reasons, the request will not obtain a
RequestId). RequestId is required for locating a problem.

4. Example
Example1 Query Version Release Environment List
Query information about the environment list with ZoneId set to zone-2k3lomh6sdcb.
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnvironments<Common request parameters>{"ZoneId": "zone-2k3lomh6sdcb"}

Output Example{"Response": {"TotalCount": 1,"EnvInfos": [{"EnvId": "env-2kplomhisdcb","EnvType": "production","Status": "running","Scope": ["ALL"],"CreateTime": "2023-09-21T00:00:00+00:00","UpdateTime": "2023-09-22T00:00:00+00:00",©2013-2022 Tencent Cloud. All rights reserved.

Page 617 of 760

Tencent Cloud EdgeOne"CurrentConfigGroupVersionInfos": [{"VersionId": "ver-2k3lomh6sdcb","VersionNumber": "1.0","GroupId": "cg-2k3lomh6sdcb","GroupType": "l7_acceleration","Description": "Used for production","Status": "active","CreateTime": "2023-09-22T00:00:00+00:00"}]}],"RequestId": "9bd9c732-0f9a-4cd3-a3e8-1e9db5e53631"}}

5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call
APIs.
Tencent Cloud SDK 3.0 for Python
Tencent Cloud SDK 3.0 for Java
Tencent Cloud SDK 3.0 for PHP
Tencent Cloud SDK 3.0 for Go
Tencent Cloud SDK 3.0 for Node.js
Tencent Cloud SDK 3.0 for .NET
Tencent Cloud SDK 3.0 for C++

Command Line Interface
Tencent Cloud CLI 3.0

6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

©2013-2022 Tencent Cloud. All rights reserved.

Page 618 of 760

Tencent Cloud EdgeOne

Data Types：

Last updated 2024-07-10 16:14:13

AccelerateMainland
Cross-MLC-border acceleration.
Used by actions: CreateApplicationProxy, DescribeApplicationProxies, DescribeZoneSetting, ModifyApplicationProxy.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable Cross-MLC-border acceleration. Valid values:on : Enable;
off : Disable.

AccelerateType
Acceleration type
Used by actions: DescribeHostsSetting.
Name

Type

Required

Description
Acceleration switch. Values:

SwitchStringYeson : Enable
off : Disable

AccelerationDomain
Accelerated domain name
Used by actions: DescribeAccelerationDomains.
Name

Type

Description

ZoneIdStringID of the site.

DomainName

StringAccelerated domain name

DomainStatus

StringStatus of the accelerated domain name. Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 619 of 760

Tencent Cloud EdgeOne

online : Activatedprocess : Being deployedoffline : Disabledforbidden : Blocked
init : Pending activation

OriginDetail

OriginDetail

Details of the origin.
Note: This field may return null, indicating that novalid values can be obtained.
Origin-pull protocol configuration. Values:
FOLLOW : Follow the protocol of origin
HTTP : Send requests to the origin over HTTP

OriginProtocol

StringHTTPS : Send requests to the origin over
HTTPS
Note: This field may return·null, indicating that novalid values can be obtained.

HttpOriginPort

Integer

The port used for HTTP origin-pull requests
Note: This field may return·null, indicating that novalid values can be obtained.

HttpsOriginPort

Integer

The port used for HTTPS origin-pull requests
Note: This field may return·null, indicating that novalid values can be obtained.
IPv6 status. Values:
follow : Follow the IPv6 configuration of thesite

IPv6Status

Stringon : Enable
off : Disable
Note: This field may return·null, indicating that novalid values can be obtained.

Cname

StringThe CNAME address.
Ownership verification status. Values:
pending : Pending verification

IdentificationStatus

Stringfinished : Verified
Note: This field may return null, indicating that novalid values can be obtained.

CreatedOn

Timestamp ISO8601©2013-2022 Tencent Cloud. All rights reserved.

Creation time of the accelerated domain name.

Page 620 of 760

Tencent Cloud EdgeOne

ModifiedOnTimestamp ISO8601

OwnershipVerification

Modification time of the accelerated domain name.
Information required to verify the ownership of adomain name.
Note: This field may return·null, indicating that no

OwnershipVerification

valid values can be obtained.

Certificate

AccelerationDomainCertificate

Domain name certificate information
Note: This field may return·null, indicating that novalid values can be obtained.

AccelerationDomainCertificate
Information of the acceleration domain name certificate.
Used by actions: DescribeAccelerationDomains.
Name

Mode

Type

Required

StringDescription
Certificate configuration mode. Values:
disable : Do not configure the certificate;Noeofreecert : Use a free certificate provided by EdgeOne;
sslcert : Configure an SSL certificate.

List

Array ofCertificateInfo

List of certificates
Note: This field may return·null, indicating that no valid values canNobe obtained.

AclCondition
The condition that makes up an access control rule
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

MatchFrom

StringYes

Filters:
host : Request domain name;sip : Client IP;
ua : User-Agent;cookie : Cookie;
cgi : CGI script;©2013-2022 Tencent Cloud. All rights reserved.

Page 621 of 760

Tencent Cloud EdgeOne

xff : XFF header;url : Request URL;
accept : Request content type;
method : Request method<;/li>header : Request header;
app_proto : Application layer protocol;
sip_proto : Network layer protocol;
uabot : UA rules (only available in custom bot rules);
idcid : IDC rules (only available in custom bot rules);sipbot : Search engine rules (only available in custom bot
rules);
portrait : Client reputation (only available in custom bot
rules);
header_seq : Header sequence (only available in custom bot
rules);
hdr : Request body (only available in custom Web protection
rules).
MatchParamStringYes

The parameter of the field. When MatchFrom = header , the key
contained in the header can be passed.
The logical operator. Values:
equal : Value equals
not_equal : Value not equals
include : String contains
not_include : String not contains
match : IP matches
not_match : IP not matches
include_area : Regions contain

Operator

Stringis_empty : Value left empty

Yes

not_exists : Key fields not exist
regexp : Regex matches
len_gt : Value greater than
len_lt : Value smaller than
len_eq : Value equals
match_prefix : Prefix matches
match_suffix : Suffix matches
wildcard : Wildcard
MatchContent

StringYes

The content to match.

AclConfig©2013-2022 Tencent Cloud. All rights reserved.

Page 622 of 760

Tencent Cloud EdgeOne

ACL configuration
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
Switch. Values:

SwitchStringYeson : Enable
off : Disable

AclUserRules

Customizes

Array of
AclUserRule
Array of
AclUserRule

Yes

The custom rule.

No

Custom managed rules
Note: This field may return null , indicating that no valid
value can be obtained.

AclUserRule
The custom rule
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

RuleName

StringYes

The rule name.
The action. Values:
trans : Allow
drop : Block the request

ActionStringYesmonitor : Observeban : Block the IP
redirect : Redirect the request
page : Return the specified pagealg : JavaScript challenge
The rule status. Values:

RuleStatus

StringYeson : Enabled
off : Disabled

AclConditions

Array of
AclCondition

Yes

The custom rule.

RulePriority

IntegerYes

The rule priority. Value range: 0-100.

©2013-2022 Tencent Cloud. All rights reserved.

Page 623 of 760

Tencent Cloud EdgeOne

RuleID

Integer

No

Rule ID, which is only used as an output parameter.

UpdateTime

StringNo

The update time, which is only used as an output
parameter.

PunishTime

IntegerNo

IP ban duration. Range: 0-2 days. It's required when
Action=ban .
The unit of the IP ban duration. Values:
second : Second

PunishTimeUnit

Stringminutes : MinuteNohour : Hour
Default value: second .
NameStringName of the custom return page. It's required when
Action=page .

No(Disused) ID of the custom return page. The default value
PageIdIntegerNo

is 0, which means that the system default blocking pageis used.
ID of custom response. The ID can be obtained via the

CustomResponseId

StringDescribeCustomErrorPages API. It's requiredNo

when Action=page .
The response code to trigger the return page. It's required
ResponseCode

IntegerNo

when Action=page . Value: 100-600. 3xx response
codes are not supported. Default value: 567.

RedirectUrl

String

The redirection URL. It's required when

No

Action=redirect .

ActionRule engine action. Each feature supports only one of the following three action types. The RuleAction array canbe of only one of the following types. For all details, see DescribeRulesSetting.
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

NormalAction

NormalAction

No

Common feature operations. The options for this category
include:Access URL overriding (AccessUrlRedirect);Origin URL overriding (UpstreamUrlRedirect);©2013-2022 Tencent Cloud. All rights reserved.

Page 624 of 760

Tencent Cloud EdgeOne

QUIC;
WebSocket;
Video dragging (VideoSeek);
Token authentication (Authentication);
Custom CacheKey (CacheKey);
Node caching TTL (Cache);
Browser caching TTL (MaxAge);
Offline caching (OfflineCache);
Smart routing (SmartRouting);
Range-based origin pull (RangeOriginPull);
HTTP/2 origin pull (UpstreamHttp2);
Host header overriding (HostHeader);Forced HTTPS (ForceRedirect);HTTPS origin pull (OriginPullProtocol);Cache pre-refresh (CachePrefresh);
Smart compression (Compression);
Hsts;
ClientIpHeader;
SslTlsSecureConf;
OcspStapling;
HTTP/2 access (Http2);
Redirection during origin pull (UpstreamFollowRedirect);
Modifying origin server (Origin);
Layer 7 origin pull timeout (HTTPUpstreamTimeout);
HTTP response (HttpResponse).
Note: This field may return null, indicating that no valid values
can be obtained.
Feature operation with a request/response header. Featuresof this type include:
RequestHeader : HTTP request header modification.
RewriteAction

RewriteAction

No

ResponseHeader : HTTP response header
modification.
Note: This field may return null, indicating that no valid values
can be obtained.
Feature operation with a status code. Features of this typeinclude:ErrorPage : Custom error page.

CodeAction

CodeAction

No

StatusCodeCache : Status code cache TTL.
Note: This field may return null, indicating that no valid values
can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 625 of 760

Tencent Cloud EdgeOne

AdvancedFilter
Key-value pair filters for conditional filtering queries and fuzzy queries, such as filtering ID, name, and status.
If more than one filter exists, the logical relationship between these filters is AND .
If one filter has multiple values, the logical relationship between these values is OR .
Used by actions: DescribeAccelerationDomains, DescribeAliasDomains, DescribeConfigGroupVersions,
DescribeCustomErrorPages, DescribeDeployHistory, DescribeOriginGroup, DescribePrefetchTasks,
DescribePurgeTasks, DescribeRealtimeLogDeliveryTasks, DescribeZones.
Name

Type

Required

Description

Name

StringYes

Field to be filtered.

ValuesArray of String

Yes

Value of the filtered field.

Fuzzy

BooleanNo

Whether to enable fuzzy query.

AiRuleAI rule engine
Used by actions: ModifySecurityPolicy.
Name

Mode

Type

Required

StringDescription
The status of the AI rule engine. Values:
smart_status_close : DisabledYessmart_status_open : Blocksmart_status_observe : Observe

AlgDetectJS
Validate client behavior.
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

Name

String

No

Method to validate client behavior.

WorkLevel

StringNo

Proof-of-work strength. Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 626 of 760

Tencent Cloud EdgeOne

low (default): Low
middle : Medium
high : High
ExecuteMode

IntegerInvalidStatTime

IntegerNo

No

Implement a delay before executing JS in milliseconds.
Value range: 0-1000. Default value: 500.
The period threshold for validating the result "Client JS
disabled" in seconds. Value range: 5-3600. Default
value: 10.

InvalidThreshold

AlgDetectResults

IntegerArray of
AlgDetectResult

No

The number of times for the result "Client JS disabled"
occurred in the specified period. Value range: 1100000000. Default value: 30.

No

Client behavior validation results.

AlgDetectResult
Active bot detection results.
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
The validation result. Values:
invalid : Invalid Cookie
cookie_empty : No Cookie/Cookie expired
js_empty : Client JS disabled

ResultStringNolow : Low-risk session
middle : Medium-risk session
high : High-risk session
timeout : JS validation timed out
not_browser : Invalid browser
is_bot : Bot client
The action. Values:
drop : Block

ActionStringNomonitor : Observe
silence : Drop w/o response
shortdelay : Add short latency
longdelay : Add long latency©2013-2022 Tencent Cloud. All rights reserved.

Page 627 of 760

Tencent Cloud EdgeOne

AlgDetectRule
Active bot detection rule.
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

RuleID

IntegerNo

ID of the rule.

RuleName

StringNo

Name of the rule.

SwitchStringNo

Whether to enable the rule.

No

Condition specified for the rule.

AlgConditions

Array of
AclCondition

Validate Cookie when the condition is satisfied.
AlgDetectSession

AlgDetectSession

No

Note: This field may return null , indicating that novalid values can be obtained.

AlgDetectJS

UpdateTime

Array of
AlgDetectJS
StringNo

Validate client behavior when the condition is satisfied.

No

The update time, which is only used as an output
parameter.

AlgDetectSession
Validate Cookie.
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

Name

String

No

Method to validate Cookie.

DetectMode

String

No

The validation mode. Values:
detect : Validate only
update_detect (default): Update Cookie
and validate

SessionAnalyzeSwitch

StringNo

Whether to enable Cookie-based session check.
The default value is off . Values:
off : Disable©2013-2022 Tencent Cloud. All rights reserved.

Page 628 of 760

Tencent Cloud EdgeOne

on : Enable
The period threshold for validating the result "No
InvalidStatTime

IntegerNo

Cookie/Cookie expired" in seconds. Value range:
5-3600. Default value: 10.
The number of times for the result "No
Cookie/Cookie expired" occurred in the specified

InvalidThreshold

IntegerNo

AlgDetectResults

Array of
AlgDetectResult

No

Cookie validation results.

No

Cookie-based session check results.

Array of

SessionBehaviors

AlgDetectResult

period. Value range: 1-100000000. Default value:
300.

AliasDomain
Information of the alias domain name
Used by actions: DescribeAliasDomains.
Name

Type

Description

AliasName

String

The alias domain name.

ZoneIdString

The site ID.

TargetName

String

The target domain name.
Status of the alias domain name. Values:
active : Activated

StatusStringpending : Deploying
conflict : Reclaimed
stop : Stopped

ForbidMode

Integer

The blocking mode. Values:
0 : Not blocked
11 : Blocked due to regulatory compliance
14 : Blocked due to ICP filing not obtained

CreatedOn

Timestamp ISO8601

Creation time of the alias domain name.

ModifiedOnTimestamp ISO8601

Modification time of the alias domain name.

©2013-2022 Tencent Cloud. All rights reserved.

Page 629 of 760

Tencent Cloud EdgeOne

ApplicationProxy
Application proxy instance
Used by actions: DescribeApplicationProxies.
Name

Type

Description

ZoneIdString

The site ID.

ZoneName

String

The site name.

ProxyId

String

The proxy ID.

String

The domain name or subdomain name when
ProxyType=hostname .

ProxyName

The instance name when ProxyType=instance .

ProxyType

String

The proxy type. Values:
hostname : The proxy is created by subdomain
name.
instance : The proxy is created by instance.
The scheduling mode. Values:

PlatType

String

ip : Schedule via Anycast IP.
domain : Schedule via CNAME.
Acceleration region. Values:
mainland : Chinese mainland.

Area

Stringoverseas : Global (outside the Chinese mainland);Default value: overseas.
Whether to enable security protection. Values:

SecurityType

Integer

0 : Disable security protection.
1 : Enable security protection.

AccelerateType

Integer

Whether to enable acceleration. Values:
0 : Disable acceleration.
1 : Enable acceleration.

SessionPersistTime

Integer

The session persistence duration.

StatusString

The rule status. Values:
online : Enabledoffline : Disabled©2013-2022 Tencent Cloud. All rights reserved.

Page 630 of 760

Tencent Cloud EdgeOne

progress : Deploying
stopping : Disabling
fail : Failed to deploy or disable
The blocking status of the proxy. Values:
banned : Blocked
BanStatus

banning : Blocking

Stringrecover : Unblocked
recovering : Unblocking
ScheduleValue

Array of String

Scheduling information.

HostIdString

Ipv6

Ipv6

The IPv6 access configuration.

UpdateTime

Timestamp ISO8601

The update time.

ApplicationProxyRules

Array of
ApplicationProxyRule

List of rules.

AccelerateMainland

AccelerateMainland

Cross-MLC-border acceleration.

When ProxyType=hostname :This field indicates the unique ID of the subdomain name.

ApplicationProxyRule
Application proxy rule
Used by actions: CreateApplicationProxy, DescribeApplicationProxies.
Name

Proto

Type

StringRequired

Description

Yes

The protocol. Values:
TCP : TCP protocol.
UDP : UDP protocol.

Port

Array of
StringYes

The access port, which can be:
A single port, such as 80
A port range, such as 81-82
Note that each rule can have up to 20 ports.

OriginType

StringYes

Origin server type. Valid values:
custom: Manually added;
loadbalancer: Cloud Load Balancer;©2013-2022 Tencent Cloud. All rights reserved.

Page 631 of 760

Tencent Cloud EdgeOne

origins: Origin server group.
Details of the origin server:
When OriginType is custom, it indicates one or more origin
servers, such as ["8.8.8.8","9.9.9.9"] or OriginValue=
OriginValue

Array of
StringYes["test.com"];
When OriginType is loadbalancer, it indicates a single
Cloud Load Balancer, such as ["lb-xdffsfasdfs"];
When OriginType is origins, it requires one and only one
element, which represents an origin server group ID, such as["origin-537f5b41-162a-11ed-abaa-525400c5da15"].

RuleIdStringNo

The rule ID.
The rule status. Values:
online : Enabled.

StatusStringNo

offline : Disabled.
progress : Deploying
stopping : Disabling
fail : Failed to deploy or disable
Passes the client IP. Values:
TOA : Pass the client IP via TOA (available only when
Proto=TCP ).

ForwardClientIp

StringNo

PPV1 : Pass the client IP via Proxy Protocol V1(available only when Proto=TCP ).
PPV2 : Pass the client IP via Proxy Protocol V2.
OFF : Not pass the client IP.
Default value: OFF.
Whether to enable session persistence. Values:

SessionPersist

BooleanNo

true : Enablefalse : Disable
Default value: false

SessionPersistTime

OriginPort

IntegerStringNo

No

Duration for the persistent session. The value takes effect only
when SessionPersist = true .
Note: This field may return null, indicating that no valid values
can be obtained.
The origin port, which can be:
A single port, such as 80
A port range, such as 81-82

RuleTagStringNo©2013-2022 Tencent Cloud. All rights reserved.

Rule tag.
Note: This field may return null, indicating that no valid values

Page 632 of 760

Tencent Cloud EdgeOne

can be obtained.

AscriptionInfo
The site ownership information
Used by actions: DescribeIdentifications, IdentifyZone.
Name

Type

Description

Subdomain

StringRecordType

String

The record type.

RecordValue

String

The record value.

BillingData
Billing data item
Used by actions: DescribeBillingData.
Name

Type

DescriptionTime

Timestamp ISO8601

Time.

Value

Integer

Value.

BillingDataFilter
Billing data filter criteria.
Used by actions: DescribeBillingData.
Name

Type

Required

Description

Type

StringYes

Parameter name.

Value

StringYes

Parameter value.

©2013-2022 Tencent Cloud. All rights reserved.

Page 633 of 760

Tencent Cloud EdgeOne

BindSharedCNAMEMap
Bindings between a shared CNAME and connected domain names
Used by actions: BindSharedCNAME.
Name

Type

Required

Description

SharedCNAME

StringYes

The shared CNAME to be bound with or unbound from.

DomainNames

Array of String

Yes

Acceleration domains (up to 20).

BotConfig
Bot security configuration
Used by actions: ModifySecurityPolicy.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable bot security. Values:on : Enable
off : Disable

BotManagedRule

BotManagedRule

No

BotPortraitRule

BotPortraitRule

NoIntelligenceRuleIntelligenceRuleNo

The settings of the bot managed rule. If it is null, thesettings that were last configured will be used.
The settings of the client reputation rule. If it is null, thesettings that were last configured will be used.
The bot intelligence settings. If it is null, the settings
that were last configured will be used.
Note: This field may return null, indicating that no valid
values can be obtained.

BotUserRules

Array of
BotUserRule

No

Settings of the custom bot rule. If it is null, the settings
that were last configured will be used.

AlgDetectRule

Array of
AlgDetectRule

No

Active bot detection rule.

Customizes

Array ofNo

Settings of the bot managed rule. It is only used for

BotUserRule

output.
Note: This field may return null , indicating that novalid values can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 634 of 760

Tencent Cloud EdgeOne

BotExtendAction
Bot extended actions
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
Action. Valid values:
monitor : Observe;alg : JavaScript challenge;
captcha : Managed challenge;

ActionStringrandom : Actions are executed based on the percentage specified in

Yes

ExtendActions ;silence : Silence;
shortdelay : Add short latency;
longdelay : Add long latency.

Percent

IntegerNo

The probability for triggering the action. Value range: 0-100.
Note: This field may return null , indicating that no valid values can beobtained.

BotManagedRule
Bot managed rules. The rule IDs can be obtained from the output of DescribeBotManagedRules.
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
The rule action. Values:
drop : Block

ActionStringYestrans : Allowalg : JavaScript challengemonitor : Observe

RuleID

TransManagedIds

IntegerArray ofIntegerNo

The rule ID, which is only used as an output parameter.
The ID of the rule that applies the "Allow" action.

No©2013-2022 Tencent Cloud. All rights reserved.

Note: This field may return null, indicating that no valid
values can be obtained.

Page 635 of 760

Tencent Cloud EdgeOne

AlgManagedIds

Array ofIntegerNo

The ID of the rule that applies the "JavaScript challenge"
action.
Note: This field may return null, indicating that no valid
values can be obtained.
The ID of the rule that applies the "Managed challenge"

CapManagedIds

MonManagedIds

DropManagedIds

Array ofIntegerArray ofIntegerArray ofIntegerNoaction.
Note: This field may return null, indicating that no valid
values can be obtained.
The ID of the rule that applies the "Observe" action.

No

No

Note: This field may return null, indicating that no valid
values can be obtained.
The ID of the rule that applies the "Block" action.
Note: This field may return null, indicating that no valid
values can be obtained.

BotPortraitRule
Bot user portrait rules
Used by actions: ModifySecurityPolicy.
Name

SwitchType

StringRequired

Description

Yes

Switch. Values:on : Enable
off : Disable

RuleID

IntegerNo

The rule ID, which is only used as an output parameter.
The ID of the rule that applies the "JavaScript challenge"

AlgManagedIds

Array ofIntegerNoaction.
Note: This field may return null, indicating that no valid values
can be obtained.
The ID of the rule that applies the "Managed challenge"

CapManagedIds

MonManagedIds

Array ofIntegerArray ofIntegerNoaction.
Note: This field may return null, indicating that no valid values
can be obtained.
The ID of the rule that applies the "Observe" action.

No©2013-2022 Tencent Cloud. All rights reserved.

Note: This field may return null, indicating that no valid values
can be obtained.

Page 636 of 760

Tencent Cloud EdgeOne

DropManagedIds

Array ofIntegerNo

The ID of the rule that applies the "Block" action.
Note: This field may return null, indicating that no valid values
can be obtained.

BotUserRule
Custom bot rules
Used by actions: ModifySecurityPolicy.
Name

Type

Required

RuleName

StringYes

Description

The action. Values:
drop : Block the request
monitor : Observetrans : Allow
redirect : Redirect the request
page : Return the specified page
ActionStringYes

alg : JavaScript challenge
captcha : Managed challenge
random : Handle the request randomly by theweightsilence : Keep the connection but do notresponse to the client
shortdelay : Add a short latency period
longdelay : Add a long latency period
The rule status. Values:

RuleStatus

StringYeson : Enabled
off : Disabled
Default value: on

AclConditions

Array of
AclCondition

Yes

Details of the rule.

RulePriority

IntegerYes

The rule weight. Value range: 0-100.

RuleID

Integer

No

Rule ID, which is only used as an output parameter.

ExtendActions

Array of
BotExtendAction©2013-2022 Tencent Cloud. All rights reserved.

No[Currently unavailable] Specify the random action andpercentage.

Page 637 of 760

Tencent Cloud EdgeOne

FreqFields

Array of StringNo

The filter. Values:
sip : Client IP
This parameter is left empty by default.

UpdateTime

StringNo

The update time, which is only used as an output
parameter.
Query scope. Values:
source_to_eo : (Response) Traffic going fromthe origin to EdgeOne.

FreqScope

Array of StringNoclient_to_eo : (Request) Traffic going fromthe client to EdgeOne.
Default: source_to_eo .

NameCustomResponseId

StringStringNo

No

Name of the custom return page. It's required when
Action=page .
ID of custom response. The ID can be obtained via
the DescribeCustomErrorPages API. It's
required when Action=page .

ResponseCode

Integer

No

RedirectUrl

StringNo

The response code to trigger the return page. It's
required when Action=page . Value: 100-600.
3xx response codes are not supported. Default value:567.
The redirection URL. It's required when
Action=redirect .

CC
CC configuration item.
Used by actions: DescribeHostsSetting.
Name

Type

Required

Description
WAF switch. Values:

SwitchStringYeson : Enable
off : Disable

PolicyId

Integer©2013-2022 Tencent Cloud. All rights reserved.

No

ID of the policy

Page 638 of 760

Tencent Cloud EdgeOne

CLSTopic
The configuration information of real-time log delivery to Tencent Cloud CLS
Used by actions: CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks.
Name

Type

Required

Description

LogSetId

StringYes

The ID of the Tencent Cloud CLS log set.

TopicId

StringYes

The ID of the Tencent Cloud CLS log topic.

LogSetRegion

StringYes

The region of the Tencent Cloud CLS log set.

Cache
Cache time settings
Used by actions: DescribeHostsSetting, ModifyZoneSetting.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable cache configuration. Values:on : Enable
off : Disable

CacheTime

IntegerCache expiration time setting.
Unit: second. The maximum value is 365 days.

No

Note: This field may return null, indicating that no valid values can beobtained.

CacheConfig
Cache rule configuration.
Used by actions: DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting.
Name

Cache

Type

Cache

Required

Description

No

Cache configuration
Note: This field may return null, indicating that no valid values
can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 639 of 760

Tencent Cloud EdgeOne

NoCache

NoCacheNo

No-cache configuration
Note: This field may return null, indicating that no valid values
can be obtained.

FollowOrigin

FollowOrigin

No

Follows the origin server configuration
Note: This field may return null, indicating that no valid values
can be obtained.

CacheKeyThe cache key configuration.
Used by actions: DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether to enable full-path cache. Values:on : Enable full-path cache (i.e., disable Ignore Query
String).

FullUrlCache

StringNo

off : Disable full-path cache (i.e., enable Ignore Query
String).
Note: This field may return null, indicating that no valid values
can be obtained.
Whether to ignore case in the cache key. Values:on : Ignore

IgnoreCase

StringNo

off : Not ignore
Note: This field may return null, indicating that no valid values
can be obtained.
Request parameter contained in CacheKey .

QueryString

QueryStringNo

Note: This field may return null , indicating that no valid
values can be obtained.

CachePrefresh
Cache prefresh
Used by actions: DescribeZoneSetting, ModifyZoneSetting.

©2013-2022 Tencent Cloud. All rights reserved.

Page 640 of 760

Tencent Cloud EdgeOne

Name

SwitchType

StringRequired

Description

Yes

Whether to enable cache prefresh. Values:on : Enable
off : Disable
The cache prefresh percentage. Values: 1-99

Percent

IntegerNo

Note: This field may return null, indicating that no valid values can beobtained.

CacheTag
The information attached when the node cache purge type is set to purge_cache_tag.
Used by actions: CreatePurgeTask.
Name

Type

Required

Description

Domains

Array of String

Yes

List of domain names to purge cache for.

CertificateInfo
HTTPS server certificate configuration
Used by actions: DescribeAccelerationDomains.
Name

Type

Description

CertIdStringID of the server certificate.

Alias

StringAlias of the certificate.

Type

StringType of the certificate. Values:
default : Default certificate
upload : Specified certificate
managed : Tencent Cloud-managed certificate

ExpireTime

Timestamp ISO8601

The certificate expiration time.

DeployTime

Timestamp ISO8601

Time when the certificate is deployed.

SignAlgo

StringSignature algorithm.

StatusStringStatus of the certificate. Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 641 of 760

Tencent Cloud EdgeOne

u200c
deployed : The deployment has completed
u200c
processing : Deployment in progress
u200c
applying : Application in progress
u200c
failed : Application rejectedissued : Binding failed.

ClientIpCountry
Location information of the client IP carried in origin-pull. It is formatted as a two-letter ISO-3166-1 country/region
code.
Used by actions: DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable configuration. Values:on : Enable
off : Disable

HeaderName

StringNo

Name of the request header that contains the client IP region. It is valid
when Switch=on .
The default value EO-Client-IPCountry is used when it is not
specified.

ClientIpHeader
The client IP header configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description

SwitchStringYes

Whether to enable the configuration. Values:on : Enable
off : Disable©2013-2022 Tencent Cloud. All rights reserved.

Page 642 of 760

Tencent Cloud EdgeOne

Name of the request header that contains the client IP for origin-pull.
The default value X-Forwarded-IP is used when it is not
HeaderName

StringNo

specified.
Note: This field may return null , indicating that no valid values canbe obtained.

CnameStatus
CNAME status
Used by actions: CheckCnameStatus.
Name

Type

Description

RecordName

String

The domain name.

Cname

StringThe CNAME address.
Note: This field may return null, indicating that no valid values can be obtained.
The CNAME status. Values:
active : Activated

StatusStringmoved : Not activatedNote: This field may return null, indicating that no valid values can be obtained.

CodeAction
Rule engine action with a status code
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

ActionStringYes

Feature name. For details, see
DescribeRulesSetting API

Yes

Operation parameter.

Parameters

Array of
RuleCodeActionParams

Compression©2013-2022 Tencent Cloud. All rights reserved.

Page 643 of 760

Tencent Cloud EdgeOne

Smart compression configuration.
Used by actions: DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable smart compression. Values:on : Enable
off : Disable
Compression algorithm. Values:
brotli : Brotli algorithm

Algorithms

Array of
Stringgzip : Gzip algorithm

No

Note: This field may return null, indicating that no valid values canbe obtained.

ConfigGroupVersionInfo
Version information about the configuration group.
Used by actions: DeployConfigGroupVersion, DescribeConfigGroupVersionDetail, DescribeConfigGroupVersions,
DescribeDeployHistory, DescribeEnvironments.
Name

Type

Required

Description

VersionId

StringYes

Version ID.

VersionNumber

String

No

Version No.

GroupId

String

No

Configuraration group ID.

No

Configuration group type. Valid values:
l7_acceleration: L7 acceleration configuration group.

GroupType

Stringedge_functions: Edge function configuration group.
Description

StatusStringString

No

No

Version description.
Version status. Valid values:
creating: Being created.
inactive: Not effective.
active: Effective.

CreateTime

Timestamp
ISO8601No©2013-2022 Tencent Cloud. All rights reserved.

Version creation time. The time format follows the ISO 8601
standard and is represented in Coordinated Universal Time

Page 644 of 760

Tencent Cloud EdgeOne(UTC).

CustomEndpoint
The configuration information of real-time log delivery to a custom HTTP(S) interface
Used by actions: CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks,
ModifyRealtimeLogDeliveryTask.
Name

Type

Required

Description
The address of the custom HTTP interface for real-time log

Url

AccessId

StringStringYes

No

delivery. Currently, only HTTP and HTTPS protocols aresupported.
Specifies the custom SecretId for generating an encryptedsignature. This parameter is required if the origin server needs
authentication.

AccessKey

String

No

Specifies the custom SecretKey for generating an encryptedsignature. This parameter is required if the origin server needs
authentication.
The type of data compression. Valid values:

CompressType

StringNo

gzip: gzip compression.
If this field is not filled in, compression is disabled.
The type of the application layer protocol used when POST
requests log delivery. Valid values:

ProtocolStringNo

http: HTTP protocol;
https: HTTPS protocol.
If this field is not filled in, the protocol type will be parsed from the
URL field.
The custom request header carried during log delivery. If theheader name you fill in is the default header carried by EdgeOne

Array
Headersof
HeaderNo

log delivery such as Content-Type, then the header value you fill inwill override the default value. The header value supports referring
to a single variable ${batchSize} to obtain the number of log entries
included in each POST request.

CustomErrorPage©2013-2022 Tencent Cloud. All rights reserved.

Page 645 of 760

Tencent Cloud EdgeOne

Custom error code page structure.
Used by actions: DescribeCustomErrorPages.
Name

Type

Description

PageIdStringCustom error page ID.

ZoneIdStringZone ID.

Name

StringCustom error page name.

ContentType

StringCustom error page type.

Description

StringCustom error page description.

Content

StringCustom error page content.

References

Array of ErrorPageReference

Custom error page reference.

CustomField
The custom log field in a real-time log delivery task
Used by actions: CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks,
ModifyRealtimeLogDeliveryTask.
Name

Type

Required

Description
Extracts data from specified positions in HTTP requests and responses.
Valid values:
ReqHeader: Extract a specified field value from an HTTP request
header;Name

StringYes

RspHeader: Extract a specified field value from an HTTP response
header;cookie: Extract a specified field value from a cookie.
Note: This field may return null, indicating that no valid values can beobtained.
Indicates the name of the parameter from which a value needs to be

Value

StringYes

extracted, such as Accept-Language.
Note: This field may return null, indicating that no valid values can beobtained.

EnabledBooleanNo

Indicates whether to deliver this field. If not filled in, this field will not be©2013-2022 Tencent Cloud. All rights reserved.

Page 646 of 760

Tencent Cloud EdgeOne

delivered.
Note: This field may return null, indicating that no valid values can beobtained.

DDoS
DDoS mitigation configuration
Used by actions: DescribeHostsSetting.
Name

Type

Required

Description
Switch. Values:

SwitchStringon : EnableYes

off : Disable

DDoSAttackEvent
Information of the DDoS attacker
Used by actions: DescribeDDoSAttackEvent.
Name

Type

Description

EventId

String

The event ID.

AttackType

String

The attack type.

AttackStatus

Integer

The attack status.

AttackMaxBandWidthInteger

The maximum attack bandwidth.

AttackPacketMaxRate

Integer

The peak attack packet rate.

AttackStartTime

Integer

The attack start time recorded in seconds.

AttackEndTime

Integer

The attack end time recorded in seconds.
The DDoS policy ID.

PolicyId

Integer

Note: This field may return null , indicating that no valid
value was found.

ZoneIdString

The site ID.
Note: This field may return null , indicating that no valid©2013-2022 Tencent Cloud. All rights reserved.

Page 647 of 760

Tencent Cloud EdgeOne

value was found.
Geolocation scope. Values:
overseas : Regions outside the Chinese mainlandAreamainland : Chinese mainland

StringNote: This field may return null , indicating that no valid
value was found.

DDoSBlockData

Array of
DDoSBlockData

The blocking time of a DDoS attack.
Note: This field may return null , indicating that no valid
value was found.

DDoSBlockData
DDoS blocking details
Used by actions: DescribeDDoSAttackEvent.
Name

Type

Description

StartTime

Integer

The start time recorded in UNIX timestamp.

EndTimeInteger

The end time recorded in UNIX timestamp. 0 indicates the blocking is ongoing.

BlockArea

String

The regions blocked.

DDosProtectionConfig
Exclusive DDoS protection specifications configuration applicable to Layer 4 proxy or web site service.
Used by actions: CreateL4Proxy, DescribeL4Proxy.
Name

Type

Required

Description

LevelMainland

StringNo

Dedicated anti-DDoS specifications in the Chinese
mainland. For details, refer to Dedicated Anti-DDoS
Related Fees.
PLATFORM: uses the default protection. Dedicatedanti-DDoS is not enabled;
BASE30_MAX300: uses dedicated anti-DDoS, which
provides 30 Gbps guaranteed protection bandwidth and up
to 300 Gbps elastic protection bandwidth;©2013-2022 Tencent Cloud. All rights reserved.

Page 648 of 760

Tencent Cloud EdgeOne

BASE60_MAX600: uses dedicated anti-DDoS, which
provides 60 Gbps guaranteed protection bandwidth and up
to 600 Gbps elastic protection bandwidth.
If this field is not specified, the default value 'PLATFORM'
will be used.
Configuration of elastic protection bandwidth for exclusive
DDoS protection in the Chinese mainland.Valid only whenexclusive DDoS protection in the Chinese mainland isenabled (refer to the LevelMainland parameter
configuration), and the value has the following limitations:
When exclusive DDoS protection is enabled in the

MaxBandwidthMainland

Integer

No

Chinese mainland and the 30 Gbps baseline protection
bandwidth is used (the LevelMainland parameter value is
BASE30_MAX300): the value range is 30 to 300 in Gbps;
When exclusive DDoS protection is enabled in the
Chinese mainland and the 60 Gbps baseline protection
bandwidth is used (the LevelMainland parameter value is
BASE60_MAX600): the value range is 60 to 600 in Gbps;
When the default protection of the platform is used (theLevelMainland parameter value is PLATFORM):
configuration is not supported, and the value of thisparameter is invalid.
Dedicated anti-DDoS specifications in global regions(excluding the Chinese mainland).
PLATFORM: uses the default protection. Dedicated

LevelOverseas

StringNo

anti-DDoS is not enabled;
ANYCAST300: uses dedicated anti-DDoS, which
provides 300 Gbps protection bandwidth;
ANYCAST_ALLIN: uses dedicated anti-DDoS, which
provides all available protection resources.
If this field is not specified, the default value 'PLATFORM'
will be used.

DefaultServerCertInfo
HTTPS server certificate configuration
Used by actions: DescribeDefaultCertificates.
Name

Type

Required

Description

CertIdStringYes

ID of the server certificate.

©2013-2022 Tencent Cloud. All rights reserved.

Page 649 of 760

Tencent Cloud EdgeOne

Note: This field may return null, indicating that no valid
values can be obtained.

Alias

StringNo

Alias of the certificate.
Note: This field may return null, indicating that no valid
values can be obtained.
Type of the certificate. Values:
default : Default certificate;
upload : Custom certificate;

Type

StringNomanaged : Tencent Cloud-managed certificate.
Note: This field may return null, indicating that no valid
values can be obtained.

ExpireTime

EffectiveTime

CommonName

Timestamp
ISO8601

Timestamp
ISO8601

String

NoTime when the certificate expires.
Note: This field may return null, indicating that no valid
values can be obtained.
Time when the certificate takes effect.

No

No

Note: This field may return null, indicating that no valid
values can be obtained.
Common name of the certificate.
Note: This field may return null, indicating that no valid
values can be obtained.

SubjectAltName

Array of String

No

Domain names added to the SAN certificate.
Note: This field may return null, indicating that no valid
values can be obtained.
Deployment status. Values:
processing : Deployment in progress
deployed : Deployed

StatusStringNo

failed : Deployment failed
Note: This field may return null , indicating that no valid
value can be obtained.
Failure description

Message

SignAlgo

StringString

No

No

Note: This field may return null, indicating that no valid
values can be obtained.
Certificate algorithm.
Note: This field may return null , indicating that no valid
value can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 650 of 760

Tencent Cloud EdgeOne

DeliveryCondition
Real-time log delivery conditions used to define the scope of log delivery. The relationship between items in a
DeliveryCondition array is "or", whereas the relationship between items in an inner Conditions array is "and".
Used by actions: CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks,
ModifyRealtimeLogDeliveryTask.
Name

Type

Required

Description

Conditions

Array ofNo

Log filter conditions. Detailed filter conditions are as follows:

QueryCondition

EdgeResponseStatusCode: Filter by status code returned tothe client by the EdgeOne node.
Supported operators: equal, great, less, great_equal,
less_equal
Value range: Any integer greater than or equal to 0
OriginResponseStatusCode: Filter by response status codeof the origin server.
Supported operators: equal, great, less, great_equal,
less_equal
Value range: Any integer greater than or equal to -1
SecurityAction: Filter by final action after the request hits the
security rule.
Supported operators: equal
Options are as follows:-: Unknown/unhit
Monitor: Log only
JSChallenge: JavaScript challenge
Deny: Interception
Allow: Allow
BlockIP: IP ban
Redirect: Redirect
ReturnCustomPage: Return to custom page
ManagedChallenge: Managed challenge
Silence: Silence
LongDelay: Response after a long wait
ShortDelay: Response after a short wait
SecurityModule: Filter according to the name of the security
module that ultimately handles the request.
Supported operators: equal
Options are as follows:-: Unknown/missCustomRule: Web protection - custom rules
RateLimitingCustomRule: Web protection - rate limiting ruleManagedRule: Web Protection - Managed Rules©2013-2022 Tencent Cloud. All rights reserved.

Page 651 of 760

Tencent Cloud EdgeOne

L7DDoS: Web Protection - CC Attack Protection
BotManagement: Bot Management - Bot Basic Management
BotClientReputation: Bot Management - Client Reputation
Analysis
BotBehaviorAnalysis: Bot Management - Bot Intelligence
Analysis
BotCustomRule: Bot Management - Custom Bot Rules
BotActiveDetection: Bot Management - Active Detection

DeployRecord
Version release record details for the configuration group.
Used by actions: DescribeDeployHistory.
Name
ConfigGroupVersionInfos

DeployTime

Type
Array ofConfigGroupVersionInfo

Timestamp ISO8601

Description
Details about the released version.
Release time. The time format follows the ISO 8601
standard and is represented in Coordinated Universal
Time (UTC).
Release status. Valid values:

StatusStringMessage

Stringdeploying: Being released.
failure: Release failed.
success: Released successfully.
Release result information.
Release record ID.

RecordId

StringNote: this field may return null, indicating that no valid
values can be obtained.

Description

StringChange description.

DetailHost
Domain name configuration information
Used by actions: DescribeHostsSetting.

©2013-2022 Tencent Cloud. All rights reserved.

Page 652 of 760

Tencent Cloud EdgeOne

Name

Type

Description

ZoneIdString

The site ID.
The acceleration status. Values:

Statusprocess : In progress

Stringonline : Enabledoffline : Disabled

Host

String

The domain name.

ZoneName

StringName of the site

Cname

String

The assigned CNAME

Id

String

The resource ID.

InstanceId

String

The instance ID.

LockInteger

The lock status.

Mode

Integer

The domain name status.
The acceleration area of the domain name. Values:

Area

global : Global.

Stringmainland : Chinese mainland.
overseas : Outside the Chinese mainland.
The acceleration type configuration item.

AccelerateType

Https

AccelerateType

Https

Note: This field may return null, indicating that no valid values can beobtained.
The HTTPS configuration item.
Note: This field may return null, indicating that no valid values can beobtained.

CacheConfig

CacheConfig

The cache configuration item.
Note: This field may return null, indicating that no valid values can beobtained.
The origin configuration item.

OriginSecurityType

OriginSecurityType

Note: This field may return null, indicating that no valid values can beobtained.
The security type.
Note: This field may return null, indicating that no valid values can beobtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 653 of 760

Tencent Cloud EdgeOne

CacheKey

CacheKeyThe cache key configuration item.
Note: This field may return null, indicating that no valid values can beobtained.

Compression

Compression

The smart compression configuration item.
Note: This field may return null, indicating that no valid values can beobtained.

Waf

Waf

CC

CC

DDoS

DDoS

The WAF protection configuration item.
Note: This field may return null, indicating that no valid values can beobtained.
The CC protection configuration item.
Note: This field may return null, indicating that no valid values can beobtained.
DDoS mitigation configuration
Note: This field may return null, indicating that no valid values can beobtained.

SmartRouting

SmartRouting

Ipv6

Ipv6

The smart routing configuration item.
Note: This field may return null, indicating that no valid values can beobtained.
The IPv6 access configuration item.

ClientIpCountry

Note: This field may return null, indicating that no valid values can beobtained.

ClientIpCountry

Whether to carry the location information of the client IP during originpull.
Note: This field may return null , indicating that no valid value can beobtained.

DiffIPWhitelist
Differences between the newest and existing intermediate IPs
Used by actions: DescribeOriginProtection.
Name

Type

Description

LatestIPWhitelist

IPWhitelist

The latest intermediate IPs.

AddedIPWhitelist

IPWhitelist

The intermediate IPs added to the existing list.

©2013-2022 Tencent Cloud. All rights reserved.

Page 654 of 760

Tencent Cloud EdgeOne

RemovedIPWhitelist

IPWhitelist

The intermediate IPs removed from the existing list.

NoChangeIPWhitelist

IPWhitelist

The intermediate IPs that remain unchanged.

DnsVerification
Used by actions: CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones.
Name

Type

Description

Subdomain

String

The host record.

RecordType

String

The record type.

RecordValue

String

The record value.

DropPageConfig
Block page configuration
Used by actions: ModifySecurityPolicy.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable configuration. Values:on : Enable
off : Disable
The settings of the block page that applies managed
rules. If it is null, the settings that were last configured

WafDropPageDetail

DropPageDetailNowill be used.
Note: This field may return null, indicating that no valid
values can be obtained.

AclDropPageDetail

DropPageDetailNo

The settings of the block page that applies custom
rules. If it is null, the settings that were last configured
will be used.
Note: This field may return null, indicating that no valid
values can be obtained.

DropPageDetail©2013-2022 Tencent Cloud. All rights reserved.

Page 655 of 760

Tencent Cloud EdgeOne

The configuration details of the block page
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
The ID of the block page. Specify 0 to use the default block

PageIdIntegerYes

page.
(Disused) If 0 is passed, the default block page will be used.
The HTTP status code to trigger the block page. Range: 100600, excluding 3xx codes. Code 566: Requests blocked by

StatusCode

IntegerYes

NameStringYes

The block page file or URL.

Type

StringYesType of the block page. Values:
page : Return the specified page.

No

ID of custom response. The ID can be obtained via the
DescribeCustomErrorPages API. It's required when

CustomResponseId

Stringmanaged rules. Code 567: Requests blocked by web security
rules (except managed rules).

Type=page .

EntityStatus
Status of domain names bound with this template.
Used by actions: DescribeSecurityTemplateBindings.
Name

Type

Description

EntityString

Instance name. Only subdomain names are supported.

StatusString

Instance configuration status. Values:
online : Configuration has taken effect;
fail : Configuration failed;process : Configuration is being delivered.

Message

StringMessage returned after the operation completed.

EnvInfo©2013-2022 Tencent Cloud. All rights reserved.

Page 656 of 760

Tencent Cloud EdgeOne

Environment information.
Used by actions: DescribeEnvironments.
Name

Type

Description

EnvId

StringEnvironment ID.

StringEnvironment type. Valid values:
production: Production environment.

EnvTypestaging: Test environment.
Environment status. Valid values:
creating: Being created.
running: The environment is stable, with
StatusStringversion changes allowed.
version_deploying: The version is currently
being deployed, with no more changes
allowed.
Effective scope of the configuration in thecurrent environment. Valid values:

Scope

Array of String

ALL: It takes effect on the entire network
when EnvType is set to production.
It returns the IP address of the test node forhost binding during testing when EnvType isset to staging.
For the effective versions of each configurationgroup in the current environment, there are two
possible scenarios based on the value of
Status:CurrentConfigGroupVersionInfos

Array ofConfigGroupVersionInfo

When Status is set to version_deploying,
the returned value of this field represents thepreviously effective version. In other words,
during the deployment of the new version, theeffective version is the one that was in effectbefore any changes were made.
When Status is set to running, the value
returned by this field is the currently effective
version.

CreateTime

Timestamp ISO8601

Creation time. The time format follows the ISO
8601 standard and is represented in
Coordinated Universal Time (UTC).

UpdateTime

Timestamp ISO8601

Update time. The time format follows the ISO©2013-2022 Tencent Cloud. All rights reserved.

Page 657 of 760

Tencent Cloud EdgeOne

8601 standard and is represented in
Coordinated Universal Time (UTC).

ErrorPageReference
Custom error page's referenced source
Used by actions: DescribeCustomErrorPages.
Name

Type

Description

BusinessId

StringReferenced business ID, such as the custom block rule ID.

ExceptConfig
Exception rules, which are used to bypass specific rules
Used by actions: ModifySecurityPolicy.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable configuration. Values:on : Enable
off : Disable

ExceptUserRules

Array of
ExceptUserRule

No

The settings of the exception rule. If it is null, the settings
that were last configured will be used.
Note: This field may return null, indicating that no valid
values can be obtained.

ExceptUserRule
The settings of the exception rule
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

RuleName

StringYes

The rule name.

ActionStringYes

The rule action. It only supports the©2013-2022 Tencent Cloud. All rights reserved.

Page 658 of 760

Tencent Cloud EdgeOne

value skip , which indicatesskipping all managed rules.

RuleStatus

StringYes

The rule status. Values:on : Enabled
off : Disabled

RuleID

IntegerNo

The rule ID, which is automaticallycreated and only used as an output
parameter.
The update time. If it is null, thecurrent date and time is recorded.

UpdateTime

Timestamp ISO8601

No

Note: This field may return null ,indicating that no valid value can beobtained.
The matching condition.

ExceptUserRuleConditions

Array of
ExceptUserRuleConditionNo

Note: This field may return null,indicating that no valid values can beobtained.

ExceptUserRuleScope

ExceptUserRuleScopeNo

The scope to which the exception
rule applies.
Note: This field may return null,indicating that no valid values can beobtained.

RulePriority

IntegerNo

The rule priority. Value range: 0-100.
If it is null, it defaults to 0.

ExceptUserRuleCondition
The condition of the exception rule
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

MatchFrom

String

No

The field to match. Values:
host : Request domain namesip : Client IP
ua : User-Agentcookie : Cookie
cgi : CGI script©2013-2022 Tencent Cloud. All rights reserved.

Page 659 of 760

Tencent Cloud EdgeOne

xff : XFF header
url : Request URL
accept : Request content type
method : Request method
header : Request header
sip_proto : Network layer protocol
MatchParamString

The parameter of the field. Only when MatchFrom = header , theNo

key contained in the header can be passed.
The logical operator. Values:
equal : String equals
not_equal : Value not equals
include : String contains
not_include : String not contains
match : IP matches
not_match : IP not matches
include_area : Regions contain

Operator

Stringis_empty : Value left empty

Nonot_exists : Key fields not exist
regexp : Regex matches
len_gt : Value greater than
len_lt : Value smaller than
len_eq : Value equals
match_prefix : Prefix matches
match_suffix : Suffix matches
wildcard : Wildcard
MatchContent

String

No

The value of the parameter.

ExceptUserRuleScope
The scope to which the exception rule applies
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
Exception mode. Values:

Type

StringNocomplete : Skip the exception rule for full requests.
partial : Skip the exception rule for partial requests.

ModulesArray ofNo

©2013-2022 Tencent Cloud. All rights reserved.

The module to be activated. Values:

Page 660 of 760

Tencent Cloud EdgeOne

Stringwaf : Tencent Cloud-managed rules
rate : Rate limiting rules
acl : Custom rule
cc : CC attack defense
bot : Bot protection
Note: this field may return null , indicating that no valid
value is obtained.

PartialModules

Array of
PartialModule

Module settings of the exception rule. If it is null, the settings
that were last configured will be used.

No

Note: This field may return null , indicating that no valid
value can be obtained.

SkipConditions

Array of
SkipCondition

Condition settings of the exception rule. If it is null, thesettings that were last configured will be used.

No

Note: This field may return null , indicating that no valid
value can be obtained.

FailReason
Failure reason
Used by actions: CreatePrefetchTask, CreatePurgeTask.
Name

Type

Description

ReasonStringFailure reason.

Targets

Array of String

List of resources failed to be processed.

FileAscriptionInfo
Verification file, used to verify site ownership
Used by actions: DescribeIdentifications, IdentifyZone.
Name

Type

Description

IdentifyPath

StringDirectory of the verification file.

IdentifyContent

StringContent of the verification file.

©2013-2022 Tencent Cloud. All rights reserved.

Page 661 of 760

Tencent Cloud EdgeOne

FileVerification
Information required for verifying via a file. It's applicable to sites connected via CNAMEs.
Used by actions: CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones.
Name

Path

Type

Description

StringEdgeOne obtains the file verification information in the format of "Scheme + Host + URL
Path", (e.g. https://www.example.com/.well-known/teo-verification/z12h416twn.txt). This
field is the URL path section of the URL you need to create.

Content

StringContent of the verification file. The contents of this field need to be filled into the text file
returned by Path .

FilterKey-value pair filters for conditional filtering queries, such as filtering ID, name, and status.
If more than one filter exists, the logical relationship between these filters is AND .
If multiple values exist in one filter, the logical relationship between these values under the same filter is OR .
Used by actions: DescribeApplicationProxies, DescribeDefaultCertificates, DescribeHostsSetting,DescribeIdentifications, DescribeL4Proxy, DescribeL4ProxyRules, DescribeOriginProtection, DescribeRules.
Name

Type

Required

Description

Name

StringYes

Fields to be filtered.

ValuesArray of String

Yes

Value of the filtered field.

FirstPartConfig
The configuration to detect slow attacks based on the transfer period the first 8 KB of requests
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

SwitchStringYes

Switch. Values:on : Enable
off : Disable©2013-2022 Tencent Cloud. All rights reserved.

Page 662 of 760

Tencent Cloud EdgeOne

Note: This field may return null , indicating that no valid value can beobtained.
The transfer period threshold of the first 8 KB. If the threshold is reached,
StatTime

IntegerNo

it’s considered a slow attack. Default: 5 .
Note: This field may return null , indicating that no valid value can beobtained.

FollowOrigin
The origin cache configuration
Used by actions: DescribeHostsSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether to enable the configuration of following the origin

SwitchStringYes

server. Valid values:on : Enable
off : Disable

DefaultCacheTime

Integer

No

Sets the default cache time when the origin server does not
return the Cache-Control header.
Note: This field may return null , indicating that no valid
value can be obtained.
Specifies whether to enable cache when the origin server

DefaultCache

StringNo

does not return the Cache-Control header.
Note: This field may return null , indicating that no valid
value can be obtained.
Specifies whether to use the default caching policy when

DefaultCacheStrategy

StringNo

Cache-Control is not returned from the origin
Note: This field may return null , indicating that no valid
value can be obtained.

ForceRedirect
Force HTTPS redirect configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.

©2013-2022 Tencent Cloud. All rights reserved.

Page 663 of 760

Tencent Cloud EdgeOne

Name

Type

Required

Description
Whether to enable force HTTPS redirect. Values:

SwitchStringon : EnableYes

off : Disable
Redirect status code. Values:
301 : 301 redirect
RedirectStatusCode

Integer

302 : 302 redirectNo

Note: This field may return null, indicating that no valid values
can be obtained.

Grpc
Configuration of gRPC support
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether to enable gRPC support. Valid values:

SwitchStringon : Enable;Yes

off : Disable.

HeaderHTTP header, used as input for the CreatePrefetchTask API
Used by actions: CreatePrefetchTask, CreateRealtimeLogDeliveryTask, ModifyRealtimeLogDeliveryTask.
Name

Type

Required

Description

Name

StringYes

HTTP header name.

Value

StringYes

HTTP header value

Hsts
HSTS configuration©2013-2022 Tencent Cloud. All rights reserved.

Page 664 of 760

Tencent Cloud EdgeOne

Used by actions: DescribeHostsSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether to enable the configuration. Values:

SwitchStringYeson : Enable
off : Disable
MaxAge (in seconds). The maximum value is 1 day.

MaxAgeIntegerNo

Note: This field may return null , indicating that no valid
values can be obtained.
Whether to contain subdomain names. Values:on : Enable

IncludeSubDomains

StringNo

off : Disable
Note: This field may return null, indicating that no valid values
can be obtained.
Whether to enable preloading. Values:on : Enable

PreloadStringNo

off : Disable
Note: This field may return null, indicating that no valid values
can be obtained.

Https
Domain name HTTPS acceleration configuration. This is disabled by default.
Used by actions: DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether to enable HTTP2. Values:on : Enable

Http2

StringNo

off : Disable
Note: This field may return null, indicating that no valid values
can be obtained.

OcspStapling

StringNo

Whether to enable OCSP. Values:on : Enable
off : Disable©2013-2022 Tencent Cloud. All rights reserved.

Page 665 of 760

Tencent Cloud EdgeOne

Note: This field may return null, indicating that no valid values
can be obtained.
TLS version. Valid values:
TLSv1 : TLSv1 version;
TLSV1.1 : TLSv1.1 version;
TlsVersion

Array of String

No

TLSV1.2 : TLSv1.2 version;
TLSv1.3 : TLSv1.3 version.
Only consecutive versions can be enabled at the same time.
Note: This field may return null , indicating that no valid
values can be obtained.
HSTS Configuration

Hsts

CertInfo

Hsts

Array ofServerCertInfo

No

No

Note: This field may return null, indicating that no valid values
can be obtained.
The certificate configuration.
Note: This field may return null, indicating that no valid values
can be obtained.
Whether the certificate is managed by EdgeOne. Values:
apply : Managed by EdgeOne.

ApplyType

StringNonone : Not managed by EdgeOne.
If it is left empty, the default value none is used.
Note: This field may return null , indicating that no valid
value can be obtained.
The cipher suite, with values:
loose-v2023: Provides high compatibility with generalsecurity, and supports TLS 1.0-1.3 cipher suites;

CipherSuite

StringNo

general-v2023: Provides relatively high compatibility withmoderate security, and supports TLS 1.2-1.3 cipher suites;
strict-v2023: Provides high security, disables all cipher
suites with security risks, and supports TLS 1.2-1.3 cipher
suites.
Note: This field may return null, which indicates a failure toobtain a valid value.

IPGroup
IP range group©2013-2022 Tencent Cloud. All rights reserved.

Page 666 of 760

Tencent Cloud EdgeOne

Used by actions: CreateSecurityIPGroup, DescribeSecurityIPGroup, DescribeSecurityIPGroupInfo,
ModifySecurityIPGroup.
Name

Type

Required

Description

GroupId

IntegerYesGroup ID. Enter 0 .

NameStringYes

Group name.

Content

Array of StringYes

IP group content. Only supports IP and IP mask.

IPRegionInfo
IP location information query
Used by actions: DescribeIPRegion.
Name

Type

Description

IP

StringIP address, IPV4 or IPV6.

StringWhether the IP belongs to an EdgeOne node. Valid values:
yes: This IP belongs to an EdgeOne node;

IsEdgeOneIP

no: This IP does not belong to an EdgeOne node.

IPWhitelistIntermediate IPs
Used by actions: DescribeOriginProtection.
Name

Type

Description

IPv4

Array of String

List of IPv4 addresses

IPv6

Array of String

List of IPv6 addresses

Identification
The site verification information©2013-2022 Tencent Cloud. All rights reserved.

Page 667 of 760

Tencent Cloud EdgeOne

Used by actions: DescribeIdentifications.
Name

Type

Description

ZoneName

String

The site name.

DomainString

The subdomain name to be verified. To verify the ownership of asite, leave it blank.
Note: This field may return null , indicating that no valid
values can be obtained.

StatusString

The verification status. Values:
pending : The verification is ongoing.
finished : The verification completed.

Ascription

AscriptionInfo

Details of the DNS record.
The NS record of the domain name.

OriginalNameServers

Array of String

Note: This field may return null, indicating that no valid values
can be obtained.

FileAscription

FileAscriptionInfo

Details of the verification file.

ImageOptimize
Image optimization configuration.
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether to enable configuration. Values:

SwitchStringYeson : Enable
off : DisableIntelligenceRule
Bot intelligence rules
Used by actions: ModifySecurityPolicy.
Name

Type

©2013-2022 Tencent Cloud. All rights reserved.

Required

Description

Page 668 of 760

Tencent Cloud EdgeOne

SwitchStringNo

Switch. Values:on : Enable
off : Disable
Note: This field may return null, indicating thatno valid values can be obtained.

IntelligenceRuleItems

Array ofIntelligenceRuleItem

Items in a bot intelligence rule
Note: This field may return null, indicating thatNono valid values can be obtained.

IntelligenceRuleItem
Bot intelligence rule items
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
The tag to categorize bots. Values:
evil_bot : Malicious bot

Label

StringYessuspect_bot : Suspected bot
good_bot : Good bot
normal : Normal request
The action taken on bots. Values
drop : Block

ActionStringYestrans : Allowalg : JavaScript challenge
captcha : Managed challengemonitor : Observe

IpTableConfig
IP/Region blocklist/allowlist configuration
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

SwitchStringYes

Switch. Values:on : Enable©2013-2022 Tencent Cloud. All rights reserved.

Page 669 of 760

Tencent Cloud EdgeOne

off : Disable
Note: This field may return null, indicating that no valid values
can be obtained.

IpTableRules

Array ofIpTableRuleNo

The settings of the basic access control rule. If it is null, thesettings that were last configured will be used.
Note: This field may return null, indicating that no valid values
can be obtained.

IpTableRule
IP blocklist/allowlist rule details
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
The action. Values:

ActionStringYesdrop : Blocktrans : Allow
monitor : Observe

MatchFrom

StringYes

The matching dimension. Values:
ip : Match by IP.
area : Match by IP region.
Matching method. It defaults to equal if it’s left empty.
Values:is_empty : The field is empty.
not_exists : The configuration item does not exist.
include : Include

Operator

StringNo

not_include : Do not include
equal : Equal tonot_equal : Not equal toNote: This field may return null, indicating that no valid values
can be obtained.

RuleID
UpdateTime

Integer
Timestamp
ISO8601No

The rule ID, which is only used as an output parameter.

No

The update time, which is only used as an output parameter.

©2013-2022 Tencent Cloud. All rights reserved.

Page 670 of 760

Tencent Cloud EdgeOne

StatusStringNo

The rule status. A null value indicates that the rule is enabled.
Values:on : Enabled
off : Disabled
Note: This field may return null, indicating that no valid values
can be obtained.

RuleName

StringNo

The rule name.
Note: This field may return null, indicating that no valid values
can be obtained.

MatchContent

StringNo

Matching content. It’s not required when Operator is
is_emty or not_exists .

Ipv6
The IPv6 access configuration.
Used by actions: CreateApplicationProxy, DescribeApplicationProxies, DescribeHostsSetting, DescribeZoneSetting,
ModifyApplicationProxy, ModifyZoneSetting.
Name

Type

Required

Description
Whether to enable IPv6 access. Valid values:

SwitchStringYeson : Enable;
off : Disable.

L4OfflineLog
The L7 log details
Used by actions: DownloadL4Logs.
Name

Type

Description

ProxyId

StringL4 proxy instance ID.

String

Log query area. Valid values:
mainland : Chinese mainland;Areaoverseas : Global (outside the Chinese mainland).
LogPacketName

String©2013-2022 Tencent Cloud. All rights reserved.

Log packet name.

Page 671 of 760

Tencent Cloud EdgeOne

Url

StringLog download address.

LogTimeInteger(Disused) Log packaging time.

LogStartTime

Timestamp ISO8601

Start time of log packaging.

LogEndTime

Timestamp ISO8601

End time of the log package.

Size

IntegerLog size (in bytes).

L4Proxy
Layer 4 proxy instance.
Used by actions: DescribeL4Proxy.
Name

Type

Required

Description

ZoneIdString

No

Zone ID.

ProxyId

StringNo

Layer 4 proxy instance ID.

ProxyName

StringNo

Layer 4 proxy instance name.
Acceleration zone of the Layer 4 proxyinstance.
mainland: Availability zone in the Chinese

Area

StringNo

mainland;overseas: Global availability zone
(excluding the Chinese mainland);global: Global availability zone.

Cname

Ips

StringArray of String

No

No

Access via CNAME.
After the fixed IP address is enabled, thisvalue will return the corresponding access IP
address; if it is not enabled, this value will be
empty.

StatusStringNo

Status of the Layer 4 proxy instance.
online: Enabled;
offline: Disabled;
progress: Deploying;
stopping: Disabling;©2013-2022 Tencent Cloud. All rights reserved.

Page 672 of 760

Tencent Cloud EdgeOne

banned: Blocked;
fail: Failed to deploy or disable.
Specifies whether to enable IPv6 access.
Ipv6

StaticIp

AccelerateMainland

DDosProtectionConfig

StringNo

StringNo

StringNo

DDosProtectionConfig

No

on: Enable;
off: Disable.
Specifies whether to enable the fixed IP
address.
on: Enable;
off: Disable.
Specifies whether to enable network
optimization in the Chinese mainland.
on: Enable
off: Disable
Security protection configuration.
Note: This field may return null, indicating thatno valid value can be obtained.

L4ProxyRuleCount

IntegerNo

Number of forwarding rules under the Layer 4
proxy instance.

UpdateTime

Timestamp ISO8601

No

Latest modification time.

L4ProxyRule
Details of Layer 4 proxy forwarding rules.
Used by actions: CreateL4ProxyRules, DescribeL4ProxyRules, ModifyL4ProxyRules.
Name

RuleIdType

StringRequired

Description

No

Forwarding rule ID.
Note: Do not fill in this parameter when L4ProxyRule isused as an input parameter in CreateL4ProxyRules; itmust be filled in when L4ProxyRule is used as an input
parameter in ModifyL4ProxyRules.

ProtocolStringNo

Forwarding protocol. Valid values:
TCP: TCP protocol;
UDP: UDP protocol.
Note: This parameter must be filled in when©2013-2022 Tencent Cloud. All rights reserved.

Page 673 of 760

Tencent Cloud EdgeOne

L4ProxyRule is used as an input parameter in
CreateL4ProxyRules; it is optional when L4ProxyRule isused as an input parameter in ModifyL4ProxyRules. If
not specified, it will retain its existing value.
Forwarding port, which can be set as follows:
A single port, such as 80;

PortRange

Array
of

A range of ports, such as 81-85, representing ports
81, 82, 83, 84, 85.
NoStringNote: This parameter must be filled in when
L4ProxyRule is used as an input parameter in
CreateL4ProxyRules; it is optional when L4ProxyRule isused as an input parameter in ModifyL4ProxyRules. If
not specified, it will retain its existing value.
Origin server type. Valid values:
IP_DOMAIN: IP/Domain name origin server;
ORIGIN_GROUP: Origin server group;
LB: Cloud Load Balancer, currently only open to theallowlist.

OriginType

StringNo
Note: This parameter must be filled in when
L4ProxyRule is used as an input parameter in
CreateL4ProxyRules; it is optional when L4ProxyRule isused as an input parameter in ModifyL4ProxyRules. If
not specified, it will retain its existing value.
Origin server address.
When OriginType is set to IP_DOMAIN, enter the IP
address or domain name, such as 8.8.8.8 or test.com;
When OriginType is set to ORIGIN_GROUP, enter

OriginValue

Array
of

No

the origin server group ID, such as og-537y24vf5b41;
When OriginType is set to LB, enter the Cloud Load
Balancer instance ID, such as lb-2qwk30xf7s9g.

StringNote: This parameter must be filled in when
L4ProxyRule is used as an input parameter in
CreateL4ProxyRules; it is optional when L4ProxyRule isused as an input parameter in ModifyL4ProxyRules. If
not specified, it will retain its existing value.
OriginPortRange

StringNo

Origin server port, which can be set as follows:
A single port, such as 80;
A range of ports, such as 81-85, representing ports
81, 82, 83, 84, 85. When inputting a range of ports,©2013-2022 Tencent Cloud. All rights reserved.

Page 674 of 760

Tencent Cloud EdgeOne

ensure that the length corresponds with that of theforwarding port range. For example, if the forwarding
port range is 80-90, this port range should be 90-100.
Note: This parameter must be filled in when
L4ProxyRule is used as an input parameter in
CreateL4ProxyRules; it is optional when L4ProxyRule isused as an input parameter in ModifyL4ProxyRules. If
not specified, it will retain its existing value.
Transmission of the client IP address. Valid values:
TOA: Available only when Protocol=TCP;
PPV1: Transmission via Proxy Protocol V1. Available
only when Protocol=TCP;
PPV2: Transmission via Proxy Protocol V2;
SPP: Transmission via Simple Proxy Protocol.
ClientIPPassThroughMode

StringNo

Available only when Protocol=UDP;
OFF: No transmission.
Note: This parameter is optional when L4ProxyRule isused as an input parameter in CreateL4ProxyRules, and
if not specified, the default value OFF will be used; it is
optional when L4ProxyRule is used as an input
parameter in ModifyL4ProxyRules. If not specified, it willretain its existing value.
Specifies whether to enable session persistence. Validvalues:on: Enable;
off: Disable.

SessionPersist

StringNo

Note: This parameter is optional when L4ProxyRule isused as an input parameter in CreateL4ProxyRules, and
if not specified, the default value off will be used; it is
optional when L4ProxyRule is used as an input
parameter in ModifyL4ProxyRules. If not specified, it willretain its existing value.

SessionPersistTime

IntegerNo

Session persistence period, with a range of 30-3600,
measured in seconds.
Note: This parameter is optional when L4ProxyRule isused as an input parameter in CreateL4ProxyRules. It isvalid only when SessionPersist is set to on and defaults©2013-2022 Tencent Cloud. All rights reserved.

Page 675 of 760

Tencent Cloud EdgeOne

to 3600 if not specified. It is optional when L4ProxyRule
is used as an input parameter in ModifyL4ProxyRules. If
not specified, it will retain its existing value.
Rule tag. Accepts 1-50 arbitrary characters.

RuleTagStringNo

Note: This parameter is optional when L4ProxyRule isused as an input parameter in CreateL4ProxyRules; it is
optional when L4ProxyRule is used as an input
parameter in ModifyL4ProxyRules. If not specified, it willretain its existing value.
Rule status. Valid values:
online: Enabled;
offline: Disabled;
progress: Deploying;

StatusStringNo

stopping: Disabling;
fail: Failed to deploy or disable.
Note: Do not set this parameter when L4ProxyRule isused as an input parameter in CreateL4ProxyRules andModifyL4ProxyRules.

BuId

StringNo

BuID.

L7OfflineLog
Details of L7 logs.
Used by actions: DownloadL7Logs.
Name

Type

Description

DomainStringLog domain name.

String

Log query area. Valid values:
mainland : Chinese mainland;Areaoverseas : Global (outside the Chinese mainland).
LogPacketName

StringLog packet name.

Url

StringLog download address.

LogTimeInteger(Disused) Log packaging time.

LogStartTime

Timestamp ISO8601

Start time of log packaging.

©2013-2022 Tencent Cloud. All rights reserved.

Page 676 of 760

Tencent Cloud EdgeOne

LogEndTime

Timestamp ISO8601

End time of the log package.

Size

Integer

Original log size (in bytes).

LogFormat
Output format for real-time log delivery. You can directly use the specified predefined log output format (JSON Lines /csv) through the FormatType parameter, or define a variant output format through additional parameters based on thepredefined log output format.
Used by actions: CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks,
ModifyRealtimeLogDeliveryTask.
Name

FormatType

Type

StringRequiredYes

Description
Predefined output format type for log delivery. Valid values:
json: Use the predefined log output format JSON Lines, where
fields in each log record are presented as key-value pairs;
csv: Use the predefined log output format csv, where fields ineach log record is only presented as field values, excluding fieldnames.
A string added before each log delivery batch. Each log delivery

BatchPrefix

StringNo

BatchSuffix

StringNo

A string appended after each log delivery batch.

RecordPrefix

StringNo

A string added before each log record.

RecordSuffix

StringNo

A string appended after each log record.

RecordDelimiter

StringNobatch may contain multiple log records.

A string inserted between log records as a separator. Valid values:\n: Line break;\t: Tab character;,: Half-width comma.

FieldDelimiter

StringNo

A string inserted between fields as a separator within a single log
record. Valid values:\t: Tab character;,: Half-width comma;;: Half-width semicolon.

MaxAge©2013-2022 Tencent Cloud. All rights reserved.

Page 677 of 760

Tencent Cloud EdgeOne

Browser cache rule configuration, which is used to set the default value of MaxAge and is disabled by default.
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

Type

FollowOrigin

StringRequiredNo

Description
Whether to follow the origin server. Values:on : Follow the origin server and ignore the field MaxAgeTime;off : Do not follow the origin server and apply the field
MaxAgeTime.
Specifies the maximum amount of time (in seconds). The maximum

MaxAgeTime

Integer

Novalue is 365 days.
Note: The value 0 means not to cache.

NoCacheNo-cache configuration
Used by actions: DescribeHostsSetting, ModifyZoneSetting.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable no-cache configuration. Valid values:on : Enable
off : Disable

NormalAction
Common action of the rule engine
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

RequiredActionStringYes

Parameters

Array of
RuleNormalActionParams

Yes©2013-2022 Tencent Cloud. All rights reserved.

Description
Feature name. For details, see
DescribeRulesSetting API
Parameter

Page 678 of 760

Tencent Cloud EdgeOne

NsVerification
Information required for switching DNS servers. It's applicable to sites connected via NSs.
Used by actions: CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones.
Name

Type

Description

NameServers

Array
of

The DNS server address assigned to the user when connecting a site to EO via NS.

String

You need to switch the NameServer of the domain name to this address.

OfflineCache
Offline cache feature status switch.
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether offline cache is enabled. Valid values:

SwitchStringon : EnableYes

off : Disable

OriginThe origin server configuration.
Used by actions: DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description

Origins

Array of
StringNo

Primary origin server list
Note: This field may return null, indicating that no valid values

BackupOrigins

Array of
StringNo

The list of backup origin servers.
Note: This field may return null, indicating that no valid values
can be obtained.

OriginPullProtocol

StringNo

Origin-pull protocol configuration. Values:

can be obtained.

http : Force HTTP for origin-pull.

©2013-2022 Tencent Cloud. All rights reserved.

Page 679 of 760

Tencent Cloud EdgeOne

follow : Follow protocol.
https : Force HTTPS for origin-pull.
Note: This field may return null , indicating that no valid
value can be obtained.
Whether to allow private access to buckets when
OriginType=cos . Valid values:on : Private access;
CosPrivateAccess

StringNo

off : Public access.
Note: This field may return null , indicating that no valid
values can be obtained.

OriginDetail
Details of the origin.
Used by actions: DescribeAccelerationDomains.
Name

Type

Description
Origin server type, with values:
IP_DOMAIN: IPv4, IPv6, or domain name type origin
server;OriginType

StringCOS: Tencent Cloud COS origin server;
AWS_S3: AWS S3 origin server;
ORIGIN_GROUP: origin server group type origin server;
VODEO: VOD on EO;
VOD: Video on Demand;
SPACE: origin server uninstallation. Currently only
available to the allowlist;
LB: load balancing. Currently only available to the allowlist.

OriginStringOrigin server address, which varies according to the value ofOriginType:
When OriginType = IP_DOMAIN, this parameter should
be an IPv4 address, an IPv6 address, or a domain name;
When OriginType = COS, this parameter should be theaccess domain name of the COS bucket;
When OriginType = AWS_S3, this parameter should be
the access domain name of the S3 bucket;
When OriginType = ORIGIN_GROUP, this parametershould be the origin server group ID;©2013-2022 Tencent Cloud. All rights reserved.

Page 680 of 760

Tencent Cloud EdgeOne

When OriginType = VOD, this parameter should be the
VOD application ID;
When OriginType = VODEO, if VodeoDistributionRange =ALL, then this parameter is "all-buckets-in-vodeo-application";
if VodeoDistributionRange = Bucket, then this parameter isthe domain name of the corresponding bucket.

BackupOrigin

StringOriginGroupName

StringBackOriginGroupName

StringSecondary origin group ID. This parameter is valid only when
OriginType is ORIGIN_GROUP and a secondary origin groupis configured.
Primary origin group name. This parameter returns a value
when OriginType is ORIGIN_GROUP.
Secondary origin group name. This parameter is valid only
when OriginType is ORIGIN_GROUP and a secondary origingroup is configured.
Whether access to the private object storage origin server isallowed. This parameter is valid only when the origin server
type OriginType is COS or AWS_S3. Valid values:

PrivateAccess

Stringon: Enable private authentication;
off: Disable private authentication.
If this field is not specified, the default value 'off' will be used.

PrivateParameters

Array of
PrivateParameter

Private authentication parameter. This parameter is valid only
when PrivateAccess is on.
Note: This field may return null, indicating that no valid values
can be obtained.

VodeoSubAppId

Integer

MO sub-application ID

VodeoDistributionRange

StringMO distribution range. Valid values:
All: all
Bucket: bucket

VodeoBucketId

StringMO bucket ID, required when the distribution range(DistributionRange) is bucket (Bucket)

OriginGroup
Origin group information.
Used by actions: DescribeOriginGroup.

©2013-2022 Tencent Cloud. All rights reserved.

Page 681 of 760

Tencent Cloud EdgeOne

Name

Type

Description

GroupId

StringThe ID of the origin group.

Name

String

The name of the origin group.

StringThe origin group type. Values:
GENERAL : General origin group

Type

HTTP : HTTP-specific origin group
Records

Array of OriginRecord

Details of the origin record.

References

Array ofOriginGroupReference

List of instances referencing this origin group.

CreateTime

Timestamp ISO8601

Creation time of the origin group.

UpdateTime

Timestamp ISO8601

The update time of the origin group.
Origin-pull host header

HostHeader

StringNote: This field may return·null, indicating that no valid values canbe obtained.

OriginGroupReference
Services referencing this origin group
Used by actions: DescribeOriginGroup.
Name

Type

Description
Services referencing the origin group. Values:
AccelerationDomain : Acceleration domain nameInstanceType

StringRuleEngine : Rules engine
Loadbalance : Load balancer
ApplicationProxy : L4 proxy

InstanceId

StringID of the instances referencing the origin group

InstanceName

StringName of the instance referencing the origin group

OriginInfo©2013-2022 Tencent Cloud. All rights reserved.

Page 682 of 760

Tencent Cloud EdgeOne

Details of the origin.
Used by actions: CreateAccelerationDomain, ModifyAccelerationDomain.
Name

Type

Required

Description
Origin server type, with values:
IP_DOMAIN: IPv4, IPv6, or domain nametype origin server;
COS: Tencent Cloud COS origin server;
AWS_S3: AWS S3 origin server;

OriginType

StringYes

ORIGIN_GROUP: origin server group typeorigin server;
VOD: Video on Demand;
SPACE: origin server uninstallation.
Currently only available to the allowlist;
LB: load balancing. Currently only available
to the allowlist.
Origin server address, which varies according
to the value of OriginType:
When OriginType = IP_DOMAIN, fill in an
IPv4 address, an IPv6 address, or a domain
name;When OriginType = COS, fill in the accessdomain name of the COS bucket;
When OriginType = AWS_S3, fill in theaccess domain name of the S3 bucket;

OriginStringYes

When OriginType = ORIGIN_GROUP, fill inthe origin server group ID;
When OriginType = VOD, fill in the VODapplication ID;
When OriginType = LB, fill in the Cloud Load
Balancer instance ID. This feature is currently
only available to the allowlist;
When OriginType = SPACE, fill in the origin
server uninstallation space ID. This feature iscurrently only available to the allowlist.
The ID of the secondary origin group. Thisparameter is valid only when OriginType is

BackupOrigin

StringNo

ORIGIN_GROUP. This field indicates the oldversion capability, which cannot be configured
or modified on the control panel after being
called. Please submit a ticket if required.

©2013-2022 Tencent Cloud. All rights reserved.

Page 683 of 760

Tencent Cloud EdgeOne

PrivateAccess

StringNo

Whether access to the private Cloud Object
Storage origin server is allowed. This parameteris valid only when OriginType is COS orAWS_S3. Valid values:
on: Enable private authentication;
off: Disable private authentication.
If it is not specified, the default value is off.

PrivateParameters

Array of
PrivateParameter

No

VodeoSubAppId

IntegerNo

VodeoDistributionRange

StringNo

Private authentication parameter. Thisparameter is valid only when PrivateAccess ison.
VODEO sub-application ID. This parameter isrequired when OriginType is VODEO.
VOD on EO distribution range. This parameteris required when OriginType = VODEO. The
values are:
All: all buckets under the current application;
Bucket: a specified bucket.
VODEO storage bucket ID. This parameter is

VodeoBucketId

StringNorequired when OriginType is VODEO and
VodeoDistributionRange is Bucket.

OriginProtectionInfo
Origin protection configuration
Used by actions: DescribeOriginProtection.
Name

Type

Description

ZoneIdStringID of the site.

Hosts

Array of
StringList of domain names.

ProxyIds

Array of
StringList of proxy IDs.

CurrentIPWhitelist

IPWhitelist

The existing intermediate IPs.
Note: This field may return null , indicating that no valid values can©2013-2022 Tencent Cloud. All rights reserved.

Page 684 of 760

Tencent Cloud EdgeOne

be obtained.

NeedUpdate

BooleanWhether the intermediate IP update is needed for the site. Values:
true : Update needed;
false : Update not needed.
Status of the origin protection configuration. Values:
online : Origin protection is activated;

StatusStringoffline : Origin protection is disabled.
nonactivate : Origin protection is not activated. This value isreturned only when the feature is not activated before it’s used.

PlanSupport

BooleanWhether origin protection is supported in the plan. Values:
true : Origin protection supported;
false : Origin protection not supported.
Differences between the latest and existing intermediate IPs.

DiffIPWhitelist

DiffIPWhitelist

Note: This field may return null , indicating that no valid values canbe obtained.

OriginRecord
Origin group record
Used by actions: CreateOriginGroup, DescribeOriginGroup, ModifyOriginGroup.
Name

Type

Required

Description

RecordStringYes

The origin record value, which can be an IPv4/IPv6
address or a domain name.
The origin type. Values:
IP_DOMAIN : IPv4/IPv6 address or domain

TypeStringNo

name
COS : COS bucket address
AWS_S3 : AWS S3 bucket address

RecordId

StringNo

The origin record ID.
Weight of an origin. Range: 0-100. If it is not specified,a random weight is assigned. If 0 is passed in,

WeightIntegerNo

there is no traffic scheduled to this origin.
Note: This field may return·null, indicating that no valid
values can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 685 of 760

Tencent Cloud EdgeOne

PrivateBooleanNo

Whether to enable private authentication. It is valid
when OriginType=COS/AWS_S3 . Values:
true : Yes.
false : No.
Default: false .

Array of
PrivateParameter

PrivateParameters

No

Private authentication parameters. This field is valid
when Private=true .

OwnershipVerification
Information of domain name ownership verification.
Used by actions: CreateAccelerationDomain, CreateZone, DescribeAccelerationDomains, DescribeZones.
Name

Type

Description
u200cInformation required for authentication using DNS resolution. It's
applicable to sites connected via CNAME. See Ownership Verification.

DnsVerification

DnsVerification
Note: This field may return·null, indicating that no valid values can beobtained.
u200cInformation required for verifying via a file. It's applicable to sites
connected via CNAMEs. See Ownership Verification.

FileVerification

FileVerification
Note: This field may return·null, indicating that no valid values can beobtained.
u200cInformation required for switching DNS servers. It's applicable to

NsVerification

NsVerificationsites connected via NSs. For details, see Modifying DNS Server.
Note: This field may return·null, indicating that no valid values can beobtained.

PartialModule
Module settings of the exception rule
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

ModuleString

No

The module. Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 686 of 760

Tencent Cloud EdgeOne

waf : Managed rules

IncludeArray ofInteger

List of managed rule IDs to be skipped.
Note: This field may return null , indicating that no valid value canNo

be obtained.

PlanInfo
EdgeOne plan information
Used by actions: DescribeAvailablePlans.
Name

Currency

Type

Description

StringSettlement currency. Values:
CNY : Settled by Chinese RMB;USD : Settled by US dollars.

Flux

Integer

Traffic quota of the plan. It includes the traffic for security acceleration, content
acceleration and smart acceleration. Unit: byte.
Settlement cycle. Values:y : Settled by year;

Frequency

Stringm : Settled by month;h : Settled by hour;
M : Settled by minute;s : Settled by second.

PlanType

String

The plan option. Values:sta : Standard plan that supports content delivery network outside the Chinese
mainland.
sta_with_bot : Standard plan that supports content delivery network outside
the Chinese mainland and bot management.
sta_cm : Standard plan that supports content delivery network inside theChinese mainland.
sta_cm_with_bot : Standard plan that supports content delivery network
inside the Chinese mainland and bot management.
sta : Standard plan that supports content delivery network over the globe.
sta_global_with_bot : Standard plan that supports content delivery
network over the globe and bot management.
ent : Enterprise plan that supports content delivery network outside theChinese mainland.
ent_with_bot : Enterprise plan that supports content delivery network
outside the Chinese mainland and bot management.

©2013-2022 Tencent Cloud. All rights reserved.

Page 687 of 760

Tencent Cloud EdgeOne

ent_cm : Enterprise plan that supports content delivery network inside theChinese mainland.
ent_cm_with_bot : Enterprise plan that supports content delivery network
inside the Chinese mainland and bot management.
ent_global : Enterprise plan that supports content delivery network over the
globe.
ent_global_with_bot : Enterprise plan that supports content delivery
network over the globe and bot management.
Price

Float

Plan price (in CNY fen/US cent). The price unit depends on the settlement currency.

RequestInteger

Quota on security acceleration requests

SiteNumber

IntegerNumber of sites to be bound to the planArea

The acceleration region. Values:
mainland : Chinese mainland

Stringoverseas : Global (Chinese mainland not included)
global : Global (Chinese mainland included)

PostMaxSize
Maximum size of the file uploaded for streaming via a POST request
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable POST upload limit (default limit: 32 MB). Valid values:on : Enable;
off : Disable.
Maximum size. Value range: 1-500 MB.

MaxSize

IntegerNo

Note: This field may return null, indicating that no valid values can beobtained.

PrepaidPlanParam
Prepaid Plan Billing Parameters
Used by actions: CreatePlan.
Name

Type

Required

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 688 of 760

Tencent Cloud EdgeOne

Prepaid plan duration, unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9,
PeriodIntegerNo

10, 11, 12, 24, 36.
If this field is not specified, the default value '1' will be used.
The auto-renewal flag for prepaid plan has the following values:

RenewFlag

Stringon: Enable auto-renewal;
off: Disable auto-renewal.

No

If this field is not specified, the default value 'off' will be used. When
auto-renewal is enabled, it defaults to renewing for one month.

PrivateParameter
Private authentication parameters for Cloud Object Storage origin server
Used by actions: CreateAccelerationDomain, CreateOriginGroup, DescribeAccelerationDomains,
DescribeOriginGroup, ModifyAccelerationDomain, ModifyOriginGroup.
Name

Type

Required

Description
The name of the private authentication parameter. Valid values:
AccessKeyId: Access Key ID for authentication;

Name

StringYes

SecretAccessKey: Secret Access Key for authentication;
SignatureVersion: Authentication version, v2 or v4;
Region: The region of the storage bucket.

Value

StringYes

The parameter value.

QueryCondition
The query condition
Used by actions: CreateRealtimeLogDeliveryTask, DescribeOverviewL7Data, DescribeTimingL4Data,
DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeTopL7AnalysisData,
DescribeTopL7CacheData, ModifyRealtimeLogDeliveryTask.
Name

Type

Required

Description

Key

StringYes

The key of QueryCondition.

Operator

StringYes

The conditional operator. Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 689 of 760

Tencent Cloud EdgeOne

equals : Equals
notEquals : Does not equalinclude : Contains
notInclude : Does not containstartWith : Starts with
notStartWith : Does not start withendWith : Ends with
notEndWith : Does not end with
Value

Array of StringYes

The value of QueryCondition.

QueryString
Request parameter contained in CacheKey
Used by actions: DescribeHostsSetting, ModifyZoneSetting.
Name

Type

Required

Description
Whether to use QueryString as part of CacheKey . Values:

SwitchStringYeson : Yes
off : NoSpecifies how to use query strings in the cache key. Values:
includeCustom : Include partial query strings.</li>

ActionStringNo<li> excludeCustom`: Exclude partial query strings.
Note: This field may return null, indicating that no valid values can beobtained.

Value

Array
of

No

StringArray of query strings used/excluded
Note: This field may return null, indicating that no valid values can beobtained.

Quic
QUIC configuration item
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 690 of 760

Tencent Cloud EdgeOne

SwitchStringYes

Whether to enable QUIC. Valid values:on : Enable;
off : Disable.

Quota
Purging/Pre-warming available usage and quota
Used by actions: DescribeContentQuota.
Name

Type

Description

Batch

Integer

Daily

Integer

Daily submission quota limit.

DailyAvailable

Integer

Remaining daily submission quota.
Type of cache purging/pre-warming. Values:
purge_prefix : Purge by prefix
purge_url : Purge by URL

TypeStringpurge_host : Purge by hostname
purge_all : Purge all caches
purge_cache_tag : Purge by cache tag
prefetch_url : Pre-warm by URL

RateLimitConfig
Rate limiting rules
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
Switch. Values:

SwitchStringYeson : Enable
off : Disable
The settings of the custom rate limiting rule. If it

RateLimitUserRules

Array ofRateLimitUserRuleNo

is null, the settings that were last configured will
be used.

RateLimitTemplate

RateLimitTemplateNo

The settings of the rate limiting template. If it is©2013-2022 Tencent Cloud. All rights reserved.

Page 691 of 760

Tencent Cloud EdgeOnenull, the settings that were last configured will
be used.
Note: This field may return null, indicating thatno valid values can be obtained.

RateLimitIntelligence

RateLimitIntelligence

The client filtering settings. If it is null, thesettings that were last configured will be used.

No

Note: This field may return null, indicating thatno valid values can be obtained.
The custom rate limiting rules. If it is null ,RateLimitCustomizes

Array ofRateLimitUserRule

the previous settings is used.
Note: This field may return null , indicatingNothat no valid value can be obtained.

RateLimitIntelligence
Client filtering
Used by actions: ModifySecurityPolicy.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable configuration. Values:on : Enable
off : Disable

ActionStringYes

Action to be executed. Values:
monitor : Observealg : Challenge

RuleIdIntegerNo

The rule ID, which is only used as a response parameter.

RateLimitTemplate
Rate limit template
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

Mode

StringYes

The mode. Values:
sup_loose : Super loose©2013-2022 Tencent Cloud. All rights reserved.

Page 692 of 760

Tencent Cloud EdgeOne

loose : Looseemergency : Emergency
normal : Moderate
strict : Strictclose : Off
The action. Values:alg : JavaScript challenge
ActionStringNomonitor : Observe
If it is left empty, the default value
alg is used.

RateLimitTemplateDetail

RateLimitTemplateDetailNo

The settings of the rate limiting template.
It is only used as an output parameter.

RateLimitTemplateDetail
The settings of the rate limiting template
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

Mode

StringYes

Note: This field may return null, which indicates a failure to obtain avalid value.

ID

IntegerYes

The unique ID.

ActionStringYes

PunishTime

Integer

Yes

Note: This field may return null, which indicates a failure to obtain avalid value.

ThresholdIntegerYes

The request threshold. Value range: 0-4294967294.

PeriodIntegerYes

The statistical period. Value range: 0-120 seconds.

Note: This field may return null, which indicates a failure to obtain avalid value.

RateLimitUserRule
Rate limit rule
Used by actions: ModifySecurityPolicy.

©2013-2022 Tencent Cloud. All rights reserved.

Page 693 of 760

Tencent Cloud EdgeOne

Name

Type

Required

Description

ThresholdIntegerYes

The request threshold. Value range: 0-4294967294.

PeriodIntegerYes

The statistical period. The value can be 10, 20, 30, 40,
50, or 60 seconds.

RuleName

StringYes

The rule name, which consists of only letters, digits, andunderscores and cannot start with an underscore.
Action. Values:
monitor : Observe;

ActionStringYesdrop : Block;redirect : Redirect;
page : Return a specific page;alg : JavaScript challenge.

PunishTime

PunishTimeUnit

IntegerStringYes

Yes

The amount of time taken to perform the action. Value
range: 0 seconds - 2 days.
The time unit. Values:
second : Second
minutes : Minutehour : Hour

RuleStatus

StringYes

The rule status. Values:on : Enabled
off : Disabled
Default value: on

AclConditions

Array of
AclCondition

Yes

The rule details.

RulePriority

IntegerYes

The rule weight. Value range: 0-100.

RuleID

Integer

No

Rule ID, which is only used as an output parameter.
The filter. Values:

FreqFields

Array of
StringNo

sip : Client IP
This parameter is left empty by default.

UpdateTime

StringNo

Update time. It is only used as a response parameter, anddefaults to the current time.

FreqScope

Array of
StringNo

Query scope. Values:©2013-2022 Tencent Cloud. All rights reserved.

Page 694 of 760

Tencent Cloud EdgeOne

source_to_eo : (Response) Traffic going from theorigin to EdgeOne.
client_to_eo : (Request) Traffic going from theclient to EdgeOne.
Default: source_to_eo .
NameStringName of the custom return page. It's required when
Action=page .

No

ID of custom response. The ID can be obtained via the
CustomResponseId

StringDescribeCustomErrorPages API. It's requiredNo

when Action=page .
The response code to trigger the return page. It's required
ResponseCode

IntegerNo

when Action=page . Value: 100-600. 3xx response
codes are not supported. Default value: 567.

RedirectUrl

String

The redirection URL. It's required when

No

Action=redirect .

RealtimeLogDeliveryTask
Real-time log delivery task
Used by actions: DescribeRealtimeLogDeliveryTasks.
Name

Type

Description

TaskIdStringThe ID of the real-time log delivery task.

TaskName

String

The name of the real-time log delivery task.
The status of the real-time log delivery task. Valid values:

DeliveryStatus

Stringenabled: Enabled;
disabled: Disabled;
deleted: Abnormal deletion. Check whether the destination
Tencent Cloud CLS log set/log topic has been deleted.

TaskType

StringEntityList

Array of String©2013-2022 Tencent Cloud. All rights reserved.

The type of the real-time log delivery task. Valid values:
cls: Push to Tencent Cloud CLS;
custom_endpoint: Push to a custom HTTP(S) address;
s3: Push to an AWS S3-compatible bucket address.
The list of entities (Layer 7 domains or Layer 4 proxy instances)

Page 695 of 760

Tencent Cloud EdgeOne

corresponding to the real-time log delivery task. Valid value
examples:Layer 7 domain: domain.example.com;
Layer 4 proxy instance: sid-2s69eb5wcms7.
The data delivery type. Valid values:

LogType

Stringdomain: Site acceleration log;
application: Layer 4 proxy log;
web-rateLiming: Rate limit and CC attack defense log;
web-attack: Managed rule log;
web-rule: Custom rule log;
web-bot: Bot management log.
The data delivery area. Valid values:

Area

StringFieldsArray of String

CustomFields

DeliveryConditions

SampleArray ofCustomField
Array of
DeliveryCondition
Integermainland: Within the Chinese mainland;
overseas: Global (excluding the Chinese mainland).
The list of predefined fields for delivery.
The list of custom fields for delivery.

Log delivery filter conditions.
The sampling ratio in permille. Value range: 1 to 1000. For example,
605 represents a sampling ratio of 60.5%.
Output format for log delivery. When the output parameter is null,
the default format is used, which works as follows:
When TaskType is 'custom_endpoint', the default format is anarray of JSON objects, with each JSON object representing a log

LogFormat

LogFormat

entry;
When TaskType is 's3', the default format is JSON Lines.
Note: This field may return 'null', which indicates a failure to obtain avalid value.

CLS

CLSTopic

CustomEndpoint

CustomEndpoint

S3

S3©2013-2022 Tencent Cloud. All rights reserved.

Note: This field may return null, indicating that no valid values canbe obtained.
Note: This field may return null, indicating that no valid values canbe obtained.
Note: This field may return null, indicating that no valid values canbe obtained.

Page 696 of 760

Tencent Cloud EdgeOne

CreateTime

Timestamp
ISO8601

The creation time.

Timestamp

UpdateTime

The update time.

ISO8601

RenewFlag
Auto-renewal configuration item in a prepaid plan.
Used by actions: ModifyPlan.
Name

Type

Required

Description

SwitchStringYes

The auto-renewal flag for prepaid plan has the following values:
on: Enable auto-renewal;
off: Disable auto-renewal.

Resource
Billable resource
Used by actions: DescribeZones.
Name

Type

Description

Id

String

The resource ID.

PayModeInteger

Billing mode
0 : Pay-as-you-go

CreateTime

Timestamp
ISO8601

The creation time.

EnableTime

Timestamp
ISO8601

The effective time.

ExpireTime
StatusTimestamp
ISO8601
String

The expiration time.
The plan status. Values:
normal : Normal
isolated : Isolated©2013-2022 Tencent Cloud. All rights reserved.

Page 697 of 760

Tencent Cloud EdgeOne

destroyed : Terminated
Sv

AutoRenewFlag

Array of Sv

Integer

Pricing query parameter
Whether to enable auto-renewal. Values:
0 : Default status.
1 : Enable auto-renewal.
2 : Disable auto-renewal.

PlanIdArea

StringStringID of the resource associated with the plan.
Applicable area. Values:
mainland : Chinese mainland
overseas : Regions outside the Chinese mainland
global : Global
The resource type. Values:
plan : Plan resources
pay-as-you-go : Pay-as-you-go resourcesGroup

Stringvalue-added : Value-added resources
Note: This field may return null, indicating that no valid values can beobtained.
The sites that are associated with the current resources.

ZoneNumber

IntegerType

StringNote: This field may return null, indicating that no valid values can beobtained.
Resource tag type. Valid values:
vodeo: vodeo resource.

RewriteAction
Rule engine action for the HTTP request/response header
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

ActionStringYes

Feature name. For details, see
DescribeRulesSetting API

Parameters

Array of
RuleRewriteActionParams

Yes

Parameter©2013-2022 Tencent Cloud. All rights reserved.

Page 698 of 760

Tencent Cloud EdgeOne

Rule
Rule item of the rule engine. The items in the Conditions array are in OR relationship, and the items in the
inner Conditions list are in AND relationship.
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

Conditions

Array of
RuleAndConditions

Yes

Feature execution conditions.
Note: If any condition in the array is met, the feature
will run.

Actions

Array of Action

No

SubRulesArray of SubRuleItem

No

Feature to be executed.
Note: Actions and SubRules cannot both be empty.
The nested rule.
Note: Actions and SubRules cannot both be empty.

RuleAndConditions
List of rule engine conditions in AND relationship
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

Conditions

Array of
RuleCondition

Yes

Rule engine condition. This condition will be considered met if
all items in the array are met.

RuleChoicePropertiesItem
Detailed settings of the rule engine that can be used for request match, which are optional parameter configuration
items.
Used by actions: DescribeRulesSetting.
Name

Type

Description

Name

String

The parameter name.

Type

String

The parameter value type.

©2013-2022 Tencent Cloud. All rights reserved.

Page 699 of 760

Tencent Cloud EdgeOne

CHOICE: The parameter value can be selected only from
Values .
TOGGLE: The parameter value is of switch type and can beselected from ChoicesValue .
CUSTOM_NUM: The parameter value is a custom integer.
CUSTOM_STRING: The parameter value is a custom string.

ChoicesValue

Valid parameter values.
Note: If Type is CUSTOM_NUM or CUSTOM_STRING , thisArray of String

parameter will be an empty array.
Minimum value. If both Min and Max are set to 0 , thisMin

IntegerMax

Integer

IsMultiple

BooleanWhether multiple values can be selected or entered.

IsAllowEmpty

BooleanWhether the parameter can be left empty.

parameter does not take effect.
Maximum value. If both Min and Max are set to 0 , thisparameter does not take effect.

Special parameter.
NULL: Select NormalAction for RuleAction .
ExtraParameter

RuleExtraParameter

If the member parameter Id is Action , selectRewirteAction for RuleAction .
If the member parameter Id is StatusCode , select
CodeAction for RuleAction .

RuleCodeActionParams
Parameters of the action with the StatusCode field as the rule engine condition
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

StatusCode

IntegerYes

The status code.

Name

StringYes

The parameter name. For details, see DescribeRulesSetting.

ValuesArray of StringYes

The parameter value.

RuleCondition©2013-2022 Tencent Cloud. All rights reserved.

Page 700 of 760

Tencent Cloud EdgeOne

Rule engine condition parameters
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description
Operator. Valid values:
equals : Equals

Operator

StringnotEquals : Does not equalYesexist : Exists
notexist : Does not exist
Match type. Valid values:
filename: File name;extension: File extension;
host: Host name;

TargetStringYesfull_url: The complete URL path under the current site, which must
include the HTTP protocol, host, and path;
url: Request for the URL path under the current site;client_country: Client country/region;
query_string: The query string of the URL requested under thecurrent site;
request_header: HTTP request header;client_ip: Client IP address.

ValuesArray of
String

No

The parameter values for match types. It is allowed to pass an empty
array only when the match type is query_string or request_header andthe operator value is Exist or Does Not Exist. The corresponding
match types include:
File extension: Extensions like jpg, txt, etc.;
File name: For example, foo in foo.jpg;
All: All requests for domain names under the site;
HOST: The host under the current site, for example,
www.maxx55.com;
URL Path: Request for the URL path under the current site, forexample, /example;
URL Full: The complete URL request under the current site, whichmust include the HTTP protocol, host, and path, for example,
https://www.maxx55.cn/example;
Client country/region: Country/region codes compliant with the
ISO3166 standard;
Query string: The parameter values in the query string of the URL
requested under the current site, for example, cn and 1 inlang=cn&version=1;
HTTP request header: The value of the HTTP request header field,
for example, zh-CN,zh;q=0.9 in Accept-Language:zh-CN,zh;q=0.9;©2013-2022 Tencent Cloud. All rights reserved.

Page 701 of 760

Tencent Cloud EdgeOne

Client IP: The client IP address carried by the current request,
supporting IPv4, IPv6, and an IP range.
IgnoreCase

BooleanNo

Whether the parameter value is case insensitive. Default value: false.
The parameter name of the match type. This field is required only
when Target=query_string/request_header .

NameStringquery_string : Name of the query string, such as "lang" andNo"version" in "lang=cn&version=1".
request_header : Name of the HTTP request header, such as"Accept-Language" in the "Accept-Language:zh-CN,zh;q=0.9" header.

RuleExtraParameter
Rule engine parameter details and special parameter types.
Used by actions: DescribeRulesSetting.
Name

Type

Description
Parameter name. Valid values:
Action : Required parameter for HTTP header modification when

Id

StringRewirteAction is selected for RuleAction .
StatusCode : Required parameter for the status code feature when
CodeAction is selected for RuleAction .

Type

StringParameter value type.
CHOICE : The parameter value can be selected only from Values .
CUSTOM_NUM : The parameter value is a custom integer.
CUSTOM_STRING : The parameter value is a custom string.

ChoicesArrayofStringValid values.
Note: If the value of Id is StatusCode , values in the array are all integer values.
When entering a parameter value, enter the integer value of the string.

RuleItem
Rule details of the rule engine
Used by actions: DescribeRules.
Name

Type

Description©2013-2022 Tencent Cloud. All rights reserved.

Page 702 of 760

Tencent Cloud EdgeOne

RuleIdString

The rule ID.

RuleName

String

The rule name. It is a string that can contain 1–255 characters.

StringRule status. Values:
enable : Enabled

Statusdisable : Disabled
Rules

Array of
Rule

RulePriority

Integer

Tags

Array of
String

The rule content.
The rule priority. The greater the value, the higher the priority. The minimum
value is 1 .
Tag of the rule.

RuleNormalActionParams
Common action parameter of a rule engine condition
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

Name

StringYes

The parameter name. For details, see DescribeRulesSetting.

ValuesArray of StringYes

The parameter value.

RuleRewriteActionParams
Parameter of the action for the HTTP request/response header of a rule engine condition.
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

ActionType

StringRequiredYes

Description
Feature parameter name. For details, see DescribeRulesSetting.
add : Add the HTTP header.
set : Rewrite the HTTP header.
del : Delete the HTTP header.

Name

StringYes©2013-2022 Tencent Cloud. All rights reserved.

Parameter name

Page 703 of 760

Tencent Cloud EdgeOne

ValuesArray of String

Yes

Parameter value

RulesProperties
Detailed settings of the rule engine that can be used for request match.
Used by actions: DescribeRulesSetting.
Name

Type

Description

Name

StringParameter name.

Min

Integer

ChoicesValue

Array of String

Minimum value. If both Min and Max are set to 0 ,this parameter does not take effect.
Valid parameter values.
Note: If Type is CUSTOM_NUM or
CUSTOM_STRING , this parameter will be an empty array.
The parameter value type.
CHOICE : If Type=CHOICE , choose a value in
ChoiceValue .
TOGGLE : If Type=TOGGLE , choose on or off

TypeStringfrom ChoicesValue .
OBJECT : Specify an object. If this is specified,
ChoiceProperties includes attributes of the specified
object. See Example 2. Create a rule with Type=OBJECTCUSTOM_NUM : (Integer) Custom value.
CUSTOM_STRING : (String) Custom value.
Maximum value. If both Min and Max are set to 0 ,MaxInteger

IsMultiple

BooleanWhether multiple values can be selected or entered.

IsAllowEmpty

BooleanWhether the parameter can be left empty.

this parameter does not take effect.

Associated configuration parameters of this parameter,
ChoiceProperties

Array of
RuleChoicePropertiesItem

ExtraParameter

RuleExtraParameter

which are required for API call.
Note: This parameter will be an empty array if no special
parameters are added as optional parameters.
NULL: No special parameters when NormalAction
is selected for RuleAction .

©2013-2022 Tencent Cloud. All rights reserved.

Page 704 of 760

Tencent Cloud EdgeOne

Note: This field may return null, indicating that no valid
values can be obtained.

RulesSettingAction
List of the settings of the rule engine that can be used for request match and their detailed information.
Used by actions: DescribeRulesSetting.
Name

Type

Description
Feature name. Valid values:
Access URL rewrite ( AccessUrlRedirect ).
Origin-pull URL rewrite ( UpstreamUrlRedirect ).
Custom error page
( ErrorPage ).
QUIC ( QUIC ).
WebSocket ( WebSocket ).
Video dragging ( VideoSeek ).
Token authentication ( Authentication ).
CacheKey : Custom cache key.
Cache : Node cache TTL.
MaxAge : Browser cache TTL.
OfflineCache : Offline cache.

ActionStringSmartRouting : Smart acceleration.
RangeOriginPull : Range GETs.
UpstreamHttp2 : HTTP/2 forwarding.
HostHeader : Host header rewrite.
ForceRedirect : Force HTTPS.
OriginPullProtocol : Origin-pull HTTPS.
CachePrefresh : Cache prefresh.
Compression : Smart compression.
RequestHeader : HTTP request header modification.
HTTP response header modification ( ResponseHeader ).
Status code cache TTL ( StatusCodeCache ).
Hsts .
ClientIpHeader .
TlsVersion .
OcspStapling .

Properties

Array of RulesProperties©2013-2022 Tencent Cloud. All rights reserved.

Parameter information

Page 705 of 760

Tencent Cloud EdgeOne

S3
The configuration information of real-time log delivery to an AWS S3 compatible bucket
Used by actions: CreateRealtimeLogDeliveryTask, DescribeRealtimeLogDeliveryTasks,
ModifyRealtimeLogDeliveryTask.
Name

Endpoint

Type

StringRequiredYes

Description
The URL without bucket name or path, for example:
https://storage.googleapis.com , https://s3.apnortheast-2.amazonaws.com , and https://cos.apnanjing.myqcloud.com .

RegionBucketStringStringYes

Yes

The region where the bucket is located, for example: apnortheast-2 .
The bucket name and log storage directory, for example:
your_bucket_name/EO-logs/ . If the directory does not exist
in the bucket, it will be created automatically.

AccessId

StringYes

The Access Key ID used to access the bucket.

AccessKey

StringYes

The secret key used to access the bucket.
The data compress type. Valid values:

CompressType

StringNo

gzip: gzip compression.
If this field is not filled in, compression is disabled.

SecEntry
Returned value of security data entry
Used by actions: DescribeDDoSAttackData.
Name

Type

Description

Key

String

The query dimension value.

Value

Array of SecEntryValue

The details.

SecEntryValue©2013-2022 Tencent Cloud. All rights reserved.

Page 706 of 760

Tencent Cloud EdgeOne

The security data queried by metric
Used by actions: DescribeDDoSAttackData.
Name

Type

Description

MetricString

The metric name.

DetailArray of TimingDataItem

The time-series data details.

Max

Integer

The maximum value.

Avg

Float

The average value.

Sum

Float

Sum

SecurityConfig
Security configuration
Used by actions: ModifySecurityPolicy.
Name

WafConfig

Type

WafConfig

RequiredNo

Description
Managed rule. If the parameter is null or not filled, theconfiguration last set will be used by default.
Note: This field may return null, indicating that no valid
value can be obtained.
Rate limiting. If the parameter is null or not filled, the

RateLimitConfig

RateLimitConfig

Noconfiguration last set will be used by default.
Note: This field may return null, indicating that no valid
value can be obtained.
Custom rule. If the parameter is null or not filled, the

AclConfig

AclConfig

Noconfiguration last set will be used by default.
Note: This field may return null, indicating that no valid
value can be obtained.
Bot configuration. If the parameter is null or not filled, the

BotConfig

BotConfig

No

SwitchConfig

SwitchConfig

Noconfiguration last set will be used by default.
Note: This field may return null, indicating that no valid
value can be obtained.
Switch setting of the 7-layer protection. If the parameteris null or not filled, the configuration last set will be used©2013-2022 Tencent Cloud. All rights reserved.

Page 707 of 760

Tencent Cloud EdgeOne

by default.Note: This field may return null, indicating thatno valid value can be obtained.

IpTableConfig

IpTableConfig

No

Basic access control. If the parameter is null or not filled,
the configuration last set will be used by default.
Note: This field may return null, indicating that no valid
value can be obtained.

ExceptConfig

ExceptConfig

No

Exception rule configuration. If the parameter is null or
not filled, the configuration last set will be used bydefault.Note: This field may return null, indicating that novalid value can be obtained.

DropPageConfig

DropPageConfig

No

Custom block page settings. If the parameter is null or
not filled, the configuration last set will be used bydefault.Note: This field may return null, indicating that novalid value can be obtained.

TemplateConfig

TemplateConfig

No

Security template settings
Note: This field may return null , indicating that novalid value can be obtained.

SlowPostConfig

SlowPostConfig

No

Settings for slow attack defense. If the parameter is nullor not filled, the configuration last set will be used bydefault.Note: This field may return null, indicating that novalid value can be obtained.

SecurityTemplateBinding
Bindings of a security policy template
Used by actions: DescribeSecurityTemplateBindings.
Name

Type

Description

TemplateId

Stringtemplate ID

TemplateScope

Array of TemplateScope

Binding status of the template.

SecurityType
The security type setting item.

©2013-2022 Tencent Cloud. All rights reserved.

Page 708 of 760

Tencent Cloud EdgeOne

Used by actions: DescribeHostsSetting.
Name

Type

Required

Description
Whether to enable the security type setting. Values:

SwitchStringon : EnableYes

off : Disable

ServerCertInfo
HTTPS server certificate configuration
Used by actions: DescribeHostsSetting, ModifyHostsCertificate, ModifyZoneSetting.
Name

CertIdType

StringRequired

Description

Yes

ID of the server certificate.
Note: This field may return null, indicating that no valid
values can be obtained.

Alias

StringNo

Alias of the certificate.
Note: This field may return null, indicating that no valid
values can be obtained.
Type of the certificate. Values:
u200c
default : Default certificate

Type

StringNo

u200c
upload : Custom certificate
u200c
managed : Tencent Cloud-managed certificate
Note: This field may return·null, indicating that no valid
values can be obtained.

ExpireTime

DeployTime

Timestamp
ISO8601

Timestamp
ISO8601

NoTime when the certificate expires.
Note: This field may return null, indicating that no valid
values can be obtained.

No©2013-2022 Tencent Cloud. All rights reserved.

Time when the certificate is deployed.
Note: This field may return null, indicating that no valid
values can be obtained.

Page 709 of 760

Tencent Cloud EdgeOne

SignAlgo

StringNo

Signature algorithm.
Note: This field may return null, indicating that no valid
values can be obtained.

CommonName

String

No

Domain name of the certificate.
Note: This field may return null , indicating that no valid
value can be obtained.

SkipCondition
Exception rule conditions, used to filter requests by specific fields
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
The field type. Values:
header_fields : HTTP request header
cookie : HTTP request cookie

Type

StringYes

query_string : Query string in the HTTP request URL
uri : HTTP request URI
body_raw : HTTP request bodybody_json : JSON HTTP request body
The specific field. Values:
args : Query parameter in the URI, such as "?
name1=jack&age=12"
path : Partial path in the URI, such as"/path/to/resource.jpg"

Selector

StringYesfull : Full path in the URI, such as"example.com/path/to/resource.jpg?name1=jack&age=12"
upload_filename : File path segment
keys : All keys
values : Values of all keys
key_value : Key and its value

MatchFromType

String

No

The match method used to match the key. Values:
equal : Exact match
wildcard : Wildcard match (only asterisks)

MatchFrom

Array of
StringNo©2013-2022 Tencent Cloud. All rights reserved.

The value that matches the key.
Note: This field may return null , indicating that no valid
value can be obtained.

Page 710 of 760

Tencent Cloud EdgeOne

MatchContentType

String

No

The match method used to match the content.
equal : Exact match
wildcard : Wildcard match (only asterisks)

MatchContent

Array of
String

The value that matches the content.
Note: This field may return null , indicating that no valid

No

value can be obtained.

SlowPostConfig
Slow attack defense configuration.
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description
Values:SwitchStringYeson : Enable
off : Disable
Detect slow attacks by the transfer period of the first 8 KBFirstPartConfig

FirstPartConfigNoof requests
Note: This field may return null , indicating that novalid value can be obtained.

SlowRateConfig

SlowRateConfig

No

Detect slow attacks by the data rate of the main body(excluding the first 8 KB) of requests
Note: This field may return null , indicating that novalid value can be obtained.
The action to taken when a slow attack is detected.
Values:monitor : Observe

ActionStringNodrop : Block the request
Note: This field may return null , indicating that novalid value can be obtained.

RuleIdIntegerNo

ID of the rule
Note: This field may return null , indicating that novalid value can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 711 of 760

Tencent Cloud EdgeOne

SlowRateConfig
The configuration to detect slow attacks
Used by actions: ModifySecurityPolicy.
Name

SwitchType

StringRequired

Description

Yes

Switch. Values:on : Enable
off : Disable
The sampling interval in seconds. In this way, the first 8 KB of the request
is ignored. The rest of data is separated in to multiple parts according toInterval

IntegerNo

this interval for slow attack measurement.
Note: This field may return null , indicating that no valid value can beobtained.
The transfer rate threshold in bps. When the transfer rate of a sample isThresholdIntegerlower than the threshold, it’s considered a slow attack and handledaccording to the specified Action .

No

Note: This field may return null , indicating that no valid value can beobtained.

SmartRouting
Smart acceleration configuration
Used by actions: DescribeHostsSetting, DescribeZoneSetting, ModifyZoneSetting.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable smart acceleration. Values:on : Enable
off : Disable

StandardDebug
Standard debugging
Used by actions: DescribeZoneSetting, ModifyZoneSetting.

©2013-2022 Tencent Cloud. All rights reserved.

Page 712 of 760

Tencent Cloud EdgeOne

Name

Type

Required

Description
Whether to enable standard debugging. Values:

SwitchStringon : EnableYes

off : Disable
Array of

AllowClientIPList

StringTimestamp
ISO8601

ExpireTime

The client IP to allow. It can be an IPv4/IPv6 address or a

Yes

CIDR block. If not specified, it means to allow any client IP
The time when the standard debugging setting expires. If it isexceeded, this feature becomes invalid.

Yes

SubRuleNested rule settings
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

Conditions

Array of
RuleAndConditions

Yes

The condition that determines if a feature should run.
Note: If any condition in the array is met, the feature
will run.

Actions

Array of Action

Yes

The feature to be executed.

SubRuleItem
Rule engine nested rule
Used by actions: CreateRule, DescribeRules, ModifyRule.
Name

Type

Required

Description

Rules

Array of SubRule

Yes

Nested rule settings

Tags

Array of StringNo

Tag of the rule.

Sv
Pricing query parameter©2013-2022 Tencent Cloud. All rights reserved.

Page 713 of 760

Tencent Cloud EdgeOne

Used by actions: DescribeZones.
Name

Type

Required

Description

Key

StringYes

The parameter key.

Value

StringYes

The parameter value.
Quota for a resource. Values:
zone : Quota for sites
custom-rule : Quota for custom rules

Pack

StringNo

rate-limiting-rule : Quota for rate limiting rules
l4-proxy-instance : Quota for L4 proxy instances
Note: This field may return null, indicating that no valid values canbe obtained.

InstanceId

StringNo

ID of the L4 proxy instance.
Note: This field may return null, indicating that no valid values canbe obtained.

ProtectionSpecs

String

No

The protection specification.
Values:cm_30G : 30 Gbps base protection bandwidth in Chinese
mainland service area
cm_60G : 60 Gbps base protection bandwidth in Chinese
mainland service area
cm_100G : 100 Gbps base protection bandwidth in Chinese
mainland service area
anycast_300G : 300 Gbps Anycast-based protection in
Global (MLC) service area
anycast_unlimited : Unlimited Anycast-based protection
bandwidth in Global (MLC) service area
cm_30G_anycast_300G : 30 Gbps base protection
bandwidth in Chinese mainland service area and 300 Gbps
Anycast-based protection bandwidth in Global (MLC) service area
cm_30G_anycast_unlimited : 30 Gbps base protection
bandwidth in Chinese mainland service area and unlimited
Anycast-based protection bandwidth in Global (MLC) service area
cm_60G_anycast_300G : 60 Gbps base protection
bandwidth in **Chinese mainland** service areaand 300 Gbps Anycast-based protection bandwidthin **Global (MLC)** service area</li><li>
cm_60G_anycast_unlimited : 60 Gbps base protection©2013-2022 Tencent Cloud. All rights reserved.

Page 714 of 760

Tencent Cloud EdgeOne

bandwidth in Chinese mainland service area and unlimited
Anycast-based protection bandwidth in Global (MLC) service area
cm_100G_anycast_300G : 100 Gbps base protection
bandwidth in Chinese mainland service area and 300 Gbps
Anycast-based protection bandwidth in Global (MLC) service area
cm_100G_anycast_unlimited`: 100 Gbps base protection
bandwidth in Chinese mainland service area and unlimited
Anycast-based protection bandwidth in Global (MLC) service area
Note: This field may return null, indicating that no valid values canbe obtained.

SwitchConfig
Web security configuration switch
Used by actions: ModifySecurityPolicy.
Name

Type

WebSwitch

StringRequired

Description
Whether to enable web protection. Values:on : EnableYes

off : Disable
It does not affect DDoS and bot configuration.

Tag
Tag configuration
Used by actions: CreateZone, DescribeZones.
Name

TagKeyType

StringRequired

Description

Yes

The tag key.
Note: This field may return null, indicating that no valid values can beobtained.
The tag value.

TagValue

StringYes

Note: This field may return null, indicating that no valid values can beobtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 715 of 760

Tencent Cloud EdgeOne

Task
Content management task result
Used by actions: DescribePrefetchTasks, DescribePurgeTasks.
Name

Type

Description

JobId

StringID of the task.

TargetStringResource.

Type

StringType of the task.
Node cache purge method, with values:
invalidate: Marks as expired. A back-to-origin validation is triggered upon

MethodStringuser request, sending an HTTP conditional request with If-None-Match and IfModified-Since headers. If the origin server responds with 200, the node will
fetch new resources from the origin and update the cache; if the origin server
responds with 304, the cache will not be updated;
delete: Directly deletes the node's cache, triggering a resource fetch from theorigin upon user request.
Note: This field may return null, which indicates a failure to obtain a valid value.
Status. Valid values:

StatusStringprocessing: Processing;
success: Succeeded;failed: Failed;timeout: Timed out.

CreateTime

Timestamp
ISO8601

Creation time of the task.

UpdateTime

Timestamp
ISO8601

Completion time of the task.

TemplateConfig
Security template settings
Used by actions: ModifySecurityPolicy.
Name

Type

©2013-2022 Tencent Cloud. All rights reserved.

Required

Description

Page 716 of 760

Tencent Cloud EdgeOne

TemplateId

StringYes

The template ID.

TemplateName

StringYes

The template name.

TemplateScope
Domain names bound with the template.
Used by actions: DescribeSecurityTemplateBindings.
Name

ZoneIdType

StringRequired

Description

No

ID of the site.
Note: This field may return·null, indicating that no valid values
can be obtained.

EntityStatus

Array ofEntityStatus

No

List of instance statuses
Note: This field may return·null, indicating that no valid values
can be obtained.

TimingDataItem
Data items of the statistical curve
Used by actions: DescribeDDoSAttackData, DescribeOverviewL7Data, DescribeTimingL4Data,
DescribeTimingL7AnalysisData, DescribeTimingL7CacheData.
Name

Type

Description

Timestamp

Integer

The query time recorded in seconds using UNIX timestamp.

Value

Integer

The value.

TimingDataRecord
The time-series data
Used by actions: DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData,
DescribeTimingL7CacheData.
Name

Type

©2013-2022 Tencent Cloud. All rights reserved.

Description

Page 717 of 760

Tencent Cloud EdgeOne

TypeKey

String

The query dimension value.

TypeValue

Array of TimingTypeValue

Detailed time series data

TimingTypeValue
Detailed data of time series type
Used by actions: DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData,
DescribeTimingL7CacheData.
Name

Type

Description

Sum

IntegerSum.

Max

Integer

The maximum value.

Avg

Integer

The average value.

MetricName

StringMetric name.

Array of

Details.
Note: This field may return null, indicating that no valid values can be

DetailTimingDataItem

obtained.

TopDataRecord
The top-ranked data record
Used by actions: DescribeTopL7AnalysisData, DescribeTopL7CacheData.
Name

Type

Description

TypeKey

String

The query dimension value.

DetailData

Array of TopDetailData

Top data rankings

TopDetailData
The top-ranked data details©2013-2022 Tencent Cloud. All rights reserved.

Page 718 of 760

Tencent Cloud EdgeOne

Used by actions: DescribeTopL7AnalysisData, DescribeTopL7CacheData.
Name

Type

Description

Key

String

The field name.

Value

Integer

The field value.

TopEntry
The Top-ranked data
Used by actions: DescribeDDoSAttackTopData.
Name

Type

Description

Key

String

The query dimension value.

Value

Array of TopEntryValue

The details.

TopEntryValue
The top-ranked data
Used by actions: DescribeDDoSAttackTopData.
Name

Type

Description

Name

String

The item name.

Count

Integer

The number of items.

UpstreamHttp2
HTTP2 origin-pull configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

Type

Required

Description

SwitchStringYes

Whether to enable HTTP2 origin-pull. Valid values:©2013-2022 Tencent Cloud. All rights reserved.

Page 719 of 760

Tencent Cloud EdgeOne

on : Enable;
off : Disable.

VanityNameServers
Custom name servers
Used by actions: DescribeZones, ModifyZone.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable custom name servers. Values:on : Enable
off : Disable

Servers

Array of String

No

List of custom name servers

VanityNameServersIps
IP information of the custom name server
Used by actions: DescribeZones.
Name

Type

Description

Name

StringCustom name of the name server

IPv4String

IPv4 address of the custom name server

Waf
N/A
Used by actions: DescribeHostsSetting.
Name

Type

Required

Description
Whether to enable WAF. Values:

SwitchStringYeson : Enable
off : Disable©2013-2022 Tencent Cloud. All rights reserved.

Page 720 of 760

Tencent Cloud EdgeOne

PolicyId

IntegerNo

ID of the policy

WafConfig
WAF configuration.
Used by actions: ModifySecurityPolicy.
Name

SwitchType

StringRequiredYes

Description
Whether to enable WAF configuration. Values:on : Enable
off : Disable
The configuration can be modified even when it is disabled.
The protection level. Values:
loose : Loose

Level

Stringnormal : Moderate

Yesstrict : Strict
stricter : Super strict
custom : Custom

Mode

StringYes

The WAF global mode. Values:
block : Block globallyobserve : Observe globally

WafRuleWafRuleNo

AiRuleAiRuleNo

The settings of the managed rule. If it is null, the settings that were lastconfigured will be used.
The setting of the AI rule engine. If it is null, the setting that was lastconfigured will be used.

WafRuleWAF rule
Used by actions: ModifySecurityPolicy.
Name

Type

Required

Description

SwitchStringYes

Whether to enable managed rules. Values:on : Enable
off : Disable©2013-2022 Tencent Cloud. All rights reserved.

Page 721 of 760

Tencent Cloud EdgeOne

BlockRuleIDs

Array of IntegerYes

IDs of the rules to be disabled.

ObserveRuleIDs

Array of IntegerYes

IDs of the rules to be executed in Observe mode.

WebSocket
WebSocket configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name

SwitchType

StringRequired

Description

Yes

Whether to enable WebSocket connection timeout. Values:on : The field "Timeout" can be configured.
off : The field "Timeout" is fixed to 15 seconds.

Timeout

IntegerNo

The timeout period in seconds. Maximum value: 120.

Zone
Site information
Used by actions: DescribeZones.
Name

Type

Description

ZoneIdStringSite ID.

ZoneName

String

The site name.

OriginalNameServers

Array of String

List of name servers used by the site

NameServers

Array of String

The list of name servers assigned by Tencent Cloud.

StatusString

The site status. Values:
u200c
active : The name server is switched to EdgeOne.
u200c
pending : The name server is not switched.
u200c©2013-2022 Tencent Cloud. All rights reserved.

Page 722 of 760

Tencent Cloud EdgeOne

moved : The name server is changed to otherservice providers.
u200c
deactivated : The site is blocked.
initializing : The site is not bound with any
plan.

Type

StringSite connection method, valid values:
full: Connect via NS;
partial: Connect via CNAME;
noDomainAccess: Connect without using a domain
name;vodeo: Connect by default when VODEO is enabled.

PausedBooleanWhether the site is disabled.
Whether CNAME acceleration is enabled. Values:

CnameSpeedUp

Stringenabled : Enableddisabled : Disabled

CnameStatus

String

CNAME record access status. Values:
finished : The site is verified.
pending : The site is being verified.

Tags

Array of Tag

The list of resource tags.

Resources

Array of Resource

The list of billable resources.

CreatedOn

Timestamp ISO8601

The creation time of the site.

ModifiedOnTimestamp ISO8601

The modification date of the site.
The site access region. Values:

Area

Stringglobal : Global.
mainland : Chinese mainland.
overseas : Outside the Chinese mainland.
The custom name server information.

VanityNameServers

VanityNameServers

VanityNameServersIps

Array of
VanityNameServersIps

ActiveStatus

String©2013-2022 Tencent Cloud. All rights reserved.

Note: This field may return null, indicating that no valid
values can be obtained.
The custom name server IP information.
Note: This field may return null, indicating that no valid
values can be obtained.
Status of the proxy. Values:

Page 723 of 760

Tencent Cloud EdgeOne

active : Enabled
inactive : Not activatedpaused : Disabled

AliasZoneName

IsFakeThe site alias. It can be up to 20 characters consisting ofdigits, letters, hyphens (-) and underscores (_).

StringNote: This field may return null, indicating that no valid
values can be obtained.
Whether it’s a fake site. Valid values:
0 : Non-fake site;

Integer

1 : Fake site.
Lock status. Values:
enable : Normal. Modification is allowed.
LockStatus

Stringdisable : Locked. Modification is not allowed.
plan_migrate : Adjusting the plan. Modification is
not allowed.
Ownership verification information

OwnershipVerification

OwnershipVerification

Note: This field may return·null, indicating that no valid
values can be obtained.

ZoneSetting
The site configuration.
Used by actions: DescribeZoneSetting.
Name

Type

Description

ZoneName

StringName of the site
Site acceleration region. Values:

Area

Stringmainland : Acceleration in the Chinese mainland.
overseas : Acceleration outside the Chinese mainland.
Node cache key configuration

CacheKey

Quic

CacheKey

Quic

Note: This field may return null, indicating that no valid values
can be obtained.
The QUIC access configuration.
Note: This field may return null, indicating that no valid values
can be obtained.

©2013-2022 Tencent Cloud. All rights reserved.

Page 724 of 760

Tencent Cloud EdgeOne

PostMaxSize

PostMaxSize

The POST transport configuration.
Note: This field may return null, indicating that no valid values
can be obtained.
Smart compression configuration.

Compression

UpstreamHttp2

Compression

UpstreamHttp2

Note: This field may return null, indicating that no valid values
can be obtained.
HTTP2 origin-pull configuration
Note: This field may return null, indicating that no valid values
can be obtained.

ForceRedirect

ForceRedirect

Force HTTPS redirect configuration
Note: This field may return null, indicating that no valid values
can be obtained.
Cache expiration time configuration

CacheConfig

OriginCacheConfig

OriginNote: This field may return null, indicating that no valid values
can be obtained.
Origin server configuration.
Note: This field may return null, indicating that no valid values
can be obtained.

SmartRouting

SmartRouting

Smart acceleration configuration
Note: This field may return null, indicating that no valid values
can be obtained.
Browser cache configuration

MaxAgeOfflineCache

MaxAgeOfflineCache

Note: This field may return null, indicating that no valid values
can be obtained.
The offline cache configuration.
Note: This field may return null, indicating that no valid values
can be obtained.

WebSocket

WebSocket

WebSocket configuration.
Note: This field may return null, indicating that no valid values
can be obtained.
Origin-pull client IP header configuration

ClientIpHeader

ClientIpHeader

Note: This field may return null, indicating that no valid values
can be obtained.
Cache prefresh configuration

CachePrefresh

CachePrefresh©2013-2022 Tencent Cloud. All rights reserved.

Note: This field may return null, indicating that no valid values
can be obtained.

Page 725 of 760

Tencent Cloud EdgeOne

Ipv6

Ipv6

IPv6 access configuration
Note: This field may return null, indicating that no valid values
can be obtained.

Https

Https

HTTPS acceleration configuration
Note: This field may return null, indicating that no valid values
can be obtained.

ClientIpCountry

ClientIpCountry

Whether to carry the location information of the client IP during
origin-pull.
Note: This field may return null , indicating that no valid
value can be obtained.

Grpc

Grpc

Configuration of gRPC support
Note: This field may return null , indicating that no valid
value can be obtained.

ImageOptimize

ImageOptimize

Image optimization configuration.
Note: This field may return null , indicating that no valid
value was found.

AccelerateMainland

AccelerateMainland

Cross-MLC-border acceleration.
Note: This field may return null , indicating that no valid
values can be obtained.

StandardDebug

StandardDebug©2013-2022 Tencent Cloud. All rights reserved.

Standard debugging configuration.
Note: This field may return null, indicating that no valid values
can be obtained.

Page 726 of 760

Tencent Cloud EdgeOne

Error Codes：

Last updated 2024-06-13 17:03:15

Feature Description
If there is an Error field in the response, it means that the API call failed. For example:{"Response": {"Error": {"Code": "AuthFailure.SignatureFailure","Message": "The provided credentials could not be validated. Please check your si
gnature is correct."},"RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"}}
Code in Error indicates the error code, and Message indicates the specific information of the error.

Error Code List
Common Error Codes
Error CodeDescription

ActionOffline

This API has been deprecated.

AuthFailure.InvalidAuthorization

Authorization in the request header is invalid.

AuthFailure.InvalidSecretId

Invalid key (not a TencentCloud API key type).

AuthFailure.MFAFailure

MFA failed.

AuthFailure.SecretIdNotFoundKey does not exist. Check if the key has been
deleted or disabled in the console, and if not, checkif the key is correctly entered. Note that whitespaces
should not exist before or after the key.

AuthFailure.SignatureExpire©2013-2022 Tencent Cloud. All rights reserved.

Signature expired. Timestamp and server timecannot differ by more than five minutes. Please

Page 727 of 760

Tencent Cloud EdgeOne

ensure your current local time matches the standard
time.

AuthFailure.SignatureFailure

Invalid signature. Signature calculation error. Please
ensure you’ve followed the signature calculation
process described in the Signature API
documentation.

AuthFailure.TokenFailure
AuthFailure.UnauthorizedOperation

Token error.
The request is not authorized. For more information,
see the CAM documentation.
DryRun Operation. It means that the request would

DryRunOperation

have succeeded, but the DryRun parameter wasused.

FailedOperation

Operation failed.

InternalError

Internal error.

InvalidAction

The API does not exist.

InvalidParameter

Incorrect parameter.

InvalidParameterValue

Invalid parameter value.

InvalidRequest

The multipart format of the request body is incorrect.

IpInBlacklist

Your IP is in uin IP blacklist.

IpNotInWhitelistYour IP is not in uin IP whitelist.

LimitExceeded

Quota limit exceeded.

MissingParameter

A parameter is missing.

NoSuchProduct

The product does not exist.

NoSuchVersion

The API version does not exist.

RequestLimitExceeded

The number of requests exceeds the frequency limit.

RequestLimitExceeded.GlobalRegionUinLimitExceeded

Uin exceeds the frequency limit.

RequestLimitExceeded.IPLimitExceeded

The number of ip requests exceeds the frequency
limit.

RequestLimitExceeded.UinLimitExceeded

The number of uin requests exceeds the frequency©2013-2022 Tencent Cloud. All rights reserved.

Page 728 of 760

Tencent Cloud EdgeOne

limit.
RequestSizeLimitExceeded

The request size exceeds the upper limit.

ResourceInUse

Resource is in use.

ResourceInsufficientInsufficient resource.

ResourceNotFoundThe resource does not exist.

ResourceUnavailable

Resource is unavailable.

ResponseSizeLimitExceeded

The response size exceeds the upper limit.

ServiceUnavailable

Service is unavailable now.

UnauthorizedOperation

Unauthorized operation.

UnknownParameter

Unknown parameter.

UnsupportedOperation

Unsupported operation.

UnsupportedProtocol

HTTP(S) request protocol error; only GET and
POST requests are supported.

UnsupportedRegion

API does not support the requested region.

Service Error Codes
Error CodeDescription

FailedOperation.CertificateHasExpired

Failed to publ
The certificate
expired.

FailedOperation.CertificateNotFound

FailedOperation.ConfigConditionSyntaxError

The certificate
not exist.
Syntax error in
condition exprof the configur
file.
Unrecognized

FailedOperation.ConfigConditionUnknownTarget

condition matc
type.

FailedOperation.ConfigConditionValueEmptyError

The value field©2013-2022 Tencent Cloud. All rights reserved.

Page 729 of 760

Tencent Cloud EdgeOne

condition expr
cannot be em
the configurat

FailedOperation.ConfigFieldTypeError

The configura
contains fields
inconsistent dtypes.

FailedOperation.ConfigFormatError

Syntax error in
configuration fi

FailedOperation.ConfigMalformedContent

Incorrect form
the configurat
Parsing failed

FailedOperation.ConfigParamValidateErrors

Parameterverification err
the configurat
The specified

FailedOperation.ConfigUnknownField

the configurat
is not recogniz
indicating a po
spelling error
incorrect plac
within the filestructure.

FailedOperation.ConfigUnsupportedFormatVersion

FailedOperation.CreateClsLogSetFailed

The current
configuration fi
version is notsupported.
Failed to crea
log set. Check
whether the lo
name already
Failed to crea
log topic task.

FailedOperation.CreateClsLogTopicTaskFailed

whether the lo
name or task
already exists

FailedOperation.CreateLogTopicTaskAuthFailure

Authentication
while creating©2013-2022 Tencent Cloud. All rights reserved.

Page 730 of 760

Tencent Cloud EdgeOne

custom push t
Check whethe
push address
correct.

FailedOperation.InsufficientAccountBalance

FailedOperation.InvalidZoneStatus

The accountbalance isinsufficient.
The site statu
invalid.

FailedOperation.MissingConfigChunk

The content ismissing a man
configuration

FailedOperation.ModifyFailed

Operation failFailedOperation.RealtimeLogAuthFailure

The real-timeauthentication

FailedOperation.RealtimeLogNotFoundThe real-time
push task doe
exist.

FailedOperation.UnknownConfigGroupType

Unknown
configuration g
type.

InternalError.BackendError

Server error.

InternalError.ConfigLocked

The configura
locked. Please
unlock and try

InternalError.DBError

Database erroInternalError.DomainConfig

Failed to get
configuration

InternalError.FailedToGenerateUrl

Failed to genean upload link

InternalError.GetRoleError

Failed to get t

InternalError.ProxyServer

An unknown eoccurred in th
backend serv

©2013-2022 Tencent Cloud. All rights reserved.

Page 731 of 760

Tencent Cloud EdgeOne

InternalError.QuotaSystem
InternalError.RouteError

Server error.
The backend
address is inc

InternalError.SystemError

Internal systemerror.

InternalError.UnknowError

Unknown erroInvalidParameter.AccessRedirectRegexError

The regex is n
the standard R
format.

InvalidParameter.ActionInProgress

Too many atte
Please try agalater.

InvalidParameter.AliasDomainNotSupportSMCert

Chinese SM
certificates aresupported fordomain name

InvalidParameter.CacheKeyQueryStringRequiresFullUrlCacheOff

Invalid query s

InvalidParameter.CacheKeyQueryStringTooManyValue

The query stritoo many valu

InvalidParameter.CertNotMatchDomain

Mismatch bet
the HTTPS
certificate anddomain name

InvalidParameter.CertSystemError

Internal error.

InvalidParameter.CertToExpire

The HTTPS
certificate is a
expire.

InvalidParameter.CertTooShortKeySize

Certificate err
IPv6 access

InvalidParameter.ClientIpCountryConflictsWithIpv6

conflicts with c
IP geographic
location.

InvalidParameter.CnameWildHostNotAllowApplyCertificate©2013-2022 Tencent Cloud. All rights reserved.

Unable to app
wildcard certifi

Page 732 of 760

Tencent Cloud EdgeOne

under CNAME
mode.
InvalidParameter.CompressionInvalidAlgorithms

InvalidParameter.ConflictHostOrigin

Invalid compr
algorithm.
The origin can
the same as thdomain name

InvalidParameter.DomainNotFoundThe domain ndoes not exist
not belong toaccount.
Traffic schedu

InvalidParameter.DomainOnTrafficSchedulingalready enabl
the current do
name.

InvalidParameter.DuplicateRule

Duplicate rule
The current

InvalidParameter.ErrActionUnsupportTarget

conditions do
support therequested ope

InvalidParameter.ErrInvalidAction

Invalid operat
Invalid operat

InvalidParameter.ErrInvalidActionDuplicateAction

Duplicate ope
configuration.
Invalid rule enoperation. The

InvalidParameter.ErrInvalidActionOriginPrivateAddress

server IP canna private netw
or loopback
address.

InvalidParameter.ErrInvalidActionParam

InvalidParameter.ErrInvalidActionParamAction
InvalidParameter.ErrInvalidActionParamBadValueType©2013-2022 Tencent Cloud. All rights reserved.

Invalid operat
Invalid param
Invalid param"action".
Invalid value t
the parameter

Page 733 of 760

Tencent Cloud EdgeOne"action".
Invalid param
InvalidParameter.ErrInvalidActionParamDuplicateName

Duplicate para
names.
Invalid value t

InvalidParameter.ErrInvalidActionParamName

the parameter"action".
Invalid param

InvalidParameter.ErrInvalidActionParamTooManyValues

The paramete
too many valu

InvalidParameter.ErrInvalidActionParamValue

Invalid action.

InvalidParameter.ErrInvalidActionType

Invalid action

InvalidParameter.ErrInvalidCondition

Invalid conditi
The operation

InvalidParameter.ErrInvalidConditionCannotOnlyContainHostWhenModifyOriginActionConfigured

modifying theserver cannot
only to configu
host matching
You can only

InvalidParameter.ErrInvalidConditionHostTooManyWhenModifyOriginActionConfigured

InvalidParameter.ErrInvalidConditionIgnoreCase

configure one
matching typemodifying theInvalid conditi
The letter cas
ignored.

InvalidParameter.ErrInvalidConditionNameBadName

Invalid conditi
Invalid param
name.

InvalidParameter.ErrInvalidConditionNameTargetNotSupportName

InvalidParameter.ErrInvalidConditionValueBadRegular

Invalid conditi
The match typ
not supported
parameter.
Invalid conditi
Invalid regula
expression forparameter val©2013-2022 Tencent Cloud. All rights reserved.

Page 734 of 760

Tencent Cloud EdgeOne

InvalidParameter.ErrInvalidConditionValueBadUrl

Invalid paramvalue "url".
Invalid conditi

InvalidParameter.ErrInvalidConditionValueBadValue

InvalidParameter.ErrInvalidConditionValueBadValueContainFileNameExtension

The paramete
is invalid.
Invalid paramvalue: File ext
is not allowed

InvalidParameter.ErrInvalidConditionValueTooLongValue

Invalid conditi
The paramete
exceeds the li

InvalidParameter.ErrInvalidConditionValueTooManyRegular

The condition
too many regu
expressions.

InvalidParameter.ErrInvalidConditionValueTooManyValues

Invalid conditi
The paramete
exceeds the li
Invalid conditi

InvalidParameter.ErrInvalidConditionValueTooManyWildcard

Too many wildin the parame
Invalid conditi

InvalidParameter.ErrInvalidConditionValueZeroLength

The paramete
is 0.
ELSE is not

InvalidParameter.ErrInvalidElseWhenModifyOriginActionConfigured

supported forserver modific

InvalidParameter.ErrNilCondition

Empty conditi
To enable gR

InvalidParameter.GrpcRequireHttp2

support, HTT
support must
enabled as we

InvalidParameter.HostHeaderInvalid
InvalidParameter.HostNotFound©2013-2022 Tencent Cloud. All rights reserved.

Host header e
The domain ndoes not exist

Page 735 of 760

Tencent Cloud EdgeOne

InvalidParameter.HostStatusNotAllowApplyCertificate

CNAME is noswitched or th
origin is not ro
the EdgeOne

InvalidParameter.InvalidAccelerateType
InvalidParameter.InvalidAuthentication

Parameter err
Invalid token
authentication
Invalid token

InvalidParameter.InvalidAuthenticationTypeExpireTime

authentication
expiration time

InvalidParameter.InvalidAuthenticationTypeSecretKey

InvalidParameter.InvalidAuthenticationTypeSignParam

Invalid key forauthentication
Invalid token
authentication
parameter.
Invalid

InvalidParameter.InvalidAuthenticationTypeTimeFormat

authentication
format.
Invalid

InvalidParameter.InvalidAuthenticationTypeTimeParamauthentication
parameter.
The format ofInvalidParameter.InvalidAutoUseVoucher

automaticallyvouchers isincorrect. Entecorrect format

InvalidParameter.InvalidAwsPrivateAccess

Invalid third-p
object storage
Invalid region
Please fill in a

InvalidParameter.InvalidAwsRegion

correct region
third-party obj
storage servic

InvalidParameter.InvalidAwsSecretKey

Invalid third-p
object storage

InvalidParameter.InvalidBackupServerName

Invalid second©2013-2022 Tencent Cloud. All rights reserved.

Page 736 of 760

Tencent Cloud EdgeOne

origin domain
InvalidParameter.InvalidCacheConfigCache

Invalid node c

InvalidParameter.InvalidCacheConfigFollowOrigin

Invalid node c
The origin beh
is followed.

InvalidParameter.InvalidCacheKey
InvalidParameter.InvalidCacheKeyCookie

Invalid cache
Invalid cachecookie.

InvalidParameter.InvalidCacheKeyIgnoreCase

Cases are ign
the cache key

InvalidParameter.InvalidCacheKeyQueryStringAction

Invalid query s

InvalidParameter.InvalidCacheKeyQueryStringValue

Invalid query s

InvalidParameter.InvalidCacheKeyScheme

Invalid cache
scheme.

InvalidParameter.InvalidCacheOnlyOnSwitch

Invalid node c

InvalidParameter.InvalidCacheTime

Invalid node cvalidity.

InvalidParameter.InvalidCertInfo

Incorrect certi
information.
Invalid client I
location
configuration.
HeaderName

InvalidParameter.InvalidClientIpCountryHeaderName

consists of 1alphanumericcharacters an
cannot start owith hyphens

InvalidParameter.InvalidClientIpHeaderName

Invalid client I
request heade
Invalid origin f

InvalidParameter.InvalidClientIpOrigin©2013-2022 Tencent Cloud. All rights reserved.

region-specificorigin-pull.

Page 737 of 760

Tencent Cloud EdgeOne

InvalidParameter.InvalidConditions

Invalid conditi
Invalid originconfiguration.
OriginTyp

InvalidParameter.InvalidCosDomain

COS orAWS_S3 , thorigin address
be an object s
domain name

InvalidParameter.InvalidDynamicRoutine

Invalid smart
acceleration.
The package

InvalidParameter.InvalidDynamicRoutineBilling

not support S
Acceleration.

InvalidParameter.InvalidErrorPage

Invalid custom
page.

InvalidParameter.InvalidErrorPageRedirectUrl

Invalid custom
page.

InvalidParameter.InvalidForceRedirectType

Invalid forced
HTTPS direct
settings

InvalidParameter.InvalidHttps

InvalidParameter.InvalidHttpsCertInfo

Invalid param"https".
Invalid HTTPS
certificate.

InvalidParameter.InvalidHttpsCipherSuiteAndTlsVersion

The cipher su
does not matc
TLS version.

InvalidParameter.InvalidHttpsHstsMaxAge

Invalid HTTPS
HSTS.

InvalidParameter.InvalidHttpsTlsVersion

Invalid HTTPS
version.

InvalidParameter.InvalidInterval

Invalid interva
value should b©2013-2022 Tencent Cloud. All rights reserved.

Page 738 of 760

Tencent Cloud EdgeOne

either [min 5m
hour day].
InvalidParameter.InvalidIpv6Switch

Invalid IPv6 s

InvalidParameter.InvalidLogFormatFieldDelimiter

The field sepa
in the log outp
format is incor
The log outpu

InvalidParameter.InvalidLogFormatFormatType

InvalidParameter.InvalidLogFormatRecordDelimiter

format type isincorrect.
The log record
separator in th
output format
incorrect.

InvalidParameter.InvalidMaxAgeFollowOrigin

Invalid browse
cache.

InvalidParameter.InvalidMaxAgeTime

Invalid browse
cache.

InvalidParameter.InvalidMetricThe querydimension is i

InvalidParameter.InvalidOrigin

Invalid origin s

InvalidParameter.InvalidOriginGroupType

The origin sergroup type isincorrect.
The origin can

InvalidParameter.InvalidOriginIpa private IP or
loopback add

InvalidParameter.InvalidOriginType

Incorrect origi
server type.

InvalidParameter.InvalidOriginValue

The origin ser
incorrect orinexistent.

InvalidParameter.InvalidParameter

Invalid param

InvalidParameter.InvalidPeriod

The plan cycle
format is incor©2013-2022 Tencent Cloud. All rights reserved.

Page 739 of 760

Tencent Cloud EdgeOne

Enter the corr
format.

InvalidParameter.InvalidPlanType

The plan type
is incorrect. E
the correct for
The speciThe

InvalidParameter.InvalidPostMaxSizeBilling

InvalidParameter.InvalidPostSizeValue

does not supp
limiting the ma
upload size.
Invalid POST
request size.
AccessKeyId
SecretAccess

InvalidParameter.InvalidPrivateAccessParams

InvalidParameter.InvalidPrivateAccessSwitch

are required toaccess the thiparty object s
The value ofPrivateAc
should be on
off .

InvalidParameter.InvalidQuicBilling

InvalidParameter.InvalidQuotaNumber

InvalidParameter.InvalidQuotaType

The plan does
support QUICThe quota qua
format is incor
Enter the corr
format.
The quota typformat is incor
Enter the corr
quota type forInvalidParameter.InvalidRangeOriginPull

Invalid Range
The auto-rene

InvalidParameter.InvalidRenewFlag

InvalidParameter.InvalidRequestHeaderName©2013-2022 Tencent Cloud. All rights reserved.

flag format isincorrect. Entecorrect format
Invalid requesPage 740 of 760

Tencent Cloud EdgeOne

header.
Invalid reques
InvalidParameter.InvalidRequestHeaderNameXff

header x-forw
for.

InvalidParameter.InvalidRequestHeaderValue

Invalid requesheader.

InvalidParameter.InvalidResourceIdBilling

You have notpurchased a pyet.

InvalidParameter.InvalidResponseHeaderName

InvalidParameter.InvalidResponseHeaderValue

Invalid respon
header.
Invalid respon
header.

InvalidParameter.InvalidRuleEngineAction

Invalid rule enoperation.

InvalidParameter.InvalidRuleEngineNotFoundThe rule does
exist.

InvalidParameter.InvalidRuleEngineTarget

Invalid rule encondition.

InvalidParameter.InvalidRuleEngineTargetsExtension

Invalid file ext
in the rule eng
condition.

InvalidParameter.InvalidRuleEngineTargetsUrl

InvalidParameter.InvalidRuleProto

Invalid URL inrule engine
condition.
Incorrect proto
the rules.
(TCP/UDP).

InvalidParameter.InvalidServerName

Invalid origin
domain.

InvalidParameter.InvalidStandardDebug

Invalid debug
configuration f
EdgeOne.

InvalidParameter.InvalidStandardDebugClientIp

Invalid client I©2013-2022 Tencent Cloud. All rights reserved.

Page 741 of 760

Tencent Cloud EdgeOne

CIDR block.
The
AllowClientIP
parameter ismandatory. Th
and IPv6 netw
InvalidParameter.InvalidStandardDebugEmptyList

segments aresupported. 0.0
indicates that
IPv4 clients ca
debugged, an
indicates that
IPv6 clients ca
debugged.

InvalidParameter.InvalidStandardDebugExpireTimeLimit

The expiration
is exceeded.

InvalidParameter.InvalidUpstreamRequestQueryStringValue

Origin-pull req
configuration e
Invalid query s

InvalidParameter.InvalidUrlRedirect

Invalid URL re

InvalidParameter.InvalidUrlRedirectHost

Invalid target
the URL rewri
rule.
The target UR

InvalidParameter.InvalidUrlRedirectUrl

URL rewrite isinvalid.

InvalidParameter.InvalidWebSocketTimeout

Invalid WebSo

InvalidParameter.KeyRulesInvalidQueryStringValue

Invalid cache

InvalidParameter.LengthExceedsLimit

Maximum parlength exceed

InvalidParameter.LoadBalanceInstanceIdIsRequired©2013-2022 Tencent Cloud. All rights reserved.

The Cloud Lo
Balancer insta
is required in t
operation ofmodifying theserver.

Page 742 of 760

Tencent Cloud EdgeOne

InvalidParameter.MultiplyLayerNotSupportSmartRouting

InvalidParameter.NotSupportThisPreset

Smart routing
supported.
Unsupported
variables exis
The domain n

InvalidParameter.OCDirectOriginRequiresSmartRouting

configured toforward requethe origin direiSmart Accele
must be enab

InvalidParameter.OriginIsInnerIp

InvalidParameter.OriginL4RecordIPV4MixDomain

InvalidParameter.OriginL4RecordMultiDomain

The origin add
cannot be a p
IP address.
The layer-4 prstrictly prohib
mixing IPs anddomain name
Usage of multdomain origin
is forbidden fo
layer-4 proxy.

InvalidParameter.OriginNameExists

The origin gro
name alreadyInvalidParameter.OriginOriginGroupIdIsRequired

The origin gro
is required.

InvalidParameter.OriginPullProtocolIsRequired

The return pro
is required in t
operation ofmodifying theserver.

InvalidParameter.OriginRecordFormatError

Incorrect origi
server format.

InvalidParameter.OriginRecordWeightValue

Weight value
0-100.

InvalidParameter.OriginThirdPartyParamFormatError©2013-2022 Tencent Cloud. All rights reserved.

The key forma
incorrect.

Page 743 of 760

Tencent Cloud EdgeOne

InvalidParameter.ParameterError

Parameter err
Invalid “End ti
The interval b
the start and etime cannot ex
7 days.

InvalidParameter.PlanNotFound

InvalidParameter.PostMaxSizeLimitExceeded

InvalidParameter.ProxyNameDuplicating

The plan does
exist.
Maximum uplosize exceeded
The instancealready exists
Instance nam
contain 1 to 5
characters. Th
allowed chara

InvalidParameter.ProxyNameNotMatched

are a to z, 0 to
and -. - canno
registered alo
used continuo
and cannot be
placed at the
beginning or t
end.

InvalidParameter.RealtimeLogEntityAlreadyCreated

The push inst
has been crea

InvalidParameter.RealtimeLogInvalidDeliveryArea

The log push
is invalid.

InvalidParameter.RealtimeLogInvalidLogType

The log pushinvalid.

InvalidParameter.RealtimeLogInvalidTaskType

The real-time
delivery type iinvalid.

InvalidParameter.RealtimeLogNumsExceedLimit

The real-time
push task dat
exceeded theInvalidParameter.ResponseHeaderCacheControlNotAllowDelete

Invalid respon©2013-2022 Tencent Cloud. All rights reserved.

Page 744 of 760

Tencent Cloud EdgeOne

header.
Incorrect origi
InvalidParameter.RuleOriginFormatError

InvalidParameter.RuleOriginMultiDomain

server informa
format of the r
The origin of t
does not supp
multiple domanames.

InvalidParameter.RuleOriginPortInteger

The origin por
rule must be a
integer.

InvalidParameter.RuleOriginValueError

Invalid origin i
rule.

InvalidParameter.RulePortDuplicating

The rule port a
exists.
Incorrect port

InvalidParameter.RulePortGroup

number segm
the rules.

InvalidParameter.RulePortInteger

The port numbthe rules must
integer.

InvalidParameter.Security

Invalid param

InvalidParameter.SettingInvalidParam

Configuration
parameter err

InvalidParameter.SpaceNotBindOrigin

Shield Space
bound with an

InvalidParameter.StatusCodeCacheInvalidStatusCode

Invalid status
in cache.

InvalidParameter.Target

Resource erroInvalidParameter.TaskNotGenerated

Failed to crea
task

InvalidParameter.TaskSystemError

Internal error.

InvalidParameter.TlsVersionNotInSequence

TLS version is©2013-2022 Tencent Cloud. All rights reserved.

Page 745 of 760

Tencent Cloud EdgeOne

continuous for
HTTPS.
InvalidParameter.TooManyFilterValues

Too many filte
values.

InvalidParameter.UploadUrl

Invalid file upl
link.

InvalidParameter.ZoneHasBeenBoundThe site is alre
bound.

InvalidParameter.ZoneHasNotBeenBoundToPlan

The zone is nobound to a pa
The site is bei
upgraded. Ch

InvalidParameter.ZoneIsGrayPublishingis not support
Please try agalater.
To switch a si

InvalidParameter.ZoneNameIsRequiredconnecting wi
domain nameconnecting via
CNAME, the sname is requi

InvalidParameter.ZoneNotFoundThe site does
exist.

InvalidParameterValue.AccessBlacklist

The domain n
for this zone h
been banned.

InvalidParameterValue.ConflictRecord

It conflicts wit
existing record

InvalidParameterValue.ConflictWithDNSSEC

DNS records
with DNSSECThis DNS rec

InvalidParameterValue.ConflictWithNSRecord

conflicts withrecords.

InvalidParameterValue.ContentSameAsName

The host reco
cannot be theas the record©2013-2022 Tencent Cloud. All rights reserved.

Page 746 of 760

Tencent Cloud EdgeOne

The page con
InvalidParameterValue.ContentTypeNotMatchdoes not matc
Content-Type

InvalidParameterValue.DomainNotMatchZone

The specified
domain namenot match theInvalidParameterValue.FormatMismatch

Format misma

InvalidParameterValue.GeneralMismatch

Configuration
parameter for
mismatch.

InvalidParameterValue.IncludeInvalidValue

Contains inva
value.
The alias dom
name is invali
must contain

InvalidParameterValue.InvalidAliasDomainName

numerics, Engcharacters, anhyphens, but
is not allowed
beginning or t
end.
Invalid alias dsuffix. This do

InvalidParameterValue.InvalidAliasNameSuffix

for internal us
and cannot beas the alias do

InvalidParameterValue.InvalidDNSContent

Incorrect DNS
record.

InvalidParameterValue.InvalidDNSName

Incorrect DNS
record name.
Invalid accele

InvalidParameterValue.InvalidDomainName

domain namecontain [0-9],[a-z] and [-]. It
cannot start owith "-".

©2013-2022 Tencent Cloud. All rights reserved.

Page 747 of 760

Tencent Cloud EdgeOne

InvalidParameterValue.InvalidDomainStatus

Invalid domainname. Please
the status.

InvalidParameterValue.InvalidProxyOrigin

Incorrect DNS
The tag value

InvalidParameterValue.InvalidTagValue

InvalidParameterValue.MissingNecessaryParam

contains inval
characters.
Missing requir
configuration
parameters.
Wildcard dom

InvalidParameterValue.NotAllowedWildcardSharedCNAME

InvalidParameterValue.NotInEnumeration

InvalidParameterValue.NotWithinRange

CNAMEs aresupported.
The value is nwithin the requcollection.
The value is nwithin the spe
range.

InvalidParameterValue.OriginGroupNotExists

The specified
group does noInvalidParameterValue.PageNameAlreadyExist

The page nam
already exists

InvalidParameterValue.RegExMismatch

Does not matc
specified regu
expression.
Enter a valid s

InvalidParameterValue.SharedCNAMEPrefixNotMatch

InvalidParameterValue.TopLevelDomainNotSupport

CNAME prefix
to 50 characte
The current do
suffix is notsupported foraccess. Pleas
contact us if yneed to use it

InvalidParameterValue.UnrecognizableValue

Configuration©2013-2022 Tencent Cloud. All rights reserved.

Page 748 of 760

Tencent Cloud EdgeOne

error.

InvalidParameterValue.ZoneNameInvalid

The zone nam
format is incor
Please input acorrectly form
domain name

InvalidParameterValue.ZoneNameNotSupportPunyCode

Punycode acc
not supported
present.
The zone doe
support subdo

InvalidParameterValue.ZoneNameNotSupportSubDomain

access. Pleas
second-leveldomains for z
access.

InvalidParameterValue.ZoneSameAsName

LimitExceeded.BatchQuota

The site alias
already exists
Reached the ulimit of resourc
number
The number oregular expres

LimitExceeded.CustomLogFieldRegexLimitExceeded

type fields in r
time log custo
fields exceeds
limit.

LimitExceeded.DailyQuota

Reached the dupper limit ofresource num

LimitExceeded.PackNotAllow

Not supported
plan.

LimitExceeded.ProxyRulesLimitExceeded

The number oimported has
exceeded theLimitExceeded.QueryTimeLimitExceeded

Query time lim
exceeded.

©2013-2022 Tencent Cloud. All rights reserved.

Page 749 of 760

Tencent Cloud EdgeOne

LimitExceeded.RateLimitExceeded

Reached the A
rate limit.
The number oLimitExceeded.RuleLimitExceeded

has reached tlimit.

LimitExceeded.Security

Limit exceede

LimitExceeded.UserQuotaLimited

User instancequantity limita

LimitExceeded.ZoneBindPlan

Reached the ulimit of sites oplan

OperationDenied

Operation den

OperationDenied.AccelerateMainlandDisable

Cross-MLC-b
acceleration isbeta. To join tbeta, submit a

OperationDenied.AccelerateMainlandIpv6Conflict

Cross-MLC-b
acceleration a
IPv6 cannot b
configured atsame time.

OperationDenied.AccelerateMainlandMultiplyLayerConflict

The existing dfeature undercurrent site cowith the Chinemainland netw
optimization, acannot beconfigured atsame time.

OperationDenied.AccelerationDomainStatusNotInOnline

OperationDenied.ConfigLocked©2013-2022 Tencent Cloud. All rights reserved.

An L7 DNS sereferencing th
origin group is
deployed. Pleedit later.
The configura
locked. Please

Page 750 of 760

Tencent Cloud EdgeOne

unlock and try
OperationDenied.DeleteZonePreCheckFailed

The pre-check
during site deOperationDenied.DisableZoneNotCompleted

The EdgeOne
service of thebeing disabled
Please try agalater.

OperationDenied.DomainInShareCnameGroup

Switch failed:are domain na
the shared CN
group.

OperationDenied.DomainIsBlocked

Unable to use
domain nameit’s blocked.

OperationDenied.DomainNoICPThe domain ndoesn't have afiling number.

OperationDenied.DomainNumberIsNotZero

Unable to modservice area: T
are domain na
under the site
Some domain

OperationDenied.DomainStatusUnstablenames on theare currently
experiencing
instability. The
stable states fdomain name"online" and "oThe Enterpris

OperationDenied.EnterprisePlanAutoRenewUnsupported

OperationDenied.EnterprisePlanRenewUnsupported©2013-2022 Tencent Cloud. All rights reserved.

Edition Plan dnot support au
renewal.
The Enterpris
Edition Plan dnot support rePage 751 of 760

Tencent Cloud EdgeOne

OperationDenied.EnterprisePlanUpgradeUnsupported

The Enterpris
Edition Plan dnot support
upgrades.
The site

OperationDenied.EnvNotReady

OperationDenied.ErrZoneIsAlreadyPaused

OperationDenied.InvalidAdvancedDefenseSecurityType

OperationDenied.InvalidAdvancedDefenseZoneArea

environment iready.
The EdgeOne
service of thedisabled. Plea
enable it and t
again.
The security s
must be enab
when you ena
DDoS Protect
The accelerat
regions of themust be in the
Chinese mainwhen you ena
DDoS Protect
Exclusive DDoprotection con

OperationDenied.Ipv6AdvancedConflict

OperationDenied.Ipv6StaticIpConflict

OperationDenied.L4LackOfResources

with IPv6. The
cannot beconfigured atsame time.
The IPv6 featand static IP cbe enabled atsame time.
The layer-4 inresource saleskyrocketing a
now the resou
are sold out.
Replenishingprogress. Cur
new layer-4 p©2013-2022 Tencent Cloud. All rights reserved.

Page 752 of 760

Tencent Cloud EdgeOne

cannot be add
Please wait.

OperationDenied.L4PortLackOfResources

The sale of La
port resources
booming andhave been sol
We are urgen
restocking. At
present, it is npossible to ad
Layer 4 proxie
rules, and we
ask for yourpatience.

OperationDenied.L4ProxyInBannedStatus

OperationDenied.L4ProxyInOfflineStatus

OperationDenied.L4ProxyInProcessStatus

OperationDenied.L4ProxyInProgressStatus

Operation fail
The L4 proxy
blocked.
The Layer 4 c
is closed andaddition is
disallowed.
The instancecurrently in
deployment acannot be ope
The EdgeOne
service cannodisabled for th
A L4 proxy ins
is being deplo

OperationDenied.L4ProxyInStoppingStatus

Unable to disa
the site: There
L4 proxy insta
disabled.

OperationDenied.L4StatusNotInOnline

Unable to ope
the L4 instancwhen it’s not r

OperationDenied.L7HostInProcessStatus

The EdgeOne
service canno©2013-2022 Tencent Cloud. All rights reserved.

Page 753 of 760

Tencent Cloud EdgeOne

disabled for th
An acceleratedomain namebeing deploye
The affiliated C
Load Balance
OperationDenied.LoadBalanceStatusNotInOnline

OperationDenied.LoadBalancingZoneIsNotActive

OperationDenied.MsgIpv6AdvancedConflictin a running st
Operation isforbidden.
The site statu
not support
operations onbalancers.
IPv6 cannot b
enabled for nooverseas excl
protection.

OperationDenied.MultipleCnameZone

Unable to swi
NS for multipl
using CNAME

OperationDenied.NSNotAllowTrafficStrategy

Domain traffic
scheduling is
supported in N
access mode.

OperationDenied.NoDomainAccessZoneOnlyAllowModifiedToCNAME

You can only
a site connect
without a dom
name to conn
via the CNAM

OperationDenied.NoDomainAccessZoneOnlySupportModifyType

You can only
a site connect
without a dom
name to conn
via the CNAM
Other operatio
not allowed.

OperationDenied.NotInVersionControlWhiteList

The current us
not included in©2013-2022 Tencent Cloud. All rights reserved.

Page 754 of 760

Tencent Cloud EdgeOne

whitelist for ve
management.
Failed to delet
OperationDenied.OriginGroupAccelerationDomainUsed

acceleration dname is in use

OperationDenied.OriginGroupL4Used

The Layer 4 p
in use and candeleted.

OperationDenied.OriginGroupLBUsed

The Cloud Lo
Balancer is inand cannot bedeleted.

OperationDenied.OriginGroupRuleEngineUsed

The rule enginuse and cannodeleted.
Ownership

OperationDenied.OwnershipVerificationNotPassed

verification fai
Please complsite ownershipverification firs

OperationDenied.PlanDowngradeNotAllowed

A plan downg
not supported

OperationDenied.PlanHasBeenExpired

The plan has
expired.

OperationDenied.PlanHasBeenIsolated

The plan has
isolated.

OperationDenied.PlanIncreasePlanQuotaUnsupported

This plan doe
support thepurchase ofadditional planquotas.

OperationDenied.PlanNotSupportModifyZoneArea

The specified
does not suppchanging thearea of the sit

OperationDenied.PlatTypeIPAccelerateMainlandNotSupport

This site is us©2013-2022 Tencent Cloud. All rights reserved.

Page 755 of 760

Tencent Cloud EdgeOne

Anycast IP
scheduling mo
and does notsupport Cross
border accele

OperationDenied.PleaseContactBusinessPersonnel

To create an
Enterprise Ed
Plan, contact
business pers

OperationDenied.RecordIsForbidden

The DNS reco
cannot be add

OperationDenied.ResourceHasBeenLocked

Billing resourc
in operation. T
again later.

OperationDenied.ResourceLockedTemporary

This operation
conflicts withconcurrent
operations. Tr
again later.
The domain n

OperationDenied.SharedCNAMEUnsupportedAccelerateMainland

bound with a s
CNAME and c
be changed to"Cross-MLC-b
acceleration".
Please unbind
domain namethe shared CN
first.

OperationDenied.SharedCNAMEUnsupportedIPv6

The domain nbound with a s
CNAME and c
be changed toaccess". Plea
unbind the doname from theshared CNAM

OperationDenied.StaticIpAreaConflict©2013-2022 Tencent Cloud. All rights reserved.

The static IP cbe enabled fo
instance's reg

Page 756 of 760

Tencent Cloud EdgeOne

OperationDenied.VersionControlIsGraying

There is a tes
version in use
Please releas
test version tolive environme
roll back the teversion and tr
again.

OperationDenied.VersionControlLocked

The operation
allowed becau
versionmanagement
is applied.
The specified
working mode

OperationDenied.WorkModeNotInVersionControl

OperationDenied.ZoneIsBindingSharedCNAME

OperationDenied.ZoneIsReferenceCustomErrorPage

applicable to t
versionmanagement
The shared C
has been bou
another site. P
unbind first.
Error found inassociated cu
error page. Pl
unbind it first.

OperationDenied.ZoneNotActive

The zone isdisabled.

ResourceInUse.AliasDomain

Resources oc
by the alias donames underaccount.

ResourceInUse.AliasName

The alias dom
name already

ResourceInUse.Cname

Resources oc
by this accoun
CNAME.

©2013-2022 Tencent Cloud. All rights reserved.

Page 757 of 760

Tencent Cloud EdgeOne

ResourceInUse.Dns

DNS resource
occupied.

ResourceInUse.DnsRecord

The domain nbeing resolved
you need to e
acceleration,
go to DNS Re

ResourceInUse.DuplicateName

Duplicate alia
domain nameResourceInUse.GenericHost

Resources oc
by the wildcar
domain nameResources oc

ResourceInUse.Hostby the subdom
names underaccount.

ResourceInUse.NS

Resources oc
by this accoun
NS.

ResourceInUse.Others

The resource
been connect
EdgeOne by auser.
Resources oc

ResourceInUse.OthersAliasDomainby the alias donames underaccounts.

ResourceInUse.OthersCname

Resources oc
by other acco
via CNAME.

ResourceInUse.OthersHost

Resources oc
by the subdom
names underaccounts.

ResourceInUse.OthersNS

Resources oc
by other acco
via NS.

©2013-2022 Tencent Cloud. All rights reserved.

Page 758 of 760

Tencent Cloud EdgeOne

ResourceInUse.SelfAndOthersCname

ResourceInUse.SharedCNAME

Resources oc
by this accoun
others via CN
Unable to deleshared CNAM
bound to an
acceleration dname. Please
remove the bi
first.

ResourceInUse.Zone

The alias dom
name is alread
added.

ResourceNotFound.PostMaxSizeQuotaNotFound

Maximum uplosize is notconfigured.

ResourceNotFound.VersionNotFoundThe configura
group version
not exist. Pleacheck and try
The certificate

ResourceUnavailable.CertNotFound

ResourceUnavailable.DomainAlreadyExists

ResourceUnavailable.DomainNotFound

not exist or is
authorized.
The domain nalready conne
EdgeOne by aaccount. Plea
retrieve it firstorder to add it
The requested
accelerated dname doesn’t

ResourceUnavailable.FunctionNotFound

ResourceUnavailable.HostNotFound©2013-2022 Tencent Cloud. All rights reserved.

The function d
not exist or do
belong to thisaccount.
The domain ndoes not exist

Page 759 of 760

Tencent Cloud EdgeOne

use a proxy.
ResourceUnavailable.SharedCNAMEAlreadyExists

ResourceUnavailable.ZoneNotFoundThe shared C
is used by oth
The site does
exist or is notto this accoun

ResourcesSoldOut.L7LackOfResources
UnauthorizedOperation.CamUnauthorized
UnauthorizedOperation.DomainEmpty

CAM is not
authorized.
Authentication
The sub-acco

UnauthorizedOperation.NoPermission

UnauthorizedOperation.Unknown

UnsupportedOperation.TargetNameOriginTypeCos©2013-2022 Tencent Cloud. All rights reserved.

not authorized
the operation.
Please getpermissions fi
An unknown eoccurred in th
backend serv
The origin typ
the target dom
cannot be CO
an alias doma

Page 760 of 760