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 an accelerated domain name. The data was collected at an interval of five minutes. You can query data within the last 90 days. |
| DescribeDomainTopReferVisit | Queries frequently requested web pages on a specified day and sorts the web pages. You can query data within the last 90 days. |
| DescribeDomainTopUrlVisit | Queries frequently requested URLs of an accelerated domain name on a specified day. You can query data within the last 90 days. |
| DescribeDomainAverageResponseTime | Queries the average response time of one or more accelerated domain names. You can query data within the last 90 days. |
| DescribeDomainFileSizeProportionData | Queries the proportions of file sizes. The data was collected at an interval of one hour. You can query data 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). The data was collected at an interval of one day. You can query data within the last 90 days. |
| DescribeCdnRegionAndIsp | Queries ISPs in each region. |
| DescribeRangeDataByLocateAndIspService | Queries the bandwidth data at a specified time for each ISP in different regions. |
| DescribeDomainRealTimeBpsData | Queries the bandwidth data of an accelerated domain name. The data was collected at an interval of one minute. You can query data within the last seven days. |
| DescribeDomainRealTimeSrcBpsData | Queries the bandwidth data of back-to-origin requests. The data was collected at an interval of one minute. You can query data within the last seven days. |
| DescribeDomainRealTimeSrcHttpCodeData | Queries the total number and proportions of HTTP status codes returned from an accelerated domain name to back-to-origin requests. The data was collected at an interval of one minute. You can query data within the last seven days. |
| DescribeDomainRealTimeSrcTrafficData | Queries the monitoring data of back-to-origin traffic for an accelerated domain name. The data was collected at an interval of one minute. The network traffic is measured in bits. You can query data within the last 90 days. |
| DescribeDomainRealTimeByteHitRateData | Queries byte hit rates of an accelerated domain name. The data was collected at an interval of one minute. You can query data within the last seven days. |
| DescribeDomainRealTimeQpsData | Queries the number of queries per second of an accelerated domain name. The data was collected at an interval of one 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. The data was collected at an interval of one minute. You can query data within the last seven days. |
| DescribeDomainRealTimeTrafficData | Queries the monitoring data of an accelerated domain name. The data was collected at an interval of one minute. The network traffic is measured in bytes. You can query data within the last 90 days. |
| DescribeDomainRealTimeReqHitRateData | Queries the request hit rates of an accelerated domain name. The data was collected at an interval of one minute. You can only query the data within the last seven days. |
| DescribeDomainBpsData | Queries the network bandwidth data of an accelerated domain name. You can query data within the last 90 days. |
| DescribeDomainSrcBpsData | Queries the bandwidth data of back-to-origin requests. You can query data within the last 90 days. |
| DescribeDomainSrcTrafficData | Queries the monitoring data of back-to-origin traffic for an accelerated domain name. The network traffic is measured in bits. You can query data within the last 90 days. |
| DescribeDomainsUsageByDay | Queries the monitoring data of an accelerated domain name. The data was collected at an interval of one day. You can query data within the last 90 days. |
| DescribeDomainHitRateData | Queries the byte hit rates of an accelerated domain name. Hit rates are measured in percentage. You can query data 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 rates of an accelerated domain name. Hit rates 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 an accelerated domain name. You can query data within the last 90 days. |
| DescribeDomainTrafficData | Queries the monitoring data of network traffic for an accelerated domain name. The network traffic is measured in bytes. You can query data within the last 90 days. |
| DescribeTopDomainsByFlow | Queries the top N domain names ranked by network traffic. You can query data within the last 90 days. |
| DescribeDomainRegionData | Queries the visitor data classified by region for an accelerated domain name. The data was collected at an interval of one day. |
| DescribeDomainUvData | Queries the unique visitor (UV) data of an accelerated domain name. The data was collected at an interval of one hour. You can query data within the last 90 days. |
| DescribeDomainPvData | Queries the page view (PV) data of an accelerated domain name. The data was collected at an interval of one hour. |
| DescribeDomainQpsData | Queries the number of queries per second of an accelerated domain name. The data was collected at an interval of five minutes. You can query data within the last 90 days. |
| ListFCTrigger | Queries the event triggers of Function Compute. |
| DescribeDomainQpsDataByLayer | Queries the number of queries per second captured at a specific layer for an accelerated domain name. You can query data within the last 90 days. |
| DescribeDomainTopClientIpVisit | Queries client IP addresses that are ranked by the number of requests or the network traffic usage within a specific time range. You can query data within the last 90 days. |
| DescribeDomainRealTimeDetailData | Queries the data usage of each ISP and the number of visits in each region. The data was collected at an interval of one minute. You can query data within the last seven days. |
| DescribeDomainSrcTopUrlVisit | Queries frequently requested URLs of an accelerated domain name. |
| DescribeDomainSrcQpsData | Queries the number of back-to-origin requests per second of an accelerated domain name. |
Domain management
| API | Description |
|---|---|
| AddCdnDomain | Adds a domain to Alibaba Cloud CDN as an accelerated domain. |
| DeleteCdnDomain | Removes a domain from Alibaba Cloud CDN. |
| StopCdnDomain | Disables Alibaba Cloud CDN for an accelerated domain name. After Alibaba Cloud CDN is disabled for the domain name, the value of the DomainStatus parameter is changed to Offline. |
| StartCdnDomain | Enables Alibaba Cloud CDN for a domain name. After Alibaba Cloud CDN is enabled for the domain name, the value of the DomainStatus parameter is changed to Online. |
| BatchStartCdnDomain | Enables Alibaba Cloud CDN for one or more domain names. After Alibaba Cloud CDN is enabled for the specified domain names, the value of the DomainStatus parameter is changed to Online. |
| BatchSetCdnDomainConfig | Configures Alibaba Cloud CDN features for multiple domain names at a time. |
| ModifyCdnDomain | Modifies the information about an accelerated domain name. |
| DescribeUserDomains | Queries all CDN-accelerated domain names and their status under your account. You can use fuzzy match to filter domain names by name or status. |
| DescribeCdnCertificateList | Queries the list of certificates for an accelerated domain name. |
| DescribeDomainCertificateInfo | Queries the certificate information about an accelerated domain name. |
| DescribeCdnDomainDetail | Queries the basic information about an accelerated domain name. |
| DescribeDomainsBySource | Queries all domain names corresponding to one or more origins under your account. |
| SetDomainServerCertificate | Configures an SSL certificate for an accelerated domain name. |
| BatchStopCdnDomain | Disables Alibaba Cloud CDN for one or more accelerated domain names. After Alibaba Cloud CDN is disabled for an accelerated domain name, the value of the DomainStatus parameter is changed to Offline. |
| DescribeCdnDomainConfigs | Queries one or more configurations of an accelerated domain name. |
| DeleteSpecificConfig | Deletes specific configurations of an accelerated domain name. |
| DescribeUserVipsByDomain | Queries virtual IP addresses of CDN nodes by domain name. |
| BatchAddCdnDomain | Adds one or more domain names to Alibaba Cloud CDN. Each account can add up to 20 domain names to Alibaba Cloud CDN. |
| DescribeCdnHttpsDomainList | Queries all certificate information under your account. |
| ModifyCdnDomainSchdmByProperty | Modifies the accelerated region for an accelerated domain name. |
| BatchUpdateCdnDomain | Updates the configurations of one or more accelerated domain names. |
| BatchSetCdnDomainServerCertificate | Configures an SSL certificate for one or more accelerated domain names. |
| DescribeCdnDomainByCertificate | Queries accelerated domain names by certificate. |
| SetWaitingRoomConfig | Configures the virtual waiting room feature for an accelerated domain name. This operation is available only for accelerated domain names of the DCDN business type. |
| DescribeCdnCertificateDetail | Queries the detailed information about a CDN certificate. |
Log management
| API | Description |
|---|---|
| DescribeCdnDomainLogs | Queries the address where the raw access log of an accelerated domain name can be downloaded. |
| CreateRealTimeLogDelivery | Associates real-time log delivery with an accelerated domain name. |
| DeleteRealtimeLogDelivery | Disassociates real-time log delivery from an accelerated domain name. |
| DescribeDomainRealtimeLogDelivery | Queries the real-time log delivery information about an accelerated domain name. |
| DescribeRealtimeDeliveryAcc | Queries the number of real-time log deliveries. |
| DisableRealtimeLogDelivery | Disables real-time log delivery for an accelerated domain name. |
| EnableRealtimeLogDelivery | Enables real-time log delivery for an accelerated domain name. |
| ListRealtimeLogDeliveryDomains | Queries all domain names that are associated with a specific real-time log delivery configuration. |
| ListRealtimeLogDeliveryInfos | Queries all real-time log delivery information. |
| ModifyRealtimeLogDelivery | Modifies the real-time log delivery configuration for an accelerated domain name. You can delivery 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. |
| ListUserCustomLogConfig | Queries all custom log configurations under your account. |
| DescribeCustomLogConfig | Queries the detailed configuration of logging. |
Refresh and prefetch tasks
| API | Description |
|---|---|
| PushObjectCache | Prefetches content from origins to L2 CDN nodes. This reduces workloads on origins because users can directly hit cache upon their first visits. |
| DescribeRefreshQuota | Queries the maximum and remaining numbers of URLs and directories for object refreshing, and the maximum and remaining numbers of URLs for object prefetching. |
| DescribeRefreshTasks | Queries the status of refresh or prefetch tasks. |
| RefreshObjectCaches | Refreshes files on CDN nodes. 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. |
| ModifyCdnService | Changes the billing method of the CDN service. |
| DescribeCdnService | Queries the status of the CDN service. The status information includes the current billing method, the service activation time, the next effective billing method, and the current service status. |
| DescribeCdnUserResourcePackage | Queries the current resource plans that you have purchased for Alibaba Cloud CDN. |
| DescribeCdnUserQuota | Queries the resource quotas and usage. |
Resource usage queries
| API | Description |
|---|---|
| DescribeUserUsageDataExportTask | Queries tasks created in the last three months that were used to export resource usage information. |
| CreateUserUsageDataExportTask | Creates a task to export your resource usage information. The information is exported to a PDF file. |
| CreateUsageDetailDataExportTask | Creates a task to export the detailed resource usage information. The information is exported to an EXCEL file. |
| DescribeUserUsageDetailDataExportTask | Queries tasks that were used to export resource usage details of one or more accelerated domain names under your account. The resource usage information was collected at an interval of five minutes within a specific time range. |
| DescribeDomainUsageData | Queries the resource usage information of specific 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 the tags of one or more resources. |
| DescribeUserTags | Queries user tags. |
| UntagResources | Removes one or more tags from specific resources. |
| TagResources | Attaches one or more tags to specific resources. |
Auxiliary tools
| API | Description |
|---|---|
| DescribeIpInfo | Queries whether a specified IP address is the IP address of an Alibaba Cloud CDN node. |
| CreateIllegalUrlExportTask | Creates a task to export invalid URLs. |
| DescribeIllegalUrlExportTask | Queries tasks that were used to export invalid URLs. |