API
  • 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
    • 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
    • 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
    • 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
Docs Overview/
API/
API Category/

API Category

Site APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateZoneCreates a site20
DescribeIdentificationsQueries the verification information of a site.20
ModifyZoneModifies a site.20
DeleteZoneDeletes a site20
ModifyZoneStatusChanges the site status20
CheckCnameStatusQueries the CNAME status of a domain name20
IdentifyZoneVerifies site ownership20
DescribeZonesQueries the list of sites20
VerifyOwnershipVerifies ownership20
ExportZoneConfigExports site configuration20
ImportZoneConfigImports site configuration20
DescribeZoneConfigImportResultQueries site configuration import results20

Acceleration Domain Management APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateAccelerationDomainConnects a domain to EdgeOne20
DescribeAccelerationDomainsQueries accelerated domain names20
ModifyAccelerationDomainModifies an accelerated domain name20
ModifyAccelerationDomainStatusesBatch modifies the status of accelerated domains.20
DeleteAccelerationDomainsBatch remove accelerated domain names20
CreateSharedCNAMECreates a shared CNAME.20
BindSharedCNAMEBinds with a shared CNAME20
DeleteSharedCNAMEDeletes a shared CNAME20

Site Acceleration Configuration APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateRuleCreates a rule in the rule engine.20
DeleteRulesBatch deletes rules from the rule engine.20
DescribeHostsSettingQueries detailed domain name configuration20
DescribeRulesQueries the rules in the rule engine.20
DescribeRulesSettingQueries the setting parameters of the rule engine.20
DescribeZoneSettingQueries the site configuration20
ModifyRuleModifies a rule in the rule engine.20
ModifyZoneSettingModifies the site configuration20

Edge Function APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateFunctionCreates an edge function5
DescribeFunctionsQueries the list of trigger rules20
ModifyFunctionModifies an edge function20
DeleteFunctionDeletes an edge function20
CreateFunctionRuleCreates a trigger rule for an edge function20
DescribeFunctionRulesQueries a trigger rule for an edge function20
ModifyFunctionRuleModifies a trigger rule for an edge function20
ModifyFunctionRulePriorityModifies the priority of trigger rules for an edge function20
DeleteFunctionRulesDeletes a trigger rule for an edge function20
DescribeFunctionRuntimeEnvironmentQueries the runtime environment of an edge function20
HandleFunctionRuntimeEnvironmentOperates the runtime environment of an edge function20

Alias Domain APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateAliasDomainCreates an alias domain name.20
DescribeAliasDomainsQueries the information of alias domain names.20
ModifyAliasDomainModifies an alias domain name.20
ModifyAliasDomainStatusModifies the status of an alias domain name.20
DeleteAliasDomainDeletes an alias domain name.20

Security Configuration APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateSecurityIPGroupCreates a security IP group20
DescribeSecurityIPGroupQueries security IP groups20
ModifySecurityIPGroupModifies a security IP group20
DeleteSecurityIPGroupDeletes a security IP group20
DescribeOriginProtectionQueries the origin protection configuration20
DescribeSecurityTemplateBindingsQueries bindings of a policy template20
ModifySecurityPolicyModifies the web and bot security configurations20
BindSecurityTemplateToEntityBinds/Unbinds a domain name to/from a security policy template20
DescribeSecurityIPGroupInfoQueries security IP groups (deprecated)20

Layer 4 Application Proxy APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateL4ProxyCreates Layer 4 proxy instances20
ModifyL4ProxyModifies a Layer 4 proxy instance20
ModifyL4ProxyStatusModifies Layer 4 proxy instance status20
DescribeL4ProxyQueries a Layer 4 proxy instance list20
DeleteL4ProxyDeletes a Layer 4 proxy instance20
CreateL4ProxyRulesCreates Layer 4 proxy forwarding rules20
ModifyL4ProxyRulesModifies Layer 4 proxy forwarding rules20
ModifyL4ProxyRulesStatusModifies Layer 4 proxy forwarding rule status20
DescribeL4ProxyRulesQueries a Layer 4 proxy forwarding rule list20
DeleteL4ProxyRulesDeletes Layer 4 proxy forwarding rules20
CreateApplicationProxyCreates an application proxy (legacy)20
ModifyApplicationProxyModifies an application proxy (legacy)20
ModifyApplicationProxyStatusModifies the application proxy status (legacy)20
DescribeApplicationProxiesQueries the application proxy list (legacy)20
DeleteApplicationProxyDeletes an application proxy (legacy)20
CreateApplicationProxyRuleCreates an application proxy rule (legacy)20
ModifyApplicationProxyRuleModifies an application proxy rule (legacy)20
ModifyApplicationProxyRuleStatusModifies the status of an application proxy rule (legacy)20
DeleteApplicationProxyRuleDeletes an application proxy rule (legacy)20

Content Management APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreatePurgeTaskThis API is used to create a cache purging task.20
DescribePurgeTasksQuerying the cache purging history20
CreatePrefetchTaskThis API is used to create a pre-warming task.20
DescribePrefetchTasksThis API is used to query the pre-warming task status.20
DescribeContentQuotaThis API is used to query content management quotas.20

Data Analysis APIs

API NameFeatureFrequency Limit (maximum requests per second)
DescribeDDoSAttackDataQueries the time-series data of DDoS attacks.100
DescribeDDoSAttackEventQueries DDoS attack events.100
DescribeDDoSAttackTopDataQueries the top-ranked DDoS attack data.100
DescribeOverviewL7DataQuery monitoring traffic time sequence data (to be discarded)100
DescribeTimingL4DataQueries the L4 traffic data over time100
DescribeTimingL7AnalysisDataQueries the traffic analysis data over time100
DescribeTopL7AnalysisDataQueries the traffic analysis data100
DescribeTimingL7CacheDataQueries the time series data of the cache analysis (to be deprecated)100
DescribeTopL7CacheDataQueries the top N data of the cache analysis (to be deprecated)100

Log Service APIs

API NameFeatureFrequency Limit (maximum requests per second)
DownloadL7LogsDownloads L7 logs.100
DownloadL4LogsDownloads L4 logs100
CreateCLSIndexCreates a CLS index20
CreateRealtimeLogDeliveryTaskCreates a real-time log delivery task20
ModifyRealtimeLogDeliveryTaskModifies a real-time log delivery task20
DeleteRealtimeLogDeliveryTaskDeletes a real-time log delivery task20
DescribeRealtimeLogDeliveryTasksQueries the list of real-time log delivery tasks20

Billing APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreatePlanCreates plan20
UpgradePlanUpgrades plan20
RenewPlanRenews plan20
ModifyPlanModifies plan setting20
IncreasePlanQuotaPurchases additional plan quota20
DestroyPlanTerminates plan20
CreatePlanForZonePurchase a plan for a new site20
BindZoneToPlanBinds a site to a plan.20
DescribeBillingDataQueries billing data50
DescribeAvailablePlansQueries plan options available for purchase20

Certificate APIs

API NameFeatureFrequency Limit (maximum requests per second)
DescribeDefaultCertificatesQueries the list of default certificates20
ModifyHostsCertificateConfigures the certificate20

Load Balancing APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateOriginGroupCreates an origin group20
ModifyOriginGroupModifies an origin group20
DeleteOriginGroupDeletes an origin group20
DescribeOriginGroupObtains a list of origin groups.20
CreateLoadBalancerCreates a LoadBalancer20
ModifyLoadBalancerModifies a LoadBalancer20
DeleteLoadBalancerDeletes a LoadBalancer20
DescribeLoadBalancerListQueries the LoadBalancer list20
DescribeOriginGroupHealthStatusQueries the health status of origin server groups under a LoadBalancer20

Diagnostic Tool APIs

API NameFeatureFrequency Limit (maximum requests per second)
DescribeIPRegionQueries IP location information20

Custom Response Page APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateCustomizeErrorPageCreates a custom response page20
DescribeCustomErrorPagesQueries the custom response page list20
ModifyCustomErrorPageModifies a custom response page20
DeleteCustomErrorPageDeletes a custom response page20

Version Management APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateConfigGroupVersionCreate Configuration Group Version20
DeployConfigGroupVersionRelease Configuration Group Version20
DescribeConfigGroupVersionDetailQuery Configuration Group Version Details20
DescribeConfigGroupVersionsQuery Configuration Group Version List20
DescribeDeployHistoryQuery Version Release History20
DescribeEnvironmentsQuery Environment Information20