All Products
Search
Document Center

CDN:API overview

Last Updated:Mar 27, 2026

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (Cdn/2018-05-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.

Domain name management

API

Title

Description

Adding or removing domain names Adding or removing domain names
AddCdnDomain AddCdnDomain You can call the AddCdnDomain operation to add an accelerated domain name.
BatchAddCdnDomain BatchAddCdnDomain Adds one or more domain names to Alibaba Cloud CDN. You can add a maximum of 50 domain names at a time.
DeleteCdnDomain DeleteCdnDomain Removes an accelerated domain name from Alibaba Cloud CDN.
Enabling or disabling domain names Enabling or disabling domain names
StartCdnDomain StartCdnDomain Enables a disabled domain name. After the domain name is enabled, the value of the DomainStatus parameter is changed to Online.
BatchStartCdnDomain BatchStartCdnDomain Enables one or more domain names at a time. After a domain name is enabled, the value of the DomainStatus parameter is changed to Online.
StopCdnDomain StopCdnDomain Disables an accelerated domain name. After the domain name is disabled, the value of the DomainStatus parameter is changed to Offline.
BatchStopCdnDomain BatchStopCdnDomain Disables one or more accelerated domain names at a time. After an accelerated domain name is disabled, the value of the DomainStatus parameter is changed to Offline.
Domain name configuration Domain name configuration
DescribeDomainCname DescribeDomainCname You can call this API to query the CNAME record of an accelerated domain name and verify its configuration.
DescribeCdnDomainDetail DescribeCdnDomainDetail Queries the basic information about an accelerated domain name.
DescribeCdnDomainConfigs DescribeCdnDomainConfigs You can call the DescribeCdnDomainConfigs operation to retrieve the configurations of an accelerated domain name. You can query the configurations of multiple features in a single call.
BatchSetCdnDomainConfig BatchSetCdnDomainConfig You can call the BatchSetCdnDomainConfig operation to configure multiple domain names in a batch.
BatchDeleteCdnDomainConfig BatchDeleteCdnDomainConfig Deletes configurations of multiple accelerated domain names at a time.
BatchUpdateCdnDomain BatchUpdateCdnDomain Updates the configurations of multiple accelerated domain names at a time.
DeleteSpecificConfig DeleteSpecificConfig Deletes specified configurations of an accelerated domain name.
ModifyCdnDomain ModifyCdnDomain Modifies the configuration of an accelerated domain name.
Domain name configuration management in the staging environment Domain name configuration management in the staging environment
SetCdnDomainStagingConfig SetCdnDomainStagingConfig You can call SetCdnDomainStagingConfig to configure an accelerated domain name in the staging environment.
DeleteSpecificStagingConfig DeleteSpecificStagingConfig Deletes a specified configuration of the staging environment.

Refresh and prefetch

API

Title

Description

PushObjectCache PushObjectCache Prefetches content from origin servers to points of presence (POPs). This reduces loads on origin servers because users can directly hit cache upon their first visits.
DescribeRefreshTasks DescribeRefreshTasks Call the DescribeRefreshTasks operation to query the status of refresh and prefetch tasks.
DescribeRefreshTaskById DescribeRefreshTaskById You can call DescribeRefreshTaskById to query the status of refresh and prefetch tasks across the network.

Monitoring and usage analytics

API

Title

Description

Resource monitoring Resource monitoring
Visit data Visit data
DescribeDomainDetailDataByLayer DescribeDomainDetailDataByLayer Retrieves detailed data for an accelerated domain name by protocol type.
DescribeRangeDataByLocateAndIspService DescribeRangeDataByLocateAndIspService You can call DescribeRangeDataByLocateAndIspService to obtain bandwidth data by carrier and region.
Real-time Monitoring Real-time Monitoring
Source data Source data
DescribeDomainRealTimeSrcHttpCodeData DescribeDomainRealTimeSrcHttpCodeData Queries the total number and proportions of HTTP status codes returned during back-to-origin routing.

Resource usage management

API

Title

Description

DescribeCdnUserResourcePackage DescribeCdnUserResourcePackage You can call the DescribeCdnUserResourcePackage operation to query information about your current resource plans for CDN.

Certificate management

API

Title

Description

DescribeDomainCertificateInfo DescribeDomainCertificateInfo Call the DescribeDomainCertificateInfo operation to query certificate information for a specified accelerated domain name.
DescribeCdnHttpsDomainList DescribeCdnHttpsDomainList Queries all certificate information for your account.
SetCdnDomainSSLCertificate SetCdnDomainSSLCertificate Enables or disables the certificate for a domain name and updates the certificate information.

Operations reports

API

Title

Description

DescribeCdnSubList DescribeCdnSubList The DescribeCdnSubList operation queries customized report tasks.
DescribeCdnReport DescribeCdnReport Calls the DescribeCdnReport operation to query data from customized reports.
DescribeCdnReportList DescribeCdnReportList You can call the DescribeCdnReportList operation to query a list of all custom reports.
DescribeCdnDeliverList DescribeCdnDeliverList Call the DescribeCdnDeliverList operation to query a list of report tracking tasks. This operation returns all tracking tasks under your account.

Others

API

Title

Description

AddFCTrigger AddFCTrigger Adds a Function Compute trigger.
BatchDescribeCdnIpInfo BatchDescribeCdnIpInfo Queries whether one or more IP addresses are assigned to Alibaba Cloud CDN.
CheckCdnDomainExist CheckCdnDomainExist Checks whether a domain name exists.
CheckCdnDomainICP CheckCdnDomainICP Checks whether an ICP filing is obtained for the domain name.
CreateCdnCertificateSigningRequest CreateCdnCertificateSigningRequest Creates a certificate signing request (CSR).
CreateCdnDeliverTask CreateCdnDeliverTask Creates a tracking task. After you create a tracking task, the system sends operations reports to you by email on a regular basis.
CreateCdnSubTask CreateCdnSubTask Creates a custom operations report.
CreateRealTimeLogDelivery CreateRealTimeLogDelivery Enables real-time log delivery for specific accelerated domain names.
CreateUsageDetailDataExportTask CreateUsageDetailDataExportTask Creates a task to export resource usage details to an Excel file.
CreateUserUsageDataExportTask CreateUserUsageDataExportTask Creates a task to export your resource usage history to a PDF file.
DeleteCdnDeliverTask DeleteCdnDeliverTask Deletes tracking tasks by task ID.
DeleteCdnSubTask DeleteCdnSubTask The ID of the request.
DeleteFCTrigger DeleteFCTrigger Deletes a specified Function Compute trigger.
DeleteRealTimeLogLogstore DeleteRealTimeLogLogstore Deletes the Logstore that is used by a specified configuration record of real-time log delivery.
DeleteRealtimeLogDelivery DeleteRealtimeLogDelivery Deletes the configurations of real-time log delivery for specific accelerated domain names.
DeleteUsageDetailDataExportTask DeleteUsageDetailDataExportTask Deletes a task that was used to export usage details.
DeleteUserUsageDataExportTask DeleteUserUsageDataExportTask Deletes a task that was used to export usage history.
DescribeBlockedRegions DescribeBlockedRegions Queries countries and regions that can be added to the blacklist.
DescribeCdnCertificateDetail DescribeCdnCertificateDetail Queries the detailed information about an SSL certificate.
DescribeCdnCertificateDetailById DescribeCdnCertificateDetailById Queries certificate details by certificate ID.
DescribeCdnCertificateList DescribeCdnCertificateList Queries the certificates of accelerated domain names.
DescribeCdnConditionIPBInfo DescribeCdnConditionIPBInfo Queries the Internet service provider (ISP), region, and country that are required for advanced conditions.
DescribeCdnDeletedDomains DescribeCdnDeletedDomains Queries the domain names that are deleted from your account.
DescribeCdnDomainByCertificate DescribeCdnDomainByCertificate Queries accelerated domain names by SSL certificate.
DescribeCdnDomainLogs DescribeCdnDomainLogs Queries the address where you can download the log data of a specific domain name.
DescribeCdnDomainStagingConfig DescribeCdnDomainStagingConfig Queries the configurations of features in the staging environment.
DescribeCdnFullDomainsBlockIPConfig DescribeCdnFullDomainsBlockIPConfig You can call the DescribeCdnFullDomainsBlockIPConfig operation to query the configurations of full blocking.
DescribeCdnFullDomainsBlockIPHistory DescribeCdnFullDomainsBlockIPHistory Queries the blocking history.
DescribeCdnOrderCommodityCode DescribeCdnOrderCommodityCode Call DescribeCdnOrderCommodityCode to query the commodity code for a specified UID.
DescribeCdnRegionAndIsp DescribeCdnRegionAndIsp You can call the DescribeCdnRegionAndIsp operation to query regions and carriers.
DescribeCdnSMCertificateDetail DescribeCdnSMCertificateDetail Queries the details about a ShangMi (SM) certificate.
DescribeCdnSMCertificateList DescribeCdnSMCertificateList Queries the ShangMi (SM) certificates of an accelerated domain name.
DescribeCdnSSLCertificateList DescribeCdnSSLCertificateList Queries the certificate list by domain name.
DescribeCdnSecFuncInfo DescribeCdnSecFuncInfo Queries information about security features of Alibaba Cloud CDN.
DescribeCdnService DescribeCdnService You can call the DescribeCdnService operation to query the status of the Alibaba Cloud CDN service. The returned information includes the current metering method, the service activation time, the next metering method that will take effect, and the current service status.
DescribeCdnTypes DescribeCdnTypes Queries the types of domain names.
DescribeCdnUserBillHistory DescribeCdnUserBillHistory Queries the billing history under your Alibaba Cloud account.
DescribeCdnUserBillPrediction DescribeCdnUserBillPrediction Estimates resource usage of the current month.
DescribeCdnUserConfigs DescribeCdnUserConfigs Queries configurations of security features.
DescribeCdnUserDomainsByFunc DescribeCdnUserDomainsByFunc Queries accelerated domain names that have specified features configured and the status of the domain names.
DescribeCdnUserQuota DescribeCdnUserQuota Queries the quotas and usage of Alibaba Cloud CDN resources.
DescribeCertificateInfoByID DescribeCertificateInfoByID Queries the information about a specific certificate by certificate ID.
DescribeCustomLogConfig DescribeCustomLogConfig Queries the details about a custom logging configuration.
DescribeDomainAverageResponseTime DescribeDomainAverageResponseTime Queries the average response time of one or more accelerated domain names. You can query data collected within the last 90 days.
DescribeDomainBpsData DescribeDomainBpsData Queries bandwidth monitoring data for one or more accelerated domain names.
DescribeDomainBpsDataByLayer DescribeDomainBpsDataByLayer Queries bandwidth data by protocol.
DescribeDomainBpsDataByTimeStamp DescribeDomainBpsDataByTimeStamp Queries the bandwidth data at a specified time for an accelerated domain.
DescribeDomainCcActivityLog DescribeDomainCcActivityLog Queries log entries of rate limiting.
DescribeDomainCustomLogConfig DescribeDomainCustomLogConfig Queries the custom log configuration of an accelerated domain name.
DescribeDomainHitRateData DescribeDomainHitRateData Queries byte hit ratios that are measured in percentage.
DescribeDomainHttpCodeData DescribeDomainHttpCodeData Queries the total number and proportions of HTTP status codes returned from an accelerated domain name. The data is collected every 5 minutes.
DescribeDomainHttpCodeDataByLayer DescribeDomainHttpCodeDataByLayer Queries HTTP status codes by protocol.
DescribeDomainISPData DescribeDomainISPData Queries the proportions of data usage of different Internet service providers (ISPs). Data is collected every day. You can query data collected in the last 90 days.
DescribeDomainMax95BpsData DescribeDomainMax95BpsData Queries the 95th percentile bandwidth data of a domain name.
DescribeDomainMultiUsageData DescribeDomainMultiUsageData Queries the traffic data and the number of requests for multiple accelerated domain names at a time.
DescribeDomainPathData DescribeDomainPathData Queries monitoring data including the amount of network traffic and the number of visits by directory.
DescribeDomainPvData DescribeDomainPvData Queries the page view (PV) data of an accelerated domain name. The data is collected at an interval of 1 hour. You can query data in the last 90 days.
DescribeDomainQpsData DescribeDomainQpsData Queries the number of queries per second (QPS) for an accelerated domain name. The data is collected every 5 minutes. You can query data collected within the last 90 days.
DescribeDomainQpsDataByLayer DescribeDomainQpsDataByLayer Queries the number of queries per second (QPS) at a specific layer for one or more accelerated domain names. You can query data collected within the last 90 days.
DescribeDomainRealTimeBpsData DescribeDomainRealTimeBpsData Queries the bandwidth data about one or more accelerated domain names.
DescribeDomainRealTimeByteHitRateData DescribeDomainRealTimeByteHitRateData Queries the byte hit ratios of accelerated domain names.
DescribeDomainRealTimeDetailData DescribeDomainRealTimeDetailData Queries the real-time monitoring data for a domain name.
DescribeDomainRealTimeHttpCodeData DescribeDomainRealTimeHttpCodeData Queries the total number and proportions of HTTP status codes returned from an accelerated domain name.
DescribeDomainRealTimeQpsData DescribeDomainRealTimeQpsData Queries the number of queries per second for one or more accelerated domain names.
DescribeDomainRealTimeReqHitRateData DescribeDomainRealTimeReqHitRateData Queries the request hit ratios for one or more accelerated domain names.
DescribeDomainRealTimeSrcBpsData DescribeDomainRealTimeSrcBpsData Queries origin bandwidth data for accelerated domain names.
DescribeDomainRealTimeSrcTrafficData DescribeDomainRealTimeSrcTrafficData Queries the monitoring data of back-to-origin traffic for one or more specified accelerated domains. The data is collected every minute.
DescribeDomainRealTimeTrafficData DescribeDomainRealTimeTrafficData Queries the monitoring data of network traffic for one or more accelerated domain names.
DescribeDomainRealtimeLogDelivery DescribeDomainRealtimeLogDelivery Queries the real-time log delivery information about an accelerated domain name.
DescribeDomainRegionData DescribeDomainRegionData Queries the geographic distribution of users for a domain name. The data is collected at an interval of one day. You can query the data in the last 90 days.
DescribeDomainReqHitRateData DescribeDomainReqHitRateData Queries the request hit ratio in percentage.
DescribeDomainSrcBpsData DescribeDomainSrcBpsData Queries bandwidth monitoring data of requests that are redirected to origin servers for one or more accelerated domain names.
DescribeDomainSrcHttpCodeData DescribeDomainSrcHttpCodeData Queries the proportions of HTTP status codes that are returned during back-to-origin routing.
DescribeDomainSrcQpsData DescribeDomainSrcQpsData Queries the number of queries per second (QPS) that are sent to the origin server. You can query data collected in the last 90 days.
DescribeDomainSrcTopUrlVisit DescribeDomainSrcTopUrlVisit Queries frequently requested origin URLs of one or more accelerated domain names.
DescribeDomainSrcTrafficData DescribeDomainSrcTrafficData Queries origin traffic for one or more specified accelerated domain names.
DescribeDomainTopClientIpVisit DescribeDomainTopClientIpVisit Queries client IP addresses that are ranked by the number of requests or the amount of network traffic within a specific time range for one or more accelerated domain names. You can query data collected within the last 90 days.
DescribeDomainTopReferVisit DescribeDomainTopReferVisit Queries frequently requested web pages of one or more accelerated domain names on a specified day and sorts the web pages. You can query data collected within the last 90 days.
DescribeDomainTopUrlVisit DescribeDomainTopUrlVisit Queries top 100 frequently requested URLs of an accelerated domain name within a specified time range.
DescribeDomainTrafficData DescribeDomainTrafficData Queries network traffic for one or more accelerated domain names. You can query data that is collected in the last 90 days.
DescribeDomainUsageData DescribeDomainUsageData Queries the resource usage data of specific domain names in a specified billable region.
DescribeDomainUvData DescribeDomainUvData Queries the unique visitor (UV) data of an accelerated domain name. Data is collected every hour. You can query data collected in the last 90 days.
DescribeDomainVerifyData DescribeDomainVerifyData Queries the verification content of an accelerated domain name based on whether the global resource plan is enabled.
DescribeDomainsBySource DescribeDomainsBySource Queries accelerated domain names by origin server.
DescribeDomainsUsageByDay DescribeDomainsUsageByDay Queries the monitoring data of an accelerated domain name. Data is collected every day. You can query data collected within the last 90 days.
DescribeEsExceptionData DescribeEsExceptionData Queries the execution errors of a script in EdgeScript (ES).
DescribeEsExecuteData DescribeEsExecuteData Queries the execution status of scripts in EdgeScript (ES).
DescribeFCTrigger DescribeFCTrigger Queries a specified Function Compute trigger.
DescribeIpInfo DescribeIpInfo Checks whether a specified IP address is the IP address of a CDN point of presence (POP).
DescribeIpStatus DescribeIpStatus Queries the status of IP addresses of points of presence (POPs). The status of an IP address of a POP indicates whether content delivery acceleration is supported by the POP.
DescribeL2VipsByDomain DescribeL2VipsByDomain Queries the virtual IP addresses (VIPs) of L2 CDN points of presence (POPs) for a specific domain name.
DescribePreloadDetailById DescribePreloadDetailById Queries the prefetch details of a task, including the prefetch progress of all resources in the task. Only users who are included in the whitelist can use this operation. You can contact your business manager to apply for the whitelist.
DescribeRealtimeDeliveryAcc DescribeRealtimeDeliveryAcc Queries the number of real-time log deliveries.
DescribeRefreshQuota DescribeRefreshQuota DescribeRefreshQuota
DescribeStagingIp DescribeStagingIp Queries node IP addresses in the staging environment.
DescribeTagResources DescribeTagResources Queries tags that are added to specified resources.
DescribeTopDomainsByFlow DescribeTopDomainsByFlow Queries the top N domain names ranked by network traffic. You can query data collected in the last 30 days.
DescribeUserCdnStatus DescribeUserCdnStatus Queries the status of a user.
DescribeUserCertificateExpireCount DescribeUserCertificateExpireCount Queries the number of domain names whose SSL certificates are about to expire or have already expired.
DescribeUserDomains DescribeUserDomains Queries all accelerated domain names in your Alibaba Cloud account and the status of the accelerated domain names. You can filter domain names by name or status. Fuzzy match is supported.
DescribeUserTags DescribeUserTags Queries user tags.
DescribeUserUsageDataExportTask DescribeUserUsageDataExportTask Queries usage export tasks that were created in the last three months.
DescribeUserUsageDetailDataExportTask DescribeUserUsageDetailDataExportTask Queries tasks that were used to export resource usage details of one or more accelerated domain names that belong to your Alibaba Cloud account. Resource usage information is collected every five minutes.
DescribeUserVipsByDomain DescribeUserVipsByDomain Queries virtual IP addresses (VIPs) of CDN points of presence (POPs) by domain name.
DescribeVerifyContent DescribeVerifyContent Queries the ownership verification content of an accelerated domain name.
DisableRealtimeLogDelivery DisableRealtimeLogDelivery Disables real-time log delivery for specific accelerated domain names.
EnableRealtimeLogDelivery EnableRealtimeLogDelivery Enables real-time log delivery for an accelerated domain name.
ListDomainsByLogConfigId ListDomainsByLogConfigId Queries domain names by log configuration ID.
ListFCTrigger ListFCTrigger Queries the Function Compute trigger that is set for an Alibaba Cloud CDN event.
ListRealtimeLogDelivery ListRealtimeLogDelivery Queries all real-time log delivery tasks within your Alibaba Cloud account.
ListRealtimeLogDeliveryDomains ListRealtimeLogDeliveryDomains Queries all domain names that are associated with a specific real-time log delivery configuration record.
ListRealtimeLogDeliveryInfos ListRealtimeLogDeliveryInfos Queries the information about the real-time log delivery feature in a specified region.
ListTagResources ListTagResources Queries the tags that are attached to a resource.
ListUserCustomLogConfig ListUserCustomLogConfig Queries all custom log configurations in your account.
ModifyCdnDomainOwner ModifyCdnDomainOwner Transfer domain names from an Alibaba Cloud account to the current account.
ModifyCdnDomainSchdmByProperty ModifyCdnDomainSchdmByProperty Changes the acceleration region for an accelerated domain name.
ModifyCdnService ModifyCdnService Changes the metering method of Alibaba Cloud CDN.
ModifyRealtimeLogDelivery ModifyRealtimeLogDelivery Modifies the configurations of real-time log delivery for a specific domain name. Each domain name supports only one Logstore.
OpenCdnService OpenCdnService Activates Alibaba Cloud CDN. You must activate Alibaba Cloud CDN before you can manage domain names in Alibaba Cloud CDN.
PublishStagingConfigToProduction PublishStagingConfigToProduction Publishes the configurations of the staging environment to the production environment.
RefreshObjectCacheByCacheTag RefreshObjectCacheByCacheTag Refreshes the cache based on cache tags that you configured.
RefreshObjectCaches RefreshObjectCaches Purges files on POPs. After files are purged, the original file content immediately becomes invalid. If clients request the original file content, Alibaba Cloud CDN redirects the requests to the origin server where the content is stored. Then, Alibaba Cloud CDN caches the latest content to the POPs and returns it to the clients. Alibaba Cloud CDN allows you to purge content from multiple URLs at a time.
RollbackStagingConfig RollbackStagingConfig Rolls back configurations in the staging environment. After you call this operation, all configurations in the staging environment are cleared.
SetCdnDomainCSRCertificate SetCdnDomainCSRCertificate You can call this operation to configure an SSL certificate for a specific domain name.
SetCdnDomainSMCertificate SetCdnDomainSMCertificate Enables or disables a ShangMi (SM) certificate for a domain name.
SetCdnFullDomainsBlockIP SetCdnFullDomainsBlockIP Blocks or unblocks IP addresses. This setting applies to all domain names in your account.
SetWaitingRoomConfig SetWaitingRoomConfig Configures the virtual waiting room feature for an accelerated domain name. This operation is available only for accelerated domain names of the Dynamic CDN workload type.
TagResources TagResources Adds one or more tags to specific resources.
UntagResources UntagResources Removes tags from specified resources.
UpdateCdnDeliverTask UpdateCdnDeliverTask Updates a tracking task.
UpdateCdnSubTask UpdateCdnSubTask Updates one or more operations reports.
UpdateFCTrigger UpdateFCTrigger Updates a specified Function Compute trigger.
VerifyDomainOwner VerifyDomainOwner Verifies the ownership of a specified domain name.