The following tables describe API operations available for use in Alibaba Cloud CDN.

Monitoring and usage analytics

Feature API operation Description
Resource monitoring DescribeDomainSrcQpsData Queries the number of back-to-origin requests per second of one or more accelerated domain names.
DescribeDomainBpsDataByLayer Queries the bandwidth information about domain names by protocol.
DescribeDomainHttpCodeDataByLayer Queries HTTP status codes by protocol.
DescribeDomainReqHitRateData Queries the request hit ratios of one or more accelerated domain names. Hit ratios are measured in percentage. You can query data within the last 90 days.
DescribeDomainHttpCodeData Queries the total number and proportions of HTTP status codes returned from one or more accelerated domain names. You can query data within the last 90 days.
DescribeDomainTrafficData Queries the monitoring data of network traffic for one or more accelerated domain names. You can query data within the last 90 days.
DescribeDomainBpsDataByTimeStamp Queries the bandwidth value at a specified time for an accelerated domain name.
DescribeDomainHitRateData Queries the byte hit ratios of one or more accelerated domain names. Hit ratios are measured in percentage. You can query data within the last 90 days.
DescribeDomainsUsageByDay Queries the monitoring data of an accelerated domain name. Data is collected every day. You can query data within the last 90 days.
DescribeDomainSrcTrafficData Queries the back-to-origin traffic monitoring data of an accelerated domain name. You can query data within the last 90 days.
DescribeRangeDataByLocateAndIspService Queries the bandwidth values of different Internet service providers (ISPs) in different region at a specified time for an accelerated domain name.
DescribeDomainSrcHttpCodeData Queries the total number and proportions of HTTP status codes returned from one or more accelerated domain names. Data is collected every 5 minutes. You can query data within the last 90 days.
DescribeDomainSrcBpsData Queries the bandwidth values of back-to-origin requests for one or more accelerated domain names. You can query data within the last 90 days.
DescribeDomainBpsData Queries bandwidth data.
DescribeDomainQpsData Queries the number of requests redirected from an accelerated domain name to the origin server per second. Data is collected every 5 minutes. You can query data collected within the last 90 days.
DescribeDomainQpsDataByLayer Queries the number of requests to an accelerated domain name per second. You can query data within the last 90 days.
DescribeDomainDetailDataByLayer Queries the details about one or more accelerated domain names by protocol. Data is collected every 5 minutes.
Real-time Monitoring DescribeDomainRealTimeSrcBpsData Queries the bandwidth data of back-to-origin requests. Data is collected every minute. You can query data within the last seven days.
DescribeDomainRealTimeBpsData Queries the bandwidth data of one or more accelerated domain names. Data is collected every minute.
DescribeDomainRealTimeSrcHttpCodeData Queries the total number and proportions of HTTP status codes returned from the origin server to an accelerated domain name. Data is collected every minute. You can query data within the last seven days.
DescribeDomainRealTimeHttpCodeData Queries the total number and proportions of HTTP status codes returned from an accelerated domain name. Data is collected every minute.
DescribeDomainRealTimeSrcTrafficData Queries the monitoring data of back-to-origin traffic for an accelerated domain name. Data is collected every minute. You can query data collected within the last seven days.
DescribeDomainRealTimeByteHitRateData Queries the byte hit ratios of one or more accelerated domain names. Data is collected every minute. You can query data collected within the last seven days.
DescribeDomainRealTimeQpsData Queries the number of visits per second for an accelerated domain name. Data is collected every minute.
DescribeDomainRealTimeTrafficData Queries the traffic monitoring data of an accelerated domain name. Data is collected every minute. You can query data collected within the last seven days.
DescribeDomainRealTimeReqHitRateData Queries the request hit ratios of one or more accelerated domain names. Data is collected every minute. You can query data collected within the last seven days.
Resource usage management DescribeCdnUserBillHistory Queries the billing history of your Alibaba Cloud account.
DescribeUserUsageDataExportTask Queries export tasks that were created within the last three months. The tasks were used to export resource usage data.
CreateUserUsageDataExportTask Creates a task to export your resource usage history. The information is exported to a PDF file.
CreateUsageDetailDataExportTask Creates a task to export resource usage details to an Excel file.
DescribeUserUsageDetailDataExportTask Queries export tasks that were used to export details about one or more domain names that belong to your Alibaba Cloud account. The exported data was collected every 5 minutes.
DescribeDomainUsageData Queries resource usage of specified domain names in a specified billable region.
DescribeCdnUserResourcePackage Queries the resource plans that you have purchased for Alibaba Cloud CDN.
DeleteUserUsageDataExportTask Deletes a task that was used to export usage data.
DeleteUsageDetailDataExportTask Deletes a task that was used to export usage details.
DescribeCdnUserBillPrediction Estimates resource usage of the current month.
EdgeScript (ES) monitoring DescribeEsExecuteData Queries the execution status of scripts in ES
DescribeEsExceptionData Queries the executions errors of scripts in ES.

Domain name management

Feature API operation Description
Adding or removing domain names AddCdnDomain Adds a domain name to Alibaba Cloud CDN.
BatchAddCdnDomain Adds multiple domain names to Alibaba Cloud CDN at a time.
DeleteCdnDomain Removes a domain name from Alibaba Cloud CDN.
DescribeCdnDeletedDomains Queries domain names that are removed from Alibaba Cloud CDN.
Domain name ownership verification VerifyDomainOwner Verifies the ownership of a domain name.
DescribeVerifyContent Queries the result of ownership verification.
Enabling or disabling domain names StartCdnDomain Enables a disabled domain name.
BatchStartCdnDomain Enables multiple disabled domain names at a time.
StopCdnDomain Disables a domain name. After a domain name is disabled, the value of the DomainStatus parameter changes to Offline.
BatchStopCdnDomain Disables multiple domain names. After a domain name is disabled, the value of the DomainStatus parameter changes to Offline.
Domain name configuration BatchSetCdnDomainConfig Configures one or more accelerated domain names.
ModifyCdnDomain Modifies the information about an accelerated domain name.
DescribeUserDomains Queries all accelerated domain names within your Alibaba Cloud account and their status. You can filter domain names by keyword or status.
DescribeCdnDomainDetail Queries the basic configuration information about an accelerated domain name.
DescribeDomainsBySource Queries all domain names of the specified origin servers within your Alibaba Cloud account.
DescribeCdnDomainConfigs Queries the configurations of an accelerated domain name. You can query the configuration of one or more features at a time.
DeleteSpecificConfig Deletes specified configurations for an accelerated domain name.
BatchDeleteCdnDomainConfig Deletes configurations of multiple accelerated domain names at a time.
BatchUpdateCdnDomain Updates the configurations of multiple accelerated domain names at a time.
DescribeCdnUserDomainsByFunc Queries all domain names and their status under your account.
Domain name configuration management in the staging environment DescribeCdnDomainStagingConfig Queries the configurations of one or more features in the staging environment.
SetCdnDomainStagingConfig Configures a domain name to be accelerated in the staging environment.
RollbackStagingConfig Rolls back configurations in the staging environment.
PublishStagingConfigToProduction Publishes configurations from the staging environment to the production environment.
DeleteSpecificStagingConfig Deletes configurations from the staging environment.
Security settings SetWaitingRoomConfig Configures the virtual waiting room feature for an accelerated domain name. This operation is available only for accelerated domain names of the DCDN workload type.
DescribeCdnUserConfigs Queries configurations of security features.
DescribeBlockedRegions Queries the countries and regions that can be added to the region blacklist.

Log management

Feature API operation Description
Real-time log delivery CreateRealTimeLogDelivery Enables real-time log delivery for specified domain names.
DescribeDomainRealtimeLogDelivery Queries the information about real-time log delivery for an accelerated domain name.
DescribeRealtimeDeliveryAcc Queries the number of real-time log deliveries.
DisableRealtimeLogDelivery Disables real-time log delivery for specified accelerated domain names.
EnableRealtimeLogDelivery Enables real-time log delivery for specific accelerated domain names.
ListRealtimeLogDeliveryDomains Queries all domain names that have real-time log delivery enabled.
ModifyRealtimeLogDelivery Modifies the configurations of real-time log delivery for a specific domain name. Each domain name supports only one Logstore.
ListRealtimeLogDeliveryInfos Queries the information about real-time log delivery in a specified region.
DeleteRealtimeLogDelivery Deletes the configurations of real-time log delivery for specified accelerated domain names.
Offline logs DescribeDomainCustomLogConfig Queries the custom log configuration of an accelerated domain name.
ListDomainsByLogConfigId Queries domain names by log configuration ID.
ListUserCustomLogConfig Queries all custom log configurations within your Alibaba Cloud account.
DescribeCustomLogConfig Queries details about custom log configurations by configuration ID.
DescribeCdnDomainLogs Queries the address where you can download the log data of a specific domain name.

Refresh and prefetch

API operation Description
PushObjectCache Prefetches content from origin servers to L2 CDN edge nodes. This reduces loads on origin servers because users can directly hit cache upon their first visits.
DescribeRefreshQuota Queries the maximum and remaining numbers of URLs and directories that can be refreshed, the maximum and remaining numbers of URLs that can be prefetched, and the maximum and remaining numbers of URLs and directories that can be blocked on the current day.
DescribeRefreshTasks Queries the status of refresh or prefetch tasks that belong to a specified accelerated domain name.
RefreshObjectCaches Refreshes files on Alibaba Cloud CDN edge nodes. After files are refreshed, the original file content immediately becomes invalid. If clients request the original file content, Alibaba Cloud CDN redirects the requests to the origin server of the content. Then, Alibaba Cloud CDN caches the latest content to CDN edge nodes and returns it to the clients. Alibaba Cloud CDN allows you to refresh content from multiple URLs at a time.
DescribeRefreshTaskById Queries the status of refresh or prefetch tasks by ID for an accelerated domain name.
DescribeCdnUserQuota Queries the maximum and remaining quota.

Service management

API operation Description
OpenCdnService Activates Alibaba Cloud CDN.
DescribeCdnService Queries the status of Alibaba Cloud CDN. The status information includes the service activation time, current service status, current billing method, and the next billing method to take effect.
DescribeCdnRegionAndIsp Queries the most recent region and ISP lists.

Certificate management

API operation Description
CreateCdnCertificateSigningRequest Creates a certificate signing request (CSR).
DescribeDomainCertificateInfo Queries the certificate information about an accelerated domain name.
SetDomainServerCertificate Enables or disables the certificate of a domain name, and modifies the certificate information.
SetCdnDomainCSRCertificate Configures an SSL certificate for a specified domain name.
DescribeCdnDomainByCertificate Queries accelerated domain names by SSL certificate.
DescribeCdnCertificateDetail Queries the detailed information about an SSL certificate.
DescribeCdnCertificateList Queries SSL certificates configured for accelerated domain names.
DescribeCertificateInfoByID Queries the information about a specified SSL certificate.
BatchSetCdnDomainServerCertificate Enables or disables the certificates of domain names, and modifies the certificate information.
DescribeCdnHttpsDomainList Queries the information about the SSL certificates within your Alibaba Cloud account.
DescribeUserCertificateExpireCount Queries the number of domain names whose SSL certificates are about to expire or have already expired.
SetCdnDomainSMCertificate Enables or disables a ShangMi (SM) certificate for a domain name.
DescribeCdnSMCertificateLis Queries the SM certificates of an accelerated domain name.
DescribeCdnSMCertificateDetail Queries the details about an SM certificate.

Tag management

API operation Description
TagResources Adds tags to a resource.
DescribeTagResources Queries the tags that are added to specified resources.
DescribeUserTags Queries user tags.
UntagResources Removes tags from a resource.

Operations reports

API operation Description
CreateCdnSubTask Customize an operations report template.
CreateCdnDeliverTask Creates a tracking task.
DescribeCdnSubList Queries the operations report templates that you have created.
DescribeCdnReport Queries data from operations reports.
DescribeCdnReportList Queries all operations reports.
DescribeCdnDeliverList Queries the tracking tasks that you have created.
UpdateCdnSubTask Updates an operations report template.
UpdateCdnDeliverTask Updates a tracking task.
DeleteCdnSubTask Deletes an operations report template.
DeleteCdnDeliverTask Deletes a tracking task.

Function Compute management

API operation Description
AddFCTrigger Adds a Function Compute trigger.
UpdateFCTrigger Updates a specified Function Compute trigger.
DescribeFCTrigger Queries a specified Function Compute trigger.
DeleteFCTrigger Deletes a specified Function Compute trigger.
ListFCTrigger Queries the Function Compute trigger that is set for an Alibaba Cloud CDN event.

Auxiliary tools

API operation Description
DescribeIpInfo Checks whether an IP address belongs to an Alibaba Cloud CDN edge node.
DescribeStagingIp Queries the IP address of an Alibaba Cloud CDN edge node in the staging environment.
DescribeL2VipsByDomain Queries the virtual IP addresses of L2 edge nodes for a specific domain name.
DescribeCdnRegionAndIsp Queries the most recent region and ISP lists.
DescribeUserVipsByDomain Queries virtual IP addresses of the edge nodes by domain name.
DescribeIpStatus Queries the status of node IP addresses. The status of a node IP address indicates whether content delivery acceleration is supported by the node.

Security data

API operation Description
CreateIllegalUrlExportTask Creates a task to export invalid URLs.
DescribeDomainCcActivityLog Queries log entries of rate limiting.
DescribeIllegalUrlExportTask Queries tasks that were used to export invalid URLs.