-
Notifications
You must be signed in to change notification settings - Fork 61
/
cdn.py
1712 lines (1549 loc) · 131 KB
/
cdn.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- encoding:utf-8 -*-
from kscore.session import get_session
if __name__ == "__main__":
s = get_session()
client = s.create_client("cdn", use_ssl=False)
clientv2 = s.create_client("cdnv2", use_ssl=False)
clientv3 = s.create_client("cdnv3", use_ssl=False)
'''
GetCdnDomains 查询域名列表
Parameters:
PageSize long 分页大小,默认20,最大500,取值1~500间整数
PageNumber long 取第几页。默认为1,取值1~10000
DomainName string 按域名过滤,默认为空,代表当前用户下所有域名
ProjectId String 查询指定的项目下面的域名,不指定默认为全部
DomainStatus string 按域名状态过滤,默认为空,代表当前用户下所有域名状态全部
CdnType string 产品类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播,多个产品类型之间用逗号(半角)间隔,默认为空,代表当前用户下全部产品类型
FuzzyMatch string 域名过滤是否使用模糊匹配,取值为on:开启,off:关闭,默认为on
Returns:
<type 'dict'>
'''
# res = client.get_cdn_domains(PageSize=20,ProjectId='0',PageNumber=0,DomainStatus='online',CdnType='video')
# print (res);
'''
AddCdnDomain 新增域名
Parameters:
DomainName string 需要接入CDN的域名
CdnType string 产品类型,取值为video:音视频点播,file:大文件下载
ProjectId String 加速域名所属的项目,非必填项,默认归属为【默认项目】,若输入项目ID,可指定域名归属为已经创建好的项目ID下面
CdnSubType string 加速业务子类型(业务子类型是为了细分业务,默认不填写)
CdnProtocol string 客户访问边缘节点的协议。默认http,直播必须填写:http+flv, hls,rtmp
BillingRegions string 加速区域,默认CN, 可以输入多个,以逗号间隔
OriginType string 源站类型 取值:ipaddr、 domain、KS3、ksvideo分别表示:IP源站、域名源站、KS3为源站、金山云视频云源站
OriginProtocol string 回源协议,取值:http,rtmp,hls,https(当前版本不支持https回源)
OriginPort integer 可以指定 443, 80。默认值80。
Origin string 回源地址,可以是IP或域名;IP支持最多20个,以逗号区分,域名只能输入一个
SearchUrl String 是 用于探测的url,有且只能输入一个。前提是当用户输入了泛域名,客户域名不允许出现kingsoftspark单词,精确域名忽略
Returns:
<type 'dict'>
'''
# res = client.add_cdn_domain(DomainName='ntj122122.test.com',CdnType='video',ProjectId='0',CdnProtocol='http',OriginType='ipaddr',OriginProtocol='http',Origin='110.111.110.110')
# print res;
'''
AddCdnDomainV2 新增域名
Parameters:
DomainName string 需要接入CDN的域名
CdnType string 产品类型,取值为video:音视频点播,file:大文件下载
ProjectId String 加速域名所属的项目,非必填项,默认归属为【默认项目】,若输入项目ID,可指定域名归属为已经创建好的项目ID下面
CdnSubType string 加速业务子类型(业务子类型是为了细分业务,默认不填写)
CdnProtocol string 客户访问边缘节点的协议。默认http,直播必须填写:http+flv, hls,rtmp
BillingRegions string 加速区域,默认CN, 可以输入多个,以逗号间隔
OriginType string 源站类型 取值:ipaddr、 domain、KS3、ksvideo分别表示:IP源站、域名源站、KS3为源站、金山云视频云源站
OriginProtocol string 回源协议,取值:http,rtmp,hls,https(当前版本不支持https回源)
OriginPort integer 可以指定 443, 80。默认值80。
Origin string 回源地址,可以是IP或域名;IP支持最多20个,以逗号区分,域名只能输入一个
SearchUrl String 是 用于探测的url,有且只能输入一个。前提是当用户输入了泛域名,客户域名不允许出现kingsoftspark单词,精确域名忽略
Returns:
<type 'dict'>
'''
data = {
"DomainName": "ntj1332.test.com",
"CdnType": "video",
"CdnProtocol": "http",
"ProjectId": "0",
"OriginType": "ipaddr",
"OriginProtocol": "http",
"Origin": "110.111.110.110",
}
# res = clientv2.add_cdn_domain(**data)
# print res
'''
GetCdnDomainBasic 查询域名基础信息
Parameters:
DomainId String 域名ID,只允许输入单个域名ID
Returns:
<type 'dict'>
'''
# domainBasic = client.get_cdn_domain_basic_info(DomainId='2D08RFE')
# print domainBasic
'''
GetDomainConfigs 查询域名详细配置信息
Parameters:
DomainId String 域名ID
ConfigList String 需要查询的配置,多个配置用逗号(半角)分隔,不填代表查询所有
当前支持 cache_expired、ip、error_page、http_header、optimize、page_compress、
ignore_query_string、range、referer、src_host、video_seek、waf,notify_url,
redirect_type,request_auth
Returns:
'''
# res = client.get_domain_configs(DomainId='2D09555',ConfigList='cache_expired,ignore_query_string,src_host,referer,test_url,src_advanced,request_auth')
# print(res)
'''
ModifyCdnDomainBasicInfo 修改域名基础配置
Parameters:
DomainId String 域名ID
Regions String 加速区域,默认CN, 可以输入多个,以逗号间隔
OriginType String 源站类型 取值:ipaddr、 domain、KS3分别表示:IP源站、域名源站、KS3为源站。(此项目若输入,Origin必须输入)
OriginPort Integer 可以指定 443, 80。默认值80。443的话走https回源。当前版本只支持80.
Origin String 回源地址,可以是IP或域名;IP支持最多20个,以逗号区分,域名只能输入一个。IP与域名不能同时输入。 (此项目若输入,必须保证符合OriginType)
Returns:
'''
# res = client.modify_cdn_domain_basic_info(DomainId='2D09555',Origin='',OriginType='',OriginPort='')
'''
StartStopCdnDomain 用于启用、停用某个加速域名
Parameters:
ActionType String 操作接口名,系统规定参数 取值:start:启用;stop:停用;
DomainId String 需要启用或停用CDN服务的域名ID,只允许输入一个域名ID
'''
# res = client.start_stop_cdn_domain(DomainId='2D09555', ActionType='stop')
'''
DeleteCdnDomain 用于删除用户下已添加的加速域名 此操作只允许删除 DomainStatus 为已停止的域名;
Parameters:
DomainId String 域名ID
Returns:
RequestID
'''
# res = client.delete_cdn_domain(DomainId='2D09555')
'''
SetIgnoreQueryStringConfig 设置过滤参数
Parameters:
DomainId String 域名ID
Enable String 配置过滤参数功能的开启或关闭 取值:on、off ,默认为on
HashKeyArgs String 保留参数,多个用逗号(英文、半角)分隔。
'''
# client.set_ignore_query_string_config(DomainId='2D09555', Enable='on',HashKeyArgs='abcd')
# print client.get_domain_configs(DomainId='2D09555',ConfigList='ignore_query_string');
'''
SetBackOriginHostConfig 设置回源host功能
注意: 若源站为KS3域名,需将ks3域名设置为回源host(即源站域名),方可正常回源
Parameters:
DomainId String 域名ID
BackOriginHost String 是自定义回源域名,默认为空,表示不需要修改回源Host
'''
# client.set_back_origin_host_config(DomainId='2D09555', BackOriginHost='www.a.qunar.com')
'''
SetReferProtectionConfig 设置加速域名的Refer防盗链 加速域名创建后,默认不开启refer防盗链功能
Parameters:
DomainId String 域名ID
Enable String 配置是否开启或关闭 取值:on、off,默认值为off关闭。开启时,下述必须项为必填项;关闭时,只更改此标识,忽略后面的项目。
ReferType String refer类型,取值:block:黑名单;allow:白名单,开启后必填
ReferList String 逗号隔开的域名列表
AllowEmpty String 是否允许空refer访问,取值:on:允许;off:不允许;默认值:on。注:仅当选择白名单时,此项才生效
'''
# client.set_refer_protection_config(DomainId='2D09555', Enable='on', ReferType='block', ReferList='www.baidu.com,www.sina.com')
'''
SetIpProtectionConfig 设置加速域名的Ip防盗链 加速域名创建后,默认不开启Ip防盗链功能
Parameters:
DomainId String 域名ID
Enable String 配置是否开启或关闭 取值:on、off,默认值为off关闭。开启时,下述必须项为必填项;关闭时,只更改此标识,忽略后面的项目。
IpType String refer类型,取值:block:黑名单;allow:白名单,开启后必填
IpList String 逗号隔开的Ip列表
'''
# client.set_ip_protection_config(DomainId='2D09NN8', Enable='on', IpType='allow', IpList='1.1.1.1')
'''
SetCacheRuleConfig 设置缓存规则。加速域名创建后,默认缓存规则为空
更新加速域名的缓存规则为覆盖更新,需要对全部的规则进行修改,不能仅提交需要修改的部分
Parameters:
该接口需要输入json格式数据,并且在参数前面加上"**"
DomainId String 域名ID
CacheRules CacheRule[] 是由CacheRule组成的数组,表示缓存规则列表。注意:该数组是有序的
CacheRule:
CacheRuleType String 缓存规则类型 file_suffix 文件后缀 directory 目录 exact 全路径 url_regex 正则表达式
Value String 缓存规则的内容,当缓存规则类型为目录时仅允许单条输入,目录必须以/开头且以/结尾;当缓存规则类型为全路径时仅允许单条输入,全路径需输入完整路径,且必须以/开头;
当缓存规则类型为正则表达式时仅允许单条输入,且必须输入标准正则表达式;当缓存规则为文件后缀时允许多个输入,文件后缀必须输入英文文件后缀名,多个文件后缀名以逗号(半角)间隔
CacheTime Long 缓存时间,以秒为单位
RespectOrigin String 是否遵循源站,off表示不遵循,on(默认)表示遵循
IgnoreNoCache String 是否忽略源站的no-cache头,on表示忽略,off(默认)表示不忽略。 (本期暂不支持此选项)
CacheEnable String 配置缓存功能的开启或关闭,对应缓存/不缓存 取值:on、off ,默认为on 。配置on时,下面 CacheTime 为必选项,RespectOrigin为可选项;配置off时,下面 CacheTime 、RespectOrigin都为不可选项
'''
# '''
# json格式规则
'''
cacheRules = {
"DomainId":"2D075M2",
"CacheRules":
[
{
"CacheRuleType":"directory",
"Value":"/XXX/",
"CacheTime":"11",
"RespectOrigin":"",
"IgnoreNoCache":"",
"CacheEnable":"on"
}
]
}
'''
# client.set_cache_rule_config(**cacheRules)
'''
SetTestUrlConfig 设置加速域名的测试URL
Parameters:
DomainId String 域名ID
TestUrl String 测试URL列表,逗号间隔,默认为空
'''
# client.set_test_url_config(DomainId='2D09555', TestUrl='www.xinfei.cn/1.html')
'''
SetOriginAdvancedConfig 设置高级回源策略
OriginLine为default默认源的线路,是必填项,其他几个源都是选填项。OriginLine不能重复填写。开启高级回源策略后,会关闭掉基础配置中的回源配置
Parameters:
该接口需要输入json格式数据,并且在参数前面加上"**"
DomainId String 域名ID
Enable String 配置高级回源策略的开启或关闭 取值: on、off。注意:开启后会关闭掉基础配置中的的回源配置。默认值关闭。开启时,下述必须项为必填项;关闭时,只更改此标识,忽略后面的项目
OriginType String 源站类型 取值:ipaddr、domain分别表示:IP源站、域名源站
OriginAdvancedItems OriginAdvancedItem[] 是由OriginAdvancedItem组成的数组,表示源站信息
OriginPolicy String rr: 轮询; quality: 按质量最优的topN来轮询回源
OriginPolicyBestCount Long 当OriginPolicy是quality时,该项必填。取值1-10
其中OriginAdvancedItem项的类型定义为
OriginLine String 源站线路,取值: default:默认源; un: 联通源; ct: 电信源; cm: 移动源
Origin String 回源地址,可以是IP或域名;IP支持最多20个,以逗号区分,域名只能输入一个。IP与域名不能同时输入。
'''
'''
# json格式规则
'''
originParam = {
"DomainId": "2D09555",
"Enable": "on",
"OriginPolicy": "quality",
"OriginPolicyBestCount": 1,
"OriginType": "domain",
"Origin": "www.b.xunfei.cn",
"BackupOriginType": "ipaddr",
"BackupOrigin": "1.1.1.1,2.2.2.2"
}
# client.set_origin_advanced_config(**originParam)
# print client.get_domain_configs(DomainId='2D09555',ConfigList='origin_advanced_config');
'''
SetRemarkConfig 设置备注信息
Parameters:
DomainId String 域名ID
Remark String 备注信息,默认为空
'''
# client.set_remark_config(DomainId='2D09555', Remark=u'备注信息')
'''
SetRequestAuthConfig 设置时间戳+共享秘钥防盗链
Parameters:
DomainId String 域名ID
Enable String 配置是否开启或关闭 取值:on、off,默认值为off关闭。开启时,下述必须项为必填项;关闭时,只更改此标识,忽略后面的项目。
AuthType String 类型,取值:typeA, typeB
Key1 String 主密钥
Key2 String 副密钥 多个逗号分隔
ExpirationTime Long 有效时间
'''
# client.set_request_auth_config(DomainId='2D093GC', Enable='on', AuthType='typeB', Key1='111111', Key2='222222,333333', ExpirationTime='1000')
'''
SetForceRedirectConfig 设置强制跳转
Parameters:
DomainId string 域名ID
RedirectType string 配置强制跳转类型, 取值: off、 https,默认为off 。其中https表示http → https,当选择https时需保证域名已配置证书
Returns:
<type 'dict'>
'''
data = {
"DomainId": "2D09555",
"RedirectType": "off"
}
# res = client.set_force_redirect_config(**data)
# print client.get_domain_configs(DomainId='2D09555',ConfigList='force_redirect');
'''
SetHttp2OptionConfig 设置HTTP 2.0
Parameters:
DomainId string 域名ID
Enable string 配置HTTP 2.0功能的开启或关闭 取值:on、off ,默认为off ;开启需保证域名已配置证书。
Returns:
<type 'dict'>
'''
data = {
"DomainId": "2D09555",
"Enable": "off"
}
# res = client.set_http_2_option_config(**data)
# print client.get_domain_configs(DomainId='2D09555',ConfigList='http2_option');
'''
SetPageCompressConfig 设置设置智能压缩
Parameters:
DomainId string 域名ID
Enable string 配置智能压缩的开启或关闭 取值:on、off ,默认为off 。
Returns:
<type 'dict'>
'''
data = {
"DomainId": "2D09555",
"Enable": "off"
}
# res = client.set_page_compress_config(**data)
# print client.get_domain_configs(DomainId='2D09555',ConfigList='page_compress');
'''
SetErrorPageConfig 设置设置智能压缩
Parameters:
DomainId string 域名ID
ErrorPages List<ErrorPage> 由ErrorPage组成的数组,表示自定义错误页面列表。注意:该数组是有序的,如果一个相同状态码在数组里有配置子集,则以最后面的子集为准。
ErrorPage:
ErrorHttpCode String 错误的状态码。
CustomPageUrl String 自定义发生错误后跳转的页面URL。注:需要检验URL的合法性,如果URL不是以https://或者http://开头,则报错,提示输入url有误。
Returns:
<type 'dict'>
'''
data = {
"DomainId": "2D09555",
"ErrorPages": [{
"ErrorHttpCode": "400",
"CustomPageUrl": "https://www.test.com/error400.html"
}]
}
# res = client.set_error_page_config(**data)
# print client.get_domain_configs(DomainId='2D09555',ConfigList='error_page');
####################以下为统计分析API###################
'''
GetBandwidthData 获取域名带宽数据,包括边缘带宽、回源带宽数据,单位:bit/second
* 获取域名带宽数据,包括边缘带宽、回源带宽数据,单位:bit/second
* 支持按指定的起止时间查询,两者需要同时指定
* 支持批量域名查询,多个域名ID用逗号(半角)分隔
* 最多可获取最近一年内93天跨度的数据
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度的带宽值均取该粒度时间段的峰值
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Regions String 区域名称,缺省为 CN; 取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多区域查询,多个区域用逗号(半角)分隔
CdnType string 产品类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
ResultType String 取值为0:多域名多区域数据做合并;1:每个域名每个区域的数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的带宽值均取该粒度时间段的峰值
DataType String 数据类型, 取值为edge:边缘数据; origin:回源数据; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为 edge
ProtocolType 否 String 协议类型, 取值为http:htts协议数据; https:https协议数据
'''
# res = client.get_bandwidth_data(DomainIds='2D09VK5',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video',Granularity='240',ResultType='1',Regions='CN',DataType='origin',ProtocolType='http')
'''
GetFlowData 获取域名流量数据,包括边缘流量、回源流量数据, 单位:byte
* 获取域名流量数据,包括边缘流量、回源流量数据, 单位:byte
* 支持按指定的起止时间查询,两者需要同时指定
* 支持批量域名查询,多个域名ID用逗号(半角)分隔
* 最多可获取最近一年内93天跨度的数据
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度均取该粒度时间段的流量之和
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Regions String 区域名称,缺省为 CN; 取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多区域查询,多个区域用逗号(半角)分隔
CdnType string 产品类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
ResultType String 取值为0:多域名多区域数据做合并;1:每个域名每个区域的数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的带宽值均取该粒度时间段的峰值
DataType String 数据类型, 取值为edge:边缘数据; origin:回源数据; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为 edge
ProtocolType 否 String 协议类型, 取值为http:htts协议数据; https:https协议数据
'''
# res = client.get_flow_data(DomainIds='2D09VK5',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video',Granularity='240',ResultType='1',Regions='CN',DataType='origin',ProtocolType='http')
'''
GetPvData 请求数查询 获取域名请求数数据,包括边缘请求数、回源请求数, 单位:次
* 支持按指定的起止时间查询,两者需要同时指定
* 支持批量域名查询,多个域名ID用逗号(半角)分隔
* 支持多区域查询,多个区域用逗号(半角)分隔
* 最多可获取最近三年内93天跨度的数据
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度均取该粒度时间段的请求数之和
*
* 说明:
* 请求数 :统计当前域名下资源文件的访问次数
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Regions String 区域名称,缺省为 CN; 取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多区域查询,多个区域用逗号(半角)分隔
CdnType string 产品类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
ResultType String 取值为0:多域名多区域数据做合并;1:每个域名每个区域的数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的带宽值均取该粒度时间段的峰值
DataType String 数据类型, 取值为edge:边缘数据; origin:回源数据; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为 edge
ProtocolType 否 String 协议类型, 取值为http:htts协议数据; https:https协议数据
'''
# res = client.get_pv_data(DomainIds='2D09VK5',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video',Granularity='240',ResultType='0',Regions='CN',DataType='origin',ProtocolType='http')
'''
GetHitRateDetailedData 命中率详情查询
* 获取域名流量命中率、请求数命中率数据,单位:百分比
* 支持按指定的起止时间查询,两者需要同时指定
* 支持批量域名查询,多个域名ID用逗号(半角)分隔
* 最多可获取最近三年内93天跨度的数据
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;
* 时效性:5分钟延迟
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType string 产品类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
ResultType String 取值为0:多域名多区域数据做合并;1:每个域名每个区域的数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的带宽值均取该粒度时间段的峰值
HitType String 数据类型, 取值为flowhitrate:流量命中率; reqhitrate:请求数命中率; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为reqhitrate
'''
# res = client.get_hit_rate_detailed_data(DomainIds='2D09VK5',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video',Granularity='240',ResultType='0',HitType='flowhitrate')
'''
GetHitRateData 命中率查询(饼图),获取域名某一时间段内流量命中率、请求数命中率数据,用于绘制命中率饼图。
* 获取域名某一时间段内流量命中率、请求数命中率数据
* 支持按指定的起止时间查询,两者需要同时指定
* 支持批量域名查询,多个域名ID用逗号(半角)分隔
* 最多可获取最近一年内93天跨度的数据
* 说明
* Hit访问次数=边缘请求数-回源请求数
* Miss访问次数=回源请求数
* Hit访问流量=边缘流量-回源流量
* Miss访问流量=回源流量
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
'''
# res = client.get_hit_rate_data(DomainIds='2D09VK5',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video')
'''
GetProvinceAndIspFlowData 省份+运营商流量查询,获取域名在中国大陆地区各省份及各运营商的流量数据,仅包括边缘节点数据,单位:byte
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 最多可获取最近三年内93天跨度的数据<p>
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;**以上粒度均取该粒度时间段的流量之和**<p>
* 使用场景<p>
* 客户查询单个域名或多个域名在各个省份及运营商的合并后的实时流量数据<p>
* 客户查询单个域名的详细流量数据,进行数据保存及数据分析<p>
* 客户查询某一天或某1小时的详细流量区域分布,用于制作流量数据区域用量表<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Provinces String 省份区域名称, 取值详见枚举列表,支持多省份区域查询,多个省份区域用逗号(半角)分隔,缺省为全部省份区域
Isps String 运营商名称,取值详见枚举列表,支持多运营商查询,多个运营商用逗号(半角)分隔,缺省为全部运营商
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
'''
# res = client.get_province_and_isp_flow_data(DomainIds='2D09VK5',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video',ResultType='1', Granularity='1440')
'''
GetProvinceAndIspBandwidthData 省份+运营商带宽查询
*获取域名在中国大陆地区各省市及各运营商的带宽数据,仅包括边缘节点数据,单位:bit/second
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 最多可获取最近三年内93天跨度的数据<p>
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;**以上粒度均取该粒度时间段的流量之和**<p>
* 使用场景<p>
* 客户查询单个域名或多个域名在各个省份及运营商的合并后的实时流量数据<p>
* 客户查询单个域名的详细流量数据,进行数据保存及数据分析<p>
* 客户查询某一天或某1小时的详细流量区域分布,用于制作流量数据区域用量表<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Provinces String 省份区域名称, 取值详见枚举列表,支持多省份区域查询,多个省份区域用逗号(半角)分隔,缺省为全部省份区域
Isps String 运营商名称,取值详见枚举列表,支持多运营商查询,多个运营商用逗号(半角)分隔,缺省为全部运营商
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
'''
# res = client.get_province_and_isp_bandwidth_data(DomainIds='2D09VK5',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video',ResultType='0', Granularity='1440')
'''
GetHttpCodeData 状态码统计(饼图),获取域名一段时间内的Http状态码访问次数及占比数据,用于绘制饼图
* 客户查询单个域名或多个域名一段时间内各状态码访问次数<p>
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 最多可获取最近三年内93天跨度的数据<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
'''
# res = client.get_http_code_data(DomainIds='2D09555',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video')
'''
GetHttpCodeDetailedData 状态码详情统计,获取域名的Http状态码详细访问次数及占比数据
* 客户查询单个域名或多个域名各状态码详细访问数据<p>
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 最多可获取最近一年内93天跨度的数据<p>
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度,以上统计粒度均取该粒度内各状态码的访问次数之和<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
'''
# res = client.get_http_code_detailed_data(DomainIds='2D09555',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video',ResultType='0')
'''
GetTopUrlData top url 查询
* 获取单个域名或多个域名某天内某一时段的TOP Url访问数据,仅包含Top200且访问次数大于15次的 Url的访问次数、访问流量,并按次数排序<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 最多可获取最近一年内一天跨度的数据<p>
* 时效性:30分钟延迟<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
LimitN String 热门Url条数,取值为1-200,最大200,默认100
'''
# res = client.get_top_url_data(DomainIds='2D09RW5',LimitN='100',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video')
'''
GetAreaData 用户区域统计
* 获取国内各省份及运营商流量、访问次数、流量占比,请求数占比,海外地区的流量、访问次数、流量占比、请求数占比。<p>
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 最多可获取最近一年内93天跨度的数据<p>
* 说明<p>
* 运营商包含:电信、联通、移动、铁通、鹏博士、教育网、其他、海外ISP<p>
* 地区包含:国内32个省、香港、台湾、澳门、其他海外地区统一合并为海外<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
'''
# res = client.get_area_data(DomainIds='2D09555',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video')
'''
GetIspData 运营商占比统计
* 获取各运营商流量、访问次数、流量占比、访问次数占比<p>
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 最多可获取最近一年内93天跨度的数据<p>
* 说明
* 运营商包含:电信、联通、移动、铁通、鹏博士、教育网、其他、海外ISP<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
'''
# res = client.get_isp_data(StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',CdnType='video')
'''
GetDomainRankingListData 域名排行查询
* 获取用户维度下所有域名的流量、流量占比、带宽峰值、峰值时间、访问次数,并按流量排行
* 单天维度,仅指定的单天时间查询
* 支持批量域名查询,多个域名ID用逗号(半角)分隔
* 最多可获取最近一年内以天为维度的数据
* 注:仅展示查询日期内有效域名
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
'''
# res = client.get_domain_ranking_list_data(StartTime='2016-11-20T08:00+0800',EndTime='2016-11-20T12:00+0800',CdnType='video')
'''
GetLiveFlowDataByStream 直播按流维度查询流量
* 直播业务,获取按流为维度的流量数据<P>
* 支持按指定的起止时间查询,两者需要同时指定<P>
* 支持批量流名过滤查询,多个流名用逗号(半角)分隔<P>
* 最多可获取最近62天内,7天跨度的数据<P>
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度均取该粒度时间段的求和<P>
* 只支持直播业务<P>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
StreamUrls String 流名,支持批量查询,多个流名用逗号(半角)分隔
Regions String 计费区域名称,取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多计费区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
'''
# res = client.get_live_flow_data_by_stream(StartTime='2016-12-18T08:00+0800',EndTime='2016-12-20T08:00+0800',StreamUrls='rtmp://realflv3.plu.cn/live/ce781fecb2f6447d82d03590e520872f',ResultType='1',Regions='CN',Granularity='1440')
'''
GetLiveBandwidthDataByStream 直播按流维度查询带宽
* 直播业务,获取按流为维度的带宽数据,带宽单位bit/second<p>
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量流名过滤查询,多个流名用逗号(半角)分隔<p>
* 最多可获取最近62天内,7天跨度的数据<p>
* 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度的带宽值均取该粒度时间段的峰值<p>
* 只支持直播业务<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
StreamUrls String 流名,支持批量查询,多个流名用逗号(半角)分隔
Regions String 计费区域名称,取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多计费区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
'''
# res = client.get_live_bandwidth_data_by_stream(StartTime='2016-12-19T08:00+0800',EndTime='2016-12-20T08:00+0800',StreamUrls='rtmp://realflv3.plu.cn/live/ce781fecb2f6447d82d03590e520872f',ResultType='1',Regions='CN',Granularity='1440')
'''
GetLiveOnlineUserDataByDomain 直播按域名维度统计在线人数
* 获取按域名维度的直播在线人数数据, 单位:每分钟的在线人数<p>
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量域名查询,多个域名ID用逗号(半角)分隔<p>
* 支持多计费区域查询,多个计费区域用逗号(半角)分隔<p>
* 最多可获取最近1年93天跨度的数据<p>
* 统计粒度:1分钟粒度(默认);5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度均取该粒度时间段的在线人数的**峰值。<p>
* 只支持直播业务<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Regions String 计费区域名称,取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多计费区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
'''
# res = client.get_live_online_user_data_by_domain(DomainIds='2D09W0V',StartTime='2016-11-19T08:00+0800',EndTime='2016-11-20T08:00+0800',Regions='CN',Granularity='1440',ResultType='1')
'''
GetLiveOnlineUserDataByStream 直播按流维度统计在线人数
* 获取按流维度的直播在线人数数据, 单位:每分钟的在线人数<p>
* 支持按指定的起止时间查询,两者需要同时指定<p>
* 支持批量流名过滤查询,多个流名用逗号(半角)分隔<p>
* 支持多计费区域查询,多个计费区域用逗号(半角)分隔<p>
* 最多可获取最近62天内,7天跨度的数据。(注意: 按流名维度的数据,只保留2个月)<p>
* 统计粒度:1分钟粒度;5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度的在线人数均取该粒度时间段的在线人数的峰值 (注意: 需要按统计粒度来汇聚,用于在界面上展示。)<p>
* 说明:<p>
* 按流名维度的数据,返回时并不按照“域名”维度汇聚。如果需要按域名维度的数据,请按单个域名过滤<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
StreamUrls String 流名,支持批量查询,多个流名用逗号(半角)分隔
Regions String 计费区域名称,取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多计费区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity String 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
'''
# res = client.get_live_online_user_data_by_stream(StartTime='2016-12-19T08:00+0800',EndTime='2016-12-20T08:00+0800',StreamUrls='rtmp://realflv3.plu.cn/live/ce781fecb2f6447d82d03590e520872f',ResultType='0',Regions='CN',Granularity='5')
'''
GetLiveTopOnlineUserData 获取按流维度的直播在线人数排行, 单位:每分钟的在线人数<p>
* 只设置起始时间,代表起始时间这1分钟的数据。<p>
* 支持批量域名过滤查询,多个域名ID用逗号(半角)分隔<p>
* 支持多计费区域查询,多个计费区域用逗号(半角)分隔<p>
* 最多可获取最近62天内的数据。(注意: 按流维度的数据,只保留2个月)<p>
* 说明:<p>
* 按流名维度的数据,返回时并不按照“域名”维度汇聚。如果需要按域名维度的数据,请按单个域名过滤<p>
Parameters:
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Regions String 计费区域名称,取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多计费区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType String 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
LimitN 否 Int Top条数,取值为1-200,最大200,默认100
'''
# res = client.get_live_top_online_user_data(StartTime='2016-11-19T08:00+0800',ResultType='1',Regions='CN',LimitN='100')
'''
get_domain_logs 日志下载接口
Parameters:
PageSize long 分页大小,默认20,最大500,取值1~500间整数
PageNumber long 取第几页。默认为1,取值1~10000
DomainId string 按域名过滤,默认为空,代表当前用户下所有域名
StartTime string 查询开始时间,格式yyyy-MM-dd,开始时间和结束时间均不指定时,默认是当天
EndTime string 查询结束时间,格式yyyy-MM-dd,开始时间和结束时间均不指定时,默认是当天
'''
# res = client.get_domain_logs(PageSize=20,PageNumber=1,DomainId='2D09X6F',StartTime='2017-01-01',EndTime='2017-02-23')
'''
refresh_caches 刷新
同一个 ID每日设有提交刷新类请求条数限制额度,与控制台共享此额度,具体额度可查看控制台或调用GetRefreshOrPreloadQuota接口获取
刷新预热类接口包含 RefreshCaches刷新接口和PreloadCaches 预热接口
Files与Dirs必须至少指定一种,可同时指定,即文件刷新和目录刷新可同时进行
每个 Url 必须以http://或者https://开头
每个 Url 最大长度 1000 字符
每个 Url 所在的域名必须是该用户在金山云加速的域名。
Url 如果包含中文字符
单次调用 Url 上限为1000条
预热仅支持Url,不支持目录预热,不支持正则
Parameters:
Files Url[] 需要文件类型刷新的Url列表
Dirs Url[] 需要文件类型刷新的Url列表
其中url[]为:
Url String 需要提交刷新的Url,单条
'''
'''
# json格式规则
param = {
"Files": [
{
"Url": "http://test.dxz.ksyun.8686c.com/abc.txt"
},
{
"Url": "http://test.dxz.ksyun.8686c.com/test"
}],
"Dirs": [
{
"Url": "http://test.dxz.ksyun.8686c.com/abc"
},
{
"Url": "http://test.dxz.ksyun.8686c.com/def"
}]
}
'''
# res = client.refresh_caches(**param)
'''
preload_caches 预热
同一个 ID 每日设有提交预热类请求条数限制额度,与控制台共享此额度,具体额度可查看控制台或调用GetRefreshOrPreloadQuota接口获取
刷新预热类接口包含 RefreshCaches刷新接口和PreloadCaches 预热接口
每个 Url 必须以http://或者https://开头
每个 Url 最大长度 1000 字符
每个 Url 所在的域名必须是该用户在金山云加速的域名。
Url 如果包含中文字符
单次调用 Url 上限为1000条
预热仅支持Url,不支持目录预热,不支持正则
Parameters:
Urls Url[] 需要文件类型预热的Url列表
其中url[]为:
Url String 需要提交预热的Url,单条
'''
'''
# json格式规则
param = {
"Urls": [
{
"Url": "http://test.dxz.ksyun.8686c.com/1.html"
}]
}
'''
# res = client.preload_caches(**param)
'''
get_refresh_or_preload_task 预热进度查询
本接口用于获取刷新、预热任务进度百分比及状态,查看任务是否在全网生效。
支持根据任务ID、URL获取数据
支持按指定的起止时间查询,两者需要同时指定
所有参数都不指定,默认查7天内,第一页的数据(20条)
起止时间、TaskId、Url可以同时指定,逻辑与的关系
最多可获取7天内的数据
使用场景:
查询用户刷新或预热URL进度百分比及状态,查看是否在全网生效,用于在控制台展示
客户通过API获取刷新或预热任务或URL进度百分比及状态,查看是否在全网生效
注意:
接口仅支持POST请求格式
Parameters:
PageSize long 分页大小,默认20,最大500,取值1~500间整数
PageNumber long 取第几页。默认为1,取值1~10000
StartTime string 查询开始时间,格式yyyy-MM-dd,开始时间和结束时间均不指定时,默认是当天
EndTime string 查询结束时间,格式yyyy-MM-dd,开始时间和结束时间均不指定时,默认是当天
TaskId string 支持按任务ID查询,只允许输入单个任务ID
Urls Url[] 需要文件类型预热的Url列表
其中url[]为:
Url String 需要提交预热的Url,单条
'''
'''
# json格式规则
param = {
"StartTime":"2017-02-21T00:00+0800",
"EndTime":"2017-02-24T00:00+0800",
"PageSize":10,
"PageNumber":1,
"TaskId":"26ce0148-ef2e-4588-983c-c29077258020",
"Urls":[
{"Url": "http://test.dxz.ksyun.8686c.com/1.html"},
{"Url": "http://test.dxz.ksyun.8686c.com/abc"}
],
"Type":"refresh"
}
'''
# res = client.get_refresh_or_preload_task(**param)
'''
get_refresh_or_preload_quota 预热进度查询
获取刷新、预热URL及目录的最大限制数量,及当日剩余刷新、预热URL及目录的条数
刷新预热类接口包含 RefreshCaches刷新接口和PreloadCaches 预热接口
'''
# res = client.get_refresh_or_preload_quota()
'''
set_domain_log_service 设置日志服务接口
本接口用于启用、停用某个加速域名的日志服务。
支持批量域名查询,多个域名ID用逗号(半角)分隔
日志服务支持按域名维度启用、停用
注意:域名对应账户如果由于欠费,或域名处于非法状态(审核中、审核失败、停用),则无法正常调用该接口启用加速域名的日志服务。
Parameters:
ActionType string 操作类型,取值为start:启用;stop:停用
DomainIds string 需要启用或停用日志服务的域名ID,支持批量域名开启或停用,多个域名ID用逗号(半角)分隔
Granularity Long 日志存储粒度,取值为60:按小时粒度存储;1440:按天粒度存储,当前暂不支持按小时粒度存储;开启时为必填,关闭时可不填
'''
# res = client.set_domain_log_service(ActionType="start",DomainIds="2D09SHE",Granularity=1440)
'''
get_domain_log_service_status 设置日志服务接口
本接口用于获取域名日志服务状态。
支持批量域名查询,多个域名ID用逗号(半角)分隔
Parameters:
DomainIds string 需要查询日志服务的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
'''
# res = client.get_domain_log_service_status(DomainIds="2D09SHE")
'''
GetUvData 获取域名独立请求的IP个数,单位:个
支持按指定的起止时间查询,两者需要同时指定
支持批量域名查询,多个域名ID用逗号(半角)分隔
最多可获取最近一年内31天跨度的数据
统计粒度:5分钟粒度
时效性:30分钟延迟
接口性能:接口最大吞吐量为10000,即DomainId个数*(EndTime-StartTime)\/统计粒度 <= 10000。注:在获取多个域名合并值时,DomainId个数按照1计算
使用场景:
客户查询单个域名或多域名合并后独立请求IP的个数,用于绘制一条独立请求IP求数线图
客户查询单个域名的详细独立请求IP数据,进行数据保存及数据分析
说明:
独立访问IP数:统计当前域名下独立请求的IP个数
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播,当前不支持直播类型
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
ResultType Long 取值为0:多域名多区域数据做合并;1:每个域名每个区域的数据分别返回
Granularity Long 统计粒度,取值为 5(默认):5分钟粒度;
'''
# res = client.get_uv_data(DomainIds='2D09QXN,2D09NRU',StartTime='2017-02-08T04:40+0800',EndTime='2017-02-08T07:26+0800',CdnType='video',Granularity=5,ResultType=1)
'''
GetTopReferData 获取域名某天内某一时段的热门页面访问数据排名,仅包含Top200且访问数大于15次的热门页面的访问次数、访问流量,并按次数排名
支持批量域名查询,多个域名ID用逗号(半角)分隔
最多可获取最近一年内24小时跨度的数据
时效性:30分钟延迟
使用场景:
查询单个域名或多个域名的热门来源Refer数据,进行热门页面数据分析
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播,当前不支持直播类型
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
LimitN Long 热门Refer条数,取值为1-200,最大200,默认100
'''
# res = client.get_top_refer_data(DomainIds='2D09QJU',StartTime='2016-11-11T05:00+0800',EndTime='2016-11-11T05:05+0800',CdnType='video',LimitN=5)
# res = client.get_uv_data(DomainIds='2D09QXN,2D09NRU',StartTime='2017-02-08T04:40+0800',EndTime='2017-02-08T07:26+0800',CdnType='video',Granularity=5,ResultType=1)
'''
GetTopIpData
本接口用于获取域名某天内某一时段的TOP IP访问数据,仅包含Top200且访问次数大于15次的独立请求的IP的访问次数、访问流量,并按次数排序
支持批量域名查询,多个域名ID用逗号(半角)分隔
最多可获取最近一年内24小时跨度的数据
时效性:30分钟延迟
使用场景:
查询单个域名或多个域名的独立请求的IP的访问数据,用于感知IP攻击
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播,当前不支持直播类型
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
LimitN Long 热门Refer条数,取值为1-200,最大200,默认100
'''
# res = client.get_top_ip_data(DomainIds='2D09QJU',StartTime='2016-11-11T05:00+0800',EndTime='2016-11-11T05:05+0800',CdnType='video',LimitN=5)
'''
GetProvinceAndIspHitRateDetailedData
获取域名流量命中率、请求数命中率数据,单位:百分比
支持按指定的起止时间查询,两者需要同时指定
支持批量域名查询,多个域名ID用逗号(半角)分隔
最多可获取最近一年内31天跨度的数据
统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;
时效性:5分钟延迟
接口性能:接口最大吞吐量为10000,即Province个数*Isp个数*DomainId个数*(EndTime-StartTime)\/统计粒度 <= 10000。注:多域名多省份多运营商取合并数据时,Province个数、Isp个数、DomainId个数按照1计算。
使用场景:
客户查询单个域名或多域名在省份及运营商合并后实时命中率数据,用于绘制一条命中率线图
客户查询单个域名的详细命中率数据,进行数据保存及数据分析
说明:
请求数命中率=[边缘的hit状态的请求数\/边缘请求数]*100%
流量命中率=[边缘的hit状态的流量\/边缘流量]*100%
当边缘请求数或边缘流量为0时,命中率为0
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
Provinces String 省份区域名称,取值详见枚举列表,支持多省份区域查询,多个省份区域用逗号(半角)分隔,缺省为全部省份区域
Isps String 运营商名称,取值详见枚举列表,支持多运营商查询,多个运营商用逗号(半角)分隔,缺省为全部运营商
ResultType Long 取值为0:多域名数据做合并;1:每个域名的数据分别返回
Granularity Long 热统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度均取该粒度时间段的流量之和、请求数之和
HitType String 数据类型, 取值为flowhitrate:流量命中率;reqhitrate:请求数命中率; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为reqhitrate
'''
# res = client.get_province_and_isp_hit_rate_detailed_data(StartTime='2018-05-16T10:50+0800',EndTime='2018-05-16T11:00+0800',CdnType='video',DomainIds="2D09FBW",ResultType=1,Granularity=5,HitType='reqhitrate,flowhitrate')
# print str(res)
'''
GetProvinceAndIspHttpCodeData
获取域名一段时间内在中国大陆地区各省份及各运营商的Http状态码访问次数及占比数据(用于绘制饼图)
支持按指定的起止时间查询,两者需要同时指定
支持批量域名查询,多个域名ID用逗号(半角)分隔
最多可获取最近一年内31天 跨度的数据
时效性:5分钟延迟
使用场景:
客户查询单个域名或多个域名一段时间内在中国大陆地区各省份及各运营商的状态码访问次数,用于绘制状态码饼图
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播,当前不支持直播类型
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
Provinces String 省份区域名称,取值详见枚举列表,支持多省份区域查询,多个省份区域用逗号(半角)分隔,缺省为全部省份区域
Isps String 运营商名称,取值详见枚举列表,支持多运营商查询,多个运营商用逗号(半角)分隔,缺省为全部运营商
'''
# res = client.get_province_and_isp_http_code_data(DomainIds='2D09SXW',StartTime='2017-02-08T10:00+0800',EndTime='2017-02-08T10:20+0800',CdnType='video',Provinces='liaoning',Isps='UN')
'''
GetProvinceAndIspHttpCodeDetailedData
获取域名在中国大陆地区各省份及各运营商的Http状态码详细访问次数及占比数据(用于绘制状态码线图)
支持按指定的起止时间查询,两者需要同时指定
支持批量域名查询,多个域名ID用逗号(半角)分隔
最多可获取最近一年内31天跨度的数据 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度,以上统计粒度均取该粒度内各状态码的访问次数之和
时效性:5分钟延迟
接口性能:接口最大吞吐量为10000,即Province个数*Isp个数*DomainId个数*(EndTime-StartTime)\/统计粒度 <= 10000。注:多域名多省份多运营商取合并数据时,Province个数、Isp个数、DomainId个数按照1计算。
使用场景:
客户查询单个域名或多个域名在中国大陆地区各省份及各运营商的Http状态码详细访问数据,用于绘制状态码线图
客户查询单个域名的详细状态码数据,进行数据保存及数据分析
Parameters:
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
CdnType String 产品类型,只允许输入一种类型,取值为video:音视频点播,file:大文件下载,live:流媒体直播,当前不支持直播类型
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
Provinces String 省份区域名称,取值详见枚举列表,支持多省份区域查询,多个省份区域用逗号(半角)分隔,缺省为全部省份区域
Isps String 运营商名称,取值详见枚举列表,支持多运营商查询,多个运营商用逗号(半角)分隔,缺省为全部运营商
Granularity Long 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
ResultType Long 取值为0:多域名数据做合并;1:每个域名的数据分别返回
'''