API概览

本产品(边缘安全加速/2024-09-10)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

站点管理

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

站点配置

API标题API概述
版本管理版本管理
DeactivateVersionManagement关闭站点版本管理关闭站点的版本管理功能。
ActivateVersionManagement开启站点版本管理开启版本管理。使站点支持多个配置版本与多个部署环境,可以更灵活地管理站点的流量与配置。
DNSDNS
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拉平配置。
HTTTPS证书HTTTPS证书
站点证书站点证书
SetCertificate配置站点证书用于设置某站点下是否启用证书功能及更新证书信息。
ApplyCertificate申请免费证书申请免费证书。
GetCertificate获取指定证书信息获取站点下指定证书信息。
DeleteCertificate删除站点证书删除站点下的特定证书。
ListCertificates查询站点证书列表查询特定站点下的证书列表。
GetCertificateQuota查询免费证书配额和用量查询免费证书的配额和用量。
ListCiphers查询密码套件列表根据密码套件组名称,查询密码套件名称列表。
客户端证书客户端证书
CreateClientCertificate创建客户端证书使用ESA CA签发客户端证书。
ActivateClientCertificate激活客户端证书根据证书ID激活客户端。
DeleteClientCertificate删除客户端证书删除已吊销的客户端证书。
RevokeClientCertificate吊销客户端证书吊销已激活的客户端证书。
SetClientCertificateHostnames设置客户端证书域名绑定给指定的客户端CA证书绑定域名,不指定证书时,域名绑定到ESA CA证书。
GetClientCertificateHostnames获取客户端证书的域名绑定获取指定客户端CA证书的域名绑定列表,当不指定证书时,返回ESA CA证书的域名绑定列表。
GetClientCertificate获取客户端证书信息获取指定的客户端证书信息。
ListClientCertificates获取客户端证书列表获取指定站点下客户端证书列表。
UploadClientCaCertificate上传客户端CA证书上传客户端CA证书。
DeleteClientCaCertificate删除客户端CA证书删除指定的客户端CA证书。
GetClientCaCertificate获取客户端CA证书获取指定的客户端CA证书。
ListClientCaCertificates获取客户端CA证书列表获取指定站点下的客户端CA证书列表。
安全防护安全防护
WAFWAF
ListWafPhases列举WAF运行阶段列举指定站点的WAF运行阶段及其关联的规则集信息。
ListWafTemplateRules列举WAF模板规则列出Web应用防火墙(WAF)中的模板规则。这些规则通常是预先定义的规则集,用于快速启用对常见攻击类型的防护。
ListWafManagedRules列举WAF托管规则列出Web应用防火墙(WAF)下的所有托管规则或根据特定条件筛选规则,用户可以使用此接口以分页形式查询WAF托管规则的详细信息。
ListManagedRulesGroups列举WAF托管规则组列举用户账户下所有WAF托管规则组。用户可以通过此接口获取所有规则组的列表以及它们的概要信息。
GetWafQuota获取WAF资源相关配额获取Web应用防火墙(WAF)相关资源的配额详情。这些配额定义了客户可以使用的对应资源的数量限制,例如托管规则组、自定义列表、自定义响应页面以及场景防护规则数量等。
GetWafFilter获取WAF匹配引擎信息获取指定站点在特定WAF阶段的匹配引擎信息,这些信息定义了WAF如何检测和处理不同类型的网络请求。
GetWafBotAppKey获取WAFBOT阶段的APP key该接口用于获取站点Web应用防火墙(WAF)中BOT行为检测功能的应用密钥 (AppKey),密钥通常用于与WAF服务进行身份验证和数据交换。
ListWafUsageOfRules列举WAF规则的使用情况该接口用于列举WAF规则使用情况。
GetSiteWafSettings获取站点的WAF配置该接口用于获取站点WAF配置。
EditSiteWafSettings编辑站点的WAF配置该接口用于编辑站点的Web应用防火墙(WAF)配置。用户可以通过此接口修改站点的WAF设置,如修改WAF识别的客户端IP等。
BatchGetExpressionFields批量获取表达式的匹配域该接口用于批量获取表达式的匹配项。
DDoSDDoS
SetHttpDDoSAttackProtection设置HTTP DDoS攻击防护配置信息该接口用于设置HTTP DDoS攻击防护策略模式。
DescribeHttpDDoSAttackProtection查询HTTP DDoS攻击防护配置信息该接口用于查询HTTP DDoS攻击防护配置信息。
DescribeDDoSBpsList查询DDoS网络层数据查询DDoS网络层BPS、PPS数据。
DescribeDDoSL7QpsList查询DDoS应用层时间维度聚合统计信息调用DescribeDdosL7QpsList查询DDoS应用层时间维度聚合统计信息。
SetHttpDDoSAttackIntelligentProtection设置HTTP DDoS深度学习和防护配置信息该接口用于设置HTTP DDoS深度学习和防护配置信息。
DescribeHttpDDoSAttackIntelligentProtection查询HTTP DDoS深度学习和防护配置信息该接口用于查询HTTP DDoS智能防护配置信息,返回DDoS的防护模式以及防护等级。
DescribeDDoSAllEventList查询DDoS攻击事件列表该接口用于查询DDoS攻击事件列表。
源站防护源站防护
CreateOriginProtection开启源站防护开启源站防护。
DeleteOriginProtection关闭源站防护关闭源站防护功能。
UpdateOriginProtection修改源站防护功能修改源站防护功能,用来开启或关闭回源收敛。
UpdateOriginProtectionIpWhiteList确认更新站点回源IP白名单到最新版本确认更新站点回源IP白名单到最新版本。
GetOriginProtection获取源站防护信息查询站点源站防护相关配置,包括源站防护开关、回源收敛开关、是否需要更新回源IP白名单,以及回源IP白名单相关详细信息,包括现在站点所使用的回源IP白名单、最新的回源IP白名单以及两者之间的差异。
缓存内容管理缓存内容管理
刷新缓存刷新缓存
PurgeCaches刷新节点缓存刷新节点上的文件内容。支持文件、目录、缓存标记、去参数、主机名及全站刷新。
DescribePurgeTasks查询刷新任务查询刷新任务的执行情况。
GetPurgeQuota获取刷新配额获取不同刷新类型的配额及配额已使用量。
批量刷新预热批量刷新预热
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列出指定定时预热任务下的执行计划。
内容封禁内容封禁
BlockObjectURL封禁对指定URL禁止访问。
全局配置全局配置
站点暂停站点暂停
UpdateSitePause修改站点暂停配置修改站点暂停配置。
GetSitePause查询站点暂停配置查询站点暂停配置。
站点名称独占站点名称独占
UpdateSiteNameExclusive修改站点名称独占配置修改站点名称独占配置。开启该功能后,其他的账号不再能创建当前站点的同名站点或子站点。
GetSiteNameExclusive查询站点名称独占配置查询站点名称独占配置。开启该功能后,其他的账号不再能创建当前站点的同名站点或子站点。
开发模式开发模式
UpdateDevelopmentMode修改站点开发模式配置修改站点开发模式配置。功能开启的情况下,能够让所有请求都绕过边缘节点上的缓存组件,直接传递到源服务器,以便于能够实时查看源站服务器上的最新资源。
GetDevelopmentMode查询站点开发模式配置查询站点开发模式配置。
IPv6IPv6
UpdateIPv6修改站点IPv6配置修改站点IPv6配置。
GetIPv6查询站点IPv6配置查询站点IPv6配置。
托管转换托管转换
UpdateManagedTransform修改站点托管转换配置修改站点托管转换配置。
GetManagedTransform查询站点托管转换配置查询站点托管转换配置。
缓存标签缓存标签
UpdateCacheTag修改站点缓存标签配置修改站点缓存标签配置,在使用按缓存标签刷新功能时,用于指定源站响应信息中携带的CacheTag名称。
GetCacheTag查询站点缓存标签配置查询站点缓存标签配置,在使用按缓存标签刷新功能时,用于指定源站响应信息中携带的CacheTag名称。
多级缓存多级缓存
UpdateTieredCache修改站点多级缓存配置修改站点多级缓存配置。
GetTieredCache查询站点多级缓存配置查询站点多级缓存配置。
缓存保持缓存保持
GetCacheReserveSpecification查询可购买的缓存保持规格查询当前可购买的缓存保持规格列表。
ListCacheReserveInstances查询缓存保持实例列表查询当前用户的缓存保持实例列表。
规则配置规则配置
SSL/TLS规则SSL/TLS规则
CreateHttpsBasicConfiguration添加站点HTTPS基础配置新增站点HTTPS基础配置。
DeleteHttpsBasicConfiguration删除站点HTTPS基础配置删除HTTPS基础配置。
UpdateHttpsBasicConfiguration修改站点HTTPS基础配置修改HTTPS基础配置。
ListHttpsBasicConfigurations查询HTTPS基础配置列表查询多条HTTPS基础配置。
GetHttpsBasicConfiguration查询站点HTTPS基础配置查询单条HTTPS基础配置。
HTTPS规则HTTPS规则
CreateHttpsApplicationConfiguration添加站点HTTPS应用配置新增站点HTTPS应用配置。
DeleteHttpsApplicationConfiguration删除站点HTTPS应用配置删除HTTPS应用配置。
UpdateHttpsApplicationConfiguration修改站点HTTPS应用配置修改HTTPS应用配置。
ListHttpsApplicationConfigurations查询HTTPS应用配置列表查询多条HTTPS应用配置。
GetHttpsApplicationConfiguration查询站点HTTPS应用配置查询单条HTTPS应用配置。
重定向规则重定向规则
CreateRedirectRule创建重定向配置新增站点的重定向配置。
DeleteRedirectRule删除重定向配置删除站点的重定向配置。
UpdateRedirectRule更新重定向配置修改站点的重定向配置。
ListRedirectRules查询重定向配置列表查询站点的重定向配置列表。
GetRedirectRule查询重定向配置详情查询站点的重定向配置的详情。
重写URL重写URL
CreateRewriteUrlRule添加重写URL配置新增站点的重写URL功能配置。
DeleteRewriteUrlRule删除重写URL配置删除站点的重写URL配置。
UpdateRewriteUrlRule修改重写URL配置修改站点的重写URL配置。
ListRewriteUrlRules查询站点的重写URL配置列表查询站点重写URL配置列表。
GetRewriteUrlRule查询重写URL配置查询重写URL配置详情。
修改请求头修改请求头
CreateHttpRequestHeaderModificationRule创建修改HTTP请求头配置新增站点的修改HTTP请求头配置。
DeleteHttpRequestHeaderModificationRule删除修改HTTP请求头配置删除站点的修改HTTP请求头配置。
UpdateHttpRequestHeaderModificationRule更新修改HTTP请求头配置修改HTTP请求头规则。
ListHttpRequestHeaderModificationRules查询修改HTTP请求头配置列表查询修改HTTP请求头配置列表。
GetHttpRequestHeaderModificationRule查询修改HTTP请求头配置详情查询站点的修改HTTP响应头详情。
修改响应头修改响应头
CreateHttpResponseHeaderModificationRule创建修改HTTP响应头配置新增HTTP修改响应头配置。
DeleteHttpResponseHeaderModificationRule删除修改HTTP响应头配置删除站点的修改HTTP响应头配置。
UpdateHttpResponseHeaderModificationRule更新修改HTTP响应头配置更新站点的修改HTTP响应头配置。
ListHttpResponseHeaderModificationRules查询修改HTTP响应头的配置列表查询站点的修改HTTP响应头的配置列表。
GetHttpResponseHeaderModificationRule查询修改HTTP响应头配置详情查询站点的修改HTTP响应头配置详情。
缓存规则缓存规则
CreateCacheRule添加站点缓存配置新增站点缓存配置。
DeleteCacheRule删除站点缓存配置删除缓存配置。
UpdateCacheRule修改站点缓存配置修改缓存配置。
ListCacheRules查询站点缓存配置列表查询多条缓存配置。
GetCacheRule查询站点缓存配置查询单条缓存配置。
网络优化规则网络优化规则
CreateNetworkOptimization添加站点网络优化配置新增站点网络优化配置。
DeleteNetworkOptimization删除站点网络优化配置删除网络优化配置。
UpdateNetworkOptimization修改站点网络优化配置修改网络优化配置。
ListNetworkOptimizations查询网络优化配置列表查询多条网络优化配置。
GetNetworkOptimization查询站点网络优化配置查询单条网络优化配置。
图像处理图像处理
CreateImageTransform新增站点图片转换配置新增站点图片转换配置。
DeleteImageTransform删除站点图片转换配置删除站点图片转换配置。
UpdateImageTransform修改站点图片转换配置修改站点图片转换配置。
ListImageTransforms查询多条站点图片转换配置查询多条站点图片转换配置列表。
GetImageTransform查询单条站点图片转换配置查询单条站点图片转换配置。
文件压缩文件压缩
CreateCompressionRule创建压缩规则配置新增站点的压缩规则配置。
DeleteCompressionRule删除压缩规则配置删除站点的压缩规则配置。
UpdateCompressionRule修改压缩规则配置修改站点的压缩规则配置。
ListCompressionRules查询压缩规则配置列表查询压缩规则配置列表。
GetCompressionRule查询压缩规则配置详情查询站点的压缩规则详情。
回源规则回源规则
CreateOriginRule添加站点回源规则配置新增站点回源规则配置。
DeleteOriginRule删除站点回源规则配置删除回源规则配置。
UpdateOriginRule修改站点回源规则配置修改站点回源规则配置。
ListOriginRules查询站点回源规则配置列表查询多条回源规则配置。
GetOriginRule查询站点回源规则配置查询单条回源规则配置。
流量流量
等候室等候室
CreateWaitingRoom创建等候室创建站点等候室。
DeleteWaitingRoom删除等候室通过站点删除等候室。
UpdateWaitingRoom更新等候室更新指定等候室的配置信息。
ListWaitingRooms查询等候室列表查询指定站点下已配置的所有等候室的详细信息。
CreateWaitingRoomRule创建等候室绕过规则创建一个等候室绕过规则。
DeleteWaitingRoomRule删除等候室绕过规则通过站点删除等候室绕过规则。
UpdateWaitingRoomRule修改等候室绕过规则更新指定站点的等候室绕过规则配置。
ListWaitingRoomRules查询等候室绕过规则列表查询等候室对应的等候室绕过规则列表。
CreateWaitingRoomEvent创建等候室事件创建等候室事件,可以选择排队方式以及类型等。
DeleteWaitingRoomEvent删除等候室事件删除等候室对应的事件。
UpdateWaitingRoomEvent更新等候室事件更新等候室事件的相关配置。
ListWaitingRoomEvents查询等候室事件列表查询等候室的等候室事件详情。
UpdateSeoBypass修改站点放行搜索引擎爬虫配置修改站点放行搜索引擎爬虫配置。
GetSeoBypass查询站点放行搜索引擎爬虫配置查询站点放行搜索引擎爬虫配置。
负载均衡负载均衡
CreateLoadBalancer创建负载均衡器用于创建一个新的负载均衡器实例,支持自定义路由策略、会话保持、监控配置等高级功能。
DeleteLoadBalancer删除负载均衡器删除指定的负载均衡器。
UpdateLoadBalancer修改已有负载均衡器信息修改已有的负载均衡器信息,需要带上负载均衡器ID来标识要修改哪个负载均衡器。
ListLoadBalancerOriginStatus查询负载均衡器下源站状态查询负载均衡器下源站状态,一次可以传多个负载均衡器id,用逗号拼接。
ListLoadBalancers查询站点下负载均衡器查询站点下负载均衡器列表,返回站点下的负载均衡器信息。可以根据负载均衡器名称查询,支持分页。
ListLoadBalancerRegions查询负载均衡器区域信息查询负载均衡器一/二级区域信息,获取可用于配置负载均衡器“基于国家/区域调度”策略的地理区域代码、含义等基本信息。
GetLoadBalancer查询单个负载均衡器根据指定站点ID和负载均衡器ID,获取单个负载均衡器的详细信息。
CreateOriginPool创建源地址池在站点在创建源地址池,创建成功后,源地址池可以用于负载均衡器,也可以用于记录直接回源。
DeleteOriginPool删除源地址池传入源地址池ID,删除一条源地址池。
UpdateOriginPool修改单个源地址池修改单个源地址池,传入源地址池ID指定单个源地址池,进行修改。
ListOriginPools查询源地址池列表查询站点下所有源地址池,支持分页,可以按源地址名称精确查询、模糊查询。
GetOriginPool查询单个源地址池根据源地址池ID获取单条源地址池信息。

全局配置

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

边缘计算

API标题API概述
边缘容器边缘容器
容器管理容器管理
CreateEdgeContainerApp创建边缘容器的应用创建边缘容器的应用,通过应用的版本部署和发布完成边缘服务的容器化。
DeleteEdgeContainerApp删除边缘容器应用根据应用ID删除不再需要的边缘容器应用。
ListEdgeContainerApps获取边缘容器应用列表获取边缘容器应用列表,包括用户该账号下创建的所有边缘应用。
GetEdgeContainerTerminal获取边缘容器应用终端信息该接口用于获取边缘容器应用终端信息。
GetEdgeContainerAppStatus获取边缘容器的应用状态信息获取边缘容器的应用状态信息,包括应用的部署、发布、回滚等信息。
GetEdgeContainerApp获取边缘容器的应用信息获取边缘容器的应用信息,包括应用基础配置、健康检查等信息。
DescribeEdgeContainerAppStats提供ESA边缘容器的各项指标监控数据提供ESA边缘容器的各项指标监控数据。
日志日志
UpdateEdgeContainerAppLogRiver更新边缘容器日志采集配置信息更新边缘容器应用日志采集配置。
GetEdgeContainerAppLogRiver获取边缘容器日志采集配置信息获取边缘容器应用日志采集配置。
GetEdgeContainerLogs获取边缘容器日志信息该接口用于获取边缘容器日志信息。输出行数可指定。
触发器触发器
CreateEdgeContainerAppRecord创建边缘容器应用的关联域名创建边缘容器应用的关联域名,用户从客户端发起请求访问关联的域名,请求最终会被转发到用户的部署的边缘应用。
DeleteEdgeContainerAppRecord删除某个边缘容器应用的关联域名删除某个边缘容器应用的关联域名,删除之后则无法再通过此域名访问到边缘容器服务。
ListEdgeContainerAppRecords获取边缘容器应用的关联域名列表获取与边缘容器应用相关联的所有域名的列表。
版本管理版本管理
CreateEdgeContainerAppVersion创建边缘容器应用版本创建边缘容器应用版本,可以按照版本进行应用的迭代发布。
DeleteEdgeContainerAppVersion删除边缘容器应用的指定版本删除边缘容器应用的版本。
ListEdgeContainerAppVersions获取边缘容器应用的版本列表获取边缘容器应用的版本列表,包括用户创建成功的所有应用列表信息。
GetEdgeContainerDeployRegions获取边缘容器应用部署区域根据应用ID获取边缘容器应用部署区域。
GetEdgeContainerAppVersion获取边缘容器应用的版本信息获取边缘容器应用的版本信息,通过版本信息选择某个版本进行发布。
GetEdgeContainerStagingDeployStatus获取应用测试环境部署状态根据应用ID获取应用测试环境部署状态。
PublishEdgeContainerAppVersion发布边缘容器的指定版本发布边缘容器的指定版本,用户可以通过此接口进行应用的版本迭代。
RebuildEdgeContainerAppStagingEnv重建边缘容器应用的测试环境重新构建边缘容器应用的测试环境。
RollbackEdgeContainerAppVersion回滚边缘容器应用回滚边缘容器应用的某个版本,可以通过此接口快速回退异常版本,及时止损。
边缘存储边缘存储
存储管理存储管理
DescribeKvAccountStatus查询账户的KV状态信息查询账户在KV服务的状态信息。
GetKvAccount查询账户的KV服务使用信息查询账户在KV服务的使用信息,包含所有的KV存储空间列表等信息。
命名空间命名空间
CreateKvNamespace创建KV存储空间在当前账号下创建一个KV存储空间。
DeleteKvNamespace删除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概述
实时日志实时日志
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获取投递任务的配置信息获取一个实时日志任务投递的相关信息。

计费管理

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