All Products
Search

This Product

    Edge Security Acceleration:API overview

    Document Center

    Edge Security Acceleration:API overview

    Last Updated:Feb 09, 2026

    API standard and pre-built SDKs in multi-language

    The OpenAPI specification of this product (ESA/2024-09-10) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

    Custom signature

    If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

    Before you begin

    An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

    Website management

    API

    Title

    Description
    Query website Query website
    GetSite Query information of a single site Query the information of a single site by site ID.
    ListSites Query Site List Query Site List
    Manage tags Manage tags
    TagResources TagResources Adds one or more tags to resources.

    Website configuration

    API

    Title

    Description
    DNS DNS
    SaaS domain names SaaS domain names
    CreateCustomHostname CreateCustomHostname Creates a Software as a Service (SaaS) domain name for a site.
    DeleteCustomHostname DeleteCustomHostname Deletes a custom domain name from a Software as a Service (SaaS) site based on its HostnameId.
    UpdateCustomHostname UpdateCustomHostname Updates the parameters of a Software as a Service (SaaS) domain name, such as the attached record ID and the certificate type.
    VerifyCustomHostname VerifyCustomHostname Verifies the ownership of a Software as a Service (SaaS) domain name. After a domain name is verified, the site is automatically activated.
    GetCustomHostname GetCustomHostname Retrieves the detailed configuration of a specific Software as a Service (SaaS) domain name. The configuration includes the TXT record name and value for domain name validation, and the certificate expiration time when SSL is enabled.
    ListCustomHostnames ListCustomHostnames Queries the Software as a Service (SaaS) domain names for a site. This operation returns the ID, status, and domain validation information for each SaaS domain name. You can filter the results by the SaaS domain name, site ID, or the ID of the attached record.
    ApplyCustomHostnameCertificate ApplyCustomHostnameCertificate Requests a new free certificate for a Software as a Service (SaaS) domain name. Call this operation only if the previous certificate request failed, or the current certificate is about to expire or has expired.
    DNS records DNS records
    BatchCreateRecords Batch create DNS records Add DNS records in batch, supporting multiple record types.
    DeleteRecord Delete a DNS record Delete a single DNS record under a site by RecordId.
    UpdateRecord Update DNS Record Update DNS records, supporting multiple record types and origin authentication configuration.
    ListRecords Query DNS record list Query the list of DNS records under a site, including record values, priority, authentication configuration, and more. Filtering by conditions such as record name and record type is supported.
    GetRecord Query DNS record details Obtain the detailed configuration information of a single DNS record, including the record value, priority, origin fetch authentication configuration (exclusive to CNAME records), and more.
    CNAME flattening CNAME flattening
    UpdateCnameFlattening UpdateCnameFlattening Modifies the CNAME flattening configuration of a website.
    SSL/TLS SSL/TLS
    Website certificates Website certificates
    ApplyCertificate ApplyCertificate Applies for a free SSL certificate.
    SetCertificate Configure Site Certificate Used to configure whether to enable the certificate feature for a site and update certificate information.
    GetCertificate Get Specified Certificate Information Retrieve the certificate, private key, and certificate information
    ListCertificates List Site Certificates List certificates under a site
    ListCertificatesByRecord ListCertificatesByRecord Lists certificates that match specified records for a website. You can specify multiple records at a time.
    Client certificates Client certificates
    ListClientCaCertificates Obtain the client CA certificate list Retrieve the list of client CA certificates under the specified site.
    SetClientCertificateHostnames Set domain name binding for client certificate Attach a domain name to the specified client CA certificate. If no certificate is specified, the domain name is attached to the ESA CA certificate.
    Origin certificates Origin certificates
    UploadOriginCaCertificate Upload Origin Server CA Certificate Upload the origin server CA certificate.
    GetOriginCaCertificate Obtain CA certificate information of the origin server Obtain the CA certificate information of the origin server.
    DeleteOriginCaCertificate Delete the source server CA certificate Delete the source server CA certificate.
    ListOriginCaCertificates ListOriginCaCertificates Query the list of CA certificates for origin servers.
    GetSiteOriginClientCertificate Obtain origin fetch client certificate information with site granularity Obtain origin fetch client certificate information at the site granularity.
    DeleteSiteOriginClientCertificate Delete the site-granularity origin fetch client certificate Delete the site-granularity origin fetch client certificate.
    ListSiteOriginClientCertificates ListSiteOriginClientCertificates Lists the back-to-origin client certificates for a site.
    UploadOriginClientCertificate Upload a domain-granularity origin fetch client certificate. Upload a domain-granularity origin fetch client certificate.
    GetOriginClientCertificate Obtain origin fetch client certificate information by domain name granularity Obtain domain name granularity origin fetch client certificate information.
    DeleteOriginClientCertificate Delete the domain name granularity origin fetch client certificate Delete the domain name granularity origin fetch client certificate.
    ListOriginClientCertificates Query the origin fetch client certificate list by domain granularity Query the list of origin fetch client certificates by domain name granularity.
    SetOriginClientCertificateHostnames Attach domain names to the origin fetch client certificate at the domain name granularity. Attach domain names to the origin fetch client certificate at the domain name granularity.
    GetOriginClientCertificateHostnames Obtain the list of domain names attached to a client certificate for origin fetch at domain name granularity Obtain the list of domain names attached to a client certificate for origin fetch at domain name granularity.
    Security Security
    WAF WAF
    ListWafRules List WAF Rules List WAF Rules
    ListWafTemplateRules List WAF Template Rules List WAF Template Rules
    ListWafManagedRules List WAF Managed Rules List WAF Managed Rules
    GetWafQuota Get WAF Resource Related Quotas Get WAF Quota Details
    GetWafFilter Obtain WAF matching engine information Obtain the matching engine information for a specified site at a specific WAF phase. This information defines how the WAF detects and processes different types of network requests.
    DDoS DDoS
    DescribeDDoSAllEventList Query the DDoS attack event list This API is used to query the DDoS attack event list.
    SetHttpDDoSAttackRuleAction Set the Protection Action for Specified HTTP DDoS Attack Rules Set the Protection Action for Specified HTTP DDoS Attack Rules
    DeleteHttpDDoSIntelligentRule Delete rules for deep learning and protection distribution Deletes a rule created by Deep Learning and Protection.
    SetHttpDDoSAttackRuleStatus Set the Protection Status of Specified HTTP DDoS Attack Rules Set the Protection Status of Specified HTTP DDoS Attack Rules
    API security API security
    GetApiSchemaUsage GetApiSchemaUsage Queries the usage of the upload file quota for API security schema verification.
    Origin protection Origin protection
    GetOriginProtection Obtain origin protection information Query the site's origin protection configuration, including the origin protection toggle, origin fetch convergence toggle, whether an update to the back-to-origin IP whitelist is required, and detailed information about the back-to-origin IP whitelist, including the currently used back-to-origin IP whitelist for the site, the latest back-to-origin IP whitelist, and the differences between the two.
    Cache Cache
    Scheduled prefetch Scheduled prefetch
    ListScheduledPreloadJobs List scheduled prefetch jobs List the scheduled prefetch jobs under a site.
    Cache reserve Cache reserve
    UpdateCacheReserveSpec Cache Reserve Specification Change Cache Reserve Specification Change
    Rule configuration Rule configuration
    SSL and TLS rules SSL and TLS rules
    CreateHttpsBasicConfiguration Add Site HTTPS Basic Configuration Create a new site HTTPS basic configuration
    UpdateHttpsBasicConfiguration Modify Site HTTPS Basic Configuration Modify HTTPS Basic Configuration
    HTTPS rules HTTPS rules
    CreateHttpsApplicationConfiguration Add Site HTTPS Application Configuration Create a new site HTTPS application configuration
    UpdateHttpsApplicationConfiguration Modify Site HTTPS Application Configuration Modify HTTPS Application Configuration
    GetHttpsApplicationConfiguration Query Site HTTPS Application Configuration Query a Single HTTPS Application Configuration
    ListHttpsApplicationConfigurations List HTTPS Application Configurations Query multiple HTTPS application configurations
    Redirect rules Redirect rules
    CreateRedirectRule Create Redirect Configuration Add a Redirect Rule
    UpdateRedirectRule Update Redirect Configuration Update Redirect Rule
    Rewrite URL Rewrite URL
    CreateRewriteUrlRule Add Rewrite URL Configuration Add Rewrite URL Rule
    UpdateRewriteUrlRule Modify Rewrite URL Configuration Modify Rewrite URL Rule
    Modify Request Header Modify Request Header
    CreateHttpRequestHeaderModificationRule Create or Modify HTTP Request Header Configuration Add HTTP Request Header Rule
    UpdateHttpRequestHeaderModificationRule Update HTTP Request Header Configuration Modify HTTP Request Header Rules
    GetHttpRequestHeaderModificationRule Query HTTP Request Header Configuration Details Query HTTP Request Header Rule Details
    ListHttpRequestHeaderModificationRules List of HTTP Request Header Modification Configurations List of HTTP Request Header Rules
    Modify incoming request header (client to ESA) Modify incoming request header (client to ESA)
    CreateHttpIncomingRequestHeaderModificationRule CreateHttpIncomingRequestHeaderModificationRule Adds the configuration of modifying HTTP request headers for a website.
    UpdateHttpIncomingRequestHeaderModificationRule UpdateHttpIncomingRequestHeaderModificationRule Updates the HTTP incoming request header modification rule.
    GetHttpIncomingRequestHeaderModificationRule GetHttpIncomingRequestHeaderModificationRule Queries the configuration details of an HTTP request header modification rule for a website.
    ListHttpIncomingRequestHeaderModificationRules ListHttpIncomingRequestHeaderModificationRules Queries the configuration details of an incoming HTTP request header modification rule for a website.
    DeleteHttpIncomingRequestHeaderModificationRule DeleteHttpIncomingRequestHeaderModificationRule Deletes the configuration of modifying incoming HTTP request headers for a website.
    Modify Response Header Modify Response Header
    CreateHttpResponseHeaderModificationRule Create or Modify HTTP Response Header Configuration Add HTTP Response Header Rule
    UpdateHttpResponseHeaderModificationRule Update HTTP Response Header Configuration Modify HTTP response header rules
    GetHttpResponseHeaderModificationRule Query HTTP Response Header Configuration Details Query HTTP Response Header Rules
    ListHttpResponseHeaderModificationRules List of Configurations for Modifying HTTP Response Headers List of HTTP Response Header Rules
    Modify incoming response header (client to ESA) Modify incoming response header (client to ESA)
    CreateHttpIncomingResponseHeaderModificationRule CreateHttpIncomingResponseHeaderModificationRule Adds the configuration of modifying HTTP response headers for a website.
    UpdateHttpIncomingResponseHeaderModificationRule UpdateHttpIncomingResponseHeaderModificationRule Updates the configuration of modifying HTTP response headers for a website.
    GetHttpIncomingResponseHeaderModificationRule GetHttpIncomingResponseHeaderModificationRule Queries the configuration details of an incoming HTTP response header modification rule for a website.
    ListHttpIncomingResponseHeaderModificationRules ListHttpIncomingResponseHeaderModificationRules Queries the configurations of an incoming HTTP response header modification rule for a website.
    DeleteHttpIncomingResponseHeaderModificationRule DeleteHttpIncomingResponseHeaderModificationRule Deletes the configuration of modifying HTTP response headers for a website.
    Custom Response Codes Custom Response Codes
    CreateCustomResponseCodeRule CreateCustomResponseCodeRule Add a custom response code configuration for a site.
    DeleteCustomResponseCodeRule DeleteCustomResponseCodeRule Deletes a custom response code configuration for a site.
    GetCustomResponseCodeRule GetCustomResponseCodeRule Retrieve details about a site's custom response code configuration.
    ListCustomResponseCodeRules ListCustomResponseCodeRules List the custom response code configurations for the site.
    Managed Transform Managed Transform
    UpdateManagedTransform Modify Site Managed Transformation Configuration Modify Site Managed Transformation Configuration
    GetManagedTransform Query Managed Transform Configuration Query Managed Transform Configuration
    Cache rules Cache rules
    CreateCacheRule Add Site Cache Configuration Create a new site cache configuration
    UpdateCacheRule Modify Site Cache Configuration Modify cache configuration
    GetCacheRule Query Site Cache Configuration Query a single cache configuration
    ListCacheRules List Site Cache Configurations Query multiple cache configurations
    Network optimization rules Network optimization rules
    CreateNetworkOptimization Add Site Network Optimization Configuration Create a new site network optimization configuration
    UpdateNetworkOptimization Modify Site Network Optimization Configuration Modify network optimization configuration
    File compression File compression
    CreateCompressionRule Create Compression Rule Configuration Add a compression rule
    UpdateCompressionRule Modify Compression Rule Configuration Modify compression rule
    Image processing Image processing
    CreateImageTransform Add Site Image Transformation Configuration Add Site Image Transformation Configuration
    UpdateImageTransform Modify Site Image Transformation Configuration Modify Site Image Transformation Configuration
    Video processing Video processing
    CreateVideoProcessing CreateVideoProcessing Add video processing configurations for a website.
    UpdateVideoProcessing UpdateVideoProcessing Modifies the video processing configuration of the site.
    GetVideoProcessing GetVideoProcessing Queries the video processing configuration details of a site.
    ListVideoProcessings ListVideoProcessings Queries the video processing configurations of a site.
    DeleteVideoProcessing DeleteVideoProcessing Deletes a video processing configuration.
    Origin rules Origin rules
    CreateOriginRule Add Origin Rule Configuration for Site Create a new origin rule configuration for the site
    UpdateOriginRule Modify Origin Rule Configuration for Site Modify Origin Rule Configuration for Site
    GetOriginRule GetOriginRule Queries the configurations of a single origin rule.
    ListOriginRules List of Origin Rule Configurations for Sites Query multiple origin rule configurations
    Speed and network Speed and network
    IPv6 IPv6
    UpdateIPv6 Modify Site IPv6 Configuration Modify Site IPv6 Configuration
    GetIPv6 Query Site IPv6 Configuration Query Site IPv6 Configuration
    URL Observation URL Observation
    CreateUrlObservation CreateUrlObservation Create a web page monitoring configuration.
    UpdateUrlObservation UpdateUrlObservation Updates the webpage monitoring configuration.
    DescribeUrlObservationData DescribeUrlObservationData Queries the page monitoring data.
    ListUrlObservations ListUrlObservations Queries the list of page monitoring configurations.
    DeleteUrlObservation DeleteUrlObservation Deletes page monitoring configurations.
    Chinese mainland network optimization Chinese mainland network optimization
    GetCrossBorderOptimization GetCrossBorderOptimization Queries the configuration of Chinese mainland access optimization.
    UpdateCrossBorderOptimization UpdateCrossBorderOptimization Modifies the configuration of the Chinese mainland network access optimization.
    Traffic Traffic
    Waiting room Waiting room
    UpdateSeoBypass UpdateSeoBypass Modifies the search engine crawler configuration for a website.
    Load balancing Load balancing
    CreateLoadBalancer Create Load Balancer Add a New Load Balancer
    UpdateLoadBalancer Modify Existing Load Balancer Information Modify Load Balancer
    GetLoadBalancer Query a Single Load Balancer Query a Specific Load Balancer
    ListLoadBalancers Query Load Balancers Under a Site Query the list of load balancers
    Layer 4 proxy Layer 4 proxy
    CreateTransportLayerApplication Create Transport Layer Acceleration Application Create Transport Layer Application
    UpdateTransportLayerApplication Update Transport Layer Acceleration Application Modify Transport Layer Application
    GetTransportLayerApplication Query Transport Layer Acceleration Application Query details of the transport layer application
    ListTransportLayerApplications List of Transport Layer Acceleration Applications for a Site List of Transport Layer Applications
    DeleteTransportLayerApplication Delete Transport Layer Acceleration Application Delete Transport Layer Application
    Routine route Routine route
    ListSiteRoutes ListSiteRoutes Queries the edge function routes for a website.

    Edge computing

    API

    Title

    Description
    Edge routine Edge routine
    ListUserRoutines ListUserRoutines Queries 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.
    CreateRoutine Create Edge Routine Create an Edge Routine.
    GetRoutine Query Edge Routine configuration Query all configuration information of the Edge Routine, including the code version list, environment configuration list, associated domain configuration list, and associated Ingress configuration list.
    CreateRoutineRoute CreateRoutineRoute Adds edge function routing configurations.
    UpdateRoutineRoute UpdateRoutineRoute Modifies the route configuration of an edge function.
    GetRoutineRoute GetRoutineRoute Queries the route configurations of a single edge function.
    ListRoutineRoutes ListRoutineRoutes Queries the routes of an edge function.
    DeleteRoutineRoute DeleteRoutineRoute Deletes the route configuration of an edge function.
    CreateRoutineCodeDeployment CreateRoutineCodeDeployment Release the version of the function code in proportion to the specified environment.
    GetRoutineCodeVersion GetRoutineCodeVersion Queries information about a code version of a routine.
    ListRoutineCodeVersions ListRoutineCodeVersions Queries the code versions of a function (routine) by page.
    UpdateRoutineConfigDescription UpdateRoutineConfigDescription Modifies the description of a routine.
    CreateRoutineRelatedRecord Creation of an Edge Routine association record Add an associated site record for an Edge Routine. This creates a new record under the specified site to trigger the execution of the Edge Routine program code.
    ListRoutineRelatedRecords ListRoutineRelatedRecords The records associated with the function.
    Edge container Edge container
    Container management Container management
    UpdateEdgeContainerAppResourceReserve UpdateEdgeContainerAppResourceReserve Updates the resource reservation configuration of an edge container.
    GetEdgeContainerAppResourceReserve GetEdgeContainerAppResourceReserve Obtain the resource reservation configuration of the edge container.
    DescribeEdgeContainerAppStats DescribeEdgeContainerAppStats Provides monitoring data for metrics of ESA edge containers.
    GetEdgeContainerAppResourceStatus GetEdgeContainerAppResourceStatus Obtains the distribution of edge container application resources.
    GetEdgeContainerAppResourceCapacity GetEdgeContainerAppResourceCapacity Queries the resource capacity of a containerized application at the edge.
    Container app image secret Container app image secret
    CreateEdgeContainerAppImageSecret Create Edge Container Application Image Secret Create an image secret for the edge container application
    ListEdgeContainerAppImageSecrets Get Edge Container Application Image Secrets List Retrieve the list of image secrets for edge container applications
    DeleteEdgeContainerAppImageSecret DeleteEdgeContainerAppImageSecret Deletes the image secret for an edge containerized application.
    Version management Version management
    RollbackEdgeContainerAppVersion Roll Back Edge Container Application Roll back a specific version of an edge container application. You can use this API to quickly revert an abnormal version and minimize losses.
    Edge storage Edge storage
    Key value settings Key value settings
    GetKvDetail GetKvDetail Queries the value and time to live (TTL) of a key.

    Analysis and log

    API

    Title

    Description
    Data analytics Data analytics
    DescribeSiteTimeSeriesData Query Traffic Analysis Time Series Data Query traffic analysis time series data
    DescribeSiteTopData DescribeSiteTopData Queries the top-ranking records in a traffic analytics report by website or Alibaba Cloud account.
    Standard log Standard log
    DescribeSiteLogs DescribeSiteLogs Queries the URLs from which you can download the raw access logs of a website.

    Global settings

    API

    Title

    Description
    Global WAF Global WAF
    CreateUserWafRuleset CreateUserWafRuleset Creates an instance-level Web Application Firewall (WAF) ruleset that supports various types of protection rules.
    DeleteUserWafRuleset DeleteUserWafRuleset Deletes a WAF ruleset from a specified instance.
    GetUserWafRuleset GetUserWafRuleset Queries the details of a Web Application Firewall (WAF) ruleset for a specified instance.
    ListUserWafRulesets ListUserWafRulesets Queries the WAF rulesets for a specified instance. You can filter the results by phase, name, and other criteria.
    UpdateUserWafRuleset UpdateUserWafRuleset Modifies the WAF ruleset configuration for a specified instance, including its position, name, and other properties.
    Grouping Grouping
    ListLists List Custom Lists List all custom lists under the account and their details. You can filter the results by passing query parameters and use paging to retrieve a specific set of lists.
    Scenario policy Scenario policy
    CreateCustomScenePolicy Create Scenario-specific Policy Create a user-level scenario-specific policy and associate it with sites to execute the corresponding policy.
    UpdateCustomScenePolicy Modify a scenario-specific policy Modify the specified scenario-specific policy configuration information.
    DescribeCustomScenePolicies Query scenario-specific policies Query Scenario-specific policies configuration.
    Customize page Customize page
    ListPages List Custom Response Pages Lists all custom response pages created by the User. This API provides paging functionality and supports retrieving the response page list based on page number and page size.

    Others

    API

    Title

    Description
    ListESAIPInfo ListESAIPInfo Batch query whether the IP address is included in the ESA resolution result.
    ActivateClientCertificate ActivateClientCertificate Activates the client based on the certificate ID.
    ActivateVersionManagement ActivateVersionManagement Enable Version Management
    BatchCreateWafRules Batch Create WAF Rules Batch Create WAF Rules
    BatchDeleteKv BatchDeleteKv Deletes key-value pairs from a namespace at a time based on keys.
    BatchDeleteKvWithHighCapacity BatchDeleteKvWithHighCapacity Deletes multiple key-value pairs from a namespace at a time based on specified keys. The request body can be up to 100 MB.
    BatchGetExpressionFields Batch Get Expression Match Fields Batch Get Expression Matches
    BatchPutKv BatchPutKv Configures key-value pairs for a namespace at a time based on specified keys.
    BatchPutKvWithHighCapacity BatchPutKvWithHighCapacity Configures key-value pairs for a namespace at a time based on specified keys. The request body can be up to 100 MB.
    BatchUpdateWafRules BatchUpdateWafRules Modifies multiple rules in a specific Web Application Firewall (WAF) ruleset at a time.
    BlockObject BlockObject Blocks URLs.
    CheckSiteName CheckSiteName Checks whether a specified website name is available.
    CheckSiteProjectName CheckSiteProjectName Checks the name of a real-time log delivery task.
    CheckUserProjectName CheckUserProjectName Checks the name of a real-time log delivery task by account.
    CommitRoutineStagingCode CommitRoutineStagingCode Commits the unstable code in the staging environment to generate an official code version.
    CreateClientCertificate CreateClientCertificate Uses the ESA-managed certificate authority (CA) to issue client certificates.
    CreateEdgeContainerApp CreateEdgeContainerApp Creates a containerized application. You can deploy and release a version of the application across points of presence (POPs).
    CreateEdgeContainerAppRecord CreateEdgeContainerAppRecord Associates a domain name with a containerized application. This way, requests destined for the associated domain name are forwarded to the application.
    CreateEdgeContainerAppVersion CreateEdgeContainerAppVersion Creates a version for a containerized application. You can iterate the application based on the version.
    CreateKvNamespace CreateKvNamespace Create a namespace in your Alibaba Cloud account.
    CreateList CreateList Creates a list. Lists are used for the referencing of values in the rules engine to implement complex logic and control in security policies.
    CreateOriginPool Create Origin Address Pool Add a new origin address pool
    CreateOriginProtection CreateOriginProtection Enables origin protection.
    CreatePage CreatePage Creates 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.
    CreateRecord CreateRecord Creates a DNS record for a specific website.
    CreateScheduledPreloadExecutions CreateScheduledPreloadExecutions Creates scheduled prefetch plans.
    CreateScheduledPreloadJob CreateScheduledPreloadJob Adds a scheduled prefetch task.
    CreateSite CreateSite Adds a website.
    CreateSiteCustomLog CreateSiteCustomLog Adds the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.
    CreateSiteDeliveryTask CreateSiteDeliveryTask Creates a real-time log delivery task.
    CreateUserDeliveryTask CreateUserDeliveryTask Creates a log delivery task to ship logs to the specified destination.
    CreateWafRule Create WAF Rule Create WAF Rule
    CreateWafRuleset Create WAF Ruleset Create WAF Ruleset
    CreateWaitingRoom CreateWaitingRoom Creates a waiting room for a website.
    CreateWaitingRoomEvent CreateWaitingRoomEvent Creates a waiting room event.
    CreateWaitingRoomRule Create Waiting Room Bypass Rule Create Waiting Room Rule
    DeactivateVersionManagement DeactivateVersionManagement Disables version management for a website.
    DeleteCacheRule Delete Site Cache Configuration Delete Cache Configuration
    DeleteCertificate DeleteCertificate Deletes a certificate for a website.
    DeleteClientCaCertificate DeleteClientCaCertificate Deletes a client CA certificate.
    DeleteClientCertificate DeleteClientCertificate Deletes a revoked client certificate.
    DeleteCompressionRule Delete Compression Rule Configuration Delete compression rule
    DeleteCustomScenePolicy DeleteCustomScenePolicy Deletes a scenario-specific custom policy.
    DeleteEdgeContainerApp DeleteEdgeContainerApp Deletes a containerized application.
    DeleteEdgeContainerAppRecord DeleteEdgeContainerAppRecord Disassociates a domain name from a containerized application. After the dissociation, you can no longer use the domain name to access the containerized application.
    DeleteEdgeContainerAppVersion DeleteEdgeContainerAppVersion Deletes a version of a containerized application.
    DeleteHttpRequestHeaderModificationRule DeleteHttpRequestHeaderModificationRule Deletes the configuration of modifying HTTP request headers for a website.
    DeleteHttpResponseHeaderModificationRule DeleteHttpResponseHeaderModificationRule Deletes the configuration of modifying HTTP response headers for a website.
    DeleteHttpsApplicationConfiguration Delete Site HTTPS Application Configuration Delete HTTPS Application Configuration
    DeleteHttpsBasicConfiguration Delete Site HTTPS Basic Configuration Delete HTTPS Basic Configuration
    DeleteImageTransform Delete Site Image Transformation Configuration Delete Site Image Transformation Configuration
    DeleteKv DeleteKv Deletes a key-value pair from a namespace.
    DeleteKvNamespace DeleteKvNamespace Deletes a namespace from an Alibaba Cloud account.
    DeleteList DeleteList Deletes a custom list that is no longer needed.
    DeleteLoadBalancer Delete Load Balancer Delete Load Balancer
    DeleteNetworkOptimization Delete Site Network Optimization Configuration Delete Network Optimization Configuration
    DeleteOriginPool Delete Origin Address Pool Delete Origin Address Pool
    DeleteOriginProtection DeleteOriginProtection Disables origin protection.
    DeleteOriginRule Delete Origin Rule Configuration for Site Delete Origin Rule Configuration
    DeletePage DeletePage Deletes a custom error page that is no longer needed.
    DeleteRedirectRule DeleteRedirectRule Deletes a URL redirect rule for a website.
    DeleteRewriteUrlRule DeleteRewriteUrlRule Deletes a URL rewrite rule for a website.
    DeleteRoutine DeleteRoutine Deletes a routine in Edge Routine.
    DeleteRoutineCodeVersion DeleteRoutineCodeVersion Deletes a code version of a routine.
    DeleteRoutineRelatedRecord DeleteRoutineRelatedRecord Deletes a record that is associated with a routine.
    DeleteScheduledPreloadExecution DeleteScheduledPreloadExecution Deletes a scheduled prefetch plan based on the plan ID.
    DeleteScheduledPreloadJob DeleteScheduledPreloadJob Deletes a specified scheduled prefetch task based on the task ID.
    DeleteSite DeleteSite Deletes a website based on the specified website ID.
    DeleteSiteDeliveryTask DeleteSiteDeliveryTask Deletes a real-time log delivery task.
    DeleteUserDeliveryTask DeleteUserDeliveryTask Deletes a log delivery task from your Alibaba Cloud account.
    DeleteWafRule Delete WAF Rule Delete WAF Rule
    DeleteWafRuleset Delete WAF Ruleset Delete WAF Ruleset
    DeleteWaitingRoom DeleteWaitingRoom Deletes a waiting room.
    DeleteWaitingRoomEvent DeleteWaitingRoomEvent Deletes a waiting room event.
    DeleteWaitingRoomRule DeleteWaitingRoomRule Deletes a waiting room bypass rule.
    DescribeDDoSBpsList Query DDoS Network Layer Data Query DCDN DDoS user bps and pps data
    DescribeDDoSL7QpsList Query DDoS Application Layer Time Dimension Aggregated Statistics DDoS Analysis Layer 7 QPS Trend Chart API
    DescribeDdosMaxBurstGbps DescribeDdosMaxBurstGbps Queries the maximum burst bandwidth for a DDoS instance in mainland China.
    DescribeHttpDDoSAttackIntelligentProtection DescribeHttpDDoSAttackIntelligentProtection Queries the configuration of smart HTTP DDoS protection for a website.
    DescribeHttpDDoSAttackProtection DescribeHttpDDoSAttackProtection Queries the configurations of HTTP DDoS attack protection.
    DescribeHttpDDoSAttackRules DescribeHttpDDoSAttackRules Queries HTTP DDoS attack protection rules.
    DescribeHttpDDoSIntelligentAclRules DescribeHttpDDoSIntelligentAclRules Describes the accurate access control rules created by Deep Learning and Protection.
    DescribeHttpDDoSIntelligentRateLimitRules DescribeHttpDDoSIntelligentRateLimitRules Queries the frequency control rules generated by Deep Learning and Protection.
    DescribeKvAccountStatus DescribeKvAccountStatus Queries whether Edge KV is activated in your Alibaba Cloud account.
    DescribePreloadTasks DescribePreloadTasks Queries the details of prefetch tasks by time, task status, or prefetch URL.
    DescribePurgeTasks DescribePurgeTasks Queries the details of purge tasks.
    DescribeRatePlanInstanceStatus DescribeRatePlanInstanceStatus Queries the status of an instance that uses a plan.
    DisableCustomScenePolicy DisableCustomScenePolicy Disables a scenario-specific policy.
    EditSiteWafSettings Edit WAF Configuration for a Site Edit WAF Configuration for a Site
    EnableCustomScenePolicy EnableCustomScenePolicy Enables a scenario-specific policy.
    ExportRecords ExportRecords Exports all DNS records of a website domain as a TXT file.
    GetCacheReserveSpecification GetCacheReserveSpecification Queries the available specifications of cache reserve instances.
    GetCacheTag Query Site Cache Tag Configuration Query Site Cache Tag Configuration
    GetCertificateQuota GetCertificateQuota Query certificate quota and usage
    GetClientCaCertificate GetClientCaCertificate Queries a client CA certificate.
    GetClientCertificate GetClientCertificate Queries information about a client certificate.
    GetClientCertificateHostnames GetClientCertificateHostnames Queries 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.
    GetCnameFlattening GetCnameFlattening Queries the CNAME flattening configuration of a website
    GetCompressionRule Query Compression Rule Configuration Details Query Compression Rule Details
    GetDevelopmentMode GetDevelopmentMode Query Site Developer Mode Configuration
    GetEdgeContainerApp GetEdgeContainerApp Queries the information about a containerized application, including basic application configurations and health check configurations.
    GetEdgeContainerAppLogRiver GetEdgeContainerAppLogRiver Queries the log collection configuration of a containerized application.
    GetEdgeContainerAppStatus GetEdgeContainerAppStatus Queries the status information about a containerized application, including the deployment, release, and rollback of the application.
    GetEdgeContainerAppVersion GetEdgeContainerAppVersion Queries the information about a version of a containerized application. You can select an application version to release based on the version information.
    GetEdgeContainerDeployRegions GetEdgeContainerDeployRegions Queries regions where a containerized application is deployed based on the application ID.
    GetEdgeContainerLogs GetEdgeContainerLogs Queries Edge Container logs.
    GetEdgeContainerStagingDeployStatus GetEdgeContainerStagingDeployStatus Queries the deployment status of an application in the staging environment by using the application ID.
    GetEdgeContainerTerminal GetEdgeContainerTerminal Queries the terminal information of a containerized application.
    GetErService GetErService Checks the status of Edge Routine.
    GetHttpsBasicConfiguration Query Site HTTPS Basic Configuration Query a Single HTTPS Basic Configuration
    GetImageTransform Query Single Site Image Transformation Configuration Query Single Site Image Transformation Configuration
    GetKv GetKv Queries the value of a key in a key-value pair.
    GetKvAccount GetKvAccount Queries the Edge KV usage in your Alibaba Cloud account, including the information about all namespaces.
    GetKvNamespace GetKvNamespace Queries the information about a namespace in your Alibaba Cloud account.
    GetList GetList Queries the details of a custom list, such as the name, description, type, and content.
    GetNetworkOptimization Query Site Network Optimization Configuration Query a single network optimization configuration
    GetOriginPool Query a Single Origin Pool Query a specific origin pool
    GetPage GetPage Queries the details of a custom error page based on the error page ID.
    GetPurgeQuota GetPurgeQuota Queries the quotas and quota usage for different cache purge options.
    GetRealtimeDeliveryField GetRealtimeDeliveryField Queries the fields in real-time logs based on the log category.
    GetRedirectRule Query Redirect Configuration Details Query Redirect Rule Details
    GetRewriteUrlRule Query Rewrite URL Configuration Query details of the rewrite URL rule
    GetRoutineStagingCodeUploadInfo GetRoutineStagingCodeUploadInfo Obtains 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).
    GetScheduledPreloadJob GetScheduledPreloadJob Queries a specified scheduled prefetch task based on the task ID.
    GetSeoBypass GetSeoBypass Queries the configuration for search engine crawler of a website.
    GetSiteCurrentNS GetSiteCurrentNS Queries the nameservers configured for a website.
    GetSiteCustomLog GetSiteCustomLog Queries the configuration of custom log fields for a website.
    GetSiteDeliveryTask GetSiteDeliveryTask Queries a real-time log delivery task.
    GetSiteLogDeliveryQuota GetSiteLogDeliveryQuota Queries the remaining quota for delivering a specific category of real-time logs in a website.
    GetSiteNameExclusive GetSiteNameExclusive Queries the site hold configuration of a website. After you enable site hold, other accounts cannot add your website domain or its subdomains to ESA.
    GetSitePause GetSitePause Queries the ESA proxy configuration of a website.
    GetSiteWafSettings Get WAF Configuration for a Site Get WAF Configuration for a Site
    GetTieredCache Query Multi-level Cache Configuration for Site Query Multi-level Cache Configuration for Site
    GetUploadTask GetUploadTask Queries the execution status and running information of a file upload task based on the task ID.
    GetUserDeliveryTask GetUserDeliveryTask Queries the information about a log delivery task by account.
    GetUserLogDeliveryQuota GetUserLogDeliveryQuota Queries the remaining log delivery quota of each log category in your account.
    GetWafBotAppKey Get the APP key in the BOT phase of WAF This 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.
    GetWafRule Get Details of a Single WAF Rule Get Details of a Single WAF Rule
    GetWafRuleset Get Details of a Single WAF Ruleset Get WAF Ruleset Details
    ListCacheReserveInstances ListCacheReserveInstances Query Cache Reserve Instance List
    ListCiphers ListCiphers Query TLS Cipher Suite List
    ListClientCertificates ListClientCertificates Queries client certificates configured for a website.
    ListCompressionRules List Compression Rule Configurations Query the list of compression rules
    ListEdgeContainerAppRecords ListEdgeContainerAppRecords Lists domain names that are associated with a containerized application.
    ListEdgeContainerAppVersions ListEdgeContainerAppVersions Lists versions of all containerized applications.
    ListEdgeContainerApps ListEdgeContainerApps Queries all containerized applications in your Alibaba Cloud account.
    ListEdgeContainerRecords ListEdgeContainerRecords Queries the records that are associated with Edge Container for a website.
    ListEdgeRoutinePlans ListEdgeRoutinePlans Queries Edge Routine plans.
    ListEdgeRoutineRecords ListEdgeRoutineRecords Queries the records that are associated with Edge Routine routes for a website.
    ListHttpsBasicConfigurations Query HTTPS Basic Configuration List Query multiple HTTPS basic configurations
    ListImageTransforms Query Multiple Site Image Transformation Configurations Query Multiple Site Image Transformation Configurations
    ListInstanceQuotas ListInstanceQuotas Queries the quota details in a subscription plan.
    ListInstanceQuotasWithUsage ListInstanceQuotasWithUsage Queries quotas and the actual usage in a plan based on the website or plan ID.
    ListKvs ListKvs Lists all key-value pairs in a namespace in your Alibaba Cloud account.
    ListLoadBalancerOriginStatus Query the Status of Origins under Load Balancers Query the status of origins in load balancers
    ListLoadBalancerRegions Query Load Balancer Region Information Query Load Balancer Region List
    ListManagedRulesGroups List WAF Managed Rule Groups List Custom Managed Rule Groups
    ListNetworkOptimizations Query Network Optimization Configurations List Query multiple network optimization configurations
    ListOriginPools List Origin Pools List Origin Pools
    ListRedirectRules Query Redirect Configuration List Query Redirect Rule List
    ListRewriteUrlRules List of Rewrite URL Configurations for a Site List of Rewrite URL Rules
    ListScheduledPreloadExecutions ListScheduledPreloadExecutions Lists the plans in a scheduled prefetch task by task ID.
    ListSiteDeliveryTasks ListSiteDeliveryTasks Lists all log delivery tasks that are in progress.
    ListTagResources ListTagResources Queries tags based on the region ID and resource type.
    ListUploadTasks ListUploadTasks Queries the execution status and running information of file upload tasks based on the task time and type.
    ListUserDeliveryTasks ListUserDeliveryTasks Queries 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.
    ListUserRatePlanInstances ListUserRatePlanInstances Queries the plans that you purchased and the details of the plans.
    ListWafPhases List WAF Operation Phases List WAF Phases
    ListWafRulesets List WAF Rule Sets List WAF Rule Sets
    ListWafUsageOfRules List WAF Rule Usage List WAF Rule Usage
    ListWaitingRoomEvents ListWaitingRoomEvents Queries the information about waiting room events for a waiting room.
    ListWaitingRoomRules Query Waiting Room Bypass Rules List Query Waiting Room Bypass Rules
    ListWaitingRooms ListWaitingRooms Queries the information about all waiting rooms in a website.
    OpenErService OpenErService OpenErService
    PreloadCaches PreloadCaches Prefetches cache.
    PublishEdgeContainerAppVersion PublishEdgeContainerAppVersion Releases a specific version of a containerized application. You can call this operation to iterate an application.
    PurchaseCacheReserve Purchase Cache Retention New Purchase of Cache Retention
    PurgeCaches PurgeCaches Purges 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.
    PutKv PutKv Configures a key-value pair for a namespace. The request body can be up to 2 MB.
    PutKvWithHighCapacity PutKvWithHighCapacity Configures a large key-value pair for a namespace. The request body can be up to 25 MB.
    RebuildEdgeContainerAppStagingEnv RebuildEdgeContainerAppStagingEnv Rebuilds the staging environment for containerized applications.
    ResetScheduledPreloadJob ResetScheduledPreloadJob Resets the progress of a scheduled prefetch task and starts the prefetch from the beginning.
    RevokeClientCertificate RevokeClientCertificate Revokes an activated client certificate.
    SetDdosMaxBurstGbps SetDdosMaxBurstGbps Sets the maximum burstable protection bandwidth for a DDoS instance in mainland China.
    SetHttpDDoSAttackIntelligentProtection SetHttpDDoSAttackIntelligentProtection Configures smart HTTP DDoS protection.
    SetHttpDDoSAttackProtection SetHttpDDoSAttackProtection Configures HTTP DDoS attack protection for a website.
    StartScheduledPreloadExecution StartScheduledPreloadExecution Starts a scheduled prefetch plan based on the plan ID.
    StopScheduledPreloadExecution StopScheduledPreloadExecution Stops a scheduled prefetch plan based on the plan ID.
    UntagResources UntagResources Deletes a resource tag based on a specified resource ID.
    UpdateCacheTag UpdateCacheTag Modifies 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.
    UpdateCustomResponseCodeRule UpdateCustomResponseCodeRule Modify the response code configuration for a site.
    UpdateDevelopmentMode UpdateDevelopmentMode Modifies 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.
    UpdateEdgeContainerAppLogRiver UpdateEdgeContainerAppLogRiver Updates the log collection configuration of a containerized application.
    UpdateList UpdateList Updates a custom list.
    UpdateOriginPool Update a Single Origin Pool Modify the Monitor
    UpdateOriginProtection UpdateOriginProtection Enables or disables IP convergence.
    UpdateOriginProtectionIpWhiteList UpdateOriginProtectionIpWhiteList Updates the IP whitelist for origin protection used by a website to the latest version.
    UpdatePage UpdatePage Modifies the configurations of a custom error page, such as the name, description, content type, and content of the page.
    UpdateScheduledPreloadExecution UpdateScheduledPreloadExecution Updates a scheduled prefetch plan based on the plan ID.
    UpdateSiteAccessType UpdateSiteAccessType Converts the DNS setup option of a website.
    UpdateSiteCoverage UpdateSiteCoverage Modifies 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.
    UpdateSiteCustomLog UpdateSiteCustomLog Modifies the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.
    UpdateSiteDeliveryTask UpdateSiteDeliveryTask Modifies a real-time log delivery task.
    UpdateSiteDeliveryTaskStatus UpdateSiteDeliveryTaskStatus Changes the status of a real-time log delivery task.
    UpdateSiteNameExclusive UpdateSiteNameExclusive Modifies the site hold configuration of a website. After you enable site hold, other accounts cannot add your website domain or its subdomains to ESA.
    UpdateSitePause UpdateSitePause Modifies the ESA proxy configuration of a website.
    UpdateSiteVanityNS UpdateSiteVanityNS Updates the custom nameserver names for a single website.
    UpdateTieredCache UpdateTieredCache Modifies the tiered cache configuration of your website.
    UpdateUserDeliveryTask UpdateUserDeliveryTask Modifies the configurations of a delivery task, including the task name, log field, log category, and discard rate.
    UpdateUserDeliveryTaskStatus UpdateUserDeliveryTaskStatus Changes the status of a delivery task in your Alibaba Cloud account.
    UpdateWafRule Update WAF Rule Update WAF Rule Page
    UpdateWafRuleset Update WAF Ruleset Update WAF Ruleset
    UpdateWaitingRoom UpdateWaitingRoom Modifies the configurations of a waiting room.
    UpdateWaitingRoomEvent UpdateWaitingRoomEvent Modifies the configurations of a waiting room event.
    UpdateWaitingRoomRule Modify Waiting Room Bypass Rule Modify Waiting Room Rule
    UploadClientCaCertificate UploadClientCaCertificate Uploads a client certificate authority (CA) certificate.
    UploadFile UploadFile Uploads the file that contains resources to be purged or prefetched.
    UploadSiteOriginClientCertificate Upload Site-level Origin Client Certificate Upload site origin client certificate
    VerifySite VerifySite Verifies the ownership of a website domain. Websites that pass the verification are automatically activated.

    Billing management

    API

    Title

    Description
    Plan management Plan management
    PurchaseRatePlan New Package Purchase Purchase New Package
    UpdateRatePlanSpec Package Upgrade/Downgrade You can invoke UpdateRatePlanSpec to modify the Package Tier.