API概览_边缘安全加速(ESA)-阿里云帮助中心

本产品（边缘安全加速/2024-09-10）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

站点管理

API	标题	API概述
CreateSite	创建站点	让用户创建一个新的站点。
ListSites	查询站点列表	用于查询当前用户下的站点列表，包括站点的名称、状态、配置等信息。
GetSite	查询单个站点信息	根据站点ID查询单个站点信息。
VerifySite	校验站点归属	校验站点归属，通过校验的站点将自动被激活。
DeleteSite	删除单个站点	根据站点ID删除一个站点。
UpdateSiteCoverage	修改站点加速区域	修改单个站点的加速区域。更新站点的加速配置，以适应流量分布变化或提升特定地区用户的访问体验。
UpdateSiteAccessType	修改站点接入方式	根据站点ID和站点接入类型修改站点的接入方式。
UpdateSiteVanityNS	修改站点的自定义NS服务器	修改单个站点的自定义NS服务器名称。
GetSiteCurrentNS	查询站点的名称服务器	查询当前站点配置的DNS服务器名称。
CheckSiteName	校验站点名称是否可用	预校验一个站点名称是否可用。
ListTagResources	查询标签	根据地域ID以及资源类型查询标签。
UntagResources	删除资源标签	根据指定的资源ID删除资源标签。

缓存

API	标题	API概述
PurgeCaches	刷新节点缓存	刷新节点上的文件内容。支持文件、目录、缓存标记、去参数、主机名及全站刷新。
DescribePurgeTasks	查询刷新任务	查询刷新任务的执行情况。
PreloadCaches	预热URL	缓存预热。
DescribePreloadTasks	查询预热任务详情	查询任务预热详情，支持按时间、任务状态、预热URL进行分页查询。
BlockObject	URL封禁	对指定URL禁止访问。
GetPurgeQuota	获取刷新配额	获取不同刷新类型的配额及配额已使用量。
UploadFile	上传刷新或者预热文件	上传刷新或预热文件以提高访问速度。
ListUploadTasks	列出文件上传任务	根据时间及类型列出文件上传任务的执行状态及运行信息。
GetUploadTask	查询文件上传任务状态	通过文件上传任务ID查询对应任务的执行状态及运行信息。
StartScheduledPreloadExecution	开始单个定时预热计划	根据预热计划ID开启一个定时预热。
CreateScheduledPreloadJob	新增定时预热任务	添加一个定时预热任务。
UpdateScheduledPreloadExecution	更新单个定时预热计划	根据预热计划ID更新一个定时预热。
CreateScheduledPreloadExecutions	批量新增定时预热任务的计划	制定批量新增定时预热任务的计划。
ListScheduledPreloadExecutions	列出指定定时预热任务下的执行计划	根据定时预热任务ID列出指定定时预热任务下的执行计划。
DeleteScheduledPreloadJob	删除指定定时预热任务	根据定时预热任务ID删除指定定时预热任务。
ResetScheduledPreloadJob	重置定时预热任务的进度	重置定时预热任务的进度，从头开始预热。
StopScheduledPreloadExecution	停止单个定时预热计划	根据预热计划ID停止单个定时预热计划。
GetScheduledPreloadJob	查询单个定时预热任务	根据定时预热任务ID查询单个定时预热任务。
DeleteScheduledPreloadExecution	删除单个定时预热计划	根据预热计划ID删除单个定时预热计划。
ListScheduledPreloadJobs	列出定时预热任务列表	列出站点下的定时预热任务列表。

DNS

API	标题	API概述
BatchCreateRecords	批量创建解析记录	批量添加DNS解析记录，支持多种记录类型。
CreateRecord	创建解析记录	在站点下创建一条DNS解析记录。
DeleteRecord	删除DNS记录	根据RecordId，删除站点下的单条DNS解析记录。
ListRecords	查询解析记录列表	查询站点下解析记录列表，包括记录值、优先级、认证配置等。支持根据记录名称、记录类型等条件进行过滤。
GetRecord	查询解析记录详情	获取单条DNS解析记录的详细配置信息，包括记录值、优先级、回源鉴权配置（CNAME记录独有）等。
UpdateRecord	更新解析记录	更新DNS解析记录，支持多种记录类型及源站鉴权配置。
ListEdgeRoutineRecords	查询边缘路由记录列表	查询站点下的边缘路由记录列表。
ListEdgeContainerRecords	查询边缘容器记录列表	查询站点的边缘容器记录。
ExportRecords	导出记录	导出站点下的所有DNS记录，以固定的文本格式返回结果。

流量

API	标题	API概述
等候室	等候室
CreateWaitingRoom	创建等候室	创建站点等候室。
CreateWaitingRoomEvent	创建等候室事件	创建等候室事件，可以选择排队方式以及类型等。
CreateWaitingRoomRule	创建等候室绕过规则	创建一个等候室绕过规则。
UpdateWaitingRoomRule	修改等候室绕过规则	更新指定站点的等候室绕过规则配置。
UpdateWaitingRoomEvent	更新等候室事件	更新等候室事件的相关配置。
UpdateWaitingRoom	更新等候室	更新指定等候室的配置信息。
ListWaitingRooms	查询等候室列表	查询指定站点下已配置的所有等候室的详细信息。
ListWaitingRoomRules	查询等候室绕过规则列表	查询等候室对应的等候室绕过规则列表。
ListWaitingRoomEvents	查询等候室事件列表	查询等候室的等候室事件详情。
DeleteWaitingRoomRule	删除等候室绕过规则	通过站点删除等候室绕过规则。
DeleteWaitingRoomEvent	删除等候室事件	删除等候室对应的事件。
DeleteWaitingRoom	删除等候室	通过站点删除等候室。

SSL/TLS

API	标题	API概述
ListClientCertificates	获取客户端证书列表	获取指定站点下客户端证书列表。
ActivateClientCertificate	激活客户端证书	根据证书ID激活客户端。
SetCertificate	配置站点证书	用于设置某站点下是否启用证书功能及更新证书信息。

安全防护

API	标题	API概述
WAF	WAF
GetWafRuleset	获取单个WAF规则集详情	获取指定的WAF规则集详情。用户可以通过此接口查询特定规则集的配置和状态信息。
ListWafPhases	列举WAF运行阶段	列举指定站点的WAF运行阶段及其关联的规则集信息。
ListWafRulesets	列举WAF规则集	列举出当前WAF运行阶段下的规则集列表，通过此接口查看分页查询规则集的基本信息和状态。
UpdateWafRuleset	更新WAF规则集	根据WAF规则集的ID更新WAF规则集。
DeleteWafRuleset	删除WAF规则集	删除指定的WAF规则集。通过此接口，用户可以移除不再需要的Web应用防火墙规则集。
GetWafRule	获取单个WAF规则详情	获取Web应用防火墙（WAF）中单个规则的详细信息。通过此接口，用户可以查询特定规则的配置和状态。
ListWafRules	列举WAF规则	列出Web应用防火墙（WAF）下的所有规则或根据特定条件筛选规则，用户可以使用此接口以分页形式查询WAF规则的详细信息。
ListWafTemplateRules	列举WAF模板规则	列出Web应用防火墙（WAF）中的模板规则。这些规则通常是预先定义的规则集，用于快速启用对常见攻击类型的防护。
CreateWafRule	创建WAF规则	该接口用于在Web应用防火墙（WAF）中创建新的规则。这可以用于细化防火墙的行为，以提高网站或应用的安全性。
BatchCreateWafRules	批量创建WAF规则	该接口用于在指定的WAF运行阶段中批量创建规则。通过此接口，用户可以一次性创建多个规则，并为这些规则配置共享的设置。
UpdateWafRule	更新WAF规则	该接口用于更新Web应用防火墙（WAF）中的单个规则。通过此接口，用户可以修改特定规则的配置和状态。
BatchUpdateWafRules	批量修改WAF规则	该接口用于在指定的WAF规则集中批量修改规则。通过此接口，用户可以同时更新多个规则的配置。
DeleteWafRule	删除WAF规则	该接口用于删除Web应用防火墙（WAF）中的指定规则，此操作将删除与该规则相关联的配置和条件。
ListWafManagedRules	列举WAF托管规则	列出Web应用防火墙（WAF）下的所有托管规则或根据特定条件筛选规则，用户可以使用此接口以分页形式查询WAF托管规则的详细信息。
ListManagedRulesGroups	列举WAF托管规则组	列举用户账户下所有WAF托管规则组。用户可以通过此接口获取所有规则组的列表以及它们的概要信息。
GetWafQuota	获取WAF资源相关配额	获取Web应用防火墙（WAF）相关资源的配额详情。这些配额定义了客户可以使用的对应资源的数量限制，例如托管规则组、自定义列表、自定义响应页面以及场景防护规则数量等。
GetWafFilter	获取WAF匹配引擎信息	获取指定站点在特定WAF阶段的匹配引擎信息，这些信息定义了WAF如何检测和处理不同类型的网络请求。
GetWafBotAppKey	获取WAF中BOT阶段的APP key	该接口用于获取站点Web应用防火墙（WAF）中BOT行为检测功能的应用密钥 (AppKey)，密钥通常用于与WAF服务进行身份验证和数据交换。
ListWafUsageOfRules	列举WAF规则的使用情况	该接口用于列举WAF规则使用情况。
GetSiteWafSettings	获取站点的WAF配置	该接口用于获取站点WAF配置。
EditSiteWafSettings	编辑站点的WAF配置	该接口用于编辑站点的Web应用防火墙（WAF）配置。用户可以通过此接口修改站点的WAF设置，如修改WAF识别的客户端IP等。
BatchGetExpressionFields	批量获取表达式的匹配域	该接口用于批量获取表达式的匹配项。
DDoS	DDoS
SetHttpDDoSAttackProtection	设置HTTP DDoS攻击防护配置信息	该接口用于设置HTTP DDoS攻击防护策略模式。
DescribeHttpDDoSAttackIntelligentProtection	查询HTTP DDoS深度学习和防护配置信息	该接口用于查询HTTP DDoS智能防护配置信息，返回DDoS的防护模式以及防护等级。
SetHttpDDoSAttackIntelligentProtection	设置HTTP DDoS深度学习和防护配置信息	该接口用于设置HTTP DDoS深度学习和防护配置信息。
DescribeHttpDDoSAttackProtection	查询HTTP DDoS攻击防护配置信息	该接口用于查询HTTP DDoS攻击防护配置信息。
DescribeDDoSAllEventList	查询DDoS攻击事件列表	该接口用于查询DDoS攻击事件列表。
源站防护	源站防护
CreateOriginProtection	开启源站防护	开启源站防护
DeleteOriginProtection	关闭源站防护	关闭源站防护功能
GetOriginProtection	获取源站防护信息	查询站点源站防护相关配置，包括源站防护开关、回源收敛开关、是否需要更新回源IP白名单，以及回源IP白名单相关详细信息，包括现在站点所使用的回源IP白名单、最新的回源IP白名单以及两者之间的差异。
UpdateOriginProtection	修改源站防护功能	修改源站防护功能，用来开启或关闭回源收敛。
UpdateOriginProtectionIpWhiteList	确认更新站点回源IP白名单到最新版本	确认更新站点回源IP白名单到最新版本

全局配置

API	标题	API概述
CreatePage	创建自定义响应页面	创建自定义错误响应页面。当用户的请求被Web应用防火墙（WAF）阻断时，可以展示这些自定义的错误页面。用户可以配置页面HTML内容、页面类型、描述等信息，并通过BASE64编码方式提交页面内容。
DeletePage	删除自定义响应页面	删除已创建的自定义响应页面。当一个自定义的响应页面不再需要时，用户可以调用此接口来将其从系统中移除。
UpdatePage	更新自定义响应页面	更新用户已创建的自定义响应页面，可以通过此接口修改页面名称、描述、内容类型及内容本身。
ListPages	列举自定义响应页面	列举用户已创建的所有自定义响应页面。该接口提供了分页功能，支持根据页码和页大小获取响应页面列表。
GetPage	获取单个自定义响应页面详情	根据自定义响应页面的ID获取单个自定义响应页面详情。
CreateList	创建自定义列表	创建新的自定义列表，这些列表通常用于规则匹配引擎中值的引用，以便在各种安全策略中实现复杂的逻辑和控制。
DeleteList	删除自定义列表	删除自定义列表，如果不再需要某个列表，可以通过此接口进行删除。
UpdateList	更新自定义列表	该接口用于更新自定义列表。
ListLists	列举自定义列表	列举账户下所有自定义的列表以及它们的详细信息，可以通过传入的查询参数进行筛选，以及进行分页处理来获取特定的列表集合。
GetList	获取单个自定义列表详情	获取单个自定义列表的详细信息，用户可以通过此接口查询特定列表的属性，包括名称、描述、种类以及列表内容。
EnableCustomScenePolicy	启用定制场景策略	启用指定的定制场景策略。
DisableCustomScenePolicy	禁用定制场景策略	禁用指定的定制场景策略。
DescribeCustomScenePolicies	查询定制场景策略	查询定制场景策略配置。
DeleteCustomScenePolicy	删除定制场景策略	删除指定的定制场景策略配置信息。
UpdateCustomScenePolicy	修改定制场景策略	修改指定的定制场景策略配置信息。
CreateCustomScenePolicy	创建定制场景策略	创建用户级别定制场景策略，关联站点后执行相对应的策略。

边缘计算

API	标题	API概述
边缘函数	边缘函数
CreateRoutine	创建边缘函数	创建一个边缘函数（Routine）。
DeleteRoutineCodeVersion	删除边缘函数版本代码	删除边缘函数Routine某版本代码。
DeleteRoutine	删除边缘函数	删除边缘数Routine。
GetRoutineUserInfo	查询用户边缘函数服务用户信息	查询边缘函数服务用户级别的相关信息（绑定的subdomain，以及创建的routine列表）。
PublishRoutineCodeVersion	发布边缘函数某版本代码	发布边缘函数某版本代码，可发布到测试环境或生产环境。发布到生产环境可选择灰度发布到特定区域。
GetRoutineStagingEnvIp	查询边缘函数测试环境IP	查询边缘函数测试环境IP列表。
GetErService	查询边缘函数服务状态	检查边缘函数服务的当前运行状况。
CommitRoutineStagingCode	提交边缘函数测试版本代码	提交边缘函数Routine的测试版本（unstable）代码，生成正式版本。
GetRoutine	查询边缘函数配置	查询边缘函数Routine的所有配置信息，包含代码版本列表、环境配置信息列表、关联域名配置信息列表、关联路由配置信息列表等。
ListRoutineOptionalSpecs	查询可选Routine规格	根据用户当前套餐类型，响应可选择spec规格列表。返回所有spec规格，通过IsAvailable来标记是否可用。
GetRoutineStagingCodeUploadInfo	获取上传边缘函数测试代码上传信息	获取边缘函数Routine上传测试版本代码的上传信息，用于上传测试版本代码到OSS。
ListRoutineCanaryAreas	查询边缘函数灰度区域列表	查询边缘函数代码可灰度区域列表，如Beijing、Shanghai、Tianjin等。
边缘容器	边缘容器
ListEdgeContainerApps	获取边缘容器应用列表	获取边缘容器应用列表，包括用户该账号下创建的所有边缘应用。
DeleteEdgeContainerAppVersion	删除边缘容器应用的指定版本	删除边缘容器应用的版本。
DeleteEdgeContainerAppRecord	删除某个边缘容器应用的关联域名	删除某个边缘容器应用的关联域名，删除之后则无法再通过此域名访问到边缘容器服务。
CreateEdgeContainerAppRecord	创建边缘容器应用的关联域名	创建边缘容器应用的关联域名，用户从客户端发起请求访问关联的域名，请求最终会被转发到用户的部署的边缘应用。
RollbackEdgeContainerAppVersion	回滚边缘容器应用	回滚边缘容器应用的某个版本，可以通过此接口快速回退异常版本，及时止损。
RebuildEdgeContainerAppStagingEnv	重建边缘容器应用的测试环境	重新构建边缘容器应用的测试环境。
PublishEdgeContainerAppVersion	发布边缘容器的指定版本	发布边缘容器的指定版本，用户可以通过此接口进行应用的版本迭代。
ListEdgeContainerAppVersions	获取边缘容器应用的版本列表	获取边缘容器应用的版本列表，包括用户创建成功的所有应用列表信息。
GetEdgeContainerTerminal	获取边缘容器应用终端信息	该接口用于获取边缘容器应用终端信息。
GetEdgeContainerStagingDeployStatus	获取应用测试环境部署状态	根据应用ID获取应用测试环境部署状态。
GetEdgeContainerLogs	获取边缘容器日志信息	该接口用于获取边缘容器日志信息。输出行数可指定。
GetEdgeContainerDeployRegions	获取边缘容器应用部署区域	根据应用ID获取边缘容器应用部署区域。
GetEdgeContainerAppVersion	获取边缘容器应用的版本信息	获取边缘容器应用的版本信息，通过版本信息选择某个版本进行发布。
GetEdgeContainerAppStatus	获取边缘容器的应用状态信息	获取边缘容器的应用状态信息，包括应用的部署、发布、回滚等信息。
GetEdgeContainerApp	获取边缘容器的应用信息	获取边缘容器的应用信息，包括应用基础配置、健康检查等信息。
DeleteEdgeContainerApp	删除边缘容器应用	根据应用ID删除不再需要的边缘容器应用。
CreateEdgeContainerAppVersion	创建边缘容器应用版本	创建边缘容器应用版本，可以按照版本进行应用的迭代发布。
CreateEdgeContainerApp	创建边缘容器的应用	创建边缘容器的应用，通过应用的版本部署和发布完成边缘服务的容器化。
ListEdgeContainerAppRecords	获取边缘容器应用的关联域名列表	获取与边缘容器应用相关联的所有域名的列表。
边缘存储	边缘存储
GetKvAccount	查询账户的KV服务使用信息	查询账户在KV服务的使用信息，包含所有的KV存储空间列表等信息。
DescribeKvAccountStatus	查询账户的KV状态信息	查询账户在KV服务的状态信息。
CreateKvNamespace	创建KV存储空间	在当前账号下创建一个KV存储空间。
DeleteKvNamespace	删除KV存储空间	删除账号拥有的单个KV存储空间。
UpdateKvNamespace	更新KV存储空间的名字	更新账号下指定KV存储空间的名字。
GetKvNamespace	查询KV存储空间信息	查询账号下某个KV存储空间的信息。
PutKv	设置KV存储空间的单个键值对	设置KV存储空间的单个键值对，请求大小限制为2M。
DeleteKv	删除KV存储空间的单个键值对	从KV存储空间中删除一个特定的键值对。
GetKv	查询KV存储空间的某个键值对	查询Key-Value对的某个Key值。
BatchPutKv	批量设置KV存储空间的键值对	根据指定的键名列表来批量设置指定KV存储空间的键值对。
BatchDeleteKv	批量删除KV存储空间的键值对	根据指定的键名列表来批量删除指定KV存储空间的键值对。
PutKvWithHighCapacity	设置KV存储空间的单个大容量键值对	设置KV存储空间的单个大容量键值对，最大支持25M的值内容。
BatchPutKvWithHighCapacity	批量设置KV存储空间的大容量键值对	根据指定的键名列表来批量设置指定KV存储空间的键值对，请求体最大支持100M。
BatchDeleteKvWithHighCapacity	批量删除KV存储空间的大容量的键值对	根据指定的键名列表批量删除指定KV存储空间下的键值对，最大允许上传100M的请求体。
ListKvs	列出KV存储空间的键值对	列出账号下指定KV存储空间的所有键值对。

日志服务

API	标题	API概述
UpdateUserDeliveryTaskStatus	上下线任务投递状态	上线和下线一个用户任务投递。
UpdateUserDeliveryTask	修改用户任务投递配置	修改用户的任务投递配置，允许设置任务名、选择字段、指定实时日志类型和调整丢弃率。
UpdateSiteDeliveryTaskStatus	实时日志任务投递状态修改	修改实时日志任务投递状态。
UpdateSiteDeliveryTask	修改实时日志任务投递	对用户的实时日志任务投递进行修改。
UpdateSiteCustomLog	修改站点自定义日志字段	更新站点日志抓取时的自定义请求头、响应头及Cookie字段配置。
ListUserDeliveryTasks	查询用户任务投递列表	列出用户的全部任务投递记录，支持按业务类型筛选、分页查询。
ListSiteDeliveryTasks	列出全部实时日志任务投递	列出所有当前正在实时进行的日志任务投递情况。
GetUserLogDeliveryQuota	获取实时日志投递配额	查询指定用户各业务类型的日志投递剩余配额。
GetUserDeliveryTask	获取用户任务投递详情	查询指定用户的任务投递配置及状态信息。
GetSiteLogDeliveryQuota	获取站点日志投递配额	查询指定站点与业务类型的实时日志投递剩余配额。
GetSiteDeliveryTask	获取投递任务的配置信息	获取一个实时日志任务投递的相关信息。
GetSiteCustomLog	获取自定义日志字段	查询指定站点的自定义日志字段配置详情。
GetRealtimeDeliveryField	获取实时日志字段列表	根据日志业务类型获取实时日志对应的字段列表。
DeleteUserDeliveryTask	删除用户投递任务	根据指定任务名与阿里云UID删除用户任务投递配置。
DeleteSiteDeliveryTask	删除实时日志任务投递	删除正在进行的日志任务投递。
CreateUserDeliveryTask	创建用户粒度日志投递任务	用于新建用户自定义的日志投递任务至SLS、HTTP、OSS、S3或Kafka等目标。
CreateSiteCustomLog	创建站点自定义日志字段	用于添加站点日志中的自定义请求头、响应头及Cookie字段配置。
CreateSiteDeliveryTask	新建实时日志投递任务	新建一个实时日志投递任务。
CheckSiteProjectName	实时日志任务投递名检查	检查实时日志任务项目名称。
CheckUserProjectName	检查实时日志用户投递项目名	实时日志用户任务投递名检查。

其他

API	标题	API概述
ChangeResourceGroup	切换站点资源组	将站点切换到新的资源组。
GetCacheReserveSpecification	查询可购买的缓存保持规格	查询当前可购买的缓存保持规格列表。
ListUserRatePlanInstances	查询用户套餐实例列表	查询该用户已购买的套餐实例及其详细信息。
ListInstanceQuotas	查询实例的配额详情	根据配额名称查询当前实例或者站点对应的套餐的配额详情。
ListEdgeRoutinePlans	查询边缘函数套餐列表	查询可用的边缘函数套餐列表。
ListCacheReserveInstances	查询缓存保持实例列表	查询当前用户的缓存保持实例列表。
ListInstanceQuotasWithUsage	查询实例的配额以及用量	根据站点或者实例ID，查询对应实例套餐的某些配额以及当前的用量详情。
DeleteRoutineRelatedRecord	删除边缘函数关联记录	删除边缘函数Routine的关联记录。
DeleteRoutineRelatedRoute	删除边缘函数关联路由	删除边缘函数Routine的关联路由。
CreateRoutineRelatedRecord	创建边缘函数关联记录	添加边缘函数Routine的关联站点记录，在站点下添加一条新的记录，用于触发执行边缘函数程序代码。
CreateRoutineRelatedRoute	创建边缘函数关联路由	添加边缘函数Routine的关联站点路由，在站点下添加一条新的规则，用于触发执行边缘函数程序代码。
ListCiphers	查询密码套件列表	根据密码套件组名称，查询密码套件名称列表。
ListClientCaCertificates	获取客户端CA证书列表	获取指定站点下的客户端CA证书列表。
DeleteClientCaCertificate	删除客户端CA证书	删除指定的客户端CA证书。
UploadClientCaCertificate	上传客户端CA证书	上传客户端CA证书。
CreateClientCertificate	创建客户端证书	使用ESA CA签发客户端证书。
RevokeClientCertificate	吊销客户端证书	吊销已激活的客户端证书。
GetCertificateQuota	查询免费证书配额和用量	查询免费证书的配额和用量。
GetClientCaCertificate	获取客户端CA证书	获取指定的客户端CA证书。
GetClientCertificate	获取客户端证书信息	获取指定的客户端证书信息。
DeleteClientCertificate	删除客户端证书	删除已吊销的客户端证书。
DeleteCertificate	删除站点证书	删除站点下的特定证书。