/
client.rb
1310 lines (1197 loc) · 62 KB
/
client.rb
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
# frozen_string_literal: true
# Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
#
# 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.
require 'json'
module TencentCloud
module Kms
module V20190118
class Client < TencentCloud::Common::AbstractClient
def initialize(credential, region, profile = nil)
api_version = '2019-01-18'
api_endpoint = 'kms.tencentcloudapi.com'
sdk_version = 'KMS_' + File.read(File.expand_path('../VERSION', __dir__)).strip
super(credential, region, api_version, api_endpoint, sdk_version, profile)
end
# 对密钥进行归档,被归档的密钥只能用于解密,不能加密
# @param request: Request instance for ArchiveKey.
# @type request: :class:`Tencentcloud::kms::V20190118::ArchiveKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::ArchiveKeyResponse`
def ArchiveKey(request)
body = send_request('ArchiveKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = ArchiveKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 使用指定的RSA非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。
# @param request: Request instance for AsymmetricRsaDecrypt.
# @type request: :class:`Tencentcloud::kms::V20190118::AsymmetricRsaDecryptRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::AsymmetricRsaDecryptResponse`
def AsymmetricRsaDecrypt(request)
body = send_request('AsymmetricRsaDecrypt', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = AsymmetricRsaDecryptResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 使用指定的SM2非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。传入的密文的长度不能超过256字节。
# @param request: Request instance for AsymmetricSm2Decrypt.
# @type request: :class:`Tencentcloud::kms::V20190118::AsymmetricSm2DecryptRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::AsymmetricSm2DecryptResponse`
def AsymmetricSm2Decrypt(request)
body = send_request('AsymmetricSm2Decrypt', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = AsymmetricSm2DecryptResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 记录当前key被哪个云产品的那个资源所使用。如果当前key设置了自动过期,则取消该设置,确保当前key不会自动失效。如果当前关联关系已经创建,也返回成功。
# @param request: Request instance for BindCloudResource.
# @type request: :class:`Tencentcloud::kms::V20190118::BindCloudResourceRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::BindCloudResourceResponse`
def BindCloudResource(request)
body = send_request('BindCloudResource', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = BindCloudResourceResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 取消密钥归档,取消后密钥的状态变为Enabled。
# @param request: Request instance for CancelKeyArchive.
# @type request: :class:`Tencentcloud::kms::V20190118::CancelKeyArchiveRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::CancelKeyArchiveResponse`
def CancelKeyArchive(request)
body = send_request('CancelKeyArchive', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CancelKeyArchiveResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 取消CMK的计划删除操作
# @param request: Request instance for CancelKeyDeletion.
# @type request: :class:`Tencentcloud::kms::V20190118::CancelKeyDeletionRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::CancelKeyDeletionResponse`
def CancelKeyDeletion(request)
body = send_request('CancelKeyDeletion', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CancelKeyDeletionResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 创建用户管理数据密钥的主密钥CMK(Custom Master Key)。
# @param request: Request instance for CreateKey.
# @type request: :class:`Tencentcloud::kms::V20190118::CreateKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::CreateKeyResponse`
def CreateKey(request)
body = send_request('CreateKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CreateKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 创建白盒密钥。 密钥个数的上限为 50。
# @param request: Request instance for CreateWhiteBoxKey.
# @type request: :class:`Tencentcloud::kms::V20190118::CreateWhiteBoxKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::CreateWhiteBoxKeyResponse`
def CreateWhiteBoxKey(request)
body = send_request('CreateWhiteBoxKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CreateWhiteBoxKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口用于解密密文,得到明文数据。
# @param request: Request instance for Decrypt.
# @type request: :class:`Tencentcloud::kms::V20190118::DecryptRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DecryptResponse`
def Decrypt(request)
body = send_request('Decrypt', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DecryptResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用于删除导入的密钥材料,仅对EXTERNAL类型的CMK有效,该接口将CMK设置为PendingImport 状态,并不会删除CMK,在重新进行密钥导入后可继续使用。彻底删除CMK请使用 ScheduleKeyDeletion 接口。
# @param request: Request instance for DeleteImportedKeyMaterial.
# @type request: :class:`Tencentcloud::kms::V20190118::DeleteImportedKeyMaterialRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DeleteImportedKeyMaterialResponse`
def DeleteImportedKeyMaterial(request)
body = send_request('DeleteImportedKeyMaterial', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DeleteImportedKeyMaterialResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 删除白盒密钥, 注意:必须先禁用后,才可以删除。
# @param request: Request instance for DeleteWhiteBoxKey.
# @type request: :class:`Tencentcloud::kms::V20190118::DeleteWhiteBoxKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DeleteWhiteBoxKeyResponse`
def DeleteWhiteBoxKey(request)
body = send_request('DeleteWhiteBoxKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DeleteWhiteBoxKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用于获取指定KeyId的主密钥属性详情信息。
# @param request: Request instance for DescribeKey.
# @type request: :class:`Tencentcloud::kms::V20190118::DescribeKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DescribeKeyResponse`
def DescribeKey(request)
body = send_request('DescribeKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 该接口用于批量获取主密钥属性信息。
# @param request: Request instance for DescribeKeys.
# @type request: :class:`Tencentcloud::kms::V20190118::DescribeKeysRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DescribeKeysResponse`
def DescribeKeys(request)
body = send_request('DescribeKeys', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeKeysResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 获取白盒解密密钥
# @param request: Request instance for DescribeWhiteBoxDecryptKey.
# @type request: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxDecryptKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxDecryptKeyResponse`
def DescribeWhiteBoxDecryptKey(request)
body = send_request('DescribeWhiteBoxDecryptKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeWhiteBoxDecryptKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 获取指定密钥的设备指纹列表
# @param request: Request instance for DescribeWhiteBoxDeviceFingerprints.
# @type request: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxDeviceFingerprintsRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxDeviceFingerprintsResponse`
def DescribeWhiteBoxDeviceFingerprints(request)
body = send_request('DescribeWhiteBoxDeviceFingerprints', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeWhiteBoxDeviceFingerprintsResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 展示白盒密钥的信息
# @param request: Request instance for DescribeWhiteBoxKey.
# @type request: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxKeyResponse`
def DescribeWhiteBoxKey(request)
body = send_request('DescribeWhiteBoxKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeWhiteBoxKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 获取白盒密钥列表
# @param request: Request instance for DescribeWhiteBoxKeyDetails.
# @type request: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxKeyDetailsRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxKeyDetailsResponse`
def DescribeWhiteBoxKeyDetails(request)
body = send_request('DescribeWhiteBoxKeyDetails', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeWhiteBoxKeyDetailsResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 获取白盒密钥服务状态
# @param request: Request instance for DescribeWhiteBoxServiceStatus.
# @type request: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxServiceStatusRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DescribeWhiteBoxServiceStatusResponse`
def DescribeWhiteBoxServiceStatus(request)
body = send_request('DescribeWhiteBoxServiceStatus', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeWhiteBoxServiceStatusResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口用于禁用一个主密钥,处于禁用状态的Key无法用于加密、解密操作。
# @param request: Request instance for DisableKey.
# @type request: :class:`Tencentcloud::kms::V20190118::DisableKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DisableKeyResponse`
def DisableKey(request)
body = send_request('DisableKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DisableKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 对指定的CMK禁止密钥轮换功能。
# @param request: Request instance for DisableKeyRotation.
# @type request: :class:`Tencentcloud::kms::V20190118::DisableKeyRotationRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DisableKeyRotationResponse`
def DisableKeyRotation(request)
body = send_request('DisableKeyRotation', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DisableKeyRotationResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 该接口用于批量禁止CMK的使用。
# @param request: Request instance for DisableKeys.
# @type request: :class:`Tencentcloud::kms::V20190118::DisableKeysRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DisableKeysResponse`
def DisableKeys(request)
body = send_request('DisableKeys', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DisableKeysResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 禁用白盒密钥
# @param request: Request instance for DisableWhiteBoxKey.
# @type request: :class:`Tencentcloud::kms::V20190118::DisableWhiteBoxKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DisableWhiteBoxKeyResponse`
def DisableWhiteBoxKey(request)
body = send_request('DisableWhiteBoxKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DisableWhiteBoxKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 批量禁用白盒密钥
# @param request: Request instance for DisableWhiteBoxKeys.
# @type request: :class:`Tencentcloud::kms::V20190118::DisableWhiteBoxKeysRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::DisableWhiteBoxKeysResponse`
def DisableWhiteBoxKeys(request)
body = send_request('DisableWhiteBoxKeys', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DisableWhiteBoxKeysResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用于启用一个指定的CMK。
# @param request: Request instance for EnableKey.
# @type request: :class:`Tencentcloud::kms::V20190118::EnableKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::EnableKeyResponse`
def EnableKey(request)
body = send_request('EnableKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = EnableKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 对指定的CMK开启密钥轮换功能。
# @param request: Request instance for EnableKeyRotation.
# @type request: :class:`Tencentcloud::kms::V20190118::EnableKeyRotationRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::EnableKeyRotationResponse`
def EnableKeyRotation(request)
body = send_request('EnableKeyRotation', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = EnableKeyRotationResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 该接口用于批量启用CMK。
# @param request: Request instance for EnableKeys.
# @type request: :class:`Tencentcloud::kms::V20190118::EnableKeysRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::EnableKeysResponse`
def EnableKeys(request)
body = send_request('EnableKeys', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = EnableKeysResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 启用白盒密钥
# @param request: Request instance for EnableWhiteBoxKey.
# @type request: :class:`Tencentcloud::kms::V20190118::EnableWhiteBoxKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::EnableWhiteBoxKeyResponse`
def EnableWhiteBoxKey(request)
body = send_request('EnableWhiteBoxKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = EnableWhiteBoxKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 批量启用白盒密钥
# @param request: Request instance for EnableWhiteBoxKeys.
# @type request: :class:`Tencentcloud::kms::V20190118::EnableWhiteBoxKeysRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::EnableWhiteBoxKeysResponse`
def EnableWhiteBoxKeys(request)
body = send_request('EnableWhiteBoxKeys', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = EnableWhiteBoxKeysResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口用于加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作
# @param request: Request instance for Encrypt.
# @type request: :class:`Tencentcloud::kms::V20190118::EncryptRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::EncryptResponse`
def Encrypt(request)
body = send_request('Encrypt', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = EncryptResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 使用白盒密钥进行加密
# @param request: Request instance for EncryptByWhiteBox.
# @type request: :class:`Tencentcloud::kms::V20190118::EncryptByWhiteBoxRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::EncryptByWhiteBoxResponse`
def EncryptByWhiteBox(request)
body = send_request('EncryptByWhiteBox', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = EncryptByWhiteBoxResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口生成一个数据密钥,您可以用这个密钥进行本地数据的加密。
# @param request: Request instance for GenerateDataKey.
# @type request: :class:`Tencentcloud::kms::V20190118::GenerateDataKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::GenerateDataKeyResponse`
def GenerateDataKey(request)
body = send_request('GenerateDataKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GenerateDataKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 随机数生成接口。
# @param request: Request instance for GenerateRandom.
# @type request: :class:`Tencentcloud::kms::V20190118::GenerateRandomRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::GenerateRandomResponse`
def GenerateRandom(request)
body = send_request('GenerateRandom', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GenerateRandomResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 查询指定的CMK是否开启了密钥轮换功能。
# @param request: Request instance for GetKeyRotationStatus.
# @type request: :class:`Tencentcloud::kms::V20190118::GetKeyRotationStatusRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::GetKeyRotationStatusResponse`
def GetKeyRotationStatus(request)
body = send_request('GetKeyRotationStatus', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetKeyRotationStatusResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 获取导入主密钥(CMK)材料的参数,返回的Token作为执行ImportKeyMaterial的参数之一,返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效,失效后如需重新导入,需要再次调用该接口获取新的Token和PublicKey。
# @param request: Request instance for GetParametersForImport.
# @type request: :class:`Tencentcloud::kms::V20190118::GetParametersForImportRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::GetParametersForImportResponse`
def GetParametersForImport(request)
body = send_request('GetParametersForImport', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetParametersForImportResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 该接口用于获取非对称密钥的公钥信息,可用于本地数据加密或验签。只有处于Enabled状态的非对称密钥才可能获取公钥。
# @param request: Request instance for GetPublicKey.
# @type request: :class:`Tencentcloud::kms::V20190118::GetPublicKeyRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::GetPublicKeyResponse`
def GetPublicKey(request)
body = send_request('GetPublicKey', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetPublicKeyResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 获取可以提供KMS服务的地域列表
# @param request: Request instance for GetRegions.
# @type request: :class:`Tencentcloud::kms::V20190118::GetRegionsRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::GetRegionsResponse`
def GetRegions(request)
body = send_request('GetRegions', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetRegionsResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用于查询该用户是否已开通KMS服务
# @param request: Request instance for GetServiceStatus.
# @type request: :class:`Tencentcloud::kms::V20190118::GetServiceStatusRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::GetServiceStatusResponse`
def GetServiceStatus(request)
body = send_request('GetServiceStatus', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetServiceStatusResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入,导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料,并重新指定过期时间,但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后,指定的CMK将无法使用,需要再次导入相同的密钥材料才能正常使用。CMK是独立的,同样的密钥材料可导入不同的 CMK 中,但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。
# 只有Enabled 和 PendingImport状态的CMK可以导入密钥材料。
# @param request: Request instance for ImportKeyMaterial.
# @type request: :class:`Tencentcloud::kms::V20190118::ImportKeyMaterialRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::ImportKeyMaterialResponse`
def ImportKeyMaterial(request)
body = send_request('ImportKeyMaterial', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = ImportKeyMaterialResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 列出当前Region支持的加密方式
# @param request: Request instance for ListAlgorithms.
# @type request: :class:`Tencentcloud::kms::V20190118::ListAlgorithmsRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::ListAlgorithmsResponse`
def ListAlgorithms(request)
body = send_request('ListAlgorithms', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = ListAlgorithmsResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 根据指定Offset和Limit获取主密钥列表详情。
# @param request: Request instance for ListKeyDetail.
# @type request: :class:`Tencentcloud::kms::V20190118::ListKeyDetailRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::ListKeyDetailResponse`
def ListKeyDetail(request)
body = send_request('ListKeyDetail', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = ListKeyDetailResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 列出账号下面状态为Enabled, Disabled 和 PendingImport 的CMK KeyId 列表
# @param request: Request instance for ListKeys.
# @type request: :class:`Tencentcloud::kms::V20190118::ListKeysRequest`
# @rtype: :class:`Tencentcloud::kms::V20190118::ListKeysResponse`
def ListKeys(request)
body = send_request('ListKeys', request.serialize)
response = JSON.parse(body)