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 name management
API | Title | Description |
| Adding or removing domain names | Adding or removing domain names | |
AddCdnDomain | Adds an accelerated domain name to CDN. | |
BatchAddCdnDomain | Adds up to 50 accelerated domain names in a single request. | |
DeleteCdnDomain | Removes an accelerated domain name from Alibaba Cloud CDN. | |
| Enabling or disabling domain names | Enabling or disabling domain names | |
StartCdnDomain | Enables a disabled domain name. Sets DomainStatus to Online. | |
BatchStartCdnDomain | Enables one or more domain names at a time. Sets DomainStatus to Online. | |
StopCdnDomain | Disables an accelerated domain name. Sets DomainStatus to Offline. | |
BatchStopCdnDomain | Disables one or more accelerated domain names at a time. Sets DomainStatus to Offline. | |
| Domain name configuration | Domain name configuration | |
DescribeDomainCname | Queries the CNAME record of an accelerated domain name and verifies its configuration. | |
DescribeCdnDomainDetail | Queries an accelerated domain name. | |
DescribeCdnDomainConfigs | Queries the configurations of an accelerated domain name. Supports querying multiple features in a single call. | |
BatchSetCdnDomainConfig | Batch-configures domain names. | |
BatchDeleteCdnDomainConfig | Deletes configurations of multiple accelerated domain names at a time. | |
BatchUpdateCdnDomain | Updates multiple accelerated domain names at a time. | |
DeleteSpecificConfig | Deletes specified configurations of an accelerated domain name. | |
ModifyCdnDomain | Updates an accelerated domain name. | |
| Domain name configuration management in the staging environment | Domain name configuration management in the staging environment | |
SetCdnDomainStagingConfig | Configures an accelerated domain name in the staging environment. | |
DeleteSpecificStagingConfig | Deletes a specified configuration of the staging environment. |
Refresh and prefetch
API | Title | Description |
PushObjectCache | Prefetches content from origin servers to POPs. Reduces origin load by enabling cache hits on first visits. | |
DescribeRefreshTasks | Queries the status of refresh and prefetch tasks across the network. | |
DescribeRefreshTaskById | Queries the completion status of refresh and prefetch tasks by task ID. |
Monitoring and usage analytics
API | Title | Description |
| Resource monitoring | Resource monitoring | |
| Visit data | Visit data | |
DescribeDomainDetailDataByLayer | Retrieves detailed data for an accelerated domain name by protocol type. | |
DescribeRangeDataByLocateAndIspService | Obtains bandwidth data by carrier and region. | |
| Real-time Monitoring | Real-time Monitoring | |
| Source data | Source data | |
DescribeDomainRealTimeSrcHttpCodeData | Queries the total number and proportions of HTTP status codes returned during back-to-origin routing. |
Resource usage management
API | Title | Description |
DescribeCdnUserResourcePackage | Queries your current resource plans for CDN. |
Certificate management
API | Title | Description |
DescribeDomainCertificateInfo | Queries certificate information for a specified accelerated domain name. | |
DescribeCdnHttpsDomainList | Queries all certificate information for your account. | |
SetCdnDomainSSLCertificate | Enables or disables the certificate for a domain name and updates the certificate information. |
Operations reports
API | Title | Description |
DescribeCdnSubList | Queries custom report tasks. | |
DescribeCdnReport | Queries custom reports. | |
DescribeCdnReportList | Queries a list of all custom reports. | |
DescribeCdnDeliverList | Queries all report tracking tasks under your account. |
Others
API | Title | Description |
AddFCTrigger | Adds a Function Compute trigger. | |
BatchDescribeCdnIpInfo | Queries whether one or more IP addresses are assigned to Alibaba Cloud CDN. | |
CheckCdnDomainExist | Checks whether a domain name exists. | |
CheckCdnDomainICP | Checks whether an ICP filing is obtained for the domain name. | |
CreateCdnCertificateSigningRequest | Creates a certificate signing request (CSR). | |
CreateCdnDeliverTask | Creates a tracking task that sends operations reports to you by email on a regular basis. | |
CreateCdnSubTask | Creates a custom operations report. | |
CreateRealTimeLogDelivery | Enables real-time log delivery for specific accelerated domain names. | |
CreateUsageDetailDataExportTask | Creates a task to export resource usage details to an Excel file. | |
CreateUserUsageDataExportTask | Creates a task to export your resource usage history to a PDF file. | |
DeleteCdnDeliverTask | Deletes tracking tasks by task ID. | |
DeleteCdnSubTask | Deletes all custom operations reports. | |
DeleteFCTrigger | Deletes a specified Function Compute trigger. | |
DeleteRealTimeLogLogstore | Deletes the Logstore that is used by a specified configuration record of real-time log delivery. | |
DeleteRealtimeLogDelivery | Deletes real-time log delivery for specific accelerated domain names. | |
DeleteUsageDetailDataExportTask | Deletes a task that was used to export usage details. | |
DeleteUserUsageDataExportTask | Deletes a task that was used to export usage history. | |
DescribeBlockedRegions | Queries countries and regions that can be added to the blacklist. | |
DescribeCdnCertificateDetail | Queries an SSL certificate. | |
DescribeCdnCertificateDetailById | Queries certificate details by certificate ID. | |
DescribeCdnCertificateList | Queries the certificates of accelerated domain names. | |
DescribeCdnConditionIPBInfo | Queries the ISP, region, and country required for advanced conditions. | |
DescribeCdnDeletedDomains | Queries the domain names that are deleted from your account. | |
DescribeCdnDiagnoseReport | Queries the details of a diagnostic report. | |
DescribeCdnDomainByCertificate | Queries accelerated domain names by SSL certificate. | |
DescribeCdnDomainLogs | Queries the log download URL for a specific domain name. | |
DescribeCdnDomainStagingConfig | Queries the configurations of features in the staging environment. | |
DescribeCdnFullDomainsBlockIPConfig | Queries the configurations of full blocking. | |
DescribeCdnFullDomainsBlockIPHistory | Queries the blocking history. | |
DescribeCdnOrderCommodityCode | Queries the commodity code for a specified UID. | |
DescribeCdnRegionAndIsp | Queries regions and carriers. | |
DescribeCdnSMCertificateDetail | Queries a ShangMi (SM) certificate. | |
DescribeCdnSMCertificateList | Queries the ShangMi (SM) certificates of an accelerated domain name. | |
DescribeCdnSSLCertificateList | Queries the certificate list by domain name. | |
DescribeCdnSecFuncInfo | Queries security features of Alibaba Cloud CDN. | |
DescribeCdnService | Queries the CDN service status, including the current metering method, activation time, next effective metering method, and current service status. | |
DescribeCdnTaskList | Queries a list of diagnostic tasks. | |
DescribeCdnTypes | Queries the types of domain names. | |
DescribeCdnUserBillHistory | Queries the billing history under your Alibaba Cloud account. | |
DescribeCdnUserBillPrediction | Estimates resource usage of the current month. | |
DescribeCdnUserConfigs | Queries configurations of security features. | |
DescribeCdnUserDomainsByFunc | Queries accelerated domain names with specified features configured and their status. | |
DescribeCdnUserQuota | Queries the quotas and usage of Alibaba Cloud CDN resources. | |
DescribeCertificateInfoByID | Queries a specific certificate by certificate ID. | |
DescribeCustomLogConfig | Queries a custom logging configuration. | |
DescribeDomainBpsData | Queries bandwidth monitoring data for one or more accelerated domain names. | |
DescribeDomainBpsDataByLayer | Queries bandwidth data by protocol. | |
DescribeDomainBpsDataByTimeStamp | Queries the bandwidth data at a specified time for an accelerated domain. | |
DescribeDomainCcActivityLog | Queries log entries of rate limiting. | |
DescribeDomainCustomLogConfig | Queries the custom log configuration of an accelerated domain name. | |
DescribeDomainHitRateData | Queries byte hit ratios that are measured in percentage. | |
DescribeDomainHttpCodeData | Queries HTTP status code counts and proportions for an accelerated domain name at 5-minute intervals. | |
DescribeDomainHttpCodeDataByLayer | Queries HTTP status codes by protocol. | |
DescribeDomainMax95BpsData | Queries the 95th percentile bandwidth data of a domain name. | |
DescribeDomainPathData | Queries monitoring data including the amount of network traffic and the number of visits by directory. | |
DescribeDomainQpsData | Queries QPS data for an accelerated domain name at 5-minute intervals. Supports the last 90 days. | |
DescribeDomainQpsDataByLayer | Queries QPS at a specific layer for one or more accelerated domain names. Supports the last 90 days. | |
DescribeDomainRealTimeBpsData | Queries bandwidth data for one or more accelerated domain names. | |
DescribeDomainRealTimeByteHitRateData | Queries the byte hit ratios of accelerated domain names. | |
DescribeDomainRealTimeDetailData | Queries the real-time monitoring data for a domain name. | |
DescribeDomainRealTimeHttpCodeData | Queries the total number and proportions of HTTP status codes returned from an accelerated domain name. | |
DescribeDomainRealTimeQpsData | Queries the number of queries per second for one or more accelerated domain names. | |
DescribeDomainRealTimeReqHitRateData | Queries the request hit ratios for one or more accelerated domain names. | |
DescribeDomainRealTimeSrcBpsData | Queries origin bandwidth data for accelerated domain names. | |
DescribeDomainRealTimeSrcTrafficData | Queries back-to-origin traffic for one or more accelerated domain names at 1-minute intervals. | |
DescribeDomainRealTimeTrafficData | Queries the monitoring data of network traffic for one or more accelerated domain names. | |
DescribeDomainRealtimeLogDelivery | Queries the real-time log delivery configuration of an accelerated domain name. | |
DescribeDomainReqHitRateData | Queries the request hit ratio in percentage. | |
DescribeDomainSrcBpsData | Queries origin bandwidth data for one or more accelerated domain names. | |
DescribeDomainSrcHttpCodeData | Queries the proportions of HTTP status codes that are returned during back-to-origin routing. | |
DescribeDomainSrcQpsData | Queries origin QPS. Supports the last 90 days. | |
DescribeDomainSrcTrafficData | Queries origin traffic for one or more specified accelerated domain names. | |
DescribeDomainTrafficData | Queries network traffic for one or more accelerated domain names. Supports the last 90 days. | |
DescribeDomainUsageData | Queries the resource usage data of specific domain names in a specified billable region. | |
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. | |
DescribeDomainsBySource | Queries accelerated domain names by origin server. | |
DescribeDomainsUsageByDay | Queries the daily monitoring data of an accelerated domain name. Supports the last 90 days. | |
DescribeEsExceptionData | Queries the execution errors of a script in EdgeScript (ES). | |
DescribeEsExecuteData | Queries the execution status of scripts in EdgeScript (ES). | |
DescribeFCTrigger | Queries a specified Function Compute trigger. | |
DescribeIpInfo | Checks whether a specified IP address is the IP address of a CDN point of presence (POP). | |
DescribeIpStatus | Queries the status of POP IP addresses to determine whether they support content delivery acceleration. | |
DescribeL2VipsByDomain | Queries the IP addresses of L2 nodes for a specified domain name. | |
DescribePreloadDetailById | Queries the prefetch progress of a task, including all resources. Only allowlisted users can call this operation. Contact your business manager to request access. | |
DescribeRealtimeDeliveryAcc | Queries the number of real-time log deliveries. | |
DescribeRefreshQuota | DescribeRefreshQuota | |
DescribeStagingIp | Queries node IP addresses in the staging environment. | |
DescribeTagResources | Queries tags that are added to specified resources. | |
DescribeUserCdnStatus | Queries the status of a user. | |
DescribeUserCertificateExpireCount | Queries the number of domain names whose SSL certificates are about to expire or have already expired. | |
DescribeUserDomains | Queries all accelerated domain names and their status. Supports filtering by name or status with fuzzy match. | |
DescribeUserTags | Queries user tags. | |
DescribeUserUsageDataExportTask | Queries usage export tasks that were created in the last three months. | |
DescribeUserUsageDetailDataExportTask | Queries resource usage detail export tasks for one or more accelerated domain names. Data is collected every 5 minutes. | |
DescribeUserVipsByDomain | Queries virtual IP addresses (VIPs) of CDN points of presence (POPs) by domain name. | |
DescribeVerifyContent | Queries the ownership verification content of an accelerated domain name. | |
DisableRealtimeLogDelivery | Disables real-time log delivery for specific accelerated domain names. | |
EnableRealtimeLogDelivery | Enables real-time log delivery for an accelerated domain name. | |
GenerateCdnDiagnose | Generates a diagnostic link for a URL. | |
ListDomainsByLogConfigId | Queries domain names by log configuration ID. | |
ListFCTrigger | Queries the Function Compute trigger that is set for an Alibaba Cloud CDN event. | |
ListRealtimeLogDelivery | Queries all real-time log delivery tasks within your Alibaba Cloud account. | |
ListRealtimeLogDeliveryDomains | Queries all domain names that are associated with a specific real-time log delivery configuration record. | |
ListRealtimeLogDeliveryInfos | Queries real-time log delivery configurations in a specified region. | |
ListTagResources | Queries the tags that are attached to a resource. | |
ListUserCustomLogConfig | Queries all custom log configurations in your account. | |
ModifyCdnDomainOwner | Transfers domain names from another Alibaba Cloud account to the current account. | |
ModifyCdnDomainSchdmByProperty | Changes the acceleration region for an accelerated domain name. | |
ModifyCdnService | Changes the metering method of Alibaba Cloud CDN. | |
ModifyRealtimeLogDelivery | Updates real-time log delivery for a domain name. Each domain supports only one Logstore. | |
OpenCdnService | Activates Alibaba Cloud CDN. Required before managing domain names. | |
PublishStagingConfigToProduction | Publishes the configurations of the staging environment to the production environment. | |
RefreshObjectCacheByCacheTag | Refreshes the cache based on cache tags that you configured. | |
RefreshObjectCaches | Purges cached files on POPs. After purging, CDN fetches the latest content from origin on subsequent requests. Supports batch URL purging. | |
RollbackStagingConfig | Rolls back and clears all configurations in the staging environment. | |
SetCdnDomainCSRCertificate | Configures an SSL certificate for a specific domain name. | |
SetCdnDomainSMCertificate | Enables or disables a ShangMi (SM) certificate for a domain name. | |
SetCdnFullDomainsBlockIP | Blocks or unblocks IP addresses. This setting applies to all domain names in your account. | |
SetWaitingRoomConfig | Configures the virtual waiting room for an accelerated domain name. Available only for Dynamic CDN workload types. | |
TagResources | Adds one or more tags to specific resources. | |
UntagResources | Removes tags from specified resources. | |
UpdateCdnDeliverTask | Updates a tracking task. | |
UpdateCdnSubTask | Updates one or more operations reports. | |
UpdateFCTrigger | Updates a specified Function Compute trigger. | |
VerifyDomainOwner | Verifies the ownership of a specified domain name. |