全部产品
Search

搜索本产品

    CDN：API概览

    文档中心

    CDN：API概览

    更新时间：Nov 12, 2024
    本产品（内容分发/2018-05-10）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
    在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

    域名管理

    API标题API概述
    添加/删除域名添加/删除域名
    AddCdnDomain添加域名调用AddCdnDomain添加加速域名。
    BatchAddCdnDomain批量添加域名调用BatchAddCdnDomain可以实现批量添加加速域名，一次最多可以添加50个加速域名。
    DeleteCdnDomain删除域名调用DeleteCdnDomain删除已添加的加速域名。
    DescribeCdnDeletedDomains查询已删除域名调用DescribeCdnDeletedDomains查询您名下已删除的域名。
    域名归属校验域名归属校验
    VerifyDomainOwner校验域名归属权调用VerifyDomainOwner对域名归属权进行校验。
    DescribeVerifyContent查询校验归属权内容调用DescribeVerifyContent查询归属校验内容。
    DescribeDomainVerifyData查询域名归属校验内容调用DescribeDomainVerifyData，根据加速域名是否开启全球资源计划，返回对应的校验内容。
    停用/启用加速域名停用/启用加速域名
    StartCdnDomain启用域名调用StartCdnDomain启用状态为停用的加速域名，将DomainStatus变更为Online。
    BatchStartCdnDomain批量启用域名调用BatchStartCdnDomain批量启用状态为停用的加速域名，将DomainStatus变更为Online。
    StopCdnDomain停用域名调用StopCdnDomain停用某个加速域名，将DomainStatus变更为Offline。
    BatchStopCdnDomain批量停用域名调用BatchStopCdnDomain批量停用加速域名，将DomainStatus变更为Offline。
    域名配置域名配置
    DescribeUserDomains查询用户域名调用DescribeUserDomains查询用户名下所有的域名与状态，支持域名模糊匹配过滤和域名状态过滤。
    DescribeDomainCname检测加速域名的Cname是否完成配置调用接口对加速域名Cname进行解析检测，查看解析结果判断是否完成Cname配置。
    DescribeDomainsBySource查询域名-按源站调用DescribeDomainsBySource按源站查询加速域名。
    DescribeCdnUserDomainsByFunc查询域名-按功能调用DescribeCdnUserDomainsByFunc查询用户名下配置了指定功能的所有的域名及其状态。
    DescribeCdnDomainDetail查询域名详情调用DescribeCdnDomainDetail查询指定加速域名的基本配置。
    DescribeCdnDomainConfigs查询域名配置调用DescribeCdnDomainConfigs获取加速域名的配置信息，一次可查询多个功能配置信息。
    BatchSetCdnDomainConfig批量配置域名调用BatchSetCdnDomainConfig进行域名批量配置。
    BatchDeleteCdnDomainConfig批量删除域名配置调用BatchDeleteCdnDomainConfig批量删除加速域名的配置。
    BatchUpdateCdnDomain批量更新域名调用BatchUpdateCdnDomain批量更新加速域名基本信息。
    DeleteSpecificConfig删除域名的指定配置调用DeleteSpecificConfig删除域名的指定配置。
    ModifyCdnDomainSchdmByProperty修改域名的加速区域调用ModifyCdnDomainSchdmByProperty通过配置组修改域名的加速区域。
    ModifyCdnDomain修改域名基础信息调用ModifyCdnDomain修改加速域名基础信息。
    域名模拟环境配置域名模拟环境配置
    DescribeCdnDomainStagingConfig查询模拟环境配置调用DescribeCdnDomainStagingConfig查询模拟环境配置信息，一次可查询多个功能配置。
    SetCdnDomainStagingConfig设置模拟环境配置调用SetCdnDomainStagingConfig设置模拟环境下的加速域名配置。
    RollbackStagingConfig回滚模拟环境配置调用RollbackStagingConfig可以起到回滚模拟环境配置的作用，配置回滚后的模拟环境将被还原为初始状态，模拟环境下的所有配置都将被清空。
    PublishStagingConfigToProduction发布模拟环境配置到生产环境调用PublishStagingConfigToProduction将模拟环境配置发布为生产环境配置。
    DeleteSpecificStagingConfig删除模拟环境指定配置调用DeleteSpecificStagingConfig删除模拟环境中的指定配置。
    安全配置安全配置
    SetWaitingRoomConfig配置WaitingRoom调用SetWaitingRoomConfig设置waiting_room功能，只支持全站加速类型域名。
    DescribeCdnUserConfigs查询安全功能配置调用DescribeCdnUserConfigs查询安全功能相关的配置。
    DescribeBlockedRegions查询支持封禁的区域调用DescribeBlockedRegions查询区域封禁支持的国家和地区。

    刷新预热

    API标题API概述
    RefreshObjectCacheByCacheTag根据缓存标签刷新缓存当用户设置了缓存标签功能后，通过调用RefreshObjectCacheByCacheTag指定缓存标签对缓存进行刷新。
    DescribeRefreshQuota查询刷新预热配额调用DescribeRefreshQuota查询当天URL刷新、目录刷新、预热及封禁的最大限制数量和剩余量。
    PushObjectCache预热URL调用PushObjectCache将源站的内容主动预热到缓存节点上。您首次访问可直接命中缓存，缓解源站压力。
    RefreshObjectCaches刷新缓存调用RefreshObjectCaches刷新节点上的文件内容。被刷新的文件缓存将立即失效，新的请求将回源获取最新的文件，支持URL批量刷新。
    DescribeRefreshTasks查询刷新预热任务调用DescribeRefreshTasks查询刷新、预热状态是否在全网生效。
    DescribeRefreshTaskById查询刷新预热任务-按ID调用DescribeRefreshTaskById查询刷新状态和预热状态是否在全网生效。
    DescribePreloadDetailById查询预热任务详情查询任务预热详情，包括任务下所有资源的预热进度。该接口需要申请白名单后才可以使用，带宽大于100Gbps的情况下，可以通过您的商务经理申请白名单。
    DescribeCdnUserQuota查询用户配额调用DescribeCdnUserQuota查询用户配额上限和余量信息。

    监控查询

    API标题API概述
    资源监控资源监控
    访问数据访问数据
    DescribeDomainPathData按目录维度获取监控数据调用DescribeDomainPathData按目录维度获取监控数据，包括流量和访问次数。
    DescribeDomainQpsData查询QPS调用DescribeDomainQpsData获取5分钟计算粒度加速域名的每秒访问次数QPS，支持获取最近90天的数据。
    DescribeDomainQpsDataByLayer查询QPS-按协议调用DescribeDomainQpsDataByLayer查询加速域名的每秒访问次数QPS，支持获取最近90天的数据。
    DescribeDomainBpsData查询带宽调用DescribeDomainBpsData查询带宽数据。
    DescribeDomainBpsDataByLayer查询带宽-按协议调用DescribeDomainBpsDataByLayer按协议分类获取带宽数据。
    DescribeDomainBpsDataByTimeStamp查询带宽-按时间戳调用DescribeDomainBpsDataByTimeStamp查询加速域名的在某个时刻不同运营商和区域的带宽数据。
    DescribeDomainTrafficData查询流量调用DescribeDomainTrafficData查询加速域名的网络流量监控数据，支持获取最近90天的数据。
    DescribeDomainHttpCodeData查询HTTP状态码调用DescribeDomainHttpCodeData查询加速域名5分钟粒度的HTTP返回码总数和占比数据。
    DescribeDomainHttpCodeDataByLayer查询HTTP状态码-按协议调用DescribeDomainHttpCodeDataByLayer按协议分类获取HTTP状态码数据。
    DescribeDomainHitRateData查询字节命中率调用DescribeDomainHitRateData查询字节命中率（命中字节百分比）。
    DescribeDomainReqHitRateData查询请求命中率调用DescribeDomainReqHitRateData查询请求命中率（命中请求百分比）。
    DescribeDomainsUsageByDay查询用量-按天调用DescribeDomainsUsageByDay查询加速域名天粒度的监控统计数据，支持获取最近90天的数据。
    DescribeDomainDetailDataByLayer按协议类型获取详细数据调用DescribeDomainDetailDataByLayer按协议类型获取加速域名的数据明细（域名维度）。
    DescribeRangeDataByLocateAndIspService查询访问数据-按运营商和地域调用DescribeRangeDataByLocateAndIspService获取按运营商和地域获取带宽数据。
    回源数据回源数据
    DescribeDomainSrcBpsData查询回源带宽调用DescribeDomainSrcBpsData查询加速域名的回源带宽监控数据。
    DescribeDomainSrcHttpCodeData查询回源HTTP状态码调用DescribeDomainSrcHttpCodeData查询加速域名回源HTTP返回码的总数和占比数据。
    DescribeDomainSrcTrafficData查询回源流量调用DescribeDomainSrcTrafficData查询加速域名的回源流量监控数据。
    DescribeDomainSrcQpsData查询回源QPS调用DescribeDomainSrcQpsData查询回源QPS数据，支持获取最近90天的数据。
    实时监控实时监控
    访问数据访问数据
    DescribeDomainRealTimeTrafficData查询实时流量调用DescribeDomainRealTimeTrafficData查询加速域名的流量监控数据。
    DescribeDomainRealTimeBpsData查询实时带宽调用DescribeDomainRealTimeBpsData查询加速域名的带宽数据。
    DescribeDomainRealTimeHttpCodeData查询实时状态码调用DescribeDomainRealTimeHttpCodeData查询加速域名HTTP返回码的总数和占比数据。
    DescribeDomainRealTimeQpsData查询实时QPS调用DescribeDomainRealTimeQpsData查询加速域名每秒访问次数数据。
    DescribeDomainRealTimeReqHitRateData查询实时请求命中率调用DescribeDomainRealTimeReqHitRateData查询加速域名请求命中率数据。
    DescribeDomainRealTimeByteHitRateData查询实时字节命中率调用DescribeDomainRealTimeByteHitRateData查询域名字节命中率数据。
    回源数据回源数据
    DescribeDomainRealTimeSrcBpsData查询实时回源带宽调用DescribeDomainRealTimeSrcBpsData查询域名回源带宽数据。
    DescribeDomainRealTimeSrcHttpCodeData查询实时回源状态码调用DescribeDomainRealTimeSrcHttpCodeData查询加速域名回源HTTP返回码的总数和占比数据。
    DescribeDomainRealTimeSrcTrafficData查询实时回源流量调用DescribeDomainRealTimeSrcTrafficData查询加速域名1分钟粒度的回源流量监控数据。
    边缘脚本监控边缘脚本监控
    DescribeEsExecuteData查询ES规则的运行情况调用DescribeEsExecuteData查询ES规则的运行情况。
    DescribeEsExceptionData查询ES规则的异常情况调用DescribeEsExceptionData查询ES规则执行的异常情况。

    用量查询

    API标题API概述
    DescribeCdnUserBillHistory查询历史账单调用DescribeCdnUserBillHistory查询用户历史账单。
    DescribeCdnUserBillPrediction查询预测用量调用DescribeCdnUserBillPrediction预测用户当月的用量数据。
    CreateUserUsageDataExportTask创建用量数据导出任务调用CreateUserUsageDataExportTask创建账号历史用量数据导出任务，将历史用量生成PDF文件用于下载。
    DescribeUserUsageDataExportTask查询用量数据导出任务调用DescribeUserUsageDataExportTask查询用户最近三个月的用量导出任务信息。
    DeleteUserUsageDataExportTask删除用量数据导出任务调用DeleteUserUsageDataExportTask删除账号历史用量数据导出任务。
    CreateUsageDetailDataExportTask创建用量明细数据导出任务调用CreateUsageDetailDataExportTask创建用量明细数据导出任务，将详细用量生成Excel文件用于下载。
    DescribeUserUsageDetailDataExportTask查询用量明细导出任务详情调用DescribeUserUsageDetailDataExportTask查询您账户下单个或多个域名5分钟明细数据的导出任务。
    DeleteUsageDetailDataExportTask删除用量明细数据导出任务调用DeleteUsageDetailDataExportTask删除用量明细数据导出任务。
    DescribeDomainUsageData查询用量数据调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。
    DescribeCdnUserResourcePackage查询资源包调用DescribeCdnUserResourcePackage查询CDN用户当前资源包信息。

    日志管理

    API标题API概述
    实时日志实时日志
    DeleteRealTimeLogLogstore删除实时日志推送的Logstore调用DeleteRealTimeLogLogstore删除实时日志推送的Logstore。
    CreateRealTimeLogDelivery创建实时日志投递调用CreateRealTimeLogDelivery创建域名实时日志投递。
    ModifyRealtimeLogDelivery修改实时日志投递调用ModifyRealtimeLogDelivery更改域名实时日志投递，一个域名仅支持投递单个Logstore。
    DeleteRealtimeLogDelivery删除实时日志投递调用DeleteRealtimeLogDelivery删除实时日志推送域名。
    DisableRealtimeLogDelivery暂停实时日志投递调用DisableRealtimeLogDelivery暂停域名实时日志投递。
    EnableRealtimeLogDelivery开启实时日志投递调用EnableRealtimeLogDelivery开启域名实时日志投递。
    DescribeDomainRealtimeLogDelivery查询实时日志投递信息调用DescribeDomainRealtimeLogDelivery查询域名实时日志投递信息。
    DescribeRealtimeDeliveryAcc查询实时日志投递次数调用DescribeRealtimeDeliveryAcc查询实时日志投递次数。
    ListRealtimeLogDeliveryInfos查询实时日志投递信息列表调用ListRealtimeLogDeliveryInfos查询所有实时日志投递服务信息。
    ListRealtimeLogDeliveryDomains查询实时日志投递域名调用ListRealtimeLogDeliveryDomains查询实时日志投递服务下所有域名。
    离线日志离线日志
    DescribeDomainCustomLogConfig查询自定义日志配置-按域名调用DescribeDomainCustomLogConfig查询域名自定义日志格式配置信息。
    DescribeCustomLogConfig查询自定义日志配置-按日志配置ID调用DescribeCustomLogConfig根据configId查询自定义日志配置详细信息。
    DescribeCdnDomainLogs查询离线日志下载地址调用DescribeCdnDomainLogs查询域名的离线日志下载地址。
    ListDomainsByLogConfigId查询域名列表-按日志配置ID调用ListDomainsByLogConfigId按日志配置ID查询域名列表。
    ListUserCustomLogConfig查询自定义日志配置ID调用ListUserCustomLogConfig查询用户下所有自定义日志配置信息。

    服务管理

    API标题API概述
    OpenCdnService开通CDN服务调用OpenCdnService开通CDN服务。开通服务后才能进行域名操作。
    DescribeCdnRegionAndIsp查询地域和运营商列表调用DescribeCdnRegionAndIsp查询地域和运营商列表。
    DescribeCdnOrderCommodityCode查询商品Code调用DescribeCdnOrderCommodityCode查询客户UID对应的商品Code。
    DescribeCdnService查询CDN服务状态调用DescribeCdnService查询CDN服务状态。包括：当前计费类型、服务开通时间、下次生效的计费类型、当前业务状态等。

    证书管理

    API标题API概述
    SetDomainServerCertificate设置域名证书调用SetDomainServerCertificate设置指定域名下证书信息及证书功能是否启用。
    BatchSetCdnDomainServerCertificate批量设置域名证书调用BatchSetCdnDomainServerCertificate批量设置域名下的证书功能是否启用及配置证书信息。
    DescribeCdnDomainByCertificate查询域名-按证书调用DescribeCdnDomainByCertificate根据证书信息获取加速域名。
    DescribeDomainCertificateInfo查询域名证书信息调用DescribeDomainCertificateInfo查询指定加速域名证书信息。
    DescribeCdnCertificateDetail查询证书详情调用DescribeCdnCertificateDetail查询CDN证书详细信息。
    DescribeCdnCertificateList查询证书列表-按域名调用DescribeCdnCertificateList按照域名查询证书列表信息。
    DescribeCdnSSLCertificateList查询证书列表-按域名调用DescribeCdnSSLCertificateList按照域名查询证书列表信息。
    DescribeCdnHttpsDomainList查询证书列表调用DescribeCdnHttpsDomainList查询用户所有证书信息。
    DescribeCertificateInfoByID查询证书信息-按ID调用DescribeCertificateInfoByID按照证书ID查询指定证书信息。
    DescribeCdnCertificateDetailById查询证书详情-按ID调用DescribeCdnCertificateDetailById根据证书ID获取证书详细信息。
    DescribeUserCertificateExpireCount查询证书过期的域名数调用DescribeUserCertificateExpireCount查询用户证书过期的域名数。
    CreateCdnCertificateSigningRequest创建证书签名请求调用CreateCdnCertificateSigningRequest创建 CSR（证书签名请求）文件。
    SetCdnDomainCSRCertificate设置CSR证书调用SetCdnDomainCSRCertificate设置指定域名下的HTTPS证书。
    SetCdnDomainSMCertificate设置国密证书调用SetCdnDomainSMCertificate设置某域名下国密证书功能是否启用。
    DescribeCdnSMCertificateList查询国密证书列表调用DescribeCdnSMCertificateList查询指定加速域名下国密证书列表信息。
    DescribeCdnSMCertificateDetail查询国密证书详情调用DescribeCdnSMCertificateDetail查询国密证书的详细信息。
    SetCdnDomainSSLCertificate设置CDN域名证书调用SetCdnDomainSSLCertificate用于设置某域名下证书功能是否启用及更新证书信息。

    标签管理

    API标题API概述
    TagResources添加资源标签调用TagResources添加资源标签。
    DescribeTagResources查询资源标签调用DescribeTagResources查询资源对应的标签。
    DescribeUserTags查询用户标签调用DescribeUserTags查询用户标签。
    UntagResources删除资源标签调用UntagResources删除资源标签。
    ListTagResources查询资源标签列表调用ListTagResources查询资源标签列表。

    运营报表

    API标题API概述
    CreateCdnSubTask创建报表定制任务调用CreateCdnSubTask定制运营报表，定制后可查看定制报表数据。
    DescribeCdnSubList查询报表定制任务调用DescribeCdnSubList查询已定制的报表任务。
    UpdateCdnSubTask更新报表定制任务调用UpdateCdnSubTask更新已定制的运营报表。
    DeleteCdnSubTask删除报表定制任务调用DeleteCdnSubTask删除所有已定制的运营报表。
    DescribeCdnReport查询报表定制数据调用DescribeCdnReport查询已定制的报表数据。
    DescribeCdnReportList查询报表定制列表调用DescribeCdnReportList接口查询所有的定制报表列表。
    CreateCdnDeliverTask创建报表订阅任务调用CreateCdnDeliverTask创建报表订阅任务，订阅成功后系统会周期性地以邮件方式向您发送报表统计数据。
    DescribeCdnDeliverList查询报表订阅列表调用DescribeCdnDeliverList查询报表订阅任务列表，系统将返回该用户所有的订阅任务列表。
    UpdateCdnDeliverTask更新报表订阅任务调用UpdateCdnDeliverTask根据订阅任务ID更新已订阅的报表任务。
    DeleteCdnDeliverTask删除报表订阅任务调用DeleteCdnDeliverTask根据任务ID删除已订阅的报表任务。

    辅助工具

    API标题API概述
    DescribeIpInfo查询IP是否为CDN节点调用DescribeIpInfo验证指定的IP是否为阿里云CDN节点的IP地址。
    DescribeStagingIp查询节点IP列表-模拟环境-L1调用DescribeStagingIp查询模拟环境的节点IP地址。
    DescribeL2VipsByDomain查询节点IP地址-L2调用DescribeL2VipsByDomain查询指定域名的L2节点的IP地址。
    DescribeUserVipsByDomain查询节点IP列表-L1调用DescribeUserVipsByDomain查询域名的IP列表。
    DescribeIpStatus查询节点IP状态调用DescribeIpStatus查询节点IP可用状态，进而根据节点IP可用状态来了解节点加速服务的可用状态。
    AddFCTrigger添加函数计算触发器调用AddFCTrigger添加指定的函数计算触发器。
    UpdateFCTrigger更新函数计算触发器调用UpdateFCTrigger更新指定的函数计算触发器。
    DescribeFCTrigger查询函数计算触发器调用DescribeFCTrigger查询指定的函数计算触发器。
    DeleteFCTrigger删除函数计算触发器调用DeleteFCTrigger删除指定的函数计算触发器。
    ListFCTrigger查询函数计算的触发器列表调用ListFCTrigger查询指定事件的函数计算触发器列表。

    安全信息查询

    API标题API概述
    DescribeDomainCcActivityLog查询频次控制规则拦截日志调用DescribeDomainCcActivityLog查询频次控制规则拦截日志。

    其他

    API标题API概述
    ModifyCdnDomainOwner迁移域名调用ModifyCdnDomainOwner将其他阿里云账号下的域名迁移至本账号。
    DescribeCdnConditionIPBInfo查看高级条件所需要的信息调用DescribeCdnConditionIPBInfo查看高级条件所需要的运营商、地区和国家信息。
    ChangeCdnDomainToDcdn迁移CDN域名至DCDN调用ChangeCdnDomainToDcdn把域名从CDN产品迁移至DCDN产品。
    DescribeCdnSecFuncInfo查询CDN应用安全具体功能信息调用DescribeCdnSecFuncInfo查询CDN应用安全具体功能信息。
    CheckCdnDomainExist检测域名是否存在调用CheckCdnDomainExist检测域名是否存在。
    DescribeCdnMigrateRegisterStatus查询CDN域名注册DCDN动态选路状态调用DescribeCdnMigrateRegisterStatus接口可以查询对CDN域名执行DCDN动态选路功能注册的状态。
    CdnMigrateRegisterCDN域名注册DCDN动态选路调用CdnMigrateRegister可以对CDN域名执行DCDN动态选路功能注册，注册成功以后选路中心将会生成动态选路信息，并且下发给DCDN节点，这是将CDN域名迁移到DCDN之前必须完成的前置步骤。
    CheckCdnDomainICP查询域名是否备案调用CheckCdnDomainICP查询域名是否备案。
    BatchDescribeCdnIpInfo批量查询IP是否为CDN节点调用BatchDescribeCdnIpInfo批量查询IP是否为阿里云CDN服务IP。
    DescribeCdnFullDomainsBlockIPHistory查询封禁历史调用DescribeCdnFullDomainsBlockIPHistory获取封禁历史记录。
    SetCdnFullDomainsBlockIP设置海量封禁IP设置封禁的IP或解禁IP，该操作对您账号下所有的CDN域名同时生效。
    DescribeCdnFullDomainsBlockIPConfig查询全量封禁配置调用DescribeCdnFullDomainsBlockIPConfig查询全量封禁的相关配置。