本文为您介绍全站加速提供的相关API接口及各API接口的用法。
开通服务
API | 描述 |
---|---|
OpenDcdnService | 开通DCDN服务。 |
DescribeUserDcdnStatus | 查询全站加速是否开通、是否欠费。 |
DescribeDcdnService | 查询DCDN服务状态。包括:当前计费类型、服务开通时间、下次生效的计费类型、当前业务状态等。 |
域名管理
API | 描述 |
---|---|
AddDcdnDomain | 添加全站加速域名,一次只能提交一个加速域名。 |
BatchAddDcdnDomain | 批量添加加速域名。 |
UpdateDcdnDomain | 修改加速域名。 |
StartDcdnDomain | 启用状态为停用的加速域名,将DomainStatus变更为online。 |
BatchStartDcdnDomain | 启用状态为停用的加速域名,将DomainStatus变更为online。 |
StopDcdnDomain | 停用某个加速域名,将DomainStatus变更为offline。 |
BatchStopDcdnDomain | 停用加速域名,将DomainStatus变更为offline。 |
DeleteDcdnDomain | 删除已添加的加速域名。 |
DescribeDcdnDomainCname | 检测用户是否完成CNAME。 |
DescribeDcdnUserDomains | 查询用户名下所有的全站加速域名,支持域名模糊匹配过滤和域名状态过滤。 |
DescribeDcdnDomainDetail | 查询指定加速域名配置的基本信息。 |
ModifyDCdnDomainSchdmByProperty | 修改加速区域。 |
DescribeDcdnUserDomainsByFunc | 通过FuncId查询用户名下所有的全站加速域名。 |
BatchSetDcdnDomainConfigs | 实现域名批量配置功能。 |
DescribeDcdnDomainConfigs | 查询域名配置,一次可查询多个功能配置。 |
DeleteDcdnSpecificConfig | 删除指定域名的配置。 |
BatchDeleteDcdnDomainConfigs | 批量删除域名配置。 |
DescribeDcdnDeletedDomains | 查询您名下已删除的域名。 |
域名校验
API | 描述 |
---|---|
VerifyDcdnDomainOwner | 校验域名的归属权。 |
DescribeDcdnVerifyContent | 查询域名的归属校验内容。 |
刷新预热
API | 描述 |
---|---|
RefreshDcdnObjectCaches | 刷新节点上的文件内容、刷新指定URL内容至Cache节点。支持URL批量刷新。 |
PreloadDcdnObjectCaches | 将源站的内容主动预热到L2 Cache节点上,用户首次访问可直接命中缓存,缓解源站压力。 |
DescribeDcdnRefreshQuota | 查询当日刷新URL、预热URL及刷新目录的上限和剩余次数。 |
DescribeDcdnRefreshTasks | 查询刷新、预热状态是否在全网生效。 |
DescribeDcdnUserQuota | 查询用户资源上限及已使用情况。 |
DescribeDcdnRefreshTaskById | 查询刷新或预热是否在全网生效。 |
证书服务
API | 描述 |
---|---|
SetDcdnDomainCertificate | 设置指定域名下是否启用证书功能以及修改证书信息。 |
DescribeDcdnCertificateList | 查询证书列表信息。 |
DescribeDcdnCertificateDetail | 查询证书详细信息。 |
DescribeDcdnDomainByCertificate | 根据证书信息查询加速域名。 |
DescribeDcdnDomainCertificateInfo | 查询指定加速域名证书信息。 |
DescribeDcdnHttpsDomainList | 查询用户所有证书信息。 |
BatchSetDcdnDomainCertificate | 批量设置是否启用域名证书功能及修改证书信息。 |
SetDcdnDomainSMCertificate | 设置指定域名下是否启用国密证书功能。 |
DescribeDcdnSMCertificateDetail | 查询国密证书的详细信息。 |
DescribeDcdnSMCertificateList | 查询指定加速域名下国密证书列表信息。 |
DescribeDcdnUserCertificateExpireCount | 获取DCDN用户证书过期域名数量。 |
资源用量
API | 描述 |
---|---|
DescribeDcdnDomainHttpCodeData | 查询加速域名最小5分钟粒度的HTTP返回码总数和占比数据,支持查询最近90天的数据。 |
DescribeDcdnDomainRegionData | 查询加速域名天粒度的用户区域分布数据统计,支持查询90天的数据。 |
DescribeDcdnRegionAndIsp | 查询地域和运营商列表。 |
DescribeDcdnDomainHitRateData | 查询加速域名的命中率,支持查询最近90天的数据。 |
DescribeDcdnDomainIspData | 查询加速域名天粒度的用户运营商分布数据统计,支持查询最近90天的数据。 |
DescribeDcdnDomainQpsData | 查询加速域名的每秒访问次数QPS,支持查询最近90天的数据。 |
DescribeDcdnDomainBpsData | 查询加速域名的网络带宽监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainTrafficData | 查询加速域名的网络流量监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainOriginBpsData | 查询加速域名的回源带宽监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainOriginTrafficData | 查询加速域名的回源流量监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainWebsocketHttpCodeData | 查询加速域名WebSocket协议的最小5分钟粒度的HTTP返回码总数和占比数据。 |
DescribeDcdnDomainWebsocketBpsData | 查询加速域名WebSocket协议的网络带宽监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainWebsocketTrafficData | 查询加速域名的WebSocket网络流量监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainBpsDataByLayer | 获取加速域名的带宽信息。 |
DescribeDcdnDomainHttpCodeDataByLayer | 根据协议获取HTTP Code分布情况。 |
DescribeDcdnDomainQpsDataByLayer | 获取加速域名的每秒访问次数QPS。 |
实时监控
API | 描述 |
---|---|
DescribeDcdnDomainRealTimeSrcTrafficData | 查询加速域名的1分钟回源流量监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainRealTimeQpsData | 查询域名1分钟粒度每秒访问次数的数据。 |
DescribeDcdnDomainRealTimeSrcBpsData | 查询域名1分钟粒度回源带宽数据,支持查询最近7天的数据。 |
DescribeDcdnDomainRealTimeHttpCodeData | 查询加速域名HTTP返回码总数和占比数据。 |
DescribeDcdnDomainRealTimeByteHitRateData | 查询域名1分钟粒度字节命中率数据。 |
DescribeDcdnDomainRealTimeBpsData | 查询域名1分钟粒度带宽数据。 |
DescribeDcdnDomainRealTimeReqHitRateData | 查询域名1分钟粒度请求命中率数据。 |
DescribeDcdnDomainRealTimeSrcHttpCodeData | 查询加速域名回源1分钟粒度的HTTP返回码占比数据。 |
DescribeDcdnDomainRealTimeTrafficData | 查询加速域名以1分钟为单位时间段的流量监控数据。 |
DescribeDcdnDomainRealTimeDetailDataDescribeDcdnUserBillHistory | 批量查询域名的各地区运营商流量和访问次数的1分钟粒度数据。 |
用量查询
API | 描述 |
---|---|
DescribeDcdnUserBillHistory | 查询用户历史账单,最多查询一个月的数据。 |
DescribeDcdnUserResourcePackage | 查询全站加速用户当前流量包。 |
DescribeDcdnDomainUsageData | 查询域名在特定计费区域的用量数据。 |
DescribeDcdnBgpBpsData | 查询BGP加速五分钟粒度带宽数据。 |
DescribeDcdnBgpTrafficData | 查询BGP加速五分钟粒度流量数据。 |
日志管理
API | 描述 |
---|---|
DescribeDcdnDomainLog | 查询指定域名的原始访问日志的下载地址。 |
DescribeUserLogserviceStatus | 查看Logservice服务是否开通或者欠费。 |
CheckDcdnProjectExist | 检查实时日志项目是否存在。 |
CreateDcdnSLSRealTimeLogDelivery | 创建实时日志项目。 |
CreateSlrAndSlsProject | 创建服务关联角色(SLR)以及日志服务(SLS)项目。 |
DeleteDcdnRealTimeLogProject | 删除整个项目的实时日志。 |
DescribeDcdnRealTimeDeliveryField | 查询实时日志所有字段。 |
DescribeDcdnSLSRealtimeLogDelivery | 查看实时日志项目。 |
DescribeDcdnUserRealTimeDeliveryField | 查询用户选择的字段列表。 |
ListDcdnRealTimeDeliveryProject | 查询用户开通的项目信息。 |
UpdateDcdnSLSRealtimeLogDelivery | 更新实时日志项目。 |
UpdateDcdnUserRealTimeDeliveryField | 更新实时日志字段。 |
运营报表
API | 描述 |
---|---|
CreateDcdnSubTask | 定制运营报表。 |
CreateDcdnDeliverTask | 创建报表订阅任务,订阅成功后系统会周期性地以邮件方式向您发送报表统计数据。 |
DescribeDcdnSubList | 查询已定制的报表任务。 |
DescribeDcdnReport | 查询已定制的报表数据。 |
DescribeDcdnReportList | 查询所有的定制报表列表。 |
DescribeDcdnDeliverList | 查询报表订阅任务列表,系统将返回所有的订阅任务列表。 |
UpdateDcdnSubTask | 更新已定制的运营报表。 |
UpdateDcdnDeliverTask | 根据订阅任务ID更新已订阅的报表任务。 |
DeleteDcdnSubTask | 删除所有已定制的运营报表。 |
DeleteDcdnDeliverTask | 根据任务ID删除已订阅的报表任务。 |
边缘程序
API | 描述 |
---|---|
CreateRoutine | 创建程序(Routine)。 |
DeleteRoutine | 删除边缘程序(EdgeRoutine)的程序(Routine)配置。 |
DeleteRoutineCodeRevision | 删除边缘程序指定版本的代码。 |
DeleteRoutineConfEnvs | 删除边缘程序Env列表中的自定义灰度环境。 |
DescribeRoutine | 查询某个边缘程序ER(EdgeRoutine)的元信息,包括每个环境的ER配置,配置版本,代码版本等信息。 |
DescribeRoutineCanaryEnvs | 查询边缘程序ER支持的Canary环境列表。 |
DescribeRoutineCodeRevision | 查询边缘程序ER的某个版本的JS代码。 |
DescribeRoutineSpec | 查询边缘程序可供选择的程序规格(内测阶段有3个CPU时间片规格:5ms、50ms、100ms)。 |
DescribeRoutineUserInfo | 查询阿里云账号绑定的相关信息(绑定的subdomain,以及创建的routine列表)。 |
DescribeUserErStatus | 查看边缘程序ER是否开通或者欠费。 |
EditRoutineConf | 修改边缘程序ER的配置。 |
SetRoutineSubdomain | 设置边缘程序ER子域。 |
UploadRoutineCode | 上传边缘程序ER的代码。 |
UploadStagingRoutineCode | 上传边缘程序ER的测试代码。 |
PublishRoutineCodeRevision | 发布指定版本的边缘程序ER代码到某个Env环境。 |
CommitStagingRoutineCode | 把测试版本unstable的JS代码生成供线上Env环境使用的正式版本。 |
IP应用加速
API | 描述 |
---|---|
DescribeDcdnIpaDomainConfigs | 查询域名配置。 |
StopDcdnIpaDomain | 停用某个加速域名,将DomainStatus变更为offline。 |
DescribeUserDcdnIpaStatus | 查询全站加速IPA是否开通、是否欠费。 |
DescribeDcdnIpaService | 查询全站加速IPA服务状态。 |
UpdateDcdnIpaDomain | 修改加速域名。 |
DeleteDcdnIpaDomain | 删除已添加的加速域名。 |
StartDcdnIpaDomain | 启用状态为停用的加速域名,将DomainStatus变更为online。 |
AddDcdnIpaDomain | 添加IPA层应用加速域名,一次只能提交一个加速域名。 |
BatchSetDcdnIpaDomainConfigs | 批量配置IPA层应用加速域名。 |
DescribeDcdnIpaUserDomains | 查询用户名下所有的IPA层应用加速域名。 |
DescribeDcdnIpaDomainDetail | 查询指定加速域名配置的基本信息。 |
DeleteDcdnIpaSpecificConfig | 删除指定域名的IPA层配置。 |
DescribeDcdnDomainProperty | 查询IPA的协议类型。 |
DescribeDcdnDomainIpaBpsData | 查询加速域名四层加速的网络带宽监控数据,支持查询最近90天的数据。 |
DescribeDcdnDomainIpaTrafficData | 查询加速域名的四层加速网络流量监控数据,支持查询最近90天的数据。 |
边缘脚本
API | 描述 |
---|---|
SetDcdnDomainStagingConfig | 设置或修改域名配置(灰度)。 |
DescribeDcdnDomainStagingConfig | 查询环境配置(灰度)。 |
DeleteDcdnSpecificStagingConfig | 删除加速域名的配置(灰度)。 |
PublishDcdnStagingConfigToProduction | 将模拟环境的全站加速配置发布到生产环境。 |
RollbackDcdnStagingConfig | 将模拟环境的全站加速配置回滚成生产环境配置。 |
DescribeDcdnStagingIp | 查询公测节点有效VIP。 |
DescribeDcdnEsExceptionData | 查询ES规则执行的异常情况。 |
DescribeDcdnEsExecuteData | 查询ES规则运行情况。 |
边缘安全
API | 描述 |
---|---|
DescribeDcdnUserSecDrop | 查询全站加速用户某安全功能报文拦截数。 |
DescribeDcdnWafDomain | 查询WAF全量域名列表和开通WAF功能的加速域名的相关信息。 |
DescribeDcdnSecFuncInfo | 为全站加速控制台控界面提供边缘安全下拉列表。 |
DescribeDcdnUserSecDropByMinute | 查询边缘应用层某一时间段的安全报文拦截总数。 |
DescribeDcdnBlockedRegions | 查询区域封禁支持的国家和地区。 |
DescribeDcdnUserConfigs | 查询安全功能相关的配置。 |
WAF 防护(新版)
API | 描述 |
---|---|
DescribeDcdnWafSpecInfo | 查询使用的DCDN WAF版本信息。 |
DescribeDcdnWafScenes | 查询用户已使用的防护策略类型信息。 |
DescribeDcdnWafDomains | 获取接入WAF防护的加速域名。 |
DescribeDcdnWafPolicyDomains | 查询已接入指定WAF防护策略的加速域名。 |
CreateDcdnWafPolicy | 设置WAF防护策略。 |
DescribeDcdnWafPolicies | 查询用户已配置的WAF防护策略详细信息。 |
DescribeDcdnWafPolicy | 获取指定防护策略详细信息。 |
ModifyDcdnWafPolicy | 修改指定防护策略名称或状态。 |
DeleteDcdnWafPolicy | 删除指定防护策略。 |
DescribeDcdnWafDomainDetail | 获取指定域名的防护策略信息。 |
DescribeDcdnWafRules | 查询用户已配置的防护规则详细信息。 |
BatchDeleteDcdnWafRules | 批量删除WAF防护规则。 |
ModifyDcdnWafPolicyDomains | 修改指定防护策略绑定的域名。 |
ModifyDcdnWafRule | 修改防护规则名称、状态或规则配置信息。 |
DescribeDcdnWafRule | 获取指定防护规则详细信息。 |
DescribeDcdnWafPolicyValidDomains | 查询可被自定义防护策略绑定的域名列表。 |
BatchSetDcdnWafDomainConfigs | 批量设置域名防护状态。 |
DescribeDcdnWafFilterInfo | 查询自定义防护规则中匹配条件的匹配字段、逻辑符和匹配内容等信息。 |
BatchCreateDcdnWafRules | 设置WAF防护规则。 |
DescribeDcdnWafService | 查询DCDN WAF服务状态,包括服务开通时间、版本信息、当前业务状态、请求数计费方式、规则数计费方式等。 |
DescribeUserDcdnWafStatus | 查询DCDN WAF服务是否开通、是否欠费。 |
DescribeDcdnWafGeoInfo | 查询WAF区域封禁功能支持的国家和地区。 |
标签管理
API | 描述 |
---|---|
TagDcdnResources | 添加资源标签。 |
DescribeDcdnTagResources | 查询资源对应的标签。 |
DescribeDcdnUserTags | 查询用户标签。 |
UntagDcdnResources | 删除资源标签。 |
工具管理
API | 描述 |
---|---|
DescribeDcdnIpInfo | 验证指定的IP是否为阿里云DCDN节点的IP地址。 |