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
  • 边缘函数API
    • 创建函数
    • 描述函数
    • 修改函数
    • 创建函数规则
    • 删除函数
    • 描述函数规则
    • 修改函数规则
    • 修改函数规则优先级
    • 删除函数规则
    • 描述函数运行时环境
    • 处理函数运行时环境
  • 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
  • DNS记录API
    • 创建DNS记录
    • 删除DNS记录
    • 描述DNS记录
    • 修改DNS记录状态
    • 修改DNS记录
  • Diagnostic Tool APIs
    • DescribeIPRegion
  • Version Management APIs
    • CreateConfigGroupVersion
    • DeployConfigGroupVersion
    • DescribeConfigGroupVersionDetail
    • DescribeConfigGroupVersions
    • DescribeDeployHistory
    • DescribeEnvironments
  • Data Types
  • Error Codes
当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。

Introduction

Overview
Edge Security Acceleration Platform EO (Tencent Cloud EdgeOne, hereinafter referred to as EdgeOne) is the first domestic truly integrated edge security acceleration platform based on a new architecture. It provides comprehensive security protection, network & application performance acceleration, leading edge computing, and comprehensive monitoring and operational analysis capabilities. Currently, the four major modules of EdgeOne have gradually matured, offering developers diversified technical solutions. This section introduces EdgeOne API interfaces, all of which are API 3.0 interfaces. You can call APIs to operate EdgeOne, such as creating sites, creating acceleration domain names, Layer 4 proxy, security rules, and edge functions. For all supported API information of EdgeOne, please refer to API Overview.

glossary
Common terminology for EdgeOne API interface see the table below

TermDescription
Zone ID
A CNAME (Canonical Name) record is a DNS record type that resolves one domain name to another (CNAME domain), which then resolves to the target server IP address. When using CNAME for access, after adding an acceleration domain name and enabling proxy acceleration, EdgeOne will assign a CNAME domain in the form of .eo.dnse5.com to the acceleration domain name.
By changing the NS record address of the NS server to the NS record address provided by EdgeOne, you can transfer DNS resolution permission to EdgeOne. This enables stable and professional resolution services while also allowing you to integrate security protection and acceleration services provided by EdgeOne by enabling proxy mode.
PlanRefers to a package, which is a collection of EdgeOne product capabilities and limits available for a specific site. Different packages offer different sets of product capabilities and limits. Sites integrated with EdgeOne must subscribe to a package, which includes a package quota. Currently, EdgeOne provides the Free Edition, Personal Edition, Basic Version, Standard Version, and Enterprise Edition.

Usage limits
For API parameter limits, refer to the parameter descriptions in the API documentation.

API quick start

You can use the API Explorer Tool for online API calls.
This document uses creating site as an example. The steps for API call via API Explorer Tool are as follows:

  1. Enter the API Explorer Tool page (https://console.cloud.tencent.com/api/explorer). For more API Explorer Tool usage information, please see Using API Explorer (https://cloud.tencent.com/document/product/1278/46697).
  2. Call CreateZone to create site.
  3. After the site is created, you can view the created site on the console page. Subsequently, you can perform a series of operations for the site, such as adding a domain and configuring an acceleration strategy.