All Products
Search

This Product

    Edge Security Acceleration:API overview

    Document Center

    Edge Security Acceleration:API overview

    Last Updated:Sep 18, 2026

    API standards and multilingual preset SDKs

    The OpenAPI of this product (ESA/2024-09-10) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

    Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

    Custom signature scenarios

    If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

    Account and security preparation

    Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

    Site management

    API

    Title

    Description
    Add and verify sites Add and verify sites
    CreateSite Create a site Creates a site.
    CheckSiteName CheckSiteName Checks whether a specified website name is available.
    VerifySite VerifySite Verifies the ownership of a website domain. Websites that pass the verification are automatically activated.
    GetSiteCurrentNS GetSiteCurrentNS Queries the nameservers configured for a website.
    Query sites Query sites
    GetSite Query information of a single site Retrieves the details of a site by its ID.
    ListSites Query site list Queries the list of sites under the current user, including site names, statuses, and configurations.
    Update and delete sites Update and delete sites
    DeleteSite DeleteSite Deletes a site by site ID.
    UpdateSiteAccessType UpdateSiteAccessType Converts the DNS setup option of a website.
    UpdateSiteCoverage Modify site acceleration region Modifies the acceleration region of a site. Updates the acceleration configuration of a site to adapt to traffic distribution changes or improve the access experience for users in specific regions.
    UpdateSiteVanityNS Modify custom NS servers for a site Modifies the custom nameserver (NS) names for a single site.

    Site configuration

    API

    Title

    Description
    Site status Site status
    Site suspension Site suspension
    UpdateSitePause Modify site pause configuration Modifies the site pause configuration.
    GetSitePause GetSitePause Queries the site pause configuration.
    Site name exclusivity Site name exclusivity
    UpdateSiteNameExclusive Modify exclusive site name configuration Modifies the exclusive site name configuration. After this feature is enabled, other accounts can no longer create sites or subsites with the same name as the current site.
    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.
    Version management Version management
    DeactivateVersionManagement Disable site version management Disables the version management feature for a site.
    ActivateVersionManagement Enable site version management Enables version management. This allows a site to support multiple configuration versions and multiple deployment environments, providing more flexible management of site traffic and configuration.
    DNS DNS
    SaaS domain names SaaS domain names
    CreateCustomHostname Create a saaS domain name Creates a 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 Update a saaS domain name Updates a SaaS domain name. You can modify the bound record ID, certificate type, and other settings.
    VerifyCustomHostname Verify saaS domain name ownership Verifies the ownership of a SaaS domain name. Sites that pass the verification are automatically activated.
    GetCustomHostname Query saaS domain name details Retrieves the detailed configuration of a single SaaS domain name, including the domain verification TXT name, domain verification TXT content, and certificate expiration time (when SSL is enabled).
    ListCustomHostnames Query saaS domain names Queries the list of SaaS domain names under a site, including the ID, status, and domain name verification information of each SaaS domain name. You can filter results by SaaS domain name, site ID, or associated record ID.
    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
    CreateRecord Create DNS Record Create a DNS record under a site.
    BatchCreateRecords Batch create DNS records Creates multiple DNS records in a batch. Multiple record types are supported.
    DeleteRecord Delete a DNS record Deletes a DNS record based on its RecordId.
    UpdateRecord Update a DNS record Updates a DNS record. Various record types and origin authentication configurations are supported.
    ListRecords Query DNS Record List Queries the list of DNS records under a site, including record values, priorities, authentication configurations, etc. Supports filtering by conditions such as record name and record type.
    GetRecord Query DNS record details Retrieves the detailed configuration of a single DNS record, including the record value, priority, and back-to-origin authentication configuration (exclusive to CNAME records).
    ListEdgeRoutineRecords Query edge routing records Queries the list of edge routing records for a site.
    ListEdgeContainerRecords ListEdgeContainerRecords Queries the records that are associated with Edge Container for a website.
    ExportRecords ExportRecords Exports all DNS records of a website domain as a TXT file.
    CNAME flattening CNAME flattening
    UpdateCnameFlattening UpdateCnameFlattening Modifies the CNAME flattening configuration of a website.
    GetCnameFlattening GetCnameFlattening Queries the CNAME flattening configuration of a website
    SSL/TLS SSL/TLS
    Site certificates Site certificates
    ApplyCertificate Apply for a free certificate Applies for a free certificate.
    SetCertificate Configure site certificate Configures whether to enable the certificate feature for a site and updates certificate information.
    ListCertificatesByRecord Query site certificates that match records Queries the list of site certificates that match records. Batch record matching is supported.
    GetCertificateQuota Query free certificate quota and usage Queries the quota and usage of free certificates.
    ListCiphers ListCiphers Query TLS Cipher Suite List
    DeleteCertificate DeleteCertificate Deletes a certificate for a website.
    ListCertificates Query site certificate list Queries the certificate list for a specific site.
    GetCertificate Get specified certificate information Retrieves information about a specified certificate for a site.
    Client certificates Client certificates
    UploadClientCaCertificate Upload a client CA certificate Uploads a client CA certificate.
    GetClientCaCertificate Get a client CA certificate Retrieves a specified client CA certificate.
    DeleteClientCaCertificate DeleteClientCaCertificate Deletes a client CA certificate.
    ListClientCaCertificates Get client CA certificate list Retrieves the list of client CA certificates for a specified site.
    CreateClientCertificate Create a client certificate Issues a client certificate by using the ESA certificate authority (CA).
    GetClientCertificate Get client certificate information Retrieves information about a specified client certificate.
    DeleteClientCertificate DeleteClientCertificate Deletes a revoked client certificate.
    ListClientCertificates Get client certificate list Retrieves the list of client certificates for a specified site.
    ActivateClientCertificate ActivateClientCertificate Activates the client based on the certificate ID.
    RevokeClientCertificate RevokeClientCertificate Revokes an activated client certificate.
    SetClientCertificateHostnames Set client CA certificate hostname bindings Associates domain names with a specified client CA certificate. If no certificate is specified, the domain names are associated with the ESA CA certificate. This API is deprecated. Use SetClientCaCertificateHostnames instead.
    GetClientCertificateHostnames Get domain name bindings of a client CA certificate Retrieves the domain name bindings for a specified client CA certificate. If no certificate is specified, returns the domain name bindings for the ESA CA certificate.
    SetClientCaCertificateHostnames SetClientCaCertificateHostnames Binds hostnames to a specified client CA certificate. If you do not specify a certificate, the hostnames are bound to the ESA CA certificate.
    GetClientCaCertificateHostnames Get domain names bound to a client CA certificate Retrieves the domain name bindinglist for a specified client CA certificate. If no certificate is specified, the domain name binding list for the ESA CA certificate is returned.
    Origin certificates Origin certificates
    UploadOriginCaCertificate Upload an origin server CA certificate Uploads a CA certificate for the origin server.
    GetOriginCaCertificate Retrieve origin server CA certificate information Retrieves the CA certificate information of an origin server.
    DeleteOriginCaCertificate Delete the source server CA certificate Deletes an origin CA certificate.
    ListOriginCaCertificates ListOriginCaCertificates Queries the list of origin server CA certificates.
    UploadSiteOriginClientCertificate Upload a site-level back-to-origin client certificate Uploads a site-level back-to-origin client certificate.
    GetSiteOriginClientCertificate Retrieve site-level back-to-origin client certificate information Retrieves the back-to-origin client certificate information at the site level.
    DeleteSiteOriginClientCertificate Delete the site-granularity origin fetch client certificate Deletes a site-level origin client certificate.
    ListCasCertificates Query China shield certificate list Queries the list of China Shield certificates.
    ListSiteOriginClientCertificates List site-level origin client certificates Queries the list of back-to-origin client certificates at the site level.
    UploadOriginClientCertificate Upload a domain-level back-to-origin client certificate Uploads a domain-level back-to-origin client certificate.
    GetOriginClientCertificate Retrieve back-to-origin client certificate information at the domain name granularity Retrieves the back-to-origin client certificate information at the domain name granularity.
    DeleteOriginClientCertificate Delete the domain name granularity origin fetch client certificate Deletes an origin client certificate for a specific site.
    ListOriginClientCertificates Query back-to-origin client certificates by domain name Queries the list of back-to-origin client certificates at the domain name granularity.
    SetOriginClientCertificateHostnames Attach domain names to the origin fetch client certificate at the domain name granularity. Associates specified hostnames with an origin client certificate.
    GetOriginClientCertificateHostnames Obtain the list of domain names attached to a client certificate for origin fetch at domain name granularity Retrieves the hostnames associated with a specific origin client certificate.
    Keyless service Keyless service
    SetKeylessServer Create or update a keyless server configuration Creates or updates a Keyless server configuration.
    GetKeylessServer Get keyless server configuration Retrieves the configuration of a Keyless server.
    ListKeylessServers Get keyless server configuration list Retrieves the list of Keyless server configurations for a site.
    DeleteKeylessServer DeleteKeylessServer Deletes a keyless server configuration.
    Security protection Security protection
    Intelligent rate limiting Intelligent rate limiting
    SetAutomaticFrequencyControlConfig SetAutomaticFrequencyControlConfig Configures the automatic frequency control threshold for a site.
    GetAutomaticFrequencyControlConfig GetAutomaticFrequencyControlConfig Queries the automatic frequency control configuration for a site.
    WAF WAF
    CreateWafRule Create a WAF rule Creates a rule in Web Application Firewall (WAF). You can use this operation to refine firewall behavior and improve the security of your website or application.
    CreateWafRuleset Create WAF Ruleset Creates a WAF ruleset.
    BatchCreateWafRules Batch create WAF rules Batch creates rules in a specified WAF phase. You can create multiple rules at a time and configure shared settings for these rules.
    GetWafRule Get details of a single WAF rule Retrieves the details of a single rule in Web Application Firewall (WAF). You can use this operation to query the configuration and status of a specific rule.
    GetWafRuleset Get WAF ruleset details Retrieves the details of a specified WAF ruleset. You can call this operation to query the configuration and status information of a specific ruleset.
    ListWafRules List WAF rules Lists all rules or filters rules by specific conditions under Web Application Firewall (WAF). You can use this operation to query detailed information about WAF rules in a paged manner.
    ListWafRulesets List WAF rulesets Lists the rulesets under the current WAF execution phase. Queries basic information and status of rulesets with paging support.
    UpdateWafRule Update WAF Rule Updates a web application firewall (WAF) rule. Use this operation to modify the rule's configuration and status.
    UpdateWafRuleset Update WAF Ruleset Updates a WAF ruleset based on its ID.
    BatchUpdateWafRules Batch update WAF rules Batch updates rules in a specified WAF ruleset. You can use this operation to update the configurations of multiple rules at a time.
    DeleteWafRule Delete WAF Rule Deletes a specified rule in Web Application Firewall (WAF). This operation also deletes the configurations and conditions associated with the rule.
    DeleteWafRuleset Delete WAF Ruleset Deletes a specified Web Application Firewall (WAF) ruleset.
    ListWafPhases List WAF Operation Phases List WAF Phases
    ListWafTemplateRules List WAF Template Rules Lists the template rules in WAF. These rules are typically predefined rulesets for quickly enabling protection against common attack types.
    ListWafManagedRules List WAF managed rules Lists all managed rules under Web Application Firewall (WAF) or filters rules based on specific conditions. You can use this operation to query detailed information about WAF managed rules in a paginated manner.
    ListManagedRulesGroups List WAF managed rule groups Lists all WAF managed rule groups under the current account. You can call this operation to retrieve a list of all rule groups and their summary information.
    ListWafUsageOfRules List WAF rule usage Lists the usage of WAF rules.
    GetWafQuota Retrieve WAF resource quotas Retrieves quota details for Web Application Firewall (WAF) resources. These quotas define the quantity limits of corresponding resources that a customer can use, such as managed rule groups, custom lists, custom response pages, and scenario-specific protection rules.
    GetWafFilter Obtain WAF matching engine information Retrieves matching engine information for a site at a given WAF phase, which defines how the WAF detects and handles various network requests.
    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.
    GetSiteWafSettings Get WAF configuration of a site Retrieves the WAF configuration of a site.
    EditSiteWafSettings Edit WAF configuration of a site Modifies the Web Application Firewall (WAF) configuration of a site. You can call this operation to update WAF settings for a site, such as modifying the client IP address identified by WAF.
    BatchGetExpressionFields Batch retrieve matching fields for expressions Retrieves matching items for expressions in batches.
    DDoS DDoS
    SetHttpDDoSAttackRuleStatus Set the Protection Status of Specified HTTP DDoS Attack Rules Set the Protection Status of Specified HTTP DDoS Attack Rules
    SetHttpDDoSAttackRuleAction Set the Protection Action for Specified HTTP DDoS Attack Rules Set the Protection Action for Specified HTTP DDoS Attack Rules
    DescribeHttpDDoSAttackRules DescribeHttpDDoSAttackRules Queries HTTP DDoS attack protection rules.
    SetHttpDDoSAttackProtection SetHttpDDoSAttackProtection Configures HTTP DDoS attack protection for a website.
    DescribeHttpDDoSAttackProtection DescribeHttpDDoSAttackProtection Queries the configurations of HTTP DDoS attack protection.
    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
    DescribeDDoSAllEventList Query the DDoS attack event list Gets a list of DDoS attack events.
    SetDdosMaxBurstGbps SetDdosMaxBurstGbps Sets the maximum burstable protection bandwidth for a DDoS instance in mainland China.
    DescribeDdosMaxBurstGbps DescribeDdosMaxBurstGbps Queries the maximum burst bandwidth for a DDoS instance in mainland China.
    DescribeDDoSEventMax Query peak values of DDoS attack events Queries the peak values of DDoS attack events within a specified time range.
    DescribeDDoSBpsMax Query DDoS network-layer attack peak data Queries the peak BPS and PPS data of DDoS network-layer attacks.
    SetHttpDDoSAttackIntelligentProtection SetHttpDDoSAttackIntelligentProtection This operation configures the intelligent HTTP DDoS protection settings for a site.
    DeleteHttpDDoSIntelligentRule Delete rules for deep learning and protection distribution Deletes a rule created by Deep Learning and Protection.
    DescribeHttpDDoSAttackIntelligentProtection DescribeHttpDDoSAttackIntelligentProtection Retrieves the HTTP DDoS intelligent protection configuration, including the protection mode and protection level.
    DescribeHttpDDoSIntelligentRateLimitRules DescribeHttpDDoSIntelligentRateLimitRules Queries the frequency control rules generated by Deep Learning and Protection.
    DescribeHttpDDoSIntelligentAclRules DescribeHttpDDoSIntelligentAclRules Describes the accurate access control rules created by Deep Learning and Protection.
    API security API security
    GetApiSchemaUsage GetApiSchemaUsage Retrieves usage information for an API schema validation plan.
    Origin protection Origin protection
    CreateOriginProtection Enable origin protection Enables origin protection.
    DeleteOriginProtection DeleteOriginProtection Disable origin protection.
    UpdateOriginProtection UpdateOriginProtection Modify the origin protection feature to enable or disable origin fetch convergence.
    UpdateOriginProtectionIpWhiteList UpdateOriginProtectionIpWhiteList Confirm that you want to update the site’s origin IP whitelist to the latest version.
    GetOriginProtection GetOriginProtection Queries site origin protection configurations, including the origin protection switch, the origin convergence switch, whether the origin IP whitelist needs to be updated, and detailed information about the origin IP whitelist, including the current origin IP whitelist used by the site, the latest origin IP whitelist, and the differences between them.
    Cache Cache
    Development mode Development mode
    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.
    GetDevelopmentMode GetDevelopmentMode Query Site Developer Mode Configuration
    Purge cache Purge cache
    PurgeCaches Refresh node cache Refreshes file content on nodes. Supports refreshing by file, directory, cache tag, ignored parameters, hostname, and entire site.
    DescribePurgeTasks Query refresh tasks Queries the execution status of refresh tasks.
    GetPurgeQuota Get refresh quota Retrieves the quota and used quota for different refresh types.
    Cache tags Cache tags
    UpdateCacheTag UpdateCacheTag Modifies the cache tag configuration of your website.
    GetCacheTag Query Site Cache Tag Configuration Query Site Cache Tag Configuration
    Batch purge and prefetch Batch purge and prefetch
    UploadFile Upload a refresh or prefetch file Uploads a refresh or prefetch file to improve access speed.
    GetUploadTask Query file upload task status Queries the execution status and runtime information of a file upload task by task ID.
    ListUploadTasks List file upload tasks Lists the execution status and runtime information of file upload tasks by time and type.
    Prefetch cache Prefetch cache
    PreloadCaches Prefetch uRLs Prefetches URLs to warm the cache.
    DescribePreloadTasks Query prefetch task details Queries the details of prefetch tasks. Supports paged query by time, task status, and prefetch URL.
    Scheduled prefetch Scheduled prefetch
    CreateScheduledPreloadJob Add a scheduled prefetch task Adds a scheduled prefetch task.
    CreateScheduledPreloadExecutions Batch create scheduled prefetch task plans Creates execution plans for batch scheduled prefetch tasks.
    StartScheduledPreloadExecution Start a single scheduled prefetch plan Starts a scheduled prefetch based on the prefetch plan ID.
    StopScheduledPreloadExecution Stop a single scheduled prefetch plan Stops a single scheduled prefetch plan by prefetch plan ID. Prerequisites: (1) This operation takes effect only when the execution plan is in the running state. Execution plans in the waiting or failed state cannot be stopped. (2) Whether an execution plan can reach the running state depends on whether the associated site has passed the access verification (site Status=active).
    DeleteScheduledPreloadExecution Delete a single scheduled prefetch plan Deletes a single scheduled prefetch plan by prefetch plan ID.
    DeleteScheduledPreloadJob Delete a specified scheduled prefetch task Deletes a specified scheduled prefetch task by task ID.
    UpdateScheduledPreloadExecution Update a scheduled prefetch plan Updates a scheduled prefetch plan based on the prefetch plan ID.
    ResetScheduledPreloadJob Reset the progress of a scheduled prefetch task Resets the progress of a scheduled prefetch task and restarts the prefetch from the beginning. Before calling this operation, you must first create a scheduled prefetch task by calling CreateScheduledPreloadJob to obtain a valid task ID, and then pass the ID to this operation for resetting.
    GetScheduledPreloadJob Query a single scheduled prefetch task Queries a single scheduled prefetch task by task ID.
    ListScheduledPreloadJobs List scheduled prefetch tasks Lists the scheduled prefetch tasks for a site.
    ListScheduledPreloadExecutions List execution plans of a specified scheduled prefetch task Lists the execution plans of a specified scheduled prefetch task by task ID.
    Content blocking Content blocking
    BlockObject Block URL Blocks access to a specified URL.
    Tiered cache Tiered cache
    UpdateTieredCache Modify site multi-level cache configuration Modifies the multi-level cache configuration of a site.
    GetTieredCache Query Multi-level Cache Configuration for Site Query Multi-level Cache Configuration for Site
    Cache reserve Cache reserve
    GetCacheReserveSpecification GetCacheReserveSpecification Queries the available specifications of cache reserve instances.
    ListCacheReserveInstances Query cache reserve instances Queries the list of cache reserve instances for the current user.
    PurchaseCacheReserve Purchase a cache reserve instance Purchases a cache reserve instance.
    UpdateCacheReserveSpec Cache Reserve Specification Change Cache Reserve Specification Change
    Rules Rules
    SSL/TLS rules SSL/TLS rules
    CreateHttpsBasicConfiguration Create HTTPS basic configuration for a site Create HTTPS basic configuration for a site.
    UpdateHttpsBasicConfiguration Modify Site HTTPS Basic Configuration Modify Basic HTTPS Configuration.
    GetHttpsBasicConfiguration Query Site HTTPS Basic Configuration Query a Single HTTPS Basic Configuration
    ListHttpsBasicConfigurations Query HTTPS basic configurations Queries multiple HTTPS basic configurations.
    DeleteHttpsBasicConfiguration Delete Site HTTPS Basic Configuration Delete HTTPS Basic Configuration
    HTTPS rules HTTPS rules
    CreateHttpsApplicationConfiguration Add Site HTTPS Application Configuration Adds an HTTPS application configuration to a site.
    UpdateHttpsApplicationConfiguration Modify Site HTTPS Application Configuration Update the HTTPS Application Configuration.
    GetHttpsApplicationConfiguration Query Site HTTPS Application Configuration Retrieves a single HTTPS application configuration.
    ListHttpsApplicationConfigurations Query HTTPS Application Configuration List Query multiple HTTPS application configurations.
    DeleteHttpsApplicationConfiguration Delete Site HTTPS Application Configuration Delete HTTPS Application Configuration
    Redirect rules Redirect rules
    CreateRedirectRule Create redirect configuration Creates a redirect configuration for a site.
    UpdateRedirectRule Update redirect configuration Modifies the redirect configuration of a site.
    GetRedirectRule Query Redirect Configuration Details Query Redirect Rule Details
    ListRedirectRules Query redirect configuration list Queries the redirect configuration list of a site.
    DeleteRedirectRule DeleteRedirectRule Deletes a URL redirect rule for a website.
    Rewrite URL Rewrite URL
    CreateRewriteUrlRule CreateRewriteUrlRule Create a rewrite URL rule configuration for a site.
    UpdateRewriteUrlRule Modify URL rewrite configuration Modifies the URL rewrite configuration of a site.
    GetRewriteUrlRule Query Rewrite URL Configuration Query details of the rewrite URL rule
    ListRewriteUrlRules Query URL rewrite configurations for a site Queries the list of URL rewrite configurations for a site.
    DeleteRewriteUrlRule DeleteRewriteUrlRule Deletes a URL rewrite rule for a website.
    Modify outbound request headers (ESA to origin) Modify outbound request headers (ESA to origin)
    CreateHttpRequestHeaderModificationRule Create an HTTP request header modification configuration Creates an HTTP request header modification configuration for a site.
    UpdateHttpRequestHeaderModificationRule Update HTTP Request Header Modification Configuration Modify HTTP request header rules.
    GetHttpRequestHeaderModificationRule Query HTTP Request Header Configuration Details Retrieves the details of an HTTP request header modification rule for a site.
    ListHttpRequestHeaderModificationRules Query HTTP request header modification configurations Queries the list of HTTP request header modification configurations.
    DeleteHttpRequestHeaderModificationRule DeleteHttpRequestHeaderModificationRule Deletes the configuration of modifying HTTP request headers for a website.
    Modify inbound request headers (client to ESA) Modify inbound request headers (client to ESA)
    CreateHttpIncomingRequestHeaderModificationRule Create an HTTP inbound request header modification configuration Creates a configuration for modifying HTTP inbound request headers for a site.
    UpdateHttpIncomingRequestHeaderModificationRule Update HTTP Incoming Request Header Modification Configuration Modify HTTP incoming request header configuration.
    GetHttpIncomingRequestHeaderModificationRule GetHttpIncomingRequestHeaderModificationRule Queries the configuration details of an HTTP request header modification rule for a website.
    ListHttpIncomingRequestHeaderModificationRules Query HTTP incoming request header modification configurations Queries the list of HTTP incoming request header modification configurations for a site.
    DeleteHttpIncomingRequestHeaderModificationRule DeleteHttpIncomingRequestHeaderModificationRule Deletes the configuration of modifying incoming HTTP request headers for a website.
    Modify outbound response headers (ESA to client) Modify outbound response headers (ESA to client)
    CreateHttpResponseHeaderModificationRule Create an HTTP response header modification configuration Creates an HTTP response header modification configuration.
    UpdateHttpResponseHeaderModificationRule Update HTTP response header modification configuration Updates the HTTP response header modification configuration for a site.
    GetHttpResponseHeaderModificationRule Query HTTP Response Header Configuration Details Queries the details of an HTTP response header modification rule for a site.
    ListHttpResponseHeaderModificationRules Query HTTP response header modification configurations Queries the list of HTTP response header modification configurations for a site.
    DeleteHttpResponseHeaderModificationRule DeleteHttpResponseHeaderModificationRule Deletes the configuration of modifying HTTP response headers for a website.
    Modify inbound response headers (origin to ESA) Modify inbound response headers (origin to ESA)
    CreateHttpIncomingResponseHeaderModificationRule Create an HTTP inbound response header modification configuration Creates a configuration for modifying HTTP inbound response headers for a site.
    UpdateHttpIncomingResponseHeaderModificationRule Update HTTP incoming response header modification configuration Updates the HTTP incoming response header modification configuration for a site.
    GetHttpIncomingResponseHeaderModificationRule GetHttpIncomingResponseHeaderModificationRule Queries the configuration details of an incoming HTTP response header modification rule for a website.
    ListHttpIncomingResponseHeaderModificationRules Query configurations for modifying HTTP incoming response headers Queries the list of configurations for modifying HTTP incoming response headers of a site.
    DeleteHttpIncomingResponseHeaderModificationRule DeleteHttpIncomingResponseHeaderModificationRule Deletes the configuration of modifying HTTP response headers for a website.
    Custom response codes Custom response codes
    CreateCustomResponseCodeRule Create a custom response code rule Creates a custom response code rule for a site.
    UpdateCustomResponseCodeRule Update response code rewrite configuration Modifies the response code rewrite configuration of 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 Query custom response code configuration list Query the list of custom response code configurations for a site.
    Managed transforms Managed transforms
    UpdateManagedTransform Modify Site Managed Transformation Configuration Modify the site hosting transformation configuration.
    GetManagedTransform Query Managed Transform Configuration Retrieves the managed transform configuration for a site.
    Cache rules Cache rules
    CreateCacheRule Add Site Cache Configuration Create a Site Cache Configuration.
    UpdateCacheRule Modify Site Cache Configuration Modify the cache configuration.
    GetCacheRule Query Site Cache Configuration Retrieves a single cache configuration.
    ListCacheRules Query site cache configuration list Queries multiple cache configurations.
    DeleteCacheRule Delete Site Cache Configuration Delete Cache Configuration
    Network optimization rules Network optimization rules
    CreateNetworkOptimization Add site network optimization configuration Adds a network optimization configuration for a site.
    UpdateNetworkOptimization Modify Site Network Optimization Configuration Updates a network optimization configuration.
    GetNetworkOptimization Query Site Network Optimization Configuration Query a single network optimization configuration
    ListNetworkOptimizations Query network optimization configurations Queries multiple network optimization configurations.
    DeleteNetworkOptimization Delete Site Network Optimization Configuration Delete Network Optimization Configuration
    File compression File compression
    CreateCompressionRule Create a compression rule configuration Creates a compression rule configuration for a site.
    UpdateCompressionRule Modify compression rule configuration Modifies the compression rule configuration of a site.
    GetCompressionRule Query Compression Rule Configuration Details Query Compression Rule Details
    ListCompressionRules Query compression rule configurations Queries the list of compression rule configurations.
    DeleteCompressionRule Delete Compression Rule Configuration Delete compression rule
    Image processing Image processing
    CreateImageTransform Create site image transformation configuration Creates an image transformation configuration for a site.
    UpdateImageTransform Modify site image transformation configuration Modifies the image transformation configuration of a site.
    GetImageTransform Query a single site image transformation configuration Queries a single site image transformation configuration.
    ListImageTransforms Query image transformation configurations for a site Queries the list of image transformation configurations for a site.
    DeleteImageTransform Delete Site Image Transformation Configuration Delete Site Image Transformation Configuration
    Video processing Video processing
    CreateVideoProcessing CreateVideoProcessing Create a site video processing configuration.
    UpdateVideoProcessing Modify site video processing configuration Modifies the video processing configuration of a website.
    GetVideoProcessing GetVideoProcessing Queries the video processing configuration details of a site.
    ListVideoProcessings Query video processing configurations for a site Queries the list of video processing configurations for a site.
    DeleteVideoProcessing DeleteVideoProcessing Deletes a video processing configuration.
    Back-to-origin rules Back-to-origin rules
    CreateOriginRule Add Origin Rule Configuration for Site Create a Back-to-Origin Rule for a Site.
    UpdateOriginRule Modify Origin Rule Configuration for Site Updates a site's origin fetch rules.
    GetOriginRule GetOriginRule Queries the configurations of a single origin rule.
    ListOriginRules Query the list of site back-to-origin rule configurations Query multiple back-to-origin rule configurations.
    DeleteOriginRule Delete Origin Rule Configuration for Site Delete Origin Rule Configuration
    Speed and network Speed and network
    IPv6 IPv6
    UpdateIPv6 Modify IPv6 configuration for a website Modify IPv6 configuration for a website.
    GetIPv6 Query Site IPv6 Configuration Queries the IPv6 configuration for a site.
    Web page monitoring Web page monitoring
    CreateUrlObservation Create a web monitoring configuration Creates a web monitoring configuration.
    UpdateUrlObservation Update URL observation configuration Updates the URL observation configuration.
    DescribeUrlObservationData Query web page observation quality data Queries web page observation quality data.
    ListUrlObservations Query web page monitoring configurations Queries the list of web page observation configurations.
    DeleteUrlObservation DeleteUrlObservation Deletes page monitoring configurations.
    Chinese mainland network - access optimization Chinese mainland network - access optimization
    GetCrossBorderOptimization GetCrossBorderOptimization Queries the configuration of Chinese mainland access optimization.
    UpdateCrossBorderOptimization Modify China mainland network access optimization configuration for a site Modifies the China mainland network access optimization configuration for a site.
    Traffic Traffic
    Waiting room Waiting room
    CreateWaitingRoom Create a waiting room Creates a waiting room for a website.
    UpdateWaitingRoom Update a waiting room Updates the configuration of a specified waiting room.
    ListWaitingRooms Query waiting room list Queries the details of all configured waiting rooms for a specified site.
    DeleteWaitingRoom DeleteWaitingRoom Deletes a waiting room.
    CreateWaitingRoomRule Create a waiting room bypass rule Creates a waiting room bypass rule.
    UpdateWaitingRoomRule Update a waiting room bypass rule Updates the waiting room bypass rule configuration for a specified site.
    ListWaitingRoomRules Query Waiting Room Bypass Rules List Query Waiting Room Bypass Rules
    DeleteWaitingRoomRule DeleteWaitingRoomRule Deletes a waiting room bypass rule.
    CreateWaitingRoomEvent Create a waiting room event Creates a waiting room event. You can specify the queuing method and type.
    UpdateWaitingRoomEvent Update a waiting room event Updates the configuration of a waiting room event.
    ListWaitingRoomEvents ListWaitingRoomEvents Queries waiting room events for a waiting room.
    DeleteWaitingRoomEvent DeleteWaitingRoomEvent Deletes a waiting room event.
    UpdateSeoBypass Modify search engine crawler allowlisting configuration for a site Modifies the search engine crawler allowlisting configuration for a site.
    GetSeoBypass GetSeoBypass Queries the configuration for search engine crawler of a website.
    Origin address pools Origin address pools
    CreateOriginPool Create Origin Address Pool Creates an origin pool for a site. You can then use the origin pool with a Server Load Balancer or for direct back-to-origin requests.
    UpdateOriginPool Modify a single origin address pool Modifies a single origin address pool specified by the origin address pool ID.
    GetOriginPool Query a Single Origin Pool Retrieves a specific source address pool by its source address pool ID.
    ListOriginPools List Origin Pools Lists all origin pools within a site. Supports pagination and searching by origin pool name (exact or fuzzy).
    DeleteOriginPool Delete Origin Address Pool Delete Origin Address Pool
    Load balancing Load balancing
    CreateLoadBalancer Create a load balancer Creates a load balancer instance that supports custom routing policies, session persistence, monitoring configurations, and other advanced features.
    UpdateLoadBalancer Modify Existing Load Balancer Information To modify an existing load balancer, you must specify its load balancer ID.
    GetLoadBalancer Query a single load balancer Retrieves the details of a specific load balancer based on the specified site ID and load balancer ID.
    ListLoadBalancers Query load balancers under a site Queries the list of load balancers under a site and returns load balancing information. You can query by load balancer name. Paging is supported.
    DeleteLoadBalancer Delete Load Balancer Delete Load Balancer
    ListLoadBalancerRegions Query load balancer area information Queries the primary and secondary region information of a load balancing instance to obtain geographic region codes, descriptions, and other basic information that are active and can be used to configure a country/region-based scheduling policy for the load balancing instance.
    ListLoadBalancerOriginStatus Query the Status of Origins under Load Balancers Query the status of origins in load balancers
    Layer 4 proxy Layer 4 proxy
    CreateTransportLayerApplication Create a layer 4 acceleration application Creates a Layer 4 acceleration application.
    UpdateTransportLayerApplication Update a layer 4 acceleration application Modifies the forwarding rule configurations of a Layer 4 application under a specified site.
    GetTransportLayerApplication Query a layer 4 acceleration application Queries the details of a Layer 4 application.
    ListTransportLayerApplications Query the list of Layer 4 acceleration applications for a site Query the list of Layer 4 applications for a site.
    DeleteTransportLayerApplication Delete Transport Layer Acceleration Application Delete Transport Layer Application
    Function routing Function routing
    ListSiteRoutes Query edge routine routes for a site Queries the list of Edge Routine routes for a site.

    Edge computing

    API

    Title

    Description
    Edge functions Edge functions
    Function service Function service
    GetErService GetErService Checks the status of Edge Routine.
    OpenErService OpenErService OpenErService
    Function management Function management
    CreateRoutine Create an edge routine Creates an Edge Routine.
    ListUserRoutines Query user routine list Retrieves a paginated list of Edge Routines created by the user along with quota information.
    GetRoutine Query edge routine configuration Queries all configuration information of an Edge Routine, including the code version list, environment configuration list, associated domain name configuration list, and associated route configuration list.
    DeleteRoutine Delete an edge routine Deletes an Edge Routine.
    UpdateRoutineConfigDescription UpdateRoutineConfigDescription Modifies the description of a routine.
    Function routing Function routing
    CreateRoutineRoute Create an edge routine route configuration Creates an Edge Routine route configuration.
    UpdateRoutineRoute Modify edge routine route configuration Modifies the route configuration of an Edge Routine.
    DeleteRoutineRoute DeleteRoutineRoute Deletes the route configuration of an edge function.
    ListRoutineRoutes Query the function route list of an edge routine Queries the function route list of an Edge Routine.
    GetRoutineRoute Query a single edge routine route configuration Queries the configuration of a single Edge Routine route.
    Function-associated host records Function-associated host records
    CreateRoutineRelatedRecord Create an edge routine associated record Adds an associated site record for an Edge Routine function. This creates a new record under the site to trigger the execution of the Edge Routine function code.
    DeleteRoutineRelatedRecord Delete an edge routine association record Deletes an association record of an Edge Routine.
    ListRoutineRelatedRecords ListRoutineRelatedRecords The records associated with the function.
    Function code versions Function code versions
    GetRoutineStagingCodeUploadInfo Get upload information for edge routine test code Retrieves the upload information for uploading test version code of an Edge Routine to OSS.
    CommitRoutineStagingCode Submit edge routine staging code Submits the staging (unstable) code of an Edge Routine and generates a production version. Prerequisite: Before calling this API operation, call GetRoutineStagingCodeUploadInfo to obtain OSS upload credentials. Upload the code file through OSS POST. After the upload callback succeeds, call this API operation to submit the code.
    GetRoutineCodeVersionInfo Query routine code version information Queries the status and other information of a specific code version of a specified Routine.
    DeleteRoutineCodeVersion DeleteRoutineCodeVersion Deletes a code version of a routine.
    ListRoutineCodeVersions Query edge routine code versions Queries the code version information of a specified Edge Routine program by paging.
    GetRoutineCodeVersion Query code information of a specific edge routine version Queries the code information of a specific version of an Edge Routine.
    CreateRoutineCodeDeployment CreateRoutineCodeDeployment Creates a percentage-based canary deployment for a Routine code version in a specified environment.
    PublishRoutineCodeVersion Publish a specific version of edge routine code Publishes a specific version of Edge Routine code to a staging or production environment. When publishing to the production environment, you can perform a canary release to specific regions.
    Edge containers Edge containers
    Service management Service management
    OpenEdgeContainer Activate edge container service Activates the edge container service.
    GetEdgeContainer Retrieve edge container plan instance details Retrieves the details of an edge container plan instance.
    Container applications Container applications
    CreateEdgeContainerApp Create an edge container application Creates an edge container application. You can deploy and release the application by version to containerize edge services. Note: Activate the EdgeContainer service in the console before calling this operation. Calls from accounts that have not activated the service will return a service activation error.
    GetEdgeContainerApp Retrieve edge container application information Retrieves application information for an edge container, including basic application configurations and health check settings.
    ListEdgeContainerApps List edge container applications Retrieves a list of edge container applications, including all edge applications created under the current account.
    DeleteEdgeContainerApp Delete an edge container application Deletes an edge container application that is no longer needed by application ID.
    UpdateEdgeContainerAppResourceReserve Update edge container application resource reservation configuration Updates the resource reservation configuration of an edge container application.
    GetEdgeContainerAppResourceReserve Get edge container application resource reservation configuration Retrieves the resource reservation configuration of an edge container application.
    GetEdgeContainerTerminal Retrieve edge container application terminal information Retrieves terminal information of an edge container application.
    GetEdgeContainerAppStatus Retrieve edge container application status information Retrieves the application status information of an edge container, including deployment, publishing, and rollback details.
    DescribeEdgeContainerAppStats DescribeEdgeContainerAppStats Retrieves monitoring data for metrics of Edge Service Agent (ESA) edge containers.
    GetEdgeContainerAppResourceStatus GetEdgeContainerAppResourceStatus Obtains the distribution of edge container application resources.
    GetEdgeContainerAppResourceCapacity Get the resource capacity of an edge container application Get the resource capacity of an edge container application
    Container application image secrets Container application image secrets
    CreateEdgeContainerAppImageSecret Create Edge Container Application Image Secret Create an image secret for the edge container application
    ListEdgeContainerAppImageSecrets Retrieve image secret list for edge container application Retrieves the list of image secrets for an edge container application.
    DeleteEdgeContainerAppImageSecret DeleteEdgeContainerAppImageSecret Deletes the image secret for an edge containerized application.
    Logs Logs
    UpdateEdgeContainerAppLogRiver Update edge container log collection configuration Updates the log collection configuration of an edge container application.
    GetEdgeContainerAppLogRiver Retrieve edge container log collection configuration Retrieves the log collection configuration of an edge container application.
    GetEdgeContainerLogs Retrieve edge container log information Retrieves log information for an edge container. You can specify the number of output lines.
    Triggers Triggers
    CreateEdgeContainerAppRecord Create an associated domain name for an edge container application Creates an associated domain name for an edge container application. When a user sends a request from a client to access the associated domain name, the request is forwarded to the edge application deployed by the user.
    DeleteEdgeContainerAppRecord Delete an associated domain name of an edge container application Deletes an associated domain name from an edge container application. After deletion, the edge container service can no longer be accessed through this domain name. Note: 1) You must first call CreateEdgeContainerApp to create an edge container application and record the returned AppId. 2) You must first call CreateEdgeContainerAppRecord to bind a domain name record (RecordName) to the application. 3) A complete three-step call example of create, bind, and delete is provided.
    ListEdgeContainerAppRecords ListEdgeContainerAppRecords Lists domain names that are associated with a containerized application.
    Version management Version management
    CreateEdgeContainerAppVersion Create an edge container application version Creates an edge container application version. You can iteratively release applications by version. Note: 1) Your account must have an ESA plan with the Edge Container feature enabled. 2) Call CreateEdgeContainerApp first to create an application and obtain the AppId. 3) Complete call chain example: CreateEdgeContainerApp → ListEdgeContainerApps → CreateEdgeContainerAppVersion.
    DeleteEdgeContainerAppVersion DeleteEdgeContainerAppVersion Deletes a version of a containerized application.
    ListEdgeContainerAppVersions List edge container application versions Retrieves the version list of an edge container application, including information about all successfully created applications.
    GetEdgeContainerDeployRegions Get edge container application deployment regions Retrieves the deployment regions of an edge container application by application ID.
    GetEdgeContainerAppVersion Retrieve version information of an edge container application Retrieves the version information of an edge container application. You can use the version information to select a specific version for publishing.
    GetEdgeContainerStagingDeployStatus Get application staging environment deployment status Retrieves the staging environment deployment status of an application by application ID.
    PublishEdgeContainerAppVersion Publish a specified version of an edge container application Publishes a specified version of an edge container application, allowing users to iterate application versions through this operation.
    RebuildEdgeContainerAppStagingEnv RebuildEdgeContainerAppStagingEnv Rebuild the staging environment of an edge container application.
    RollbackEdgeContainerAppVersion Roll Back Edge Container Application Rolls back an edge container application to a specified version. Use this API to quickly recover from a failed deployment and minimize service disruption.
    Edge storage Edge storage
    Service status query Service status query
    DescribeKvAccountStatus Query KV status information of an account Queries the status information of an account in the KV service.
    GetKvAccount GetKvAccount Retrieves usage information for an account in the KV service, including a list of all namespaces.
    Key-value pair settings Key-value pair settings
    GetKvDetail Query the value and TTL information of a key-value pair Queries the value and TTL information of a key-value pair.
    ListKvs List key-value pairs in a KV namespace Lists all key-value pairs in a specified KV namespace under the account.
    GetKv GetKv Retrieves the value of a specified key.
    PutKv PutKv Creates or updates a single key-value pair in a namespace. The maximum size of a request is 2 MB.
    DeleteKv Delete a single key-value pair from a KV namespace Deletes a specific key-value pair from a KV namespace.
    BatchPutKv Batch set key-value pairs in a KV namespace Batch sets key-value pairs in a specified KV namespace based on a specified list of key names.
    BatchDeleteKv Batch delete key-value pairs from a KV namespace Batch deletes key-value pairs from a specified KV namespace based on a specified list of key names.
    PutKvWithHighCapacity Set a single large-capacity key-value pair in a KV namespace Sets a single large-capacity key-value pair in a KV namespace. The maximum value size is 25 MB.
    BatchPutKvWithHighCapacity Batch set large-capacity key-value pairs in a KV namespace Batch sets key-value pairs in a specified KV namespace based on a specified list of key names. The maximum request body size is 100 MB.
    BatchDeleteKvWithHighCapacity Batch delete high-capacity key-value pairs from a KV namespace Batch deletes key-value pairs from a specified KV namespace based on a list of key names. The maximum request body size is 100 MB.
    Storage space Storage space
    CreateKvNamespace Create a KV namespace Creates a key-value (KV) namespace under the current account.
    DeleteKvNamespace Delete a KV namespace Deletes a single KV namespace owned by the account.
    GetKvNamespace Query KV namespace information Queries the information of a KV namespace under an account.

    Analytics and logs

    API

    Title

    Description
    Data analytics Data analytics
    DescribeSiteTimeSeriesData Query network traffic analysis timing data Queries network traffic analysis timing data at the account dimension or site dimension.
    DescribeSiteTopData DescribeSiteTopData Queries the top-ranking records in a traffic analytics report by website or Alibaba Cloud account.
    Real-time logs Real-time logs
    CreateSiteDeliveryTask Create a real-time log delivery task Creates a real-time log delivery task.
    DeleteSiteDeliveryTask Delete a real-time log delivery task Deletes an ongoing log delivery task.
    UpdateSiteDeliveryTask Modify real-time log task delivery Modifies the delivery settings of a real-time log task for a user.
    UpdateSiteDeliveryTaskStatus UpdateSiteDeliveryTaskStatus Changes the status of a real-time log delivery task.
    UpdateUserDeliveryTaskStatus UpdateUserDeliveryTaskStatus Changes the status of a delivery task in your Alibaba Cloud account.
    CheckSiteProjectName Check real-time log delivery task project name Checks the project name of a real-time log delivery task.
    CheckUserProjectName CheckUserProjectName Checks the name of a real-time log delivery task by account.
    ListSiteDeliveryTasks ListSiteDeliveryTasks Lists all log delivery tasks that are in progress.
    GetRealtimeDeliveryField GetRealtimeDeliveryField Queries the fields in real-time logs based on the log category.
    GetUserLogDeliveryQuota Query real-time log delivery quota Queries the remaining log delivery quota for each business type of a specified user.
    GetSiteLogDeliveryQuota Query site log delivery quota Queries the remaining real-time log delivery quota for a specified site and business type.
    CreateSiteCustomLog CreateSiteCustomLog Adds the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.
    UpdateSiteCustomLog UpdateSiteCustomLog Modifies the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.
    GetSiteCustomLog GetSiteCustomLog Queries the configuration of custom log fields for a website.
    CreateUserDeliveryTask Create a user-level log delivery task Creates a custom log delivery task to deliver logs to destinations such as SLS, HTTP, OSS, S3, or Kafka.
    DeleteUserDeliveryTask Delete user delivery task Deletes a user task delivery configuration based on the specified task name and Alibaba Cloud UID.
    UpdateUserDeliveryTask Modify user task delivery configuration Modifies the delivery task configuration of a user, allowing you to set the task name, select fields, specify the real-time log type, and adjust the discard rate.
    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.
    GetUserDeliveryTask Get user task delivery details Queries the delivery configuration and status information of a specified task for a user.
    GetSiteDeliveryTask Get delivery task configuration information Retrieves the configuration information of a real-time log delivery task.
    Offline logs Offline logs
    DescribeSiteLogs Query site offline log download uRLs Queries the download URLs of raw access logs for a specified site.

    Global configuration

    API

    Title

    Description
    Global WAF Global WAF
    CreateUserWafRuleset Create a WAF ruleset Creates an instance-level Web Application Firewall (WAF) ruleset that supports multiple types of protection rules.
    DeleteUserWafRuleset DeleteUserWafRuleset Deletes a WAF ruleset from a specified instance.
    GetUserWafRuleset Get user WAF ruleset Queries the details of a WAF ruleset for a specified instance.
    ListUserWafRulesets ListUserWafRulesets Retrieves WAF rule sets for a specified instance, allowing filtering by phase, name, and other criteria.
    UpdateUserWafRuleset UpdateUserWafRuleset Modifies the WAF ruleset configuration for a specified instance, including its position, name, and other properties.
    Groups Groups
    CreateList Create a custom list Creates a custom list. Custom lists are typically referenced by the rule matching engine for values used in various security policies to implement complex logic and control.
    UpdateList Update a custom list Updates a custom list.
    GetList Get custom list details Retrieves the details of a specific custom list. You can use this operation to query the properties of a specific list, including the name, description, kind, and list items.
    ListLists List custom lists Lists all custom lists under the account along with their details. You can use query parameters to filter results and paginate to retrieve a specific set of lists.
    DeleteList DeleteList Deletes a custom list that is no longer needed.
    Scenario-specific policies Scenario-specific policies
    CreateCustomScenePolicy Create Scenario-specific Policy Creates a user-level custom scene policy. After you associate the policy with one or more sites, the policy applies to those sites.
    UpdateCustomScenePolicy Modify a scenario-specific policy Updates a specified custom scene policy.
    DisableCustomScenePolicy DisableCustomScenePolicy Disables a scenario-specific policy.
    EnableCustomScenePolicy EnableCustomScenePolicy Enables a scenario-specific policy.
    DescribeCustomScenePolicies Query scenario-specific policies Retrieves the configurations of custom scene policies.
    DeleteCustomScenePolicy DeleteCustomScenePolicy Deletes a scenario-specific custom policy.
    Custom pages Custom pages
    CreatePage Create a custom response page Creates a custom error response page. When a user request is blocked by Web Application Firewall (WAF), these custom error pages can be displayed. You can configure the page HTML content, page type, description, and other information, and submit the page content in BASE64 encoding.
    UpdatePage Update a custom response page Updates a custom response page that the user has created. You can use this operation to modify the page name, description, content type, and content.
    GetPage Get custom response page details Retrieves the details of a custom response page by its ID.
    ListPages List custom response pages Lists all custom response pages created by the user. This operation supports pagination and allows you to retrieve the response page list based on page number and page size.
    DeletePage DeletePage Deletes a custom error page that is no longer needed.

    Tag management

    API

    Title

    Description
    UntagResources UntagResources Deletes a resource tag based on a specified resource ID.
    TagResources TagResources Adds one or more tags to resources.
    ListTagResources Query tags Queries tags by region ID and resource type.

    Tools

    API

    Title

    Description
    Site diagnostics Site diagnostics
    ListTraceTasks Retrieve diagnostic task list Retrieves a list of diagnostic tasks.
    DescribeTraceDiagnoseReport Retrieve diagnostic report details Retrieves the details of a diagnostic report. 1. Call GenerateTraceDiagnose to obtain a diagnostic link. 2. Open the link in a browser to complete client diagnostics. 3. Call ListTraceTasks to obtain the TaskId/TraceId. 4. Call this operation to retrieve the report.
    GenerateTraceDiagnose Generate a diagnostic link Generates a diagnostic link.
    ListESAIPInfo ListESAIPInfo Batch query whether the IP address is included in the ESA resolution result.

    Billing management

    API

    Title

    Description
    Plan instance management Plan instance management
    PurchaseRatePlan Purchase a plan Calls the PurchaseRatePlan operation to purchase a plan.
    UpdateRatePlanSpec Change plan specifications Modifies the specifications of a plan by calling UpdateRatePlanSpec.
    DescribeRatePlanInstanceStatus Query plan instance status Invokes DescribeRatePlanInstanceStatus to query the instance status of a plan.
    ListEdgeRoutinePlans ListEdgeRoutinePlans Queries Edge Routine plans.
    ListUserRatePlanInstances Query user plan instance list Queries the plan instances purchased by the user and their details.
    ListPostpaidRatePlanInstances Query pay-as-you-go plan instances for a site Queries the list of pay-as-you-go plan instances.
    ListInstanceQuotas Query quota details of an instance Queries the quota details of the plan associated with a specific instance or site by quota name.
    DescribeRatePlanPrice DescribeRatePlanPrice Queries the price of a plan, including its type and status.
    Security instance management Security instance management
    DescribeBotPrice Query bot instance price Queries the price of a bot instance.
    ListDDoSInstances Query additionally purchased DDoS instances Queries the list of additionally purchased DDoS security instances.
    ReleaseInstance Schedule release Schedules the release of a security instance.
    DescribeCacheReservePrice Query cache reserve price Invokes DescribeCacheReservePrice to query the price of a query cache reserve instance.
    DescribeCacheReservePriceGap Query cache-retained specification change price Queries the price for a cache-retained specification change.
    DescribeRatePlanPriceGap Query plan specification change price difference Queries the price difference for a plan specification change by calling DescribeRatePlanPriceGap.
    PurchaseBotInstance Purchase a bot instance Purchases a new bot instance.
    Usage query Usage query
    ListInstanceQuotasWithUsage ListInstanceQuotasWithUsage Queries quotas and the actual usage in a plan based on the website or plan ID.

    Others

    API

    Title

    Description
    GetPerformanceDataCollection Query data quality collection configuration Queries the data quality collection configuration.
    UpdatePerformanceDataCollection Modify web data quality collection configuration Modifies the web data quality collection configuration.
    GetFailFile Get failed file download link Downloads the failed file for a specified upload task.
    SubmitUploadTask Submit a purge or prefetch task Starts a cache purge or prefetch task after the file is uploaded successfully.
    DescribeDDoSOverseasAttackCount Query the number of DDoS attacks outside China Queries the number of DDoS attacks outside China.
    DescribeSiteWafTimeSeriesData Query site WAF analysis time series data Retrieves time series data for WAF event analysis of a site.
    DescribeSiteWafTopData Query top WAF event analysis data for a site Retrieves the top data from WAF event analysis for a website.
    DescribeWafUsageData Query WAF usage data Queries the usage data of WAF by calling DescribeWafUsageData.
    GetDcvDelegation Retrieve managed DCV information Retrieves the delegated DCV information.
    AddUserBusinessForm Create a user requirement order Creates a user opportunity order.
    CheckSiteFeaturesMatchPlan Validate site compatibility during plan migration Validates whether a site is compatible with the target plan during site plan migration.
    CloneVersion Clone a site version Clones a new site version based on a specified site version.
    CreateEnvironment Create a site environment Creates a site environment.
    CreateRoutineBuild Create an ER build task Creates an ER build task.
    CreateRoutineBuildConfiguration Create an ER build configuration Creates an Edge Routine (ER) build configuration.
    DeleteEnvironment Delete a site environment Deletes a site environment. The default environment cannot be deleted.
    DeleteRoutineBuildConfiguration Delete ER build configuration Deletes the ER build configuration.
    DeleteRoutineEnvironmentVariables Delete environment variables of a routine Deletes environment variables of a Routine.
    DeleteVersion Delete a site version Deletes a version of a site. Version 0 cannot be deleted.
    DescribeConditionIPBInfo Query region information supported by the rules engine Queries the region information supported by the rules engine, including information in three dimensions: country, region, and ISP.
    DescribeDDoSPrice Query anti-DDoS instance price Queries the price of an Anti-DDoS Pro or Anti-DDoS Premium instance.
    DescribeRuleMetadata Retrieve rules engine metadata Retrieves metadata related to the rules engine.
    DescribeUserResourcePackage Query resource plans Queries the resource plan information of the current user.
    ExportRecordCnames Export CNAME records Exports the CNAME values of all records under the current site. When the site access mode is switched to CNAME access, you can call this operation to retrieve pre-configured CNAME values to prevent service interruptions.
    GetCacheReserve Query site cache reserve configuration Queries the cache reserve configuration of a site.
    GetMainDomainName Retrieve primary domain name Retrieves the primary domain name based on the specified site name.
    GetMatchSite Get the active site that matches a record name Retrieves the information of the longest-matching active site for a given record name under the current user. For example, if the input record name is www.test.example.com and the user has two active sites (test.example.com and example.com), the API returns the longest-matching active site test.example.com. If no matching active site is found, an error is returned.
    GetPageShield Query site page protection configuration Queries the page protection configuration of a site.
    GetReleaseTime Query scheduled release time Queries the scheduled release time.
    GetRoutineBuild Query a single ER build task Queries a single ER build task.
    GetRoutineBuildConfiguration Get build configuration Retrieves the build configuration.
    GetSiteTrafficSequence Query traffic sequences of a site Queries the traffic sequences and their details for the current site.
    GetUserMaxPlanQuota Query the maximum value of a numeric quota across all plans Queries the maximum value of a numeric quota across all plans under a user account.
    GetWaitingRoomPreviewPage Query waiting room preview page URL Queries the preview page URL of a waiting room.
    ListAsyncTasks Query asynchronous task list Queries the list of asynchronous tasks. You can use this operation to query the status of asynchronous tasks triggered by users, such as free certificate applications.
    ListAWSRegionInfos Query regions supported by AWS S3 Queries the list of regions supported by AWS S3.
    ListBotInstances Query bot security instances Queries the list of Bot security instances.
    ListEnvironments Query site environment list Queries the list of environments for a site.
    ListInstancesQuota Query quota information of multiple instances Queries the quota information of multiple instances.
    ListPostpaidSitePlans Query pay-as-you-go site plans Queries the list of pay-as-you-go site plans available for purchase by a user.
    ListQuotasMinEffectPlan Query minimum effective plan edition for a quota Queries the minimum plan edition required for a site plan quota to take effect, that is, the minimum plan edition to which the quota must be upgraded for use.
    ListRoutineBuildConfigurations List build configurations for multiple routines Lists the build configurations for multiple routines by name.
    ListRoutineBuilds Get ER build task list Retrieves the list of ER build tasks.
    ListRoutineEnvironmentVariables Query environment variables of a routine Queries the environment variables of a Routine.
    ListSiteFunctions Query site feature configurations Queries the feature configurations of a site. You can query all feature configurations of a site or specify FunctionName to query a specific feature configuration.
    ListVersions Query site version list Queries the version list of a site.
    ModifyInstanceFeatures Modify feature configurations of a plan instance Modifies the feature configurations of a plan instance.
    ModifySiteFeatures Disable plan-related configurations when changing site plan Disables plan-related configurations with one click when changing the plan for a site.
    PurchaseDDoSInstance Purchase a DDoS instance Purchases a new Anti-DDoS Pro or Anti-DDoS Premium instance.
    RecoverSite Restore a site Restores the status of a site that has been disabled.
    ReDoRoutineBuild Retry routine replication task Retries a routine replication task.
    RollbackEnvironmentVersion Roll back the deployment version of an environment Rolls back the deployment version of an environment.
    SetRoutineEnvironmentVariables Set environment variables for a routine Sets environment variables for a Routine.
    StopRoutineBuild Stop a task Stops a task.
    StopSite Deactivate a site Manually deactivates a site.
    TraceSite Tracing Analysis Performs Tracing Analysis. You can use this operation to construct and initiate an impersonation HTTP/HTTPS request to the ESA platform, displaying the site configuration matching and effective settings on the ESA platform for the request.
    UpdateBotSpec Change bot instance specifications Changes the specifications of a bot instance.
    UpdateCacheReserve Modify site cache reserve configuration Modifies the cache reserve configuration of a site.
    UpdateConfigSequence Modify rule configuration priority Modifies the priority of a single rule configuration.
    UpdateDDoSSpec Modify DDoS instance specifications Modifies the specifications of a DDoS instance.
    UpdateEnvironment Update an environment Updates an environment.
    UpdateEnvironmentVersion Modify environment deployment version Modifies the deployment version of an environment.
    UpdateRoutineBuildConfiguration Modify ER build configuration Modifies the ER build configuration.
    UpdateSiteInstance Change the plan instance of a site Changes the plan instance associated with a site.
    UpdateVersionDesc Update version description Updates the description of a version.
    UpgradeEnvironmentVersion Upgrade environment deployment version Upgrades the deployment version of an environment.