All Products
Search
Document Center

CDN:API overview

Last Updated:Jul 07, 2026

API standards and multilingual preset SDKs

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

Domain management

API

Title

Description

Add/delete domain names Add/delete domain names
AddCdnDomain AddCdnDomain To add an accelerated domain, call `AddCdnDomain`.
BatchAddCdnDomain BatchAddCdnDomain Use the `BatchAddCdnDomain` operation to add up to 50 accelerated domain names in a single request.
DeleteCdnDomain DeleteCdnDomain Removes an accelerated domain name from Alibaba Cloud CDN.
DescribeCdnDeletedDomains DescribeCdnDeletedDomains Queries the domain names that are deleted from your account.
Domain ownership verification Domain ownership verification
VerifyDomainOwner VerifyDomainOwner Verifies the ownership of a specified domain name.
DescribeDomainVerifyData DescribeDomainVerifyData Retrieves the verification content for an accelerated domain name. The returned content depends on whether the global resource plan is enabled for the domain.
Disable/enable accelerated domain names Disable/enable accelerated 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 configuration Domain configuration
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.
DescribeDomainCname DescribeDomainCname Queries the CNAME record of an accelerated domain name and verifies its configuration.
DescribeDomainsBySource DescribeDomainsBySource Queries accelerated domain names by origin server.
DescribeCdnDomainDetail DescribeCdnDomainDetail Queries an accelerated domain name.
DescribeCdnDomainConfigs DescribeCdnDomainConfigs Retrieves the configurations of an accelerated domain name. You can query the configurations of multiple features in a single call.
BatchSetCdnDomainConfig BatchSetCdnDomainConfig You can call BatchSetCdnDomainConfig to configure multiple domain names at once.
BatchDeleteCdnDomainConfig BatchDeleteCdnDomainConfig Deletes configurations for multiple accelerated domain names.
BatchUpdateCdnDomain BatchUpdateCdnDomain Updates multiple accelerated domain names at a time.
DeleteSpecificConfig DeleteSpecificConfig Deletes specified configurations of an accelerated domain name.
ModifyCdnDomainSchdmByProperty ModifyCdnDomainSchdmByProperty Changes the acceleration region for an accelerated domain name.
ModifyCdnDomain ModifyCdnDomain Updates an accelerated domain name.
Domain staging environment configuration Domain staging environment configuration
DescribeCdnDomainStagingConfig DescribeCdnDomainStagingConfig Queries the configurations of features in the staging environment.
SetCdnDomainStagingConfig SetCdnDomainStagingConfig Configures an accelerated domain name in the staging environment.
RollbackStagingConfig RollbackStagingConfig Rolls back configurations in the staging environment. After you call this operation, all configurations in the staging environment are cleared.
PublishStagingConfigToProduction PublishStagingConfigToProduction Publishes the configurations of the staging environment to the production environment.
DeleteSpecificStagingConfig DeleteSpecificStagingConfig Deletes a specified configuration of the staging environment.

Refresh and prefetch

API

Title

Description

PushObjectCache Prefetch uRLs Prefetches content from the origin server to cache nodes. This allows first-time access to directly hit the cache, reducing the load on the origin server.
DescribeRefreshTasks Query refresh and prefetch tasks Queries whether refresh or prefetch tasks have taken effect across the entire network.
DescribeRefreshTaskById DescribeRefreshTaskById Use `DescribeRefreshTaskById` to check if refresh and prefetch tasks are complete across the network.
DescribePreloadDetailById DescribePreloadDetailById Queries the prefetch progress of a task, including 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.
DescribeCdnUserQuota DescribeCdnUserQuota Queries the quotas and usage of Alibaba Cloud CDN resources.

Monitoring and query

API

Title

Description

Resource monitoring Resource monitoring
Access data Access data
DescribeDomainPathData DescribeDomainPathData Queries monitoring data including the amount of network traffic and the number of visits by directory.
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.
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.
DescribeDomainTrafficData DescribeDomainTrafficData Queries network traffic for one or more accelerated domain names. You can query data that is collected in the last 90 days.
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.
DescribeDomainHitRateData DescribeDomainHitRateData Queries byte hit ratios that are measured in percentage.
DescribeDomainReqHitRateData DescribeDomainReqHitRateData Queries the request hit ratio in percentage.
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.
DescribeDomainDetailDataByLayer DescribeDomainDetailDataByLayer Retrieves detailed data for an accelerated domain name by protocol type.
DescribeRangeDataByLocateAndIspService DescribeRangeDataByLocateAndIspService Obtains bandwidth data by carrier and region.
Origin fetch data Origin fetch data
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.
DescribeDomainSrcTrafficData DescribeDomainSrcTrafficData Queries origin traffic for one or more specified accelerated domain names.
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.
Real-time monitoring Real-time monitoring
Access data Access data
DescribeDomainRealTimeTrafficData DescribeDomainRealTimeTrafficData Queries the monitoring data of network traffic for one or more accelerated domain names.
DescribeDomainRealTimeBpsData DescribeDomainRealTimeBpsData Queries bandwidth data for one or more accelerated domain names.
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.
DescribeDomainRealTimeByteHitRateData DescribeDomainRealTimeByteHitRateData Queries the byte hit ratios of accelerated domain names.
Origin fetch data Origin fetch data
DescribeDomainRealTimeSrcBpsData DescribeDomainRealTimeSrcBpsData Queries origin bandwidth data for accelerated domain names.
DescribeDomainRealTimeSrcHttpCodeData DescribeDomainRealTimeSrcHttpCodeData Queries the total number and proportions of HTTP status codes returned during back-to-origin routing.
DescribeDomainRealTimeSrcTrafficData DescribeDomainRealTimeSrcTrafficData Queries the monitoring data of back-to-origin traffic for one or more specified accelerated domains. The data is collected every minute.
EdgeScript monitoring EdgeScript monitoring
DescribeEsExecuteData DescribeEsExecuteData Queries the execution status of scripts in EdgeScript (ES).
DescribeEsExceptionData DescribeEsExceptionData Queries the execution errors of a script in EdgeScript (ES).

Usage query

API

Title

Description

DescribeCdnUserBillHistory DescribeCdnUserBillHistory Queries the billing history under your Alibaba Cloud account.
DescribeCdnUserBillPrediction DescribeCdnUserBillPrediction Estimates resource usage of the current month.
CreateUserUsageDataExportTask CreateUserUsageDataExportTask Creates a task to export your resource usage history to a PDF file.
DescribeUserUsageDataExportTask DescribeUserUsageDataExportTask Queries usage export tasks that were created in the last three months.
DeleteUserUsageDataExportTask DeleteUserUsageDataExportTask Deletes a task that was used to export usage history.
DeleteUsageDetailDataExportTask DeleteUsageDetailDataExportTask Deletes a task that was used to export usage details.
DescribeDomainMax95BpsData DescribeDomainMax95BpsData Queries the 95th percentile bandwidth data of a domain name.
DescribeCdnUserResourcePackage DescribeCdnUserResourcePackage Queries your current resource plans for CDN.

Certificate management

API

Title

Description

DescribeCdnDomainByCertificate DescribeCdnDomainByCertificate Queries accelerated domain names by SSL certificate.
DescribeDomainCertificateInfo DescribeDomainCertificateInfo Queries certificate information for a specified accelerated domain name.
DescribeCdnCertificateDetail DescribeCdnCertificateDetail Queries an SSL certificate.
DescribeCdnCertificateList DescribeCdnCertificateList Queries the certificates of accelerated domain names.
DescribeCdnSSLCertificateList DescribeCdnSSLCertificateList Queries the certificate list by domain name.
DescribeCdnHttpsDomainList DescribeCdnHttpsDomainList Queries all certificate information for your account.
DescribeCertificateInfoByID DescribeCertificateInfoByID Queries a specific certificate by certificate ID.
DescribeUserCertificateExpireCount DescribeUserCertificateExpireCount Queries the number of domain names whose SSL certificates are about to expire or have already expired.
CreateCdnCertificateSigningRequest CreateCdnCertificateSigningRequest Creates a certificate signing request (CSR).
SetCdnDomainCSRCertificate SetCdnDomainCSRCertificate Configures an SSL certificate for a specific domain name.
SetCdnDomainSMCertificate SetCdnDomainSMCertificate Enables or disables a ShangMi (SM) certificate for a domain name.
DescribeCdnSMCertificateList DescribeCdnSMCertificateList Queries the ShangMi (SM) certificates of an accelerated domain name.
DescribeCdnSMCertificateDetail DescribeCdnSMCertificateDetail Queries a ShangMi (SM) certificate.
SetCdnDomainSSLCertificate SetCdnDomainSSLCertificate Enables or disables the certificate for a domain name and updates the certificate information.

Tag management

API

Title

Description

DescribeUserTags DescribeUserTags Queries user tags.

Operations report

API

Title

Description

CreateCdnSubTask CreateCdnSubTask Creates a custom operations report.
DescribeCdnSubList DescribeCdnSubList The DescribeCdnSubList operation queries customized report tasks.
UpdateCdnSubTask UpdateCdnSubTask Updates one or more operations reports.
DeleteCdnSubTask DeleteCdnSubTask Deletes all custom operations reports.
DescribeCdnReport DescribeCdnReport Call DescribeCdnReport to query customized reports.
DescribeCdnReportList DescribeCdnReportList Queries a list of all custom reports.
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.
DescribeCdnDeliverList DescribeCdnDeliverList Queries a list of report tracking tasks. This operation returns all tracking tasks under your account.
UpdateCdnDeliverTask UpdateCdnDeliverTask Updates a tracking task.
DeleteCdnDeliverTask DeleteCdnDeliverTask Deletes tracking tasks by task ID.

Supporting tools

API

Title

Description

DescribeIpInfo Query whether an IP address belongs to a CDN node Invokes DescribeIpInfo to authenticate whether a specified IP address is a Content Delivery Network (CDN) point of presence IP address.
DescribeL2VipsByDomain DescribeL2VipsByDomain Queries the IP addresses of L2 nodes for a specified domain name.
DescribeUserVipsByDomain DescribeUserVipsByDomain Queries virtual IP addresses (VIPs) of CDN points of presence (POPs) by domain name.
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.
ListFCTrigger ListFCTrigger Queries the Function Compute trigger that is set for an Alibaba Cloud CDN event.

Security information query

API

Title

Description

DescribeDomainCcActivityLog DescribeDomainCcActivityLog Queries log entries of rate limiting.

Legacy (discontinued)

API

Title

Description

Statistical analysis Statistical analysis
DescribeDomainAverageResponseTime Queries the average response time of an accelerated domain name Calls DescribeDomainAverageResponseTime to query the average response time of an accelerated domain name. You can query data within the last 90 days.
DescribeDomainRealTimeDetailData DescribeDomainRealTimeDetailData Queries the real-time monitoring data for a domain name.
DescribeUserConfigs DescribeUserConfigs Queries configurations of security features.
SetReqHeaderConfig SetReqHeaderConfig Sets a custom origin header.

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.
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.
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 real-time log delivery for specific accelerated domain names.
DescribeBlockedRegions DescribeBlockedRegions Queries countries and regions that can be added to the blacklist.
DescribeCdnCertificateDetailById DescribeCdnCertificateDetailById Queries certificate details by certificate ID.
DescribeCdnConditionIPBInfo DescribeCdnConditionIPBInfo Queries the Internet service provider (ISP), region, and country that are required for advanced conditions.
DescribeCdnDiagnoseReport DescribeCdnDiagnoseReport Call DescribeCdnDiagnoseReport to retrieve the details of a diagnostic report.
DescribeCdnDomainLogs DescribeCdnDomainLogs Queries the address where you can download the log data of a specific domain name.
DescribeCdnFullDomainsBlockIPConfig DescribeCdnFullDomainsBlockIPConfig Queries the configurations of full blocking.
DescribeCdnFullDomainsBlockIPHistory DescribeCdnFullDomainsBlockIPHistory Queries the blocking history.
DescribeCdnOrderCommodityCode DescribeCdnOrderCommodityCode Queries the commodity code for a specified UID.
DescribeCdnRegionAndIsp DescribeCdnRegionAndIsp Queries regions and carriers.
DescribeCdnSecFuncInfo DescribeCdnSecFuncInfo Queries security features of Alibaba Cloud CDN.
DescribeCdnService DescribeCdnService Queries 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.
DescribeCdnTaskList DescribeCdnTaskList `DescribeCdnTaskList` returns a list of diagnostic tasks.
DescribeCdnTypes DescribeCdnTypes Queries the types of domain names.
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.
DescribeCustomLogConfig DescribeCustomLogConfig Queries a custom logging configuration.
DescribeDomainCustomLogConfig DescribeDomainCustomLogConfig Queries the custom log configuration of an accelerated domain name.
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.
DescribeDomainMultiUsageData DescribeDomainMultiUsageData Queries the traffic data and the number of requests for multiple accelerated domain names at a time.
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.
DescribeDomainRealtimeLogDelivery DescribeDomainRealtimeLogDelivery Queries the real-time log delivery configuration of 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.
DescribeDomainSrcTopUrlVisit DescribeDomainSrcTopUrlVisit Queries frequently requested origin URLs of one or more 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.
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.
DescribeFCTrigger DescribeFCTrigger Queries a specified Function Compute trigger.
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.
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.
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.
GenerateCdnDiagnose GenerateCdnDiagnose Generates a diagnostic link for a URL.
ListDomainsByLogConfigId ListDomainsByLogConfigId Queries domain names by log configuration ID.
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 real-time log delivery configurations 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.
ModifyCdnService ModifyCdnService Changes the metering method of Alibaba Cloud CDN.
ModifyRealtimeLogDelivery ModifyRealtimeLogDelivery Updates 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.
RefreshObjectCacheByCacheTag RefreshObjectCacheByCacheTag Refreshes the cache based on cache tags that you configured.
RefreshObjectCaches Refresh cache Refreshes file content on nodes. The cached files that are refreshed immediately become invalid. New requests retrieve the latest files from the origin server. Batch URL refresh is supported.
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.
UpdateFCTrigger UpdateFCTrigger Updates a specified Function Compute trigger.