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
    • 导出区域配置
    • 导入区域配置
    • 描述区域配置导入结果
  • Acceleration Domain Management APIs
    • CreateAccelerationDomain
    • DescribeAccelerationDomains
    • ModifyAccelerationDomain
    • ModifyAccelerationDomainStatuses
    • DeleteAccelerationDomains
    • CreateSharedCNAME
    • DescribeSharedCNAME
    • ModifySharedCNAME
    • BindSharedCNAME
    • DeleteSharedCNAME
  • Site Acceleration Configuration APIs
    • CreateL7AccRules
    • DescribeL7AccRules
    • ModifyL7AccRule
    • DeleteL7AccRules
    • DescribeL7AccSetting
    • ModifyL7AccSetting
    • ModifyL7AccRulePriority
  • 边缘函数API
    • 创建函数
    • 描述函数
    • 修改函数
    • 删除函数
    • 创建函数规则
    • 描述函数规则
    • 修改函数规则
    • 修改函数规则优先级
    • 删除函数规则
    • 描述函数运行时环境
    • 处理函数运行时环境
    • ModifyFunctionComponentBindings
    • DescribeFunctionComponentBindings
  • Alias Domain APIs
    • CreateAliasDomain
    • DescribeAliasDomains
    • ModifyAliasDomain
    • ModifyAliasDomainStatus
    • DeleteAliasDomain
  • Security Configuration APIs
    • CreateSecurityIPGroup
    • DescribeSecurityIPGroup
    • ModifySecurityIPGroup
    • DeleteSecurityIPGroup
    • DescribeSecurityTemplateBindings
    • BindSecurityTemplateToEntity
    • DescribeSecurityPolicy
    • ModifySecurityPolicy
    • DescribeSecurityIPGroupInfo
    • DescribeSecurityIPGroupContent
    • CreateSecurityJSInjectionRule
    • DescribeSecurityJSInjectionRule
    • ModifySecurityJSInjectionRule
    • DeleteSecurityJSInjectionRule
    • CreateSecurityClientAttester
    • DescribeSecurityClientAttester
    • ModifySecurityClientAttester
    • DeleteSecurityClientAttester
    • CreateWebSecurityTemplate
    • DeleteWebSecurityTemplate
    • DescribeWebSecurityTemplates
    • ModifyWebSecurityTemplate
    • DescribeDDoSProtection
    • DescribeWebSecurityTemplate
    • ModifyDDoSProtection
  • Layer 4 Application Proxy APIs
    • CreateL4Proxy
    • ModifyL4Proxy
    • ModifyL4ProxyStatus
    • DescribeL4Proxy
    • DeleteL4Proxy
    • CreateL4ProxyRules
    • ModifyL4ProxyRules
    • ModifyL4ProxyRulesStatus
    • DescribeL4ProxyRules
    • DeleteL4ProxyRules
  • Content Management APIs
    • CreatePurgeTask
    • DescribePurgeTasks
    • CreatePrefetchTask
    • DescribePrefetchTasks
    • DescribeContentQuota
    • DescribePrefetchOriginLimit
    • ModifyPrefetchOriginLimit
  • Data Analysis APIs
    • DescribeDDoSAttackData
    • DescribeDDoSAttackEvent
    • DescribeDDoSAttackTopData
    • DescribeOverviewL7Data
    • DescribeTimingL7OriginPullData
    • DescribeTimingL4Data
    • DescribeTimingL7AnalysisData
    • DescribeTopL7AnalysisData
    • DescribeTimingL7CacheData
    • DescribeTopL7CacheData
  • Log Service APIs
    • DownloadL7Logs
    • DownloadL4Logs
    • CreateCLSIndex
    • CreateRealtimeLogDeliveryTask
    • ModifyRealtimeLogDeliveryTask
    • DeleteRealtimeLogDeliveryTask
    • DescribeRealtimeLogDeliveryTasks
  • Billing APIs
    • CreatePlan
    • DescribePlans
    • UpgradePlan
    • RenewPlan
    • ModifyPlan
    • IncreasePlanQuota
    • DestroyPlan
    • CreatePlanForZone
    • BindZoneToPlan
    • DescribeBillingData
    • DescribeAvailablePlans
  • Certificate APIs
    • DescribeDefaultCertificates
    • ModifyHostsCertificate
    • ApplyFreeCertificate
    • CheckFreeCertificateVerification
  • Origin Protection APIs
    • EnableOriginACL
    • ModifyOriginACL
    • DescribeOriginACL
    • ConfirmOriginACLUpdate
    • DisableOriginACL
  • Load Balancing APIs
    • CreateOriginGroup
    • ModifyOriginGroup
    • DeleteOriginGroup
    • DescribeOriginGroup
    • 创建负载均衡器
    • 修改负载均衡器
    • 删除负载均衡器
    • 描述负载均衡器列表
    • 描述源站组健康状态
  • Diagnostic Tool APIs
    • DescribeIPRegion
  • Custom Response Page APIs
    • CreateCustomizeErrorPage
    • DescribeCustomErrorPages
    • ModifyCustomErrorPage
    • DeleteCustomErrorPage
  • Version Management APIs
    • CreateConfigGroupVersion
    • DeployConfigGroupVersion
    • DescribeConfigGroupVersionDetail
    • DescribeConfigGroupVersions
    • DescribeDeployHistory
    • DescribeEnvironments
    • ModifyZoneWorkMode
  • API Security APIs
    • CreateSecurityAPIResource
    • DescribeSecurityAPIResource
    • ModifySecurityAPIResource
    • DeleteSecurityAPIResource
    • CreateSecurityAPIService
    • DescribeSecurityAPIService
    • ModifySecurityAPIService
    • DeleteSecurityAPIService
  • DNS记录API
    • 创建DNS记录
    • 描述DNS记录
    • 修改DNS记录
    • 修改DNS记录状态
    • 删除DNS记录
  • Content Identifier APIs
    • CreateContentIdentifier
    • DescribeContentIdentifiers
    • ModifyContentIdentifier
    • DeleteContentIdentifier
  • Legacy APIs
    • DescribeOriginProtection
    • CreateRule
    • DescribeRules
    • ModifyRule
    • DeleteRules
    • DescribeZoneSetting
    • ModifyZoneSetting
    • DescribeHostsSetting
    • DescribeRulesSetting
    • CreateApplicationProxy
    • DescribeApplicationProxies
    • ModifyApplicationProxy
    • ModifyApplicationProxyStatus
    • DeleteApplicationProxy
    • CreateApplicationProxyRule
    • ModifyApplicationProxyRule
    • ModifyApplicationProxyRuleStatus
    • DeleteApplicationProxyRule
  • Ownership APIs
    • VerifyOwnership
  • Image and Video Processing APIs
    • CreateJustInTimeTranscodeTemplate
    • DescribeJustInTimeTranscodeTemplates
    • DeleteJustInTimeTranscodeTemplates
  • Multi-Channel Security Gateway APIs
    • ConfirmMultiPathGatewayOriginACL
    • DescribeMultiPathGatewayOriginACL
    • CreateMultiPathGateway
    • DescribeMultiPathGateways
    • DescribeMultiPathGateway
    • ModifyMultiPathGateway
    • ModifyMultiPathGatewayStatus
    • DeleteMultiPathGateway
    • DescribeMultiPathGatewayRegions
    • CreateMultiPathGatewaySecretKey
    • DescribeMultiPathGatewaySecretKey
    • ModifyMultiPathGatewaySecretKey
    • RefreshMultiPathGatewaySecretKey
    • CreateMultiPathGatewayLine
    • DescribeMultiPathGatewayLine
    • ModifyMultiPathGatewayLine
    • DeleteMultiPathGatewayLine
  • KV Storage APIs
    • ModifyEdgeKVNamespace
    • EdgeKVPut
    • EdgeKVList
    • EdgeKVGet
    • EdgeKVDelete
    • DescribeEdgeKVNamespaces
    • DeleteEdgeKVNamespace
    • CreateEdgeKVNamespace
  • Data Types
  • Error Codes

Introduction

概述

边缘安全加速平台 EO(Tencent Cloud EdgeOne,下文简称为 EdgeOne)是国内首款基于全新架构的真正一体化的边缘安全加速平台。提供全面的安全防护、网络&应用性能加速、领先的边缘计算和完善的监控运营分析能力。当前 EdgeOne 产品四大板块已逐步成熟,为开发者提供多样化的技术解决方案。
本章节介绍的 EdgeOne API 接口均为 API 3.0 接口。
您可以调用 API 对 EdgeOne 进行操作,例如创建站点、创建加速域名、四层代理、安全规则、以及边缘函数等。
EdgeOne 支持的所有接口信息,请参见 API 概览。

术语表

EdgeOne API 接口的常见术语请参见下表:

术语描述
ZoneId站点 ID。
CNAMECNAME(Canonical Name)记录是 DNS 的一种记录类型,即实现将一个域名解析到另一个域名(CNAME 域名),再由 CNAME 域名来解析到需要访问的服务器 IP 地址。使用 CNAME 接入时,添加加速域名且开启代理加速完成后,EdgeOne 会为加速域名分配形如 .eo.dnse5.com 的CNAME 域名。
NS通过修改 NS 服务器的 NS 记录地址到 EdgeOne 提供的 NS 记录地址,将 DNS 解析权转移给 EdgeOne,实现稳定专业的解析服务的同时,还可以通过开启代理模式接入 EdgeOne 提供的安全防护和加速服务。
Plan即套餐,指特定站点可使用的 EdgeOne 产品能力和额度的集合,不同套餐提供的产品能力和额度集合各有不同。接入 EdgeOne 的站点必须选择订阅一个套餐,套餐内包含套餐配额。目前 EdgeOne 已提供免费版、个人版、基础版、标准版、企业版。

使用限制

对于 API 接口的参数限制,请参考各接口文档中的参数说明。

API 快速入门

您可以使用 API Explorer 工具在线调用 API。
本文以创建站点为例,通过 API Explorer 工具调用 API 接口的步骤如下:

  1. 进入 API Explorer 工具页面。更多 API Explorer 工具使用信息,请参见 使用 API Explorer。
  2. 调用 CreateZone,创建站点。
  3. 创建站点后即可在控制台页面查看到已创建的站点,后续可以针对站点进行添加域名、配置加速策略等一系列操作。