Repository navigation
Expand file tree
/
Copy pathUFileClient.php
More file actions
1780 lines (1732 loc) · 77.9 KB
/
Copy pathUFileClient.php
File metadata and controls
1780 lines (1732 loc) · 77.9 KB
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
<?php
/**
* Copyright 2026 UCloud Technology Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace UCloud\UFile;
use UCloud\Core\Client;
use UCloud\Core\Exception\UCloudException;
use UCloud\UFile\Apis\AddCORSRuleRequest;
use UCloud\UFile\Apis\AddCORSRuleResponse;
use UCloud\UFile\Apis\AddUFileSSLCertRequest;
use UCloud\UFile\Apis\AddUFileSSLCertResponse;
use UCloud\UFile\Apis\BindBucketDomainRequest;
use UCloud\UFile\Apis\BindBucketDomainResponse;
use UCloud\UFile\Apis\BuyUFilePkgRequest;
use UCloud\UFile\Apis\BuyUFilePkgResponse;
use UCloud\UFile\Apis\CreateBucketRequest;
use UCloud\UFile\Apis\CreateBucketResponse;
use UCloud\UFile\Apis\CreateUFileLifeCycleRequest;
use UCloud\UFile\Apis\CreateUFileLifeCycleResponse;
use UCloud\UFile\Apis\CreateUFileTokenRequest;
use UCloud\UFile\Apis\CreateUFileTokenResponse;
use UCloud\UFile\Apis\CreateUdsRuleRequest;
use UCloud\UFile\Apis\CreateUdsRuleResponse;
use UCloud\UFile\Apis\DeleteBucketRequest;
use UCloud\UFile\Apis\DeleteBucketResponse;
use UCloud\UFile\Apis\DeleteCORSRuleRequest;
use UCloud\UFile\Apis\DeleteCORSRuleResponse;
use UCloud\UFile\Apis\DeleteUFileLifeCycleRequest;
use UCloud\UFile\Apis\DeleteUFileLifeCycleResponse;
use UCloud\UFile\Apis\DeleteUFilePkgRequest;
use UCloud\UFile\Apis\DeleteUFilePkgResponse;
use UCloud\UFile\Apis\DeleteUFileSSLCertRequest;
use UCloud\UFile\Apis\DeleteUFileSSLCertResponse;
use UCloud\UFile\Apis\DeleteUFileTokenRequest;
use UCloud\UFile\Apis\DeleteUFileTokenResponse;
use UCloud\UFile\Apis\DescribeBucketRequest;
use UCloud\UFile\Apis\DescribeBucketResponse;
use UCloud\UFile\Apis\DescribeCORSRuleRequest;
use UCloud\UFile\Apis\DescribeCORSRuleResponse;
use UCloud\UFile\Apis\DescribeUFileAvailablePkgRequest;
use UCloud\UFile\Apis\DescribeUFileAvailablePkgResponse;
use UCloud\UFile\Apis\DescribeUFileLifeCycleRequest;
use UCloud\UFile\Apis\DescribeUFileLifeCycleResponse;
use UCloud\UFile\Apis\DescribeUFilePkgRequest;
use UCloud\UFile\Apis\DescribeUFilePkgResponse;
use UCloud\UFile\Apis\DescribeUFilePkgUsageRequest;
use UCloud\UFile\Apis\DescribeUFilePkgUsageResponse;
use UCloud\UFile\Apis\DescribeUFileRefererRequest;
use UCloud\UFile\Apis\DescribeUFileRefererResponse;
use UCloud\UFile\Apis\DescribeUFileSSLCertRequest;
use UCloud\UFile\Apis\DescribeUFileSSLCertResponse;
use UCloud\UFile\Apis\DescribeUFileTokenRequest;
use UCloud\UFile\Apis\DescribeUFileTokenResponse;
use UCloud\UFile\Apis\DescribeUdsRuleRequest;
use UCloud\UFile\Apis\DescribeUdsRuleResponse;
use UCloud\UFile\Apis\GetBucketQuotaRequest;
use UCloud\UFile\Apis\GetBucketQuotaResponse;
use UCloud\UFile\Apis\GetBucketStaticPageRuleRequest;
use UCloud\UFile\Apis\GetBucketStaticPageRuleResponse;
use UCloud\UFile\Apis\GetProjectRegionQuotaRequest;
use UCloud\UFile\Apis\GetProjectRegionQuotaResponse;
use UCloud\UFile\Apis\GetUFileDailyBillRequest;
use UCloud\UFile\Apis\GetUFileDailyBillResponse;
use UCloud\UFile\Apis\GetUFileDailyReportRequest;
use UCloud\UFile\Apis\GetUFileDailyReportResponse;
use UCloud\UFile\Apis\GetUFileMonthlyBillRequest;
use UCloud\UFile\Apis\GetUFileMonthlyBillResponse;
use UCloud\UFile\Apis\GetUFilePkgPriceRequest;
use UCloud\UFile\Apis\GetUFilePkgPriceResponse;
use UCloud\UFile\Apis\GetUFileQuotaRequest;
use UCloud\UFile\Apis\GetUFileQuotaResponse;
use UCloud\UFile\Apis\GetUFileQuotaInfoRequest;
use UCloud\UFile\Apis\GetUFileQuotaInfoResponse;
use UCloud\UFile\Apis\GetUFileQuotaPriceRequest;
use UCloud\UFile\Apis\GetUFileQuotaPriceResponse;
use UCloud\UFile\Apis\GetUFileReportRequest;
use UCloud\UFile\Apis\GetUFileReportResponse;
use UCloud\UFile\Apis\RenewUFilePkgRequest;
use UCloud\UFile\Apis\RenewUFilePkgResponse;
use UCloud\UFile\Apis\SetBucketQuotaRequest;
use UCloud\UFile\Apis\SetBucketQuotaResponse;
use UCloud\UFile\Apis\SetProjectRegionQuotaRequest;
use UCloud\UFile\Apis\SetProjectRegionQuotaResponse;
use UCloud\UFile\Apis\SetUFileRefererRequest;
use UCloud\UFile\Apis\SetUFileRefererResponse;
use UCloud\UFile\Apis\UpdateBucketRequest;
use UCloud\UFile\Apis\UpdateBucketResponse;
use UCloud\UFile\Apis\UpdateBucketStaticPageRuleRequest;
use UCloud\UFile\Apis\UpdateBucketStaticPageRuleResponse;
use UCloud\UFile\Apis\UpdateCORSRuleRequest;
use UCloud\UFile\Apis\UpdateCORSRuleResponse;
use UCloud\UFile\Apis\UpdateUFileLifeCycleRequest;
use UCloud\UFile\Apis\UpdateUFileLifeCycleResponse;
use UCloud\UFile\Apis\UpdateUFileSSLCertRequest;
use UCloud\UFile\Apis\UpdateUFileSSLCertResponse;
use UCloud\UFile\Apis\UpdateUFileTokenRequest;
use UCloud\UFile\Apis\UpdateUFileTokenResponse;
use UCloud\UFile\Apis\UpdateUdsRuleRequest;
use UCloud\UFile\Apis\UpdateUdsRuleResponse;
/**
* This client is used to call actions of **UFile** service
*/
class UFileClient extends Client
{
/**
* AddCORSRule - 添加跨域规则
*
* See also: https://docs.ucloud.cn/api/ufile-api/add_cors_rule
*
* Arguments:
*
* $args = [
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) Bucket名称
* "AllowedOrigin" => (string) 指定允许的跨域请求的来源,使用通配符(*)表示允许所有来源的跨域请求(多个Origin用‘,’分隔)
* "AllowedMethod" => (string) 指定允许的跨域请求方法。支持的方法名有:GET、PUT、POST、DELETE、HEAD、OPTIONS(多个Method用‘,’分隔)
* "AllowedHeader" => (string) 指定允许的跨域请求头(多个Header用‘,’分隔)
* "ExposeHeader" => (string) 指定允许用户从应用程序中访问的响应头(多个ExposeHeader用‘,’分隔)
* ]
*
* Outputs:
*
* $outputs = [
* "CORSId" => (string) 增加一条跨域规则的cors_id
* ]
*
* @return AddCORSRuleResponse
* @throws UCloudException
*/
public function addCORSRule(AddCORSRuleRequest $request = null)
{
$resp = $this->invoke($request);
return new AddCORSRuleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* AddUFileSSLCert - 给指定域名添加证书
*
* See also: https://docs.ucloud.cn/api/ufile-api/add_ufile_ssl_cert
*
* Arguments:
*
* $args = [
* "BucketName" => (string) 存储桶名称,全局唯一
* "Domain" => (string) 域名
* "CertificateName" => (string) SSL证书名称
* "Certificate" => (string) 填写SSL证书文件内容(PEM编码)。证书文件内容填写格式:如果您的业务场景仅需确保服务端证书可信,则证书文件需要包含服务器证书(①)和中间证书(②)。如果您的中间证书和服务器证书是两个文件,您可以在证书链配置项填写中间证书内容即可。
* "CertificateKey" => (string) 填写SSL证书私钥内容(PEM编码)。私钥内容填写格式 RSA
* "USSLId" => (string) ussl证书的资源ID
* ]
*
* Outputs:
*
* $outputs = [
* ]
*
* @return AddUFileSSLCertResponse
* @throws UCloudException
*/
public function addUFileSSLCert(AddUFileSSLCertRequest $request = null)
{
$resp = $this->invoke($request);
return new AddUFileSSLCertResponse($resp->toArray(), $resp->getRequestId());
}
/**
* BindBucketDomain - 绑定自定义域名
*
* See also: https://docs.ucloud.cn/api/ufile-api/bind_bucket_domain
*
* Arguments:
*
* $args = [
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) 自定义域名对应的bucket名称
* "Domain" => (string) 自定义域名
* ]
*
* Outputs:
*
* $outputs = [
* "BucketName" => (string) 自定义域名对应的bucket名称
* "BucketId" => (string) 自定义域名对应的Bucket的Id
* ]
*
* @return BindBucketDomainResponse
* @throws UCloudException
*/
public function bindBucketDomain(BindBucketDomainRequest $request = null)
{
$resp = $this->invoke($request);
return new BindBucketDomainResponse($resp->toArray(), $resp->getRequestId());
}
/**
* BuyUFilePkg - 购买流量包或存储包
*
* See also: https://docs.ucloud.cn/api/ufile-api/buy_ufile_pkg
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "Zone" => (string) 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "PkgName" => (string) 资源包名称
* "PkgType" => (integer) 0: 标准存储包,1: 忙时流量包,2: 闲时流量包
* "Amount" => (integer) 购买数量
* "AmountUnit" => (string) 数量单位,如 GB、TB 等
* "Duration" => (integer) 购买时长
* "DurationUnit" => (string) 时长单位,如 Month、Year 等
* ]
*
* Outputs:
*
* $outputs = [
* "ResourceId" => (string) 购买成功返回资源包Id
* ]
*
* @return BuyUFilePkgResponse
* @throws UCloudException
*/
public function buyUFilePkg(BuyUFilePkgRequest $request = null)
{
$resp = $this->invoke($request);
return new BuyUFilePkgResponse($resp->toArray(), $resp->getRequestId());
}
/**
* CreateBucket - 创建Bucket
*
* See also: https://docs.ucloud.cn/api/ufile-api/create_bucket
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) 待创建Bucket的名称,具有全局唯一性
* "Type" => (string) Bucket访问类型,public或private; 默认为private
* "Tag" => (string) Bucket所属业务组,默认为default
* ]
*
* Outputs:
*
* $outputs = [
* "BucketName" => (string) 已创建Bucket的名称
* "BucketId" => (string) 已创建Bucket的ID
* ]
*
* @return CreateBucketResponse
* @throws UCloudException
*/
public function createBucket(CreateBucketRequest $request = null)
{
$resp = $this->invoke($request);
return new CreateBucketResponse($resp->toArray(), $resp->getRequestId());
}
/**
* CreateUFileLifeCycle - 创建生命周期管理
*
* See also: https://docs.ucloud.cn/api/ufile-api/create_ufile_life_cycle
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "LifeCycleName" => (string) 生命周期名称
* "Prefix" => (string) 生命周期所适用的前缀;*为整个存储空间文件;一条规则只支持一个文件前缀;
* "Status" => (string) Enabled -- 启用,Disabled -- 不启用
* "BucketName" => (string) 存储空间名称
* "Days" => (integer) 指定一个过期天数N,文件会在其最近更新时间点的N天后过期,自动删除;参数范围:[7,36500],0代表不启用
* "ArchivalDays" => (integer) 指定一个过期天数N,文件会在其最近更新时间点的N天后,自动变为归档存储类型;参数范围:[7,36500],0代表不启用
* "IADays" => (integer) 指定一个过期天数N,文件会在其最近更新时间点的N天后,自动变为低频存储类型;参数范围:[7,36500],0代表不启用
* "HistVerDeleteDays" => (integer) 指定一个历史文件过期天数N,文件会在其最近更新时间点的N天后过期,自动删除;范围: [7,36500]
* "HistVerArchivalDays" => (integer) 指定一个历史文件过期天数N,文件会在其最近更新时间点的N天后过期,自动删除;范围: [7,36500]
* "HistVerIADays" => (integer) 指定一个历史文件过期天数N,文件会在其最近更新时间点的N天后过期,自动删除;范围: [7,36500]
* "Tags" => (string) Tag,参数格式"k1=v1&k2=v2",key的最大长度为128, value最大长度为256byte,tag的最大数量为10
* "MinSize" => (integer) 文件的最小size
* "MaxSize" => (integer) 文件的最大size
* ]
*
* Outputs:
*
* $outputs = [
* "LifeCycleId" => (string) 生命周期Id
* ]
*
* @return CreateUFileLifeCycleResponse
* @throws UCloudException
*/
public function createUFileLifeCycle(CreateUFileLifeCycleRequest $request = null)
{
$resp = $this->invoke($request);
return new CreateUFileLifeCycleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* CreateUFileToken - 创建US3令牌
*
* See also: https://docs.ucloud.cn/api/ufile-api/create_ufile_token
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "TokenName" => (string) 令牌名称
* "AllowedOps" => (array<string>) 令牌允许执行的操作[ TOKEN_ALLOW_NONE 没有权限, TOKEN_ALLOW_READ 下载权限 , TOKEN_ALLOW_WRITE 上传权限 , TOKEN_ALLOW_DELETE 删除权限 , TOKEN_ALLOW_LIST 列表权限, TOKEN_ALLOW_IOP 图片处理权限, TOKEN_DENY_UPDATE 禁止覆盖权限]。默认TOKEN_ALLOW_NONE
* "AllowedPrefixes" => (array<string>) 令牌允许操作的key前缀,默认*表示全部
* "AllowedBuckets" => (array<string>) 令牌允许操作的bucket,默认*表示全部
* "ExpireTime" => (integer) Unix 时间戳,精确到秒,为令牌过期时间点。默认过期时间为一天(即当前Unix时间戳+86400);注意:过期时间不能超过 4102416000
* "BlackIPList" => (array<string>) 令牌黑名单,支持ipv4,ipv6格式。
* "WhiteIPList" => (array<string>) 令牌白名单,支持ipv4,ipv6格式。
* ]
*
* Outputs:
*
* $outputs = [
* "TokenId" => (string) 令牌唯一ID
* "UFileTokenSet" => (object) 创建令牌的详细信息[
* "Region" => (string) 所属地区
* "TokenId" => (string) 令牌ID
* "TokenName" => (string) 令牌名称
* "PublicKey" => (string) 令牌公钥
* "PrivateKey" => (string) 令牌私钥
* "AllowedOps" => (array<string>) 令牌允许执行的操作,[ TOKEN_ALLOW_NONE 没有权限, TOKEN_ALLOW_READ 下载权限, TOKEN_ALLOW_WRITE 上传权限, TOKEN_ALLOW_DELETE 删除权限, TOKEN_ALLOW_LIST 列表权限, TOKEN_ALLOW_IOP 图片处理权限]
* "AllowedPrefixes" => (array<string>) 令牌允许操作的key前缀
* "AllowedBuckets" => (array<string>) 令牌允许操作的bucket
* "ExpireTime" => (integer) 令牌的超时时间点
* "CreateTime" => (integer) 创建时间
* "ModifyTime" => (integer) 修改时间
* "BlackIPList" => (array<string>) 令牌黑名单
* "WhiteIPList" => (array<string>) 令牌白名单
* ]
* ]
*
* @return CreateUFileTokenResponse
* @throws UCloudException
*/
public function createUFileToken(CreateUFileTokenRequest $request = null)
{
$resp = $this->invoke($request);
return new CreateUFileTokenResponse($resp->toArray(), $resp->getRequestId());
}
/**
* CreateUdsRule - 针对对象存储的文件,进行自动触发解压。
*
* See also: https://docs.ucloud.cn/api/ufile-api/create_uds_rule
*
* Arguments:
*
* $args = [
* "RuleName" => (string) 规则名称
* "SrcBucket" => (string) 源Bucket名字,全局唯一
* "SrcTokenId" => (string) 源bucket的token之一的tokenId
* "DstBucket" => (string) 目标Bucket名字,全局唯一
* "DstTokenId" => (string) 目标bucket的token之一的tokenId
* "DstDirectory" => (string) 解压后的目标目录
* "KeepUS3Name" => (boolean) 是否以压缩文件的前缀为最后一层目录
* "Prefixes" => (string) 解压缩触发的前缀
* "Ops" => (array<string>) 操作的ops数组,"Ops.0":"unzip"
* "Events" => (array<string>) 通知的事件数组
* "ContactGroupId" => (string) 联系的用户组ID
* "NotificationTypes" => (array<string>) 通知的类型数组
* ]
*
* Outputs:
*
* $outputs = [
* "RuleId" => (string) 创建规则的规则ID
* ]
*
* @return CreateUdsRuleResponse
* @throws UCloudException
*/
public function createUdsRule(CreateUdsRuleRequest $request = null)
{
$resp = $this->invoke($request);
return new CreateUdsRuleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DeleteBucket - 删除Bucket
*
* See also: https://docs.ucloud.cn/api/ufile-api/delete_bucket
*
* Arguments:
*
* $args = [
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) 待删除Bucket的名称
* ]
*
* Outputs:
*
* $outputs = [
* "BucketName" => (string) Bucket的名称
* "BucketId" => (string) Bucket的ID
* ]
*
* @return DeleteBucketResponse
* @throws UCloudException
*/
public function deleteBucket(DeleteBucketRequest $request = null)
{
$resp = $this->invoke($request);
return new DeleteBucketResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DeleteCORSRule - 删除跨域规则
*
* See also: https://docs.ucloud.cn/api/ufile-api/delete_cors_rule
*
* Arguments:
*
* $args = [
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) Bucket名称
* "CORSId" => (string) 跨域规则ID
* ]
*
* Outputs:
*
* $outputs = [
* ]
*
* @return DeleteCORSRuleResponse
* @throws UCloudException
*/
public function deleteCORSRule(DeleteCORSRuleRequest $request = null)
{
$resp = $this->invoke($request);
return new DeleteCORSRuleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DeleteUFileLifeCycle - 删除生命周期管理
*
* See also: https://docs.ucloud.cn/api/ufile-api/delete_ufile_life_cycle
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "LifeCycleId" => (string) 生命周期Id
* "BucketName" => (string) 存储空间名称
* ]
*
* Outputs:
*
* $outputs = [
* ]
*
* @return DeleteUFileLifeCycleResponse
* @throws UCloudException
*/
public function deleteUFileLifeCycle(DeleteUFileLifeCycleRequest $request = null)
{
$resp = $this->invoke($request);
return new DeleteUFileLifeCycleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DeleteUFilePkg - 删除资源包(退费)
*
* See also: https://docs.ucloud.cn/api/ufile-api/delete_ufile_pkg
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "Zone" => (string) 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "ResourceId" => (string) 资源ID
* ]
*
* Outputs:
*
* $outputs = [
* ]
*
* @return DeleteUFilePkgResponse
* @throws UCloudException
*/
public function deleteUFilePkg(DeleteUFilePkgRequest $request = null)
{
$resp = $this->invoke($request);
return new DeleteUFilePkgResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DeleteUFileSSLCert - 删除指定域名添加证书
*
* See also: https://docs.ucloud.cn/api/ufile-api/delete_ufile_ssl_cert
*
* Arguments:
*
* $args = [
* "BucketName" => (string) 存储桶名称,全局唯一
* "Domain" => (string) 域名
* ]
*
* Outputs:
*
* $outputs = [
* ]
*
* @return DeleteUFileSSLCertResponse
* @throws UCloudException
*/
public function deleteUFileSSLCert(DeleteUFileSSLCertRequest $request = null)
{
$resp = $this->invoke($request);
return new DeleteUFileSSLCertResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DeleteUFileToken - 删除令牌
*
* See also: https://docs.ucloud.cn/api/ufile-api/delete_ufile_token
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](../summary/regionlist.html)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](../summary/get_project_list.html)
* "TokenId" => (string) 令牌ID
* ]
*
* Outputs:
*
* $outputs = [
* ]
*
* @return DeleteUFileTokenResponse
* @throws UCloudException
*/
public function deleteUFileToken(DeleteUFileTokenRequest $request = null)
{
$resp = $this->invoke($request);
return new DeleteUFileTokenResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeBucket - 获取Bucket的描述信息
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_bucket
*
* Arguments:
*
* $args = [
* "Region" => (string) 如果提供此参数,则获取相应地域下所有空间的空间名称(只返回空间名称信息)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) 待获取Bucket的名称,若不提供,则获取所有Bucket
* "Offset" => (integer) 获取所有Bucket列表的偏移数目,默认为0
* "Limit" => (integer) 获取所有Bucket列表的限制数目,默认为20
* ]
*
* Outputs:
*
* $outputs = [
* "DataSet" => (array<object>) Bucket的描述信息 参数见 UFileBucketSet[
* [
* "Region" => (string) Bucket所属地域
* "StorageClass" => (string) 默认存储类型
* "BucketName" => (string) Bucket名称
* "BucketId" => (string) Bucket的ID
* "Domain" => (object) Bucket的域名集合 参数见 UFileDomainSet[
* "Src" => (array<string>) 源站域名
* "Cdn" => (array<string>) UCDN加速域名
* "CustomSrc" => (array<string>) 用户自定义源站域名
* "CustomCdn" => (array<string>) 用户自定义CDN加速域名
* ]
* "CdnDomainId" => (array<string>) 与Bucket关联的CND加速域名的ID列表
* "Type" => (string) Bucket访问类型
* "CreateTime" => (integer) Bucket的创建时间
* "ModifyTime" => (integer) Bucket的修改时间
* "Biz" => (string) Bucket所属业务, general或vod或udb general: 普通业务; vod: 视频云业务; udb: 云数据库业务
* "Tag" => (string) 所属业务组
* "HasUserDomain" => (integer) 是否存在自定义域名。0不存在,1存在,2错误
* "Storage" => (integer) 标准存储量,单位Byte
* "IaStorage" => (integer) 低频存储量,单位Byte
* "AcStorage" => (integer) 归档存储量,单位Byte
* ]
* ]
* ]
*
* @return DescribeBucketResponse
* @throws UCloudException
*/
public function describeBucket(DescribeBucketRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeBucketResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeCORSRule - 获取跨域规则信息
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_cors_rule
*
* Arguments:
*
* $args = [
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) Bucket名称
* "CORSId" => (string) 跨域规则ID,不指定则返回所有跨域规则信息
* ]
*
* Outputs:
*
* $outputs = [
* "DataSet" => (array<object>) 跨域规则信息集合[
* [
* "AllowedOrigin" => (string) 指定允许的跨域请求的来源,使用通配符(*)表示允许所有来源的跨域请求(多个Origin用‘,’分隔)
* "AllowedMethod" => (string) 指定允许的跨域请求方法。支持的方法名有:GET、PUT、POST、DELETE、HEAD、OPTIONS(多个Method用‘,’分隔)
* "CORSId" => (string) 跨域规则id
* "CreateTime" => (integer) 跨域规则创建时间
* "ModifyTime" => (integer) 跨域规则最新修改时间
* "AllowedHeader" => (string) 指定允许的跨域请求头(多个Header用‘,’分隔)
* "ExposeHeader" => (string) 指定允许用户从应用程序中访问的响应头(多个ExposeHeader用‘,’分隔)
* ]
* ]
* ]
*
* @return DescribeCORSRuleResponse
* @throws UCloudException
*/
public function describeCORSRule(DescribeCORSRuleRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeCORSRuleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUFileAvailablePkg - 查询可购买的资源包列表
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_ufile_available_pkg
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "Zone" => (string) 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* ]
*
* Outputs:
*
* $outputs = [
* "PkgList" => (array<object>) 可购买的资源包规格[
* [
* "Type" => (integer) 资源类型ID
* "Name" => (string) 资源类型名称
* "Specs" => (array<object>) 支持购买的数量规格[
* [
* "Durations" => (array<object>) 仅针对当前规格生效的durations[
* [
* "Discount" => (number) 折扣
* "Duration" => (integer) 购买时长
* "Unit" => (string) 时长单位,如: Month、Year
* ]
* ]
* "Amount" => (integer) 购买数量
* "Unit" => (string) 数量的单位,如:GB,TB
* ]
* ]
* "CommonDurations" => (array<object>) 公共支持购买的时长,当一个Spec配了独立的Durations时,就按独立配置Durations生效;否者按CommonDurations生效[
* [
* "Discount" => (number) 折扣
* "Duration" => (integer) 购买时长
* "Unit" => (string) 时长单位,如: Month、Year
* ]
* ]
* ]
* ]
* ]
*
* @return DescribeUFileAvailablePkgResponse
* @throws UCloudException
*/
public function describeUFileAvailablePkg(DescribeUFileAvailablePkgRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUFileAvailablePkgResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUFileLifeCycle - 获取生命周期信息
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_ufile_life_cycle
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) 存储空间名称
* "LifeCycleId" => (string) 生命周期Id;不传递此参数拉取存储空间下面的所有生命周期信息
* ]
*
* Outputs:
*
* $outputs = [
* "DataSet" => (array<object>) 生命周期信息[
* [
* "MinSize" => (string) 文件的最小size
* "MaxSize" => (string) 文件的最大size
* "LifeCycleId" => (string) 生命周期Id
* "LifeCycleName" => (string) 生命周期名称
* "Prefix" => (string) 生命周期所适用的前缀;*为整个存储空间文件;
* "Days" => (integer) 指定一个过期天数N,文件会在其最近更新时间点的N天后过期,自动删除,0代表不启用;
* "Status" => (string) Enabled -- 启用,Disabled -- 不启用
* "BucketName" => (string) 存储空间名称
* "ArchivalDays" => (integer) 指定一个过期天数N,文件会在其最近更新时间点的N天后过期,自动转换为归档存储类型,0代表不启用;
* "IADays" => (integer) 指定一个过期天数N,文件会在其最近更新时间点的N天后过期,自动转换为低频存储类型,0代表不启用;
* ]
* ]
* ]
*
* @return DescribeUFileLifeCycleResponse
* @throws UCloudException
*/
public function describeUFileLifeCycle(DescribeUFileLifeCycleRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUFileLifeCycleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUFilePkg - 查询已购买的资源包列表
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_ufile_pkg
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "Zone" => (string) 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "ResourceId" => (string) 查询指定的资源包,当指定ResourceId查询时,Region是必填的
* "Expired" => (integer) 默认0表示查询全部已购买的资源包,1表示查询过期的,-1表示查询非过期的
* ]
*
* Outputs:
*
* $outputs = [
* "Pkgs" => (array<object>) 已购买的资源包[
* [
* "Region" => (string) 资源包地域
* "ResourceId" => (string) 资源包ID
* "PkgName" => (string) 资源包名称
* "PkgType" => (integer) 资源包类型ID
* "Amount" => (integer) 资源包容量
* "RemainAmount" => (string) 资源包剩余容量(仅支持流量包)
* "CreateTime" => (integer) 资源包创建时间
* "ExpiredTime" => (integer) 资源包失效时间
* ]
* ]
* ]
*
* @return DescribeUFilePkgResponse
* @throws UCloudException
*/
public function describeUFilePkg(DescribeUFilePkgRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUFilePkgResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUFilePkgUsage - 查询资源包使用明细
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_ufile_pkg_usage
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "Zone" => (string) 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "ResourceId" => (string) 资源包ID
* "StartDate" => (string) 开始时间,如 2023-09-01
* "EndDate" => (string) 结束时间,如 2023-09-01
* ]
*
* Outputs:
*
* $outputs = [
* "Usage" => (array<object>) 按天返回的使用明细[
* [
* "Date" => (string) 日期
* "Cost" => (string) 使用量,单位为B
* ]
* ]
* ]
*
* @return DescribeUFilePkgUsageResponse
* @throws UCloudException
*/
public function describeUFilePkgUsage(DescribeUFilePkgUsageRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUFilePkgUsageResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUFileReferer - 对象存储防盗链列表
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_ufile_referer
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list)
* "BucketName" => (string) 存储空间名称
* ]
*
* Outputs:
*
* $outputs = [
* "RefererType" => (integer) 防盗链Referer类型,支持两种类型,1黑名单,2白名单;未开启referer时不返回此参数
* "RefererList" => (array<string>) 防盗链Referer规则列表;未开启referer时不返回此参数
* "NullRefer" => (boolean) ReferType为白名单时,NullRefer为false代表不允许NULL refer访问,为true代表允许Null refer访问; 未开启referer时不返回此参数
* "RefererStatus" => (string) 防盗链功能是否开启,"on"表示开启,"off"表示关闭
* "BlackList" => (array<string>) 黑名单列表
* "WhiteList" => (array<string>) 白名单列表
* ]
*
* @return DescribeUFileRefererResponse
* @throws UCloudException
*/
public function describeUFileReferer(DescribeUFileRefererRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUFileRefererResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUFileSSLCert - 查询指定存储桶所有证书
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_ufile_ssl_cert
*
* Arguments:
*
* $args = [
* "BucketName" => (string) 存储桶名称,全局唯一
* ]
*
* Outputs:
*
* $outputs = [
* "DataSet" => (array<object>) 证书列表[
* [
* "Domain" => (string) 域名
* "Certificate" => (string) SSL证书内容,和域名对应
* "CertificateKey" => (string) SSL证书对应的私钥
* "CertificateName" => (string) SSL证书名称
* ]
* ]
* ]
*
* @return DescribeUFileSSLCertResponse
* @throws UCloudException
*/
public function describeUFileSSLCert(DescribeUFileSSLCertRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUFileSSLCertResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUFileToken - 获取令牌信息
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_ufile_token
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](../summary/regionlist.html)
* "ProjectId" => (string) 项目ID。不填写为默认项目,子帐号必须填写。 请参考[GetProjectList接口](../summary/get_project_list.html)
* "TokenId" => (string) 令牌ID,只返回指定ID信息,否则拉取所有令牌
* "TokenName" => (string) 令牌名称,只返回指定令牌名称信息,否则拉取所有令牌
* "Display" => (integer) 0表示显示部分token信息;不传递和其他情况表示显示全部token信息
* ]
*
* Outputs:
*
* $outputs = [
* "DataSet" => (array<object>) 令牌描述信息[
* [
* "Region" => (string) 所属地区
* "TokenId" => (string) 令牌ID
* "TokenName" => (string) 令牌名称
* "PublicKey" => (string) 令牌公钥
* "PrivateKey" => (string) 令牌私钥
* "AllowedOps" => (array<string>) 令牌允许执行的操作,[ TOKEN_ALLOW_NONE 没有权限, TOKEN_ALLOW_READ 下载权限, TOKEN_ALLOW_WRITE 上传权限, TOKEN_ALLOW_DELETE 删除权限, TOKEN_ALLOW_LIST 列表权限, TOKEN_ALLOW_IOP 图片处理权限]
* "AllowedPrefixes" => (array<string>) 令牌允许操作的key前缀
* "AllowedBuckets" => (array<string>) 令牌允许操作的bucket
* "ExpireTime" => (integer) 令牌的超时时间点
* "CreateTime" => (integer) 创建时间
* "ModifyTime" => (integer) 修改时间
* "BlackIPList" => (array<string>) 令牌黑名单
* "WhiteIPList" => (array<string>) 令牌白名单
* ]
* ]
* ]
*
* @return DescribeUFileTokenResponse
* @throws UCloudException
*/
public function describeUFileToken(DescribeUFileTokenRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUFileTokenResponse($resp->toArray(), $resp->getRequestId());
}
/**
* DescribeUdsRule - 针对解压缩规则进行查询
*
* See also: https://docs.ucloud.cn/api/ufile-api/describe_uds_rule
*
* Arguments:
*
* $args = [
* "BucketName" => (string) 源BucketName
* "RuleId" => (string) 规则ID,不设置时,查询改bucket的所有规则
* ]
*
* Outputs:
*
* $outputs = [
* "TotalCount" => (integer) 此次删除的规则的ID
* "DataSet" => (array<string>) 规则数组
* ]
*
* @return DescribeUdsRuleResponse
* @throws UCloudException
*/
public function describeUdsRule(DescribeUdsRuleRequest $request = null)
{
$resp = $this->invoke($request);
return new DescribeUdsRuleResponse($resp->toArray(), $resp->getRequestId());
}
/**
* GetBucketQuota - 获取bucket配额
*
* See also: https://docs.ucloud.cn/api/ufile-api/get_bucket_quota
*
* Arguments:
*
* $args = [
* "Region" => (string) 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "Zone" => (string) 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
* "BucketName" => (string) bucket名称
* ]
*
* Outputs:
*
* $outputs = [
* "QuotaLimit" => (integer) bucket配额
* "BucketName" => (string) bucket名称
* ]
*
* @return GetBucketQuotaResponse
* @throws UCloudException
*/
public function getBucketQuota(GetBucketQuotaRequest $request = null)
{
$resp = $this->invoke($request);
return new GetBucketQuotaResponse($resp->toArray(), $resp->getRequestId());
}
/**
* GetBucketStaticPageRule - 获取bucket静态网页配置
*
* See also: https://docs.ucloud.cn/api/ufile-api/get_bucket_static_page_rule