All Products
Search
Document Center

Edge Security Acceleration:List of operations by function

Last Updated:Dec 24, 2025
This product(ESA/2024-09-10) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Website management

APITitleDescription
Add and verify websiteAdd and verify website
CreateSiteCreateSiteAdds a website.
CheckSiteNameCheckSiteNameChecks whether a specified website name is available.
VerifySiteVerifySiteVerifies the ownership of a website domain. Websites that pass the verification are automatically activated.
GetSiteCurrentNSGetSiteCurrentNSQueries the nameservers configured for a website.
Query websiteQuery website
GetSiteGetSiteQueries information about a website based on the website ID.
ListSitesListSitesQueries the information about websites in your account, such as the name, status, and configuration of each website.
Update and delete websiteUpdate and delete website
DeleteSiteDeleteSiteDeletes a website based on the specified website ID.
UpdateSiteAccessTypeUpdateSiteAccessTypeConverts the DNS setup option of a website.
UpdateSiteCoverageUpdateSiteCoverageModifies the service location for a single website. This updates the acceleration configuration of the website to adapt to changes in traffic distribution, and improve user experience in specific regions.
UpdateSiteVanityNSUpdateSiteVanityNSUpdates the custom nameserver names for a single website.
Manage tagsManage tags
TagResourcesTagResourcesAdds one or more tags to resources.
UntagResourcesUntagResourcesDeletes a resource tag based on a specified resource ID.
ListTagResourcesListTagResourcesQueries tags based on the region ID and resource type.

Website configuration

APITitleDescription
Site StatusSite Status
Suspend websiteSuspend website
UpdateSitePauseUpdateSitePauseModifies the ESA proxy configuration of a website.
GetSitePauseGetSitePauseQueries the ESA proxy configuration of a website.
Make website name exclusiveMake website name exclusive
UpdateSiteNameExclusiveUpdateSiteNameExclusiveModifies the site hold configuration of a website. After you enable site hold, other accounts cannot add your website domain or its subdomains to ESA.
GetSiteNameExclusiveGetSiteNameExclusiveQueries the site hold configuration of a website. After you enable site hold, other accounts cannot add your website domain or its subdomains to ESA.
Version managementVersion management
DeactivateVersionManagementDeactivateVersionManagementDisables version management for a website.
ActivateVersionManagementActivateVersionManagementEnable Version Management
DNSDNS
DNS recordsDNS records
CreateRecordCreateRecordCreates a DNS record for a specific website.
BatchCreateRecordsBatchCreateRecordsAdds DNS records of different record types at a time..
DeleteRecordDeleteRecordDeletes a DNS record of a website based on the specified RecordId.
UpdateRecordUpdateRecordUpdates multiple types of DNS records and origin authentication configurations.
ListRecordsListRecordsQueries a list of Domain Name System (DNS) records of a website, including the record value, priority, and authentication configurations. Supports filtering by specifying parameters such as RecordName and RecordMatchType.
GetRecordGetRecordQueries the configuration of a single DNS record, such as the record value, priority, and origin authentication setting (exclusive to CNAME records).
ListEdgeRoutineRecordsListEdgeRoutineRecordsQueries the records that are associated with Edge Routine routes for a website.
ListEdgeContainerRecordsListEdgeContainerRecordsQueries the records that are associated with Edge Container for a website.
ExportRecordsExportRecordsExports all DNS records of a website domain as a TXT file.
CNAME flatteningCNAME flattening
UpdateCnameFlatteningUpdateCnameFlatteningModifies the CNAME flattening configuration of a website.
GetCnameFlatteningGetCnameFlatteningQueries the CNAME flattening configuration of a website
HTTPS certificatesHTTPS certificates
Website certificatesWebsite certificates
SetCertificateSetCertificateConfigures whether to enable certificates and update certificate information for a website.
ApplyCertificateApplyCertificateApplies for a free SSL certificate.
GetCertificateGetCertificateRetrieve the certificate, private key, and certificate information
DeleteCertificateDeleteCertificateDeletes a certificate for a website.
ListCertificatesListCertificatesLists certificates of a website.
GetCertificateQuotaGetCertificateQuotaQuery certificate quota and usage
ListCiphersListCiphersQuery TLS Cipher Suite List
Client certificatesClient certificates
DeleteOriginClientCertificateDeleteOriginClientCertificate
DeleteSiteOriginClientCertificateDeleteSiteOriginClientCertificate
GetOriginClientCertificateGetOriginClientCertificate
GetOriginClientCertificateHostnamesGetOriginClientCertificateHostnames
GetSiteOriginClientCertificateGetSiteOriginClientCertificate
SetOriginClientCertificateHostnamesSetOriginClientCertificateHostnames
UploadOriginCaCertificateUploadOriginCaCertificate
CreateClientCertificateCreateClientCertificateUses the ESA-managed certificate authority (CA) to issue client certificates.
ActivateClientCertificateActivateClientCertificateActivates the client based on the certificate ID.
DeleteClientCertificateDeleteClientCertificateDeletes a revoked client certificate.
RevokeClientCertificateRevokeClientCertificateRevokes an activated client certificate.
SetClientCertificateHostnamesSetClientCertificateHostnamesAssociates domain names with a client CA certificate. If no certificate is specified, domain names are associated with an Edge Security Acceleration (ESA)-managed CA certificate.
GetClientCertificateHostnamesGetClientCertificateHostnamesQueries domain names associated with a client CA certificate. If no certificate is specified, domain names associated with an Edge Security Acceleration(ESA)-managed CA certificate are returned.
GetClientCertificateGetClientCertificateQueries information about a client certificate.
ListClientCertificatesListClientCertificatesQueries client certificates configured for a website.
UploadClientCaCertificateUploadClientCaCertificateUploads a client certificate authority (CA) certificate.
DeleteClientCaCertificateDeleteClientCaCertificateDeletes a client CA certificate.
GetClientCaCertificateGetClientCaCertificateQueries a client CA certificate.
ListClientCaCertificatesListClientCaCertificatesQueries a list of client certificate authority (CA) certificates for a website.
ListCertificatesByRecordListCertificatesByRecordLists certificates that match specified records for a website. You can specify multiple records at a time.
Origin certificatesOrigin certificates
GetOriginCaCertificateGetOriginCaCertificate
DeleteOriginCaCertificateDeleteOriginCaCertificate
ListOriginClientCertificatesListOriginClientCertificates
ListOriginCaCertificatesListOriginCaCertificates
UploadOriginClientCertificateUploadOriginClientCertificate
UploadSiteOriginClientCertificateUpload Site-level Origin Client CertificateUpload site origin client certificate
SecuritySecurity
WAFWAF
CreateWafRuleCreate WAF RuleCreate WAF Rule
CreateWafRulesetCreate WAF RulesetCreate WAF Ruleset
BatchCreateWafRulesBatch Create WAF RulesBatch Create WAF Rules
GetWafRuleGet Details of a Single WAF RuleGet Details of a Single WAF Rule
GetWafRulesetGet Details of a Single WAF RulesetGet WAF Ruleset Details
ListWafRulesList WAF RulesList WAF Rules
ListWafRulesetsList WAF Rule SetsList WAF Rule Sets
UpdateWafRuleUpdate WAF RuleUpdate WAF Rule Page
UpdateWafRulesetUpdate WAF RulesetUpdate WAF Ruleset
BatchUpdateWafRulesBatchUpdateWafRulesModifies multiple rules in a specific Web Application Firewall (WAF) ruleset at a time.
DeleteWafRuleDelete WAF RuleDelete WAF Rule
DeleteWafRulesetDelete WAF RulesetDelete WAF Ruleset
ListWafPhasesList WAF Operation PhasesList WAF Phases
ListWafTemplateRulesList WAF Template RulesList WAF Template Rules
ListWafManagedRulesList WAF Managed RulesList WAF Managed Rules
ListManagedRulesGroupsList WAF Managed Rule GroupsList Custom Managed Rule Groups
ListWafUsageOfRulesList WAF Rule UsageList WAF Rule Usage
GetWafQuotaGet WAF Resource Related QuotasGet WAF Quota Details
GetWafFilterGetWafFilterQueries the conditions for matching incoming requests that are configured in a WAF rule category for a website. These conditions define how WAF detects and processes different types of requests.
GetWafBotAppKeyGet the APP key in the BOT phase of WAFThis interface is used to obtain the application key (AppKey) for the BOT behavior detection feature in the site's Web Application Firewall (WAF). The key is typically used for authentication and data exchange with the WAF service.
GetSiteWafSettingsGet WAF Configuration for a SiteGet WAF Configuration for a Site
EditSiteWafSettingsEdit WAF Configuration for a SiteEdit WAF Configuration for a Site
BatchGetExpressionFieldsBatch Get Expression Match FieldsBatch Get Expression Matches
DDoSDDoS
SetHttpDDoSAttackProtectionSetHttpDDoSAttackProtectionConfigures HTTP DDoS attack protection for a website.
DescribeHttpDDoSAttackProtectionDescribeHttpDDoSAttackProtectionQueries the configurations of HTTP DDoS attack protection.
DescribeDDoSBpsListQuery DDoS Network Layer DataQuery DCDN DDoS user bps and pps data
DescribeDDoSL7QpsListQuery DDoS Application Layer Time Dimension Aggregated StatisticsDDoS Analysis Layer 7 QPS Trend Chart API
SetHttpDDoSAttackIntelligentProtectionSetHttpDDoSAttackIntelligentProtectionConfigures smart HTTP DDoS protection.
DescribeHttpDDoSAttackIntelligentProtectionDescribeHttpDDoSAttackIntelligentProtectionQueries the configuration of smart HTTP DDoS protection for a website.
DescribeDDoSAllEventListDescribeDDoSAllEventListQueries DDoS attack events.
API securityAPI security
GetApiSchemaUsageGetApiSchemaUsageQueries the usage of the upload file quota for API security schema verification.
Origin protectionOrigin protection
CreateOriginProtectionCreateOriginProtectionEnables origin protection.
DeleteOriginProtectionDeleteOriginProtectionDisables origin protection.
UpdateOriginProtectionUpdateOriginProtectionEnables or disables IP convergence.
UpdateOriginProtectionIpWhiteListUpdateOriginProtectionIpWhiteListUpdates the IP whitelist for origin protection used by a website to the latest version.
GetOriginProtectionGetOriginProtectionQueries the origin protection configurations of a website, including the origin protection, IP convergence, and the status and details of the IP whitelist for origin protection. The details includes the IP whitelist used by the website, the latest IP whitelist, and the differences between them.
CacheCache
Development modeDevelopment mode
UpdateDevelopmentModeUpdateDevelopmentModeModifies the development mode configuration of your website. If you enable Development Mode, all requests bypass caching components on POPs and are redirected to the origin server. This allows clients to retrieve the most recent resources on the origin server.
GetDevelopmentModeGetDevelopmentModeQuery Site Developer Mode Configuration
Purge cachePurge cache
PurgeCachesPurgeCachesPurges resources cached on points of presence (POPs). You can purge the cache by file URL, directory, cache tag, hostname, or URL with specified parameters ignored, or purge all the cache.
DescribePurgeTasksDescribePurgeTasksQueries the details of purge tasks.
GetPurgeQuotaGetPurgeQuotaQueries the quotas and quota usage for different cache purge options.
Cache TagsCache Tags
UpdateCacheTagUpdateCacheTagModifies the cache tag configuration of your website. You can call this operation when you need to specify tags in the Cache-Tag response header to use the purge by cache tag feature.
GetCacheTagQuery Site Cache Tag ConfigurationQuery Site Cache Tag Configuration
Batch purgeBatch purge
UploadFileUploadFileUploads the file that contains resources to be purged or prefetched.
GetUploadTaskGetUploadTaskQueries the execution status and running information of a file upload task based on the task ID.
ListUploadTasksListUploadTasksQueries the execution status and running information of file upload tasks based on the task time and type.
Prefetch cachePrefetch cache
PreloadCachesPreloadCachesPrefetches cache.
DescribePreloadTasksDescribePreloadTasksQueries the details of prefetch tasks by time, task status, or prefetch URL.
Scheduled prefetchScheduled prefetch
CreateScheduledPreloadJobCreateScheduledPreloadJobAdds a scheduled prefetch task.
CreateScheduledPreloadExecutionsCreateScheduledPreloadExecutionsCreates scheduled prefetch plans.
StartScheduledPreloadExecutionStartScheduledPreloadExecutionStarts a scheduled prefetch plan based on the plan ID.
StopScheduledPreloadExecutionStopScheduledPreloadExecutionStops a scheduled prefetch plan based on the plan ID.
DeleteScheduledPreloadExecutionDeleteScheduledPreloadExecutionDeletes a scheduled prefetch plan based on the plan ID.
DeleteScheduledPreloadJobDeleteScheduledPreloadJobDeletes a specified scheduled prefetch task based on the task ID.
UpdateScheduledPreloadExecutionUpdateScheduledPreloadExecutionUpdates a scheduled prefetch plan based on the plan ID.
ResetScheduledPreloadJobResetScheduledPreloadJobResets the progress of a scheduled prefetch task and starts the prefetch from the beginning.
GetScheduledPreloadJobGetScheduledPreloadJobQueries a specified scheduled prefetch task based on the task ID.
ListScheduledPreloadJobsListScheduledPreloadJobsQueries the scheduled prefetch tasks for a website.
ListScheduledPreloadExecutionsListScheduledPreloadExecutionsLists the plans in a scheduled prefetch task by task ID.
Block contentBlock content
BlockObjectBlockObjectBlocks URLs.
Tiered cacheTiered cache
UpdateTieredCacheUpdateTieredCacheModifies the tiered cache configuration of your website.
GetTieredCacheQuery Multi-level Cache Configuration for SiteQuery Multi-level Cache Configuration for Site
Cache reserveCache reserve
GetCacheReserveSpecificationGetCacheReserveSpecificationQueries the available specifications of cache reserve instances.
ListCacheReserveInstancesListCacheReserveInstancesQuery Cache Reserve Instance List
PurchaseCacheReservePurchase Cache RetentionNew Purchase of Cache Retention
UpdateCacheReserveSpecCache Reserve Specification ChangeCache Reserve Specification Change
Rule configurationRule configuration
SSL and TLS rulesSSL and TLS rules
CreateHttpsBasicConfigurationAdd Site HTTPS Basic ConfigurationCreate a new site HTTPS basic configuration
UpdateHttpsBasicConfigurationModify Site HTTPS Basic ConfigurationModify HTTPS Basic Configuration
GetHttpsBasicConfigurationQuery Site HTTPS Basic ConfigurationQuery a Single HTTPS Basic Configuration
ListHttpsBasicConfigurationsQuery HTTPS Basic Configuration ListQuery multiple HTTPS basic configurations
DeleteHttpsBasicConfigurationDelete Site HTTPS Basic ConfigurationDelete HTTPS Basic Configuration
HTTPS rulesHTTPS rules
CreateHttpsApplicationConfigurationAdd Site HTTPS Application ConfigurationCreate a new site HTTPS application configuration
UpdateHttpsApplicationConfigurationModify Site HTTPS Application ConfigurationModify HTTPS Application Configuration
GetHttpsApplicationConfigurationQuery Site HTTPS Application ConfigurationQuery a Single HTTPS Application Configuration
ListHttpsApplicationConfigurationsList HTTPS Application ConfigurationsQuery multiple HTTPS application configurations
DeleteHttpsApplicationConfigurationDelete Site HTTPS Application ConfigurationDelete HTTPS Application Configuration
Redirect rulesRedirect rules
CreateRedirectRuleCreate Redirect ConfigurationAdd a Redirect Rule
UpdateRedirectRuleUpdate Redirect ConfigurationUpdate Redirect Rule
GetRedirectRuleQuery Redirect Configuration DetailsQuery Redirect Rule Details
ListRedirectRulesQuery Redirect Configuration ListQuery Redirect Rule List
DeleteRedirectRuleDeleteRedirectRuleDeletes a URL redirect rule for a website.
Rewrite URLRewrite URL
CreateRewriteUrlRuleAdd Rewrite URL ConfigurationAdd Rewrite URL Rule
UpdateRewriteUrlRuleModify Rewrite URL ConfigurationModify Rewrite URL Rule
GetRewriteUrlRuleQuery Rewrite URL ConfigurationQuery details of the rewrite URL rule
ListRewriteUrlRulesList of Rewrite URL Configurations for a SiteList of Rewrite URL Rules
DeleteRewriteUrlRuleDeleteRewriteUrlRuleDeletes a URL rewrite rule for a website.
Modify Request HeaderModify Request Header
CreateHttpRequestHeaderModificationRuleCreate or Modify HTTP Request Header ConfigurationAdd HTTP Request Header Rule
UpdateHttpRequestHeaderModificationRuleUpdate HTTP Request Header ConfigurationModify HTTP Request Header Rules
GetHttpRequestHeaderModificationRuleQuery HTTP Request Header Configuration DetailsQuery HTTP Request Header Rule Details
ListHttpRequestHeaderModificationRulesList of HTTP Request Header Modification ConfigurationsList of HTTP Request Header Rules
DeleteHttpRequestHeaderModificationRuleDeleteHttpRequestHeaderModificationRuleDeletes the configuration of modifying HTTP request headers for a website.
Modify incoming request header (client to ESA)Modify incoming request header (client to ESA)
CreateHttpIncomingRequestHeaderModificationRuleCreateHttpIncomingRequestHeaderModificationRuleAdds the configuration of modifying HTTP request headers for a website.
UpdateHttpIncomingRequestHeaderModificationRuleUpdateHttpIncomingRequestHeaderModificationRuleUpdates the HTTP incoming request header modification rule.
GetHttpIncomingRequestHeaderModificationRuleGetHttpIncomingRequestHeaderModificationRuleQueries the configuration details of an HTTP request header modification rule for a website.
ListHttpIncomingRequestHeaderModificationRulesListHttpIncomingRequestHeaderModificationRulesQueries the configuration details of an incoming HTTP request header modification rule for a website.
DeleteHttpIncomingRequestHeaderModificationRuleDeleteHttpIncomingRequestHeaderModificationRuleDeletes the configuration of modifying incoming HTTP request headers for a website.
Modify Response HeaderModify Response Header
CreateHttpResponseHeaderModificationRuleCreate or Modify HTTP Response Header ConfigurationAdd HTTP Response Header Rule
UpdateHttpResponseHeaderModificationRuleUpdate HTTP Response Header ConfigurationModify HTTP response header rules
GetHttpResponseHeaderModificationRuleQuery HTTP Response Header Configuration DetailsQuery HTTP Response Header Rules
ListHttpResponseHeaderModificationRulesList of Configurations for Modifying HTTP Response HeadersList of HTTP Response Header Rules
DeleteHttpResponseHeaderModificationRuleDeleteHttpResponseHeaderModificationRuleDeletes the configuration of modifying HTTP response headers for a website.
Modify incoming response header (client to ESA)Modify incoming response header (client to ESA)
CreateHttpIncomingResponseHeaderModificationRuleCreateHttpIncomingResponseHeaderModificationRuleAdds the configuration of modifying HTTP response headers for a website.
UpdateHttpIncomingResponseHeaderModificationRuleUpdateHttpIncomingResponseHeaderModificationRuleUpdates the configuration of modifying HTTP response headers for a website.
GetHttpIncomingResponseHeaderModificationRuleGetHttpIncomingResponseHeaderModificationRuleQueries the configuration details of an incoming HTTP response header modification rule for a website.
ListHttpIncomingResponseHeaderModificationRulesListHttpIncomingResponseHeaderModificationRulesQueries the configurations of an incoming HTTP response header modification rule for a website.
DeleteHttpIncomingResponseHeaderModificationRuleDeleteHttpIncomingResponseHeaderModificationRuleDeletes the configuration of modifying HTTP response headers for a website.
Managed TransformManaged Transform
UpdateManagedTransformUpdateManagedTransformModifies the configuration of managed transforms for your website.
GetManagedTransformQuery Managed Transform ConfigurationQuery Managed Transform Configuration
Cache rulesCache rules
CreateCacheRuleAdd Site Cache ConfigurationCreate a new site cache configuration
UpdateCacheRuleModify Site Cache ConfigurationModify cache configuration
GetCacheRuleQuery Site Cache ConfigurationQuery a single cache configuration
ListCacheRulesList Site Cache ConfigurationsQuery multiple cache configurations
DeleteCacheRuleDelete Site Cache ConfigurationDelete Cache Configuration
Network optimization rulesNetwork optimization rules
CreateNetworkOptimizationAdd Site Network Optimization ConfigurationCreate a new site network optimization configuration
UpdateNetworkOptimizationModify Site Network Optimization ConfigurationModify network optimization configuration
GetNetworkOptimizationQuery Site Network Optimization ConfigurationQuery a single network optimization configuration
ListNetworkOptimizationsQuery Network Optimization Configurations ListQuery multiple network optimization configurations
DeleteNetworkOptimizationDelete Site Network Optimization ConfigurationDelete Network Optimization Configuration
File compressionFile compression
CreateCompressionRuleCreate Compression Rule ConfigurationAdd a compression rule
UpdateCompressionRuleModify Compression Rule ConfigurationModify compression rule
GetCompressionRuleQuery Compression Rule Configuration DetailsQuery Compression Rule Details
ListCompressionRulesList Compression Rule ConfigurationsQuery the list of compression rules
DeleteCompressionRuleDelete Compression Rule ConfigurationDelete compression rule
Image processingImage processing
CreateImageTransformAdd Site Image Transformation ConfigurationAdd Site Image Transformation Configuration
UpdateImageTransformModify Site Image Transformation ConfigurationModify Site Image Transformation Configuration
GetImageTransformQuery Single Site Image Transformation ConfigurationQuery Single Site Image Transformation Configuration
ListImageTransformsQuery Multiple Site Image Transformation ConfigurationsQuery Multiple Site Image Transformation Configurations
DeleteImageTransformDelete Site Image Transformation ConfigurationDelete Site Image Transformation Configuration
Video processingVideo processing
CreateVideoProcessingCreateVideoProcessingAdd video processing configurations for a website.
UpdateVideoProcessingUpdateVideoProcessingModifies the video processing configuration of the site.
GetVideoProcessingGetVideoProcessingQueries the video processing configuration details of a site.
ListVideoProcessingsListVideoProcessingsQueries the video processing configurations of a site.
DeleteVideoProcessingDeleteVideoProcessingDeletes a video processing configuration.
Origin rulesOrigin rules
CreateOriginRuleAdd Origin Rule Configuration for SiteCreate a new origin rule configuration for the site
UpdateOriginRuleModify Origin Rule Configuration for SiteModify Origin Rule Configuration for Site
GetOriginRuleGetOriginRuleQueries the configurations of a single origin rule.
ListOriginRulesList of Origin Rule Configurations for SitesQuery multiple origin rule configurations
DeleteOriginRuleDelete Origin Rule Configuration for SiteDelete Origin Rule Configuration
Speed and networkSpeed and network
IPv6IPv6
UpdateIPv6UpdateIPv6Modifies the IPv6 configuration of a website.
GetIPv6GetIPv6Queries the IPv6 configuration of a website.
URL ObservationURL Observation
CreateUrlObservationCreateUrlObservationCreate a web page monitoring configuration.
UpdateUrlObservationUpdateUrlObservationUpdates the webpage monitoring configuration.
DescribeUrlObservationDataDescribeUrlObservationDataQueries the page monitoring data.
ListUrlObservationsListUrlObservationsQueries the list of page monitoring configurations.
DeleteUrlObservationDeleteUrlObservationDeletes page monitoring configurations.
Chinese mainland network optimizationChinese mainland network optimization
GetCrossBorderOptimizationGetCrossBorderOptimizationQueries the configuration of Chinese mainland access optimization.
UpdateCrossBorderOptimizationUpdateCrossBorderOptimizationModifies the configuration of the Chinese mainland network access optimization.
TrafficTraffic
Waiting roomWaiting room
CreateWaitingRoomCreateWaitingRoomCreates a waiting room for a website.
UpdateWaitingRoomUpdateWaitingRoomModifies the configurations of a waiting room.
ListWaitingRoomsListWaitingRoomsQueries the information about all waiting rooms in a website.
DeleteWaitingRoomDeleteWaitingRoomDeletes a waiting room.
CreateWaitingRoomRuleCreate Waiting Room Bypass RuleCreate Waiting Room Rule
UpdateWaitingRoomRuleModify Waiting Room Bypass RuleModify Waiting Room Rule
ListWaitingRoomRulesQuery Waiting Room Bypass Rules ListQuery Waiting Room Bypass Rules
DeleteWaitingRoomRuleDeleteWaitingRoomRuleDeletes a waiting room bypass rule.
CreateWaitingRoomEventCreateWaitingRoomEventCreates a waiting room event.
UpdateWaitingRoomEventUpdateWaitingRoomEventModifies the configurations of a waiting room event.
ListWaitingRoomEventsListWaitingRoomEventsQueries the information about waiting room events for a waiting room.
DeleteWaitingRoomEventDeleteWaitingRoomEventDeletes a waiting room event.
UpdateSeoBypassUpdateSeoBypassModifies the search engine crawler configuration for a website.
GetSeoBypassGetSeoBypassQueries the configuration for search engine crawler of a website.
Origin poolOrigin pool
CreateOriginPoolCreate Origin Address PoolAdd a new origin address pool
UpdateOriginPoolUpdate a Single Origin PoolModify the Monitor
GetOriginPoolQuery a Single Origin PoolQuery a specific origin pool
ListOriginPoolsList Origin PoolsList Origin Pools
DeleteOriginPoolDelete Origin Address PoolDelete Origin Address Pool
Load balancingLoad balancing
CreateLoadBalancerCreate Load BalancerAdd a New Load Balancer
UpdateLoadBalancerModify Existing Load Balancer InformationModify Load Balancer
GetLoadBalancerQuery a Single Load BalancerQuery a Specific Load Balancer
ListLoadBalancersQuery Load Balancers Under a SiteQuery the list of load balancers
DeleteLoadBalancerDelete Load BalancerDelete Load Balancer
ListLoadBalancerRegionsQuery Load Balancer Region InformationQuery Load Balancer Region List
ListLoadBalancerOriginStatusQuery the Status of Origins under Load BalancersQuery the status of origins in load balancers
Layer 4 proxyLayer 4 proxy
CreateTransportLayerApplicationCreate Transport Layer Acceleration ApplicationCreate Transport Layer Application
UpdateTransportLayerApplicationUpdate Transport Layer Acceleration ApplicationModify Transport Layer Application
GetTransportLayerApplicationQuery Transport Layer Acceleration ApplicationQuery details of the transport layer application
ListTransportLayerApplicationsList of Transport Layer Acceleration Applications for a SiteList of Transport Layer Applications
DeleteTransportLayerApplicationDelete Transport Layer Acceleration ApplicationDelete Transport Layer Application
Routine routeRoutine route
ListSiteRoutesListSiteRoutesQueries the edge function routes for a website.

Edge computing

APITitleDescription
Edge routineEdge routine
OpenErServiceOpenErServiceOpenErService
GetErServiceGetErServiceChecks the status of Edge Routine.
ListUserRoutinesListUserRoutinesQueries the functions created in your account and the maximum number of functions supported by your plan. You can call this operation to perform a paged query.
CreateRoutineCreateRoutineCreates a routine.
GetRoutineGetRoutineQueries the configurations of a routine, including the code versions and the configurations of the environments, associated domain names, and associated routes.
DeleteRoutineDeleteRoutineDeletes a routine in Edge Routine.
CreateRoutineRouteCreateRoutineRouteAdds edge function routing configurations.
UpdateRoutineRouteUpdateRoutineRouteModifies the route configuration of an edge function.
GetRoutineRouteGetRoutineRouteQueries the route configurations of a single edge function.
ListRoutineRoutesListRoutineRoutesQueries the routes of an edge function.
DeleteRoutineRouteDeleteRoutineRouteDeletes the route configuration of an edge function.
CreateRoutineCodeDeploymentCreateRoutineCodeDeploymentRelease the version of the function code in proportion to the specified environment.
CommitRoutineStagingCodeCommitRoutineStagingCodeCommits the unstable code in the staging environment to generate an official code version.
GetRoutineCodeVersionGetRoutineCodeVersionQueries information about a code version of a routine.
ListRoutineCodeVersionsListRoutineCodeVersionsQueries the code versions of a function (routine) by page.
GetRoutineStagingCodeUploadInfoGetRoutineStagingCodeUploadInfoObtains the release information about the routine code that is released to the staging environment. This information can be used to upload the test code to Object Storage Service (OSS).
DeleteRoutineCodeVersionDeleteRoutineCodeVersionDeletes a code version of a routine.
UpdateRoutineConfigDescriptionUpdateRoutineConfigDescriptionModifies the description of a routine.
CreateRoutineRelatedRecordCreateRoutineRelatedRecordAdds a record to map a domain that is associated with a routine. This record is used to trigger the associated routine code.
ListRoutineRelatedRecordsListRoutineRelatedRecordsThe records associated with the function.
DeleteRoutineRelatedRecordDeleteRoutineRelatedRecordDeletes a record that is associated with a routine.
Edge containerEdge container
Container managementContainer management
CreateEdgeContainerAppCreateEdgeContainerAppCreates a containerized application. You can deploy and release a version of the application across points of presence (POPs).
GetEdgeContainerAppGetEdgeContainerAppQueries the information about a containerized application, including basic application configurations and health check configurations.
ListEdgeContainerAppsListEdgeContainerAppsQueries all containerized applications in your Alibaba Cloud account.
DeleteEdgeContainerAppDeleteEdgeContainerAppDeletes a containerized application.
UpdateEdgeContainerAppResourceReserveUpdateEdgeContainerAppResourceReserveUpdates the resource reservation configuration of an edge container.
GetEdgeContainerAppResourceReserveGetEdgeContainerAppResourceReserveObtain the resource reservation configuration of the edge container.
GetEdgeContainerTerminalGetEdgeContainerTerminalQueries the terminal information of a containerized application.
GetEdgeContainerAppStatusGetEdgeContainerAppStatusQueries the status information about a containerized application, including the deployment, release, and rollback of the application.
DescribeEdgeContainerAppStatsDescribeEdgeContainerAppStatsProvides monitoring data for metrics of ESA edge containers.
GetEdgeContainerAppResourceStatusGetEdgeContainerAppResourceStatusObtains the distribution of edge container application resources.
LogLog
UpdateEdgeContainerAppLogRiverUpdateEdgeContainerAppLogRiverUpdates the log collection configuration of a containerized application.
GetEdgeContainerAppLogRiverGetEdgeContainerAppLogRiverQueries the log collection configuration of a containerized application.
GetEdgeContainerLogsGetEdgeContainerLogsQueries Edge Container logs.
TriggerTrigger
CreateEdgeContainerAppRecordCreateEdgeContainerAppRecordAssociates a domain name with a containerized application. This way, requests destined for the associated domain name are forwarded to the application.
DeleteEdgeContainerAppRecordDeleteEdgeContainerAppRecordDisassociates a domain name from a containerized application. After the dissociation, you can no longer use the domain name to access the containerized application.
ListEdgeContainerAppRecordsListEdgeContainerAppRecordsLists domain names that are associated with a containerized application.
Version managementVersion management
CreateEdgeContainerAppVersionCreateEdgeContainerAppVersionCreates a version for a containerized application. You can iterate the application based on the version.
DeleteEdgeContainerAppVersionDeleteEdgeContainerAppVersionDeletes a version of a containerized application.
ListEdgeContainerAppVersionsListEdgeContainerAppVersionsLists versions of all containerized applications.
GetEdgeContainerDeployRegionsGetEdgeContainerDeployRegionsQueries regions where a containerized application is deployed based on the application ID.
GetEdgeContainerAppVersionGetEdgeContainerAppVersionQueries the information about a version of a containerized application. You can select an application version to release based on the version information.
GetEdgeContainerStagingDeployStatusGetEdgeContainerStagingDeployStatusQueries the deployment status of an application in the staging environment by using the application ID.
PublishEdgeContainerAppVersionPublishEdgeContainerAppVersionReleases a specific version of a containerized application. You can call this operation to iterate an application.
RebuildEdgeContainerAppStagingEnvRebuildEdgeContainerAppStagingEnvRebuilds the staging environment for containerized applications.
RollbackEdgeContainerAppVersionRollbackEdgeContainerAppVersionRolls back a version of a containerized application.
Edge storageEdge storage
Storage managementStorage management
DescribeKvAccountStatusDescribeKvAccountStatusQueries whether Edge KV is activated in your Alibaba Cloud account.
GetKvAccountGetKvAccountQueries the Edge KV usage in your Alibaba Cloud account, including the information about all namespaces.
NamespaceNamespace
CreateKvNamespaceCreateKvNamespaceCreate a namespace in your Alibaba Cloud account.
DeleteKvNamespaceDeleteKvNamespaceDeletes a namespace from an Alibaba Cloud account.
GetKvNamespaceGetKvNamespaceQueries the information about a namespace in your Alibaba Cloud account.
PutKvPutKvConfigures a key-value pair for a namespace. The request body can be up to 2 MB.
DeleteKvDeleteKvDeletes a key-value pair from a namespace.
GetKvGetKvQueries the value of a key in a key-value pair.
BatchPutKvBatchPutKvConfigures key-value pairs for a namespace at a time based on specified keys.
BatchDeleteKvBatchDeleteKvDeletes key-value pairs from a namespace at a time based on keys.
PutKvWithHighCapacityPutKvWithHighCapacityConfigures a large key-value pair for a namespace. The request body can be up to 25 MB.
BatchPutKvWithHighCapacityBatchPutKvWithHighCapacityConfigures key-value pairs for a namespace at a time based on specified keys. The request body can be up to 100 MB.
BatchDeleteKvWithHighCapacityBatchDeleteKvWithHighCapacityDeletes multiple key-value pairs from a namespace at a time based on specified keys. The request body can be up to 100 MB.
ListKvsListKvsLists all key-value pairs in a namespace in your Alibaba Cloud account.

Analysis and log

APITitleDescription
Data analyticsData analytics
DescribeSiteTimeSeriesDataQuery Traffic Analysis Time Series DataQuery traffic analysis time series data
DescribeSiteTopDataDescribeSiteTopDataQueries the top-ranking records in a traffic analytics report by website or Alibaba Cloud account.
Real-time logReal-time log
CreateSiteDeliveryTaskCreateSiteDeliveryTaskCreates a real-time log delivery task.
DeleteSiteDeliveryTaskDeleteSiteDeliveryTaskDeletes a real-time log delivery task.
UpdateSiteDeliveryTaskUpdateSiteDeliveryTaskModifies a real-time log delivery task.
UpdateSiteDeliveryTaskStatusUpdateSiteDeliveryTaskStatusChanges the status of a real-time log delivery task.
UpdateUserDeliveryTaskStatusUpdateUserDeliveryTaskStatusChanges the status of a delivery task in your Alibaba Cloud account.
CheckSiteProjectNameCheckSiteProjectNameChecks the name of a real-time log delivery task.
CheckUserProjectNameCheckUserProjectNameChecks the name of a real-time log delivery task by account.
ListSiteDeliveryTasksListSiteDeliveryTasksLists all log delivery tasks that are in progress.
GetRealtimeDeliveryFieldGetRealtimeDeliveryFieldQueries the fields in real-time logs based on the log category.
GetUserLogDeliveryQuotaGetUserLogDeliveryQuotaQueries the remaining log delivery quota of each log category in your account.
GetSiteLogDeliveryQuotaGetSiteLogDeliveryQuotaQueries the remaining quota for delivering a specific category of real-time logs in a website.
CreateSiteCustomLogCreateSiteCustomLogAdds the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.
UpdateSiteCustomLogUpdateSiteCustomLogModifies the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.
GetSiteCustomLogGetSiteCustomLogQueries the configuration of custom log fields for a website.
CreateUserDeliveryTaskCreateUserDeliveryTaskCreates a log delivery task to ship logs to the specified destination.
DeleteUserDeliveryTaskDeleteUserDeliveryTaskDeletes a log delivery task from your Alibaba Cloud account.
UpdateUserDeliveryTaskUpdateUserDeliveryTaskModifies the configurations of a delivery task, including the task name, log field, log category, and discard rate.
ListUserDeliveryTasksListUserDeliveryTasksQueries all delivery tasks in your Alibaba Cloud account by page. You can filter the delivery tasks by the category of the delivered real-time logs.
GetUserDeliveryTaskGetUserDeliveryTaskQueries the information about a log delivery task by account.
GetSiteDeliveryTaskGetSiteDeliveryTaskQueries a real-time log delivery task.
Standard logStandard log
DescribeSiteLogsDescribeSiteLogsQueries the URLs from which you can download the raw access logs of a website.

Global settings

APITitleDescription
GroupingGrouping
CreateListCreateListCreates a list. Lists are used for the referencing of values in the rules engine to implement complex logic and control in security policies.
UpdateListUpdateListUpdates a custom list.
GetListGetListQueries the details of a custom list, such as the name, description, type, and content.
ListListsListListsQueries all custom lists and their details in an Alibaba Cloud account. You can specify query arguments to filter the results and display the returned lists by page.
DeleteListDeleteListDeletes a custom list that is no longer needed.
Scenario policyScenario policy
CreateCustomScenePolicyCreateCustomScenePolicyCreates an account-level custom scenario policy. You can execute a policy after you associate the policy with a website.
UpdateCustomScenePolicyUpdateCustomScenePolicyModifies the configurations of a custom scenario-specific policy.
DisableCustomScenePolicyDisableCustomScenePolicyDisables a scenario-specific policy.
EnableCustomScenePolicyEnableCustomScenePolicyEnables a scenario-specific policy.
DescribeCustomScenePoliciesDescribeCustomScenePoliciesQueries the configurations of a scenario-specific policy.
DeleteCustomScenePolicyDeleteCustomScenePolicyDeletes a scenario-specific custom policy.
Customize pageCustomize page
CreatePageCreatePageCreates a custom error page, which is displayed when a request is blocked by Web Application Firewall (WAF). You can configure the HTML content, page type, and description, and submit the Base64-encoded page content.
UpdatePageUpdatePageModifies the configurations of a custom error page, such as the name, description, content type, and content of the page.
GetPageGetPageQueries the details of a custom error page based on the error page ID.
ListPagesListPagesLists all custom error pages that you created. You can define the page number and the number of entries per page to display the response.
DeletePageDeletePageDeletes a custom error page that is no longer needed.

Others

APITitleDescription
ListESAIPInfoListESAIPInfoBatch query whether the IP address is included in the ESA resolution result.

Billing management

APITitleDescription
Plan managementPlan management
PurchaseRatePlanPurchaseRatePlanPurchase New Package
UpdateRatePlanSpecPlan AdjustmentPlan Adjustment
DescribeRatePlanInstanceStatusDescribeRatePlanInstanceStatusQueries the status of an instance that uses a plan.
ListEdgeRoutinePlansListEdgeRoutinePlansQueries Edge Routine plans.
ListUserRatePlanInstancesListUserRatePlanInstancesQueries the plans that you purchased and the details of the plans.
ListInstanceQuotasListInstanceQuotasQueries the quota details in a subscription plan.
Usage queryUsage query
ListInstanceQuotasWithUsageListInstanceQuotasWithUsageQueries quotas and the actual usage in a plan based on the website or plan ID.