The following tables list API operations available for use in Alibaba Cloud Content Delivery Network (CDN). For more information, see OpenAPI Explorer.
Data monitoring
| API | Description |
|---|---|
| DescribeDomainSrcHttpCodeData | Queries the total number and proportions of HTTP status codes returned from one or more accelerated domain names. Data is collected every five minutes. You can query data collected within the last 90 days. |
| 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 | Queries frequently requested URLs of an accelerated domain name on a specified day. You can query data collected within the last 90 days. |
| DescribeDomainAverageResponseTime | Queries the average response time of one or more accelerated domain names. You can query data collected within the last 90 days. |
| DescribeDomainFileSizeProportionData | Queries the proportions of file sizes for an accelerated domain name. Data is collected every hour. You can query data collected within the last 90 days. |
| DescribeDomainBpsDataByTimeStamp | Queries the bandwidth data at a specified time for an accelerated domain name. |
| DescribeDomainISPData | Queries the proportions of data usage of different Internet service providers (ISPs). Data is collected every day. You can query data collected within the last 90 days. |
| DescribeCdnRegionAndIsp | Queries ISPs of each region. |
| DescribeRangeDataByLocateAndIspService | Queries the bandwidth information about an accelerated domain name at a specified time for each ISP in different regions. |
| DescribeDomainRealTimeBpsData | Queries the bandwidth information about one or more accelerated domain names. Data is collected every minute. You can query data collected within the last seven days. |
| DescribeDomainRealTimeSrcBpsData | Queries the bandwidth information about back-to-origin requests for one or more accelerated domain names. Data is collected every minute. You can query data collected within the last seven days. |
| DescribeDomainRealTimeSrcHttpCodeData | Queries the total number and proportions of HTTP status codes returned from one or more accelerated domain names to back-to-origin requests. Data is collected every minute. You can query data collected within the last seven days. |
| DescribeDomainRealTimeSrcTrafficData | Queries the monitoring data of back-to-origin traffic for one or more accelerated domain names. Data is collected every minute. The network traffic is measured in bits. You can query data collected within the last 90 days. |
| DescribeDomainRealTimeByteHitRateData | Queries 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 queries per second for one or more accelerated domain names. Data is collected every minute. You can query data collected within the last seven days. |
| DescribeDomainRealTimeHttpCodeData | Queries the total number and proportions of HTTP status codes returned from one or more accelerated domain names. Data is collected every minute. You can query data collected within the last seven days. |
| DescribeDomainRealTimeTrafficData | Queries the monitoring data of one or more accelerated domain names. Data is collected every minute. The network traffic is measured in bytes. You can query data collected within the last 90 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. |
| DescribeDomainBpsData | Queries the network bandwidth information about one or more accelerated domain names. You can query data collected 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 collected within the last 90 days. |
| DescribeDomainSrcTrafficData | Queries the monitoring data of back-to-origin traffic for one or more accelerated domain names. The network traffic is measured in bits. You can query data collected within the last 90 days. |
| 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. |
| DescribeDomainHitRateData | Queries the byte hit ratios of one or more accelerated domain names. Hit ratios are measured in percentage. You can query data collected within the last 90 days. |
| DescribeL2VipsByDomain | Queries the virtual IP addresses of L2 CDN nodes for a specific domain name. |
| DescribeDomainReqHitRateData | Queries the request hit ratios of one or more accelerated domain names. Hit ratios are measured in percentage. You can query data collected 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 collected within the last 90 days. |
| DescribeDomainTrafficData | Queries the monitoring data of network traffic for one or more accelerated domain names. The network traffic is measured in bytes. You can query data collected within the last 90 days. |
| DescribeTopDomainsByFlow | Queries the top N domain names ranked by network traffic. You can query data collected within the last 90 days. |
| DescribeDomainRegionData | Queries the visitor data classified by region for one or more accelerated domain names. The data was collected at an interval of one day. |
| DescribeDomainUvData | Queries the unique visitor (UV) data of an accelerated domain name. Data is collected every hour. You can query data collected within the last 90 days. |
| DescribeDomainPvData | Queries the page view (PV) data of an accelerated domain name. Data is collected every hour. |
| DescribeDomainQpsData | Queries the number of queries per second for one or more accelerated domain names. Data is collected every five minutes. You can query data collected within the last 90 days. |
| ListFCTrigger | Queries the Function Compute trigger that is set for an Alibaba Cloud CDN event. |
| DescribeDomainQpsDataByLayer | Queries the number of queries per second at a specific layer for one or more accelerated domain names. You can query data collected within the last 90 days. |
| 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. |
| DescribeDomainRealTimeDetailData | Queries the data usage of each ISP and the number of visits in each region for a domain name. Data is collected every minute. You can query data collected within the last seven days. |
| DescribeDomainSrcTopUrlVisit | Queries frequently requested URLs of one or more accelerated domain names. |
| DescribeDomainSrcQpsData | Queries the number of back-to-origin requests per second of one or more accelerated domain names. |
Domain name management
| API | Description |
|---|---|
| AddCdnDomain | Adds a domain name to Alibaba Cloud CDN. |
| DeleteCdnDomain | Removes an accelerated domain name from Alibaba Cloud CDN. |
| StopCdnDomain | Disables a domain name that is accelerated by Alibaba Cloud CDN. After the domain name is disabled, the value of the DomainStatus parameter is changed to Offline. |
| StartCdnDomain | Enables a disabled domain name. After the domain name is enabled, the value of the DomainStatus parameter is changed to Online. |
| 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. |
| BatchSetCdnDomainConfig | Configures multiple accelerated domain names at a time. |
| ModifyCdnDomain | Modifies the information about an accelerated domain name. |
| DescribeUserDomains | Queries all domain names accelerated by Alibaba Cloud CDN of 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. |
| DescribeCdnDomainDetail | Queries the basic information about an accelerated domain name. |
| DescribeDomainsBySource | Queries the domain names corresponding to origin servers of your Alibaba Cloud account. |
| 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. |
| DescribeCdnDomainConfigs | Queries the configurations of an accelerated domain name. You can query the configuration of one or more features at a time. |
| DeleteSpecificConfig | Deletes specific configurations for an accelerated domain name. |
| DescribeUserVipsByDomain | Queries virtual IP addresses of CDN nodes by domain name. |
| BatchAddCdnDomain | Adds multiple domain names to Alibaba Cloud CDN at a time. You can add a maximum of 20 domain names to Alibaba Cloud CDN with each Alibaba Cloud account. |
| ModifyCdnDomainSchdmByProperty | Modifies the accelerated region for an accelerated domain name. |
| BatchUpdateCdnDomain | Updates the configurations of multiple accelerated domain names at a time. |
| 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. |
Log management
| API | Description |
|---|---|
| DescribeCdnDomainLogs | Queries the address where you can download the raw access log data of a specific domain name. |
| CreateRealTimeLogDelivery | Configures the real-time log delivery feature for an accelerated domain name. |
| DeleteRealtimeLogDelivery | Deletes the configurations of the real-time log delivery feature for one or more accelerated domain names. |
| DescribeDomainRealtimeLogDelivery | Queries the information about the real-time log delivery feature for an accelerated domain name. |
| DisableRealtimeLogDelivery | Disables the real-time log delivery feature for one or more accelerated domain names. |
| EnableRealtimeLogDelivery | Enables the real-time log delivery feature for one or more accelerated domain names. |
| ListRealtimeLogDeliveryDomains | Queries all domain names that are associated with a specific real-time log delivery configuration record. |
| ListRealtimeLogDeliveryInfos | Queries the information about the real-time log delivery feature in a specified region. |
| ModifyRealtimeLogDelivery | Modifies the real-time log delivery configuration for an accelerated domain name. You can deliver log data of an accelerated domain name to only one Logstore. |
| DescribeDomainCustomLogConfig | Queries the custom log configuration of an accelerated domain name. |
| ListDomainsByLogConfigId | Queries all accelerated domain names associated with a custom log configuration record. |
| ListUserCustomLogConfig | Queries all custom log configurations of your Alibaba Cloud account. |
| DescribeCustomLogConfig | Queries the detailed configuration of logging. |
Refresh and prefetch tasks
| API | Description |
|---|---|
| PushObjectCache | Prefetches resources from origin servers to L2 CDN nodes. This reduces workloads on origin servers because users can 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. |
| DescribeRefreshTasks | Queries the status of refresh or prefetch tasks that belong to an accelerated domain name. |
| RefreshObjectCaches | Refreshes files on CDN nodes. After a file is refreshed, the version cached on CDN nodes immediately expires. When a client requests the file, the CDN node redirects the request to the origin server to retrieve the latest version of the file. Alibaba Cloud CDN allows you to refresh content of multiple URLs at a time. |
Service management
| API | Description |
|---|---|
| OpenCdnService | Activates Alibaba Cloud CDN. You must activate Alibaba Cloud CDN before you can manage domain names in Alibaba Cloud CDN. |
| DescribeCdnService | Queries the status of your Alibaba Cloud CDN service. The status information includes the service activation time, current service status, current metering method, and new metering method. |
| DescribeCdnUserResourcePackage | Queries the current resource plans that you have purchased for Alibaba Cloud CDN. |
| DescribeCdnUserQuota | Queries the quotas and usage of Alibaba Cloud CDN resources. |
Certificate management
| API | Description |
|---|---|
| CreateCdnCertificateSigningRequest | Creates a certificate signing request (CSR). |
| DescribeDomainCertificateInfo | Queries the certificate information about a specified accelerated domain name. |
| SetDomainServerCertificate | Configures a Secure Sockets Layer (SSL) certificate for an accelerated domain name. |
| 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 the list of SSL certificates configured for accelerated domain names. |
| DescribeCertificateInfoByID | Queries the information about a specific SSL certificate. |
| BatchSetCdnDomainServerCertificate | Enables, disables, or modifies the SSL certificates of one or more accelerated domain names. |
| DescribeCdnHttpsDomainList | Queries the information about SSL certificates that belong to your Alibaba Cloud account. |
Resource usage
| API | Description |
|---|---|
| DescribeUserUsageDataExportTask | Queries export tasks that were created in the last three months. The tasks were used to export resource usage information. |
| CreateUserUsageDataExportTask | Creates a task to export your resource usage history to a PDF file. |
| CreateUsageDetailDataExportTask | Creates a task to export resource usage details to an Excel file. |
| 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. |
| DescribeDomainUsageData | Queries the resource usage information about specified domain names in a specified region. |
| DeleteUserUsageDataExportTask | Deletes a task that was used to export usage history. |
| DeleteUsageDetailDataExportTask | Deletes a task that was used to export usage details. |
Tag management
| API | Description |
|---|---|
| DescribeTagResources | Queries tags that are added to specified resources. |
| DescribeUserTags | Queries user tags. |
| UntagResources | Removes tags from specified resource. |
| TagResources | Adds one or more tags to specific resources. |
Auxiliary tools
| API | Description |
|---|---|
| DescribeIpInfo | Checks whether a specified IP address is assigned to an Alibaba Cloud CDN node. |
| CreateIllegalUrlExportTask | Creates a task to export invalid URLs. |
| DescribeIllegalUrlExportTask | Queries tasks that were used to export invalid URLs. |