API概览

更新时间:
复制为 MD 格式

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

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

站点管理

API

标题

API概述

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

站点配置

API

标题

API概述

站点状态 站点状态
站点暂停 站点暂停
UpdateSitePause 修改站点暂停配置 修改站点暂停配置。
GetSitePause 查询站点暂停配置 查询站点暂停配置。
站点名称独占 站点名称独占
UpdateSiteNameExclusive 修改站点名称独占配置 修改站点名称独占配置。开启该功能后,其他的账号不再能创建当前站点的同名站点或子站点。
GetSiteNameExclusive 查询站点名称独占配置 查询站点名称独占配置。开启该功能后,其他的账号不再能创建当前站点的同名站点或子站点。
版本管理 版本管理
DeactivateVersionManagement 关闭站点版本管理 关闭站点的版本管理功能。
ActivateVersionManagement 开启站点版本管理 开启版本管理。使站点支持多个配置版本与多个部署环境,可以更灵活地管理站点的流量与配置。
DNS DNS
SaaS域名 SaaS域名
CreateCustomHostname 创建 SaaS 域名 在站点下创建一个 SaaS 域名。
DeleteCustomHostname 删除 SaaS 域名 根据 HostnameId,删除站点下的单条 SaaS 域名。
UpdateCustomHostname 更新 SaaS 域名 更新 SaaS 域名,支持修改绑定的记录 ID、证书类型等。
VerifyCustomHostname 校验 SaaS 域名归属 校验 SaaS 域名归属,通过校验的站点将自动被激活。
GetCustomHostname 查询 SaaS 域名详情 获取单条 SaaS 域名的详细配置信息,包括域名验证 TXT 名称、域名验证 TXT 内容、证书过期时间(开启 SSL)等。
ListCustomHostnames 查询 SaaS 域名列表 查询站点下的 SaaS 域名列表,包括 SaaS 域名的 ID、状态、域名验证信息等。支持根据 SaaS 域名的名称、站点 ID、绑定的记录 ID 等条件过滤。
ApplyCustomHostnameCertificate 重新申请 SaaS 域名的免费证书 重新申请 SaaS 域名的免费证书,仅支持当前免费证书申请失败、即将过期、已过期时调用。
DNS记录 DNS记录
CreateRecord 创建解析记录 在站点下创建一条DNS解析记录。
BatchCreateRecords 批量创建解析记录 批量添加DNS解析记录,支持多种记录类型。
DeleteRecord 删除DNS记录 根据RecordId,删除站点下的单条DNS解析记录。
UpdateRecord 更新解析记录 更新DNS解析记录,支持多种记录类型及源站鉴权配置。
ListRecords 查询解析记录列表 查询站点下解析记录列表,包括记录值、优先级、认证配置等。支持根据记录名称、记录类型等条件进行过滤。
GetRecord 查询解析记录详情 获取单条DNS解析记录的详细配置信息,包括记录值、优先级、回源鉴权配置(CNAME记录独有)等。
ListEdgeRoutineRecords 查询边缘路由记录列表 查询站点下的边缘路由记录列表。
ListEdgeContainerRecords 查询边缘容器记录列表 查询站点的边缘容器记录。
ExportRecords 导出记录 导出站点下的所有DNS记录,以固定的文本格式返回结果。
CNAME拉平 CNAME拉平
UpdateCnameFlattening 修改站点CNAME拉平配置 修改站点CNAME拉平配置。
GetCnameFlattening 查询站点CNAME拉平配置 查询站点CNAME拉平配置。
SSL/TLS SSL/TLS
站点证书 站点证书
ApplyCertificate 申请免费证书 申请免费证书。
SetCertificate 配置站点证书 用于设置某站点下是否启用证书功能及更新证书信息。
GetCertificate 获取指定证书信息 获取站点下指定证书信息。
DeleteCertificate 删除站点证书 删除站点下的特定证书。
ListCertificates 查询站点证书列表 查询特定站点下的证书列表。
ListCertificatesByRecord 查询匹配记录的站点证书列表 查看匹配记录的站点证书列表,支持批量记录匹配。
GetCertificateQuota 查询免费证书配额和用量 查询免费证书的配额和用量。
ListCiphers 查询密码套件列表 根据密码套件组名称,查询密码套件名称列表。
客户端证书 客户端证书
UploadClientCaCertificate 上传客户端CA证书 上传客户端CA证书。
GetClientCaCertificate 获取客户端CA证书 获取指定的客户端CA证书。
DeleteClientCaCertificate 删除客户端CA证书 删除指定的客户端CA证书。
ListClientCaCertificates 获取客户端CA证书列表 获取指定站点下的客户端CA证书列表。
CreateClientCertificate 创建客户端证书 使用ESA CA签发客户端证书。
GetClientCertificate 获取客户端证书信息 获取指定的客户端证书信息。
DeleteClientCertificate 删除客户端证书 删除已吊销的客户端证书。
ListClientCertificates 获取客户端证书列表 获取指定站点下客户端证书列表。
ActivateClientCertificate 激活客户端证书 根据证书ID激活客户端。
RevokeClientCertificate 吊销客户端证书 吊销已激活的客户端证书。
SetClientCertificateHostnames 设置客户端证书域名绑定 给指定的客户端CA证书绑定域名,不指定证书时,域名绑定到ESA CA证书。
GetClientCertificateHostnames 获取客户端证书的域名绑定 获取指定客户端CA证书的域名绑定列表,当不指定证书时,返回ESA CA证书的域名绑定列表。
源站证书 源站证书
UploadOriginCaCertificate 上传源服务器CA证书 上传源服务器CA证书。
GetOriginCaCertificate 获取源服务器CA证书信息 获取源服务器CA证书信息。
DeleteOriginCaCertificate 删除源服务器CA证书 删除源服务器CA证书。
ListOriginCaCertificates ListOriginCaCertificates 查询源服务器CA证书列表。
UploadSiteOriginClientCertificate 上传站点粒度回源客户端证书 上传站点粒度回源客户端证书。
GetSiteOriginClientCertificate 获取站点粒度回源客户端证书信息 获取站点粒度回源客户端证书信息。
DeleteSiteOriginClientCertificate 删除站点粒度回源客户端证书 删除站点粒度回源客户端证书。
ListSiteOriginClientCertificates ListSiteOriginClientCertificates 查询站点粒度回源客户端证书列表。
UploadOriginClientCertificate 上传域名粒度回源客户端证书 上传域名粒度回源客户端证书。
GetOriginClientCertificate 获取域名粒度回源客户端证书信息 获取域名粒度回源客户端证书信息。
DeleteOriginClientCertificate 删除域名粒度回源客户端证书 删除域名粒度回源客户端证书。
ListOriginClientCertificates 查询域名粒度回源客户端证书列表 查询域名粒度回源客户端证书列表。
SetOriginClientCertificateHostnames 为域名粒度回源客户端证书绑定域名 为域名粒度回源客户端证书绑定域名。
GetOriginClientCertificateHostnames 获取域名粒度回源客户端证书绑定的域名列表 获取域名粒度回源客户端证书绑定的域名列表。
安全防护 安全防护
WAF WAF
CreateWafRule 创建WAF规则 该接口用于在Web应用防火墙(WAF)中创建新的规则。这可以用于细化防火墙的行为,以提高网站或应用的安全性。
CreateWafRuleset 创建WAF规则集 创建WAF规则集。
BatchCreateWafRules 批量创建WAF规则 该接口用于在指定的WAF运行阶段中批量创建规则。通过此接口,用户可以一次性创建多个规则,并为这些规则配置共享的设置。
GetWafRule 获取单个WAF规则详情 获取Web应用防火墙(WAF)中单个规则的详细信息。通过此接口,用户可以查询特定规则的配置和状态。
GetWafRuleset 获取单个WAF规则集详情 获取指定的WAF规则集详情。用户可以通过此接口查询特定规则集的配置和状态信息。
ListWafRules 列举WAF规则 列出Web应用防火墙(WAF)下的所有规则或根据特定条件筛选规则,用户可以使用此接口以分页形式查询WAF规则的详细信息。
ListWafRulesets 列举WAF规则集 列举出当前WAF运行阶段下的规则集列表,通过此接口查看分页查询规则集的基本信息和状态。
UpdateWafRule 更新WAF规则 该接口用于更新Web应用防火墙(WAF)中的单个规则。通过此接口,用户可以修改特定规则的配置和状态。
UpdateWafRuleset 更新WAF规则集 根据WAF规则集的ID更新WAF规则集。
BatchUpdateWafRules 批量修改WAF规则 该接口用于在指定的WAF规则集中批量修改规则。通过此接口,用户可以同时更新多个规则的配置。
DeleteWafRule 删除WAF规则 该接口用于删除Web应用防火墙(WAF)中的指定规则,此操作将删除与该规则相关联的配置和条件。
DeleteWafRuleset 删除WAF规则集 删除指定的WAF规则集。通过此接口,用户可以移除不再需要的Web应用防火墙规则集。
ListWafPhases 列举WAF运行阶段 列举指定站点的WAF运行阶段及其关联的规则集信息。
ListWafTemplateRules 列举WAF模板规则 列出Web应用防火墙(WAF)中的模板规则。这些规则通常是预先定义的规则集,用于快速启用对常见攻击类型的防护。
ListWafManagedRules 列举WAF托管规则 列出Web应用防火墙(WAF)下的所有托管规则或根据特定条件筛选规则,用户可以使用此接口以分页形式查询WAF托管规则的详细信息。
ListManagedRulesGroups 列举WAF托管规则组 列举用户账户下所有WAF托管规则组。用户可以通过此接口获取所有规则组的列表以及它们的概要信息。
ListWafUsageOfRules 列举WAF规则的使用情况 该接口用于列举WAF规则使用情况。
GetWafQuota 获取WAF资源相关配额 获取Web应用防火墙(WAF)相关资源的配额详情。这些配额定义了客户可以使用的对应资源的数量限制,例如托管规则组、自定义列表、自定义响应页面以及场景防护规则数量等。
GetWafFilter 获取WAF匹配引擎信息 获取指定站点在特定WAF阶段的匹配引擎信息,这些信息定义了WAF如何检测和处理不同类型的网络请求。
GetWafBotAppKey 获取WAFBOT阶段的APP key 该接口用于获取站点Web应用防火墙(WAF)中BOT行为检测功能的应用密钥 (AppKey),密钥通常用于与WAF服务进行身份验证和数据交换。
GetSiteWafSettings 获取站点的WAF配置 该接口用于获取站点WAF配置。
EditSiteWafSettings 编辑站点的WAF配置 该接口用于编辑站点的Web应用防火墙(WAF)配置。用户可以通过此接口修改站点的WAF设置,如修改WAF识别的客户端IP等。
BatchGetExpressionFields 批量获取表达式的匹配域 该接口用于批量获取表达式的匹配项。
DDoS DDoS
SetHttpDDoSAttackRuleStatus 设置HTTP DDoS攻击防护指定规则防护状态 设置HTTP DDoS攻击防护指定规则防护状态
SetHttpDDoSAttackRuleAction 设置HTTP DDoS攻击防护指定规则防护动作 设置HTTP DDoS攻击防护指定规则防护动作。
DescribeHttpDDoSAttackRules 查询HTTP DDoS攻击防护规则 查询HTTP DDoS攻击防护规则。
SetHttpDDoSAttackProtection 设置HTTP DDoS攻击防护配置信息 该接口用于设置HTTP DDoS攻击防护策略模式。
DescribeHttpDDoSAttackProtection 查询HTTP DDoS攻击防护配置信息 该接口用于查询HTTP DDoS攻击防护配置信息。
DescribeDDoSBpsList 查询DDoS网络层数据 查询DDoS网络层BPS、PPS数据。
DescribeDDoSL7QpsList 查询DDoS应用层时间维度聚合统计信息 调用DescribeDdosL7QpsList查询DDoS应用层时间维度聚合统计信息。
DescribeDDoSAllEventList 查询DDoS攻击事件列表 该接口用于查询DDoS攻击事件列表。
SetDdosMaxBurstGbps 设置DDoS实例的国内最大防护带宽 设置DDoS实例的国内最大防护带宽
DescribeDdosMaxBurstGbps 查询DDoS实例的国内最大防护带宽 查询DDoS实例的国内最大防护带宽
SetHttpDDoSAttackIntelligentProtection 设置HTTP DDoS深度学习和防护配置信息 该接口用于设置HTTP DDoS深度学习和防护配置信息。
DeleteHttpDDoSIntelligentRule 删除深度学习和防护下发的规则 删除深度学习和防护下发的规则
DescribeHttpDDoSAttackIntelligentProtection 查询HTTP DDoS深度学习和防护配置信息 该接口用于查询HTTP DDoS智能防护配置信息,返回DDoS的防护模式以及防护等级。
DescribeHttpDDoSIntelligentRateLimitRules 查询深度学习和防护下发的频率控制规则 查询深度学习和防护下发的频率控制规则。
DescribeHttpDDoSIntelligentAclRules 查询深度学习和防护下发的精准访问控制规则 查询深度学习和防护下发的精准访问控制规则。
API 安全 API 安全
GetApiSchemaUsage 获取架构验证上传文件套餐配额用量信息 获取架构验证上传文件套餐配额用量信息
源站防护 源站防护
CreateOriginProtection 开启源站防护 开启源站防护。
DeleteOriginProtection 关闭源站防护 关闭源站防护功能。
UpdateOriginProtection 修改源站防护功能 修改源站防护功能,用来开启或关闭回源收敛。
UpdateOriginProtectionIpWhiteList 确认更新站点回源IP白名单到最新版本 确认更新站点回源IP白名单到最新版本。
GetOriginProtection 获取源站防护信息 查询站点源站防护相关配置,包括源站防护开关、回源收敛开关、是否需要更新回源IP白名单,以及回源IP白名单相关详细信息,包括现在站点所使用的回源IP白名单、最新的回源IP白名单以及两者之间的差异。
缓存 缓存
开发模式 开发模式
UpdateDevelopmentMode 修改站点开发模式配置 修改站点开发模式配置。功能开启的情况下,能够让所有请求都绕过边缘节点上的缓存组件,直接传递到源服务器,以便于能够实时查看源站服务器上的最新资源。
GetDevelopmentMode 查询站点开发模式配置 查询站点开发模式配置。
刷新缓存 刷新缓存
PurgeCaches 刷新节点缓存 刷新节点上的文件内容。支持文件、目录、缓存标记、去参数、主机名及全站刷新。
DescribePurgeTasks 查询刷新任务 查询刷新任务的执行情况。
GetPurgeQuota 获取刷新配额 获取不同刷新类型的配额及配额已使用量。
缓存标签 缓存标签
UpdateCacheTag 修改站点缓存标签配置 修改站点缓存标签配置,在使用按缓存标签刷新功能时,用于指定源站响应信息中携带的CacheTag名称。
GetCacheTag 查询站点缓存标签配置 查询站点缓存标签配置,在使用按缓存标签刷新功能时,用于指定源站响应信息中携带的CacheTag名称。
批量刷新预热 批量刷新预热
UploadFile 上传刷新或者预热文件 上传刷新或预热文件以提高访问速度。
GetUploadTask 查询文件上传任务状态 通过文件上传任务ID查询对应任务的执行状态及运行信息。
ListUploadTasks 列出文件上传任务 根据时间及类型列出文件上传任务的执行状态及运行信息。
预热缓存 预热缓存
PreloadCaches 预热URL 缓存预热。
DescribePreloadTasks 查询预热任务详情 查询任务预热详情,支持按时间、任务状态、预热URL进行分页查询。
定时预热 定时预热
CreateScheduledPreloadJob 新增定时预热任务 添加一个定时预热任务。
CreateScheduledPreloadExecutions 批量新增定时预热任务的计划 制定批量新增定时预热任务的计划。
StartScheduledPreloadExecution 开始单个定时预热计划 根据预热计划ID开启一个定时预热。
StopScheduledPreloadExecution 停止单个定时预热计划 根据预热计划ID停止单个定时预热计划。
DeleteScheduledPreloadExecution 删除单个定时预热计划 根据预热计划ID删除单个定时预热计划。
DeleteScheduledPreloadJob 删除指定定时预热任务 根据定时预热任务ID删除指定定时预热任务。
UpdateScheduledPreloadExecution 更新单个定时预热计划 根据预热计划ID更新一个定时预热。
ResetScheduledPreloadJob 重置定时预热任务的进度 重置定时预热任务的进度,从头开始预热。
GetScheduledPreloadJob 查询单个定时预热任务 根据定时预热任务ID查询单个定时预热任务。
ListScheduledPreloadJobs 列出定时预热任务列表 列出站点下的定时预热任务列表。
ListScheduledPreloadExecutions 列出指定定时预热任务下的执行计划 根据定时预热任务ID列出指定定时预热任务下的执行计划。
内容封禁 内容封禁
BlockObject URL封禁 对指定URL禁止访问。
多级缓存 多级缓存
UpdateTieredCache 修改站点多级缓存配置 修改站点多级缓存配置。
GetTieredCache 查询站点多级缓存配置 查询站点多级缓存配置。
缓存保持 缓存保持
GetCacheReserveSpecification 查询可购买的缓存保持规格 查询当前可购买的缓存保持规格列表。
ListCacheReserveInstances 查询缓存保持实例列表 查询当前用户的缓存保持实例列表。
PurchaseCacheReserve 购买缓存保持实例 调用PurchaseCacheReserve购买缓存保持实例。
UpdateCacheReserveSpec 缓存保持变配 缓存保持变配。
规则 规则
SSL/TLS规则 SSL/TLS规则
CreateHttpsBasicConfiguration 添加站点HTTPS基础配置 新增站点HTTPS基础配置。
UpdateHttpsBasicConfiguration 修改站点HTTPS基础配置 修改HTTPS基础配置。
GetHttpsBasicConfiguration 查询站点HTTPS基础配置 查询单条HTTPS基础配置。
ListHttpsBasicConfigurations 查询HTTPS基础配置列表 查询多条HTTPS基础配置。
DeleteHttpsBasicConfiguration 删除站点HTTPS基础配置 删除HTTPS基础配置。
HTTPS规则 HTTPS规则
CreateHttpsApplicationConfiguration 添加站点HTTPS应用配置 新增站点HTTPS应用配置。
UpdateHttpsApplicationConfiguration 修改站点HTTPS应用配置 修改HTTPS应用配置。
GetHttpsApplicationConfiguration 查询站点HTTPS应用配置 查询单条HTTPS应用配置。
ListHttpsApplicationConfigurations 查询HTTPS应用配置列表 查询多条HTTPS应用配置。
DeleteHttpsApplicationConfiguration 删除站点HTTPS应用配置 删除HTTPS应用配置。
重定向规则 重定向规则
CreateRedirectRule 创建重定向配置 新增站点的重定向配置。
UpdateRedirectRule 更新重定向配置 修改站点的重定向配置。
GetRedirectRule 查询重定向配置详情 查询站点的重定向配置的详情。
ListRedirectRules 查询重定向配置列表 查询站点的重定向配置列表。
DeleteRedirectRule 删除重定向配置 删除站点的重定向配置。
重写URL 重写URL
CreateRewriteUrlRule 添加重写URL配置 新增站点的重写URL功能配置。
UpdateRewriteUrlRule 修改重写URL配置 修改站点的重写URL配置。
GetRewriteUrlRule 查询重写URL配置 查询重写URL配置详情。
ListRewriteUrlRules 查询站点的重写URL配置列表 查询站点重写URL配置列表。
DeleteRewriteUrlRule 删除重写URL配置 删除站点的重写URL配置。
修改出站请求头(ESA到源站) 修改出站请求头(ESA到源站)
CreateHttpRequestHeaderModificationRule 创建修改HTTP请求头配置 新增站点的修改HTTP请求头配置。
UpdateHttpRequestHeaderModificationRule 更新修改HTTP请求头配置 修改HTTP请求头规则。
GetHttpRequestHeaderModificationRule 查询修改HTTP请求头配置详情 查询站点的修改HTTP请求头配置详情。
ListHttpRequestHeaderModificationRules 查询修改HTTP请求头配置列表 查询修改HTTP请求头配置列表。
DeleteHttpRequestHeaderModificationRule 删除修改HTTP请求头配置 删除站点的修改HTTP请求头配置。
修改入站请求头(客户端到ESA) 修改入站请求头(客户端到ESA)
CreateHttpIncomingRequestHeaderModificationRule 创建修改HTTP入站请求头配置 新增站点的修改HTTP入站请求头配置。
UpdateHttpIncomingRequestHeaderModificationRule 更新修改HTTP入站请求头配置 修改HTTP入站请求头配置。
GetHttpIncomingRequestHeaderModificationRule 查询修改HTTP入站请求头配置详情 查询站点的修改HTTP入站请求头配置详情
ListHttpIncomingRequestHeaderModificationRules 查询修改HTTP入站请求头配置列表 查询站点的修改HTTP入站请求头配置列表。
DeleteHttpIncomingRequestHeaderModificationRule 删除修改HTTP入站请求头配置 删除站点的修改HTTP入站请求头配置。
修改出站响应头(ESA到客户端) 修改出站响应头(ESA到客户端)
CreateHttpResponseHeaderModificationRule 创建修改HTTP响应头配置 新增HTTP修改响应头配置。
UpdateHttpResponseHeaderModificationRule 更新修改HTTP响应头配置 更新站点的修改HTTP响应头配置。
GetHttpResponseHeaderModificationRule 查询修改HTTP响应头配置详情 查询站点的修改HTTP响应头配置详情。
ListHttpResponseHeaderModificationRules 查询修改HTTP响应头的配置列表 查询站点的修改HTTP响应头的配置列表。
DeleteHttpResponseHeaderModificationRule 删除修改HTTP响应头配置 删除站点的修改HTTP响应头配置。
修改入站响应头(源站到ESA) 修改入站响应头(源站到ESA)
CreateHttpIncomingResponseHeaderModificationRule 创建修改HTTP入站响应头配置 新增站点的修改HTTP入站响应头配置。
UpdateHttpIncomingResponseHeaderModificationRule 更新修改HTTP入站响应头配置 更新站点的修改HTTP入站响应头配置。
GetHttpIncomingResponseHeaderModificationRule 查询修改HTTP入站响应头配置详情 查询站点的修改HTTP入站响应头配置详情。
ListHttpIncomingResponseHeaderModificationRules 查询修改HTTP入站响应头的配置列表 查询站点的修改HTTP入站响应头的配置列表,
DeleteHttpIncomingResponseHeaderModificationRule 删除修改HTTP入站响应头配置 删除站点的修改HTTP入站响应头配置。
自定义响应码 自定义响应码
CreateCustomResponseCodeRule 创建修改响应码配置 新增站点的修改响应码配置。
UpdateCustomResponseCodeRule 更新修改响应码配置 修改站点的修改响应码配置。
DeleteCustomResponseCodeRule 删除修改响应码配置 删除站点的修改响应码配置。
GetCustomResponseCodeRule 查询修改响应码配置详情 查询站点的修改响应码配置详情。
ListCustomResponseCodeRules 查询修改响应码配置列表 查询站点的修改响应码配置列表。
托管转换 托管转换
UpdateManagedTransform 修改站点托管转换配置 修改站点托管转换配置。
GetManagedTransform 查询站点托管转换配置 查询站点托管转换配置。
缓存规则 缓存规则
CreateCacheRule 添加站点缓存配置 新增站点缓存配置。
UpdateCacheRule 修改站点缓存配置 修改缓存配置。
GetCacheRule 查询站点缓存配置 查询单条缓存配置。
ListCacheRules 查询站点缓存配置列表 查询多条缓存配置。
DeleteCacheRule 删除站点缓存配置 删除缓存配置。
网络优化规则 网络优化规则
CreateNetworkOptimization 添加站点网络优化配置 新增站点网络优化配置。
UpdateNetworkOptimization 修改站点网络优化配置 修改网络优化配置。
GetNetworkOptimization 查询站点网络优化配置 查询单条网络优化配置。
ListNetworkOptimizations 查询网络优化配置列表 查询多条网络优化配置。
DeleteNetworkOptimization 删除站点网络优化配置 删除网络优化配置。
文件压缩 文件压缩
CreateCompressionRule 创建压缩规则配置 新增站点的压缩规则配置。
UpdateCompressionRule 修改压缩规则配置 修改站点的压缩规则配置。
GetCompressionRule 查询压缩规则配置详情 查询站点的压缩规则详情。
ListCompressionRules 查询压缩规则配置列表 查询压缩规则配置列表。
DeleteCompressionRule 删除压缩规则配置 删除站点的压缩规则配置。
图像处理 图像处理
CreateImageTransform 新增站点图片转换配置 新增站点图片转换配置。
UpdateImageTransform 修改站点图片转换配置 修改站点图片转换配置。
GetImageTransform 查询单条站点图片转换配置 查询单条站点图片转换配置。
ListImageTransforms 查询多条站点图片转换配置 查询多条站点图片转换配置列表。
DeleteImageTransform 删除站点图片转换配置 删除站点图片转换配置。
视频处理 视频处理
CreateVideoProcessing 新增站点视频处理配置 新增站点视频处理配置。
UpdateVideoProcessing 修改站点视频处理配置 修改站点视频处理配置。
GetVideoProcessing 查询站点视频处理配置详情 查询站点视频处理配置详情。
ListVideoProcessings 查询站点视频处理配置列表 查询站点视频处理配置列表。
DeleteVideoProcessing 删除站点视频处理配置 删除站点视频处理配置。
回源规则 回源规则
CreateOriginRule 添加站点回源规则配置 新增站点回源规则配置。
UpdateOriginRule 修改站点回源规则配置 修改站点回源规则配置。
GetOriginRule 查询站点回源规则配置 查询单条回源规则配置。
ListOriginRules 查询站点回源规则配置列表 查询多条回源规则配置。
DeleteOriginRule 删除站点回源规则配置 删除回源规则配置。
速度和网络 速度和网络
IPv6 IPv6
UpdateIPv6 修改站点IPv6配置 修改站点IPv6配置。
GetIPv6 查询站点IPv6配置 查询站点IPv6配置。
网页监测 网页监测
CreateUrlObservation 创建网页监测配置 创建网页监测配置。
UpdateUrlObservation 更新网页监测配置 更新网页监测配置。
DescribeUrlObservationData 查询网页观测质量数据 查询网页观测质量数据。
ListUrlObservations 查询网页监测配置列表 查询网页观测配置列表。
DeleteUrlObservation 删除网页监测配置 删除网页监测配置。
中国大陆网络-接入优化 中国大陆网络-接入优化
GetCrossBorderOptimization 查询站点中国大陆网络接入优化配置 查询站点中国大陆网络接入优化配置。
UpdateCrossBorderOptimization 修改站点中国大陆网络接入优化配置 修改站点中国大陆网络接入优化配置。
流量 流量
等候室 等候室
CreateWaitingRoom 创建等候室 创建站点等候室。
UpdateWaitingRoom 更新等候室 更新指定等候室的配置信息。
ListWaitingRooms 查询等候室列表 查询指定站点下已配置的所有等候室的详细信息。
DeleteWaitingRoom 删除等候室 通过站点删除等候室。
CreateWaitingRoomRule 创建等候室绕过规则 创建一个等候室绕过规则。
UpdateWaitingRoomRule 修改等候室绕过规则 更新指定站点的等候室绕过规则配置。
ListWaitingRoomRules 查询等候室绕过规则列表 查询等候室对应的等候室绕过规则列表。
DeleteWaitingRoomRule 删除等候室绕过规则 通过站点删除等候室绕过规则。
CreateWaitingRoomEvent 创建等候室事件 创建等候室事件,可以选择排队方式以及类型等。
UpdateWaitingRoomEvent 更新等候室事件 更新等候室事件的相关配置。
ListWaitingRoomEvents 查询等候室事件列表 查询等候室的等候室事件详情。
DeleteWaitingRoomEvent 删除等候室事件 删除等候室对应的事件。
UpdateSeoBypass 修改站点放行搜索引擎爬虫配置 修改站点放行搜索引擎爬虫配置。
GetSeoBypass 查询站点放行搜索引擎爬虫配置 查询站点放行搜索引擎爬虫配置。
源地址池 源地址池
CreateOriginPool 创建源地址池 在站点在创建源地址池,创建成功后,源地址池可以用于负载均衡器,也可以用于记录直接回源。
UpdateOriginPool 修改单个源地址池 修改单个源地址池,传入源地址池ID指定单个源地址池,进行修改。
GetOriginPool 查询单个源地址池 根据源地址池ID获取单条源地址池信息。
ListOriginPools 查询源地址池列表 查询站点下所有源地址池,支持分页,可以按源地址名称精确查询、模糊查询。
DeleteOriginPool 删除源地址池 传入源地址池ID,删除一条源地址池。
负载均衡 负载均衡
CreateLoadBalancer 创建负载均衡器 用于创建一个新的负载均衡器实例,支持自定义路由策略、会话保持、监控配置等高级功能。
UpdateLoadBalancer 修改已有负载均衡器信息 修改已有的负载均衡器信息,需要带上负载均衡器ID来标识要修改哪个负载均衡器。
GetLoadBalancer 查询单个负载均衡器 根据指定站点ID和负载均衡器ID,获取单个负载均衡器的详细信息。
ListLoadBalancers 查询站点下负载均衡器 查询站点下负载均衡器列表,返回站点下的负载均衡器信息。可以根据负载均衡器名称查询,支持分页。
DeleteLoadBalancer 删除负载均衡器 删除指定的负载均衡器。
ListLoadBalancerRegions 查询负载均衡器区域信息 查询负载均衡器一/二级区域信息,获取可用于配置负载均衡器“基于国家/区域调度”策略的地理区域代码、含义等基本信息。
ListLoadBalancerOriginStatus 查询负载均衡器下源站状态 查询负载均衡器下源站状态,一次可以传多个负载均衡器id,用逗号拼接。
四层代理 四层代理
CreateTransportLayerApplication 创建四层加速应用 创建一个四层加速应用。
UpdateTransportLayerApplication 更新四层加速应用 修改指定站点下四层应用的转发规则等配置。
GetTransportLayerApplication 查询四层加速应用 查询四层应用详情。
ListTransportLayerApplications 查询站点的四层加速应用列表 查询站点对应的四层应用列表。
DeleteTransportLayerApplication 删除四层加速应用 删除四层加速应用。
函数路由 函数路由
ListSiteRoutes 查询站点的函数路由列表 查询站点的函数路由列表。

边缘计算

API

标题

API概述

边缘函数 边缘函数
OpenErService 开通边缘函数服务 开通用户边缘函数服务。
GetErService 查询边缘函数服务状态 检查边缘函数服务的当前运行状况。
ListUserRoutines 查询用户Routine列表 分页获取用户创建的边缘函数列表及配额信息。
CreateRoutine 创建边缘函数 创建一个边缘函数(Routine)。
GetRoutine 查询边缘函数配置 查询边缘函数Routine的所有配置信息,包含代码版本列表、环境配置信息列表、关联域名配置信息列表、关联路由配置信息列表等。
DeleteRoutine 删除边缘函数 删除边缘数Routine。
CreateRoutineRoute 新增边缘函数路由配置 新增边缘函数路由配置。
UpdateRoutineRoute 修改边缘函数路由配置 修改边缘函数路由配置。
GetRoutineRoute 查询单条边缘函数路由配置 查询单条边缘函数路由配置。
ListRoutineRoutes 查询边缘程序的函数路由列表 查询边缘程序的函数路由列表。
DeleteRoutineRoute 删除边缘函数路由配置 删除边缘函数路由配置。
CreateRoutineCodeDeployment 创建边缘函数代码版本部署 用于在指定环境中按比例灰度发布Routine代码版本。
CommitRoutineStagingCode 提交边缘函数测试版本代码 提交边缘函数Routine的测试版本(unstable)代码,生成正式版本。
GetRoutineCodeVersion 查询边缘函数某版本代码信息 查询边缘程序某版本号代码信息。
ListRoutineCodeVersions 查询Routine代码版本列表 分页查询指定Routine程序的代码版本信息
GetRoutineStagingCodeUploadInfo 获取上传边缘函数测试代码上传信息 获取边缘函数Routine上传测试版本代码的上传信息,用于上传测试版本代码到OSS。
DeleteRoutineCodeVersion 删除边缘函数版本代码 删除边缘函数Routine某版本代码。
UpdateRoutineConfigDescription 修改边缘函数描述 修改边缘函数Routine描述信息。
CreateRoutineRelatedRecord 创建边缘函数关联记录 添加边缘函数Routine的关联站点记录,在站点下添加一条新的记录,用于触发执行边缘函数程序代码。
ListRoutineRelatedRecords 查询边缘函数关联记录列表 查询边缘函数关联记录列表。
DeleteRoutineRelatedRecord 删除边缘函数关联记录 删除边缘函数Routine的关联记录。
边缘容器 边缘容器
容器应用 容器应用
CreateEdgeContainerApp 创建边缘容器的应用 创建边缘容器的应用,通过应用的版本部署和发布完成边缘服务的容器化。
GetEdgeContainerApp 获取边缘容器的应用信息 获取边缘容器的应用信息,包括应用基础配置、健康检查等信息。
ListEdgeContainerApps 获取边缘容器应用列表 获取边缘容器应用列表,包括用户该账号下创建的所有边缘应用。
DeleteEdgeContainerApp 删除边缘容器应用 根据应用ID删除不再需要的边缘容器应用。
UpdateEdgeContainerAppResourceReserve 更新边缘容器应用资源预留配置 更新边缘容器资源预留配置。
GetEdgeContainerAppResourceReserve 获取边缘容器应用资源预留配置 获取边缘容器资源预留配置。
GetEdgeContainerTerminal 获取边缘容器应用终端信息 该接口用于获取边缘容器应用终端信息。
GetEdgeContainerAppStatus 获取边缘容器的应用状态信息 获取边缘容器的应用状态信息,包括应用的部署、发布、回滚等信息。
DescribeEdgeContainerAppStats 提供ESA边缘容器的各项指标监控数据 提供ESA边缘容器的各项指标监控数据。
GetEdgeContainerAppResourceStatus 获取边缘容器应用资源分布 获取边缘容器应用资源分布。
GetEdgeContainerAppResourceCapacity 获取边缘容器应用资源容量 获取边缘容器应用的资源容量
容器应用镜像密钥 容器应用镜像密钥
CreateEdgeContainerAppImageSecret 创建边缘容器应用镜像秘钥 创建边缘容器应用的镜像秘钥
ListEdgeContainerAppImageSecrets 获取边缘容器应用镜像秘钥列表 获取边缘容器应用的镜像秘钥列表
DeleteEdgeContainerAppImageSecret 删除边缘容器应用镜像秘钥 删除边缘容器应用的镜像秘钥
日志 日志
UpdateEdgeContainerAppLogRiver 更新边缘容器日志采集配置信息 更新边缘容器应用日志采集配置。
GetEdgeContainerAppLogRiver 获取边缘容器日志采集配置信息 获取边缘容器应用日志采集配置。
GetEdgeContainerLogs 获取边缘容器日志信息 该接口用于获取边缘容器日志信息。输出行数可指定。
触发器 触发器
CreateEdgeContainerAppRecord 创建边缘容器应用的关联域名 创建边缘容器应用的关联域名,用户从客户端发起请求访问关联的域名,请求最终会被转发到用户的部署的边缘应用。
DeleteEdgeContainerAppRecord 删除某个边缘容器应用的关联域名 删除某个边缘容器应用的关联域名,删除之后则无法再通过此域名访问到边缘容器服务。
ListEdgeContainerAppRecords 获取边缘容器应用的关联域名列表 获取与边缘容器应用相关联的所有域名的列表。
版本管理 版本管理
CreateEdgeContainerAppVersion 创建边缘容器应用版本 创建边缘容器应用版本,可以按照版本进行应用的迭代发布。
DeleteEdgeContainerAppVersion 删除边缘容器应用的指定版本 删除边缘容器应用的版本。
ListEdgeContainerAppVersions 获取边缘容器应用的版本列表 获取边缘容器应用的版本列表,包括用户创建成功的所有应用列表信息。
GetEdgeContainerDeployRegions 获取边缘容器应用部署区域 根据应用ID获取边缘容器应用部署区域。
GetEdgeContainerAppVersion 获取边缘容器应用的版本信息 获取边缘容器应用的版本信息,通过版本信息选择某个版本进行发布。
GetEdgeContainerStagingDeployStatus 获取应用测试环境部署状态 根据应用ID获取应用测试环境部署状态。
PublishEdgeContainerAppVersion 发布边缘容器的指定版本 发布边缘容器的指定版本,用户可以通过此接口进行应用的版本迭代。
RebuildEdgeContainerAppStagingEnv 重建边缘容器应用的测试环境 重新构建边缘容器应用的测试环境。
RollbackEdgeContainerAppVersion 回滚边缘容器应用 回滚边缘容器应用的某个版本,可以通过此接口快速回退异常版本,及时止损。
边缘存储 边缘存储
服务状态查询 服务状态查询
DescribeKvAccountStatus 查询账户的KV状态信息 查询账户在KV服务的状态信息。
GetKvAccount 查询账户的KV服务使用信息 查询账户在KV服务的使用信息,包含所有的KV存储空间列表等信息。
键值对设置 键值对设置
GetKvDetail 查询键值对的值和TTL信息 查询键值对的值和TTL信息。
ListKvs 列出KV存储空间的键值对 列出账号下指定KV存储空间的所有键值对。
GetKv 查询KV存储空间的某个键值对 查询Key-Value对的某个Key值。
PutKv 设置KV存储空间的单个键值对 设置KV存储空间的单个键值对,请求大小限制为2M。
DeleteKv 删除KV存储空间的单个键值对 KV存储空间中删除一个特定的键值对。
BatchPutKv 批量设置KV存储空间的键值对 根据指定的键名列表来批量设置指定KV存储空间的键值对。
BatchDeleteKv 批量删除KV存储空间的键值对 根据指定的键名列表来批量删除指定KV存储空间的键值对。
PutKvWithHighCapacity 设置KV存储空间的单个大容量键值对 设置KV存储空间的单个大容量键值对,最大支持25M的值内容。
BatchPutKvWithHighCapacity 批量设置KV存储空间的大容量键值对 根据指定的键名列表来批量设置指定KV存储空间的键值对,请求体最大支持100M。
BatchDeleteKvWithHighCapacity 批量删除KV存储空间的大容量的键值对 根据指定的键名列表批量删除指定KV存储空间下的键值对,最大允许上传100M的请求体。
存储空间 存储空间
CreateKvNamespace 创建KV存储空间 在当前账号下创建一个KV存储空间。
DeleteKvNamespace 删除KV存储空间 删除账号拥有的单个KV存储空间。
GetKvNamespace 查询KV存储空间信息 查询账号下某个KV存储空间的信息。

分析和日志

API

标题

API概述

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

全局配置

API

标题

API概述

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

工具

API

标题

API概述

ListESAIPInfo ListESAIPInfo 批量查询IP是否为ESA产品解析结果IP。

计费管理

API

标题

API概述

套餐管理 套餐管理
PurchaseRatePlan 套餐新购 调用PurchaseRatePlan购买套餐。
UpdateRatePlanSpec 套餐变配 调用UpdateRatePlanSpec修改套餐规格。
DescribeRatePlanInstanceStatus 查询套餐实例状态 调用DescribeRatePlanInstanceStatus查询套餐实例状态。
ListEdgeRoutinePlans 查询边缘函数套餐列表 查询可用的边缘函数套餐列表。
ListUserRatePlanInstances 查询用户套餐实例列表 查询该用户已购买的套餐实例及其详细信息。
ListInstanceQuotas 查询实例的配额详情 根据配额名称查询当前实例或者站点对应的套餐的配额详情。
用量查询 用量查询
ListInstanceQuotasWithUsage 查询实例的配额以及用量 根据站点或者实例ID,查询对应实例套餐的某些配额以及当前的用量详情。