tencentcloud-sdk-python-kms 3.0.1423__tar.gz → 3.0.1459__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/PKG-INFO +1 -1
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/setup.py +1 -1
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud/__init__.py +1 -1
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud/kms/v20190118/kms_client.py +68 -68
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud/kms/v20190118/models.py +544 -544
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud_sdk_python_kms.egg-info/PKG-INFO +1 -1
- tencentcloud-sdk-python-kms-3.0.1459/tencentcloud_sdk_python_kms.egg-info/requires.txt +1 -0
- tencentcloud-sdk-python-kms-3.0.1423/tencentcloud_sdk_python_kms.egg-info/requires.txt +0 -1
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/README.rst +0 -0
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/setup.cfg +0 -0
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud/kms/__init__.py +0 -0
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud/kms/v20190118/__init__.py +0 -0
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud/kms/v20190118/errorcodes.py +0 -0
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud_sdk_python_kms.egg-info/SOURCES.txt +0 -0
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud_sdk_python_kms.egg-info/dependency_links.txt +0 -0
- {tencentcloud-sdk-python-kms-3.0.1423 → tencentcloud-sdk-python-kms-3.0.1459}/tencentcloud_sdk_python_kms.egg-info/top_level.txt +0 -0
|
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
|
|
|
8
8
|
|
|
9
9
|
setup(
|
|
10
10
|
name='tencentcloud-sdk-python-kms',
|
|
11
|
-
install_requires=["tencentcloud-sdk-python-common>=3.0.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common>=3.0.1459,<4.0.0"],
|
|
12
12
|
version=tencentcloud.__version__,
|
|
13
13
|
description='Tencent Cloud Kms SDK for Python',
|
|
14
14
|
long_description=open('README.rst').read(),
|
|
@@ -27,7 +27,7 @@ class KmsClient(AbstractClient):
|
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
def ArchiveKey(self, request):
|
|
30
|
-
"""对密钥进行归档,被归档的密钥只能用于解密,不能加密
|
|
30
|
+
r"""对密钥进行归档,被归档的密钥只能用于解密,不能加密
|
|
31
31
|
|
|
32
32
|
:param request: Request instance for ArchiveKey.
|
|
33
33
|
:type request: :class:`tencentcloud.kms.v20190118.models.ArchiveKeyRequest`
|
|
@@ -50,7 +50,7 @@ class KmsClient(AbstractClient):
|
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
def AsymmetricRsaDecrypt(self, request):
|
|
53
|
-
"""使用指定的RSA非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。
|
|
53
|
+
r"""使用指定的RSA非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。
|
|
54
54
|
|
|
55
55
|
:param request: Request instance for AsymmetricRsaDecrypt.
|
|
56
56
|
:type request: :class:`tencentcloud.kms.v20190118.models.AsymmetricRsaDecryptRequest`
|
|
@@ -73,7 +73,7 @@ class KmsClient(AbstractClient):
|
|
|
73
73
|
|
|
74
74
|
|
|
75
75
|
def AsymmetricSm2Decrypt(self, request):
|
|
76
|
-
"""使用指定的SM2非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。传入的密文的长度不能超过256字节。
|
|
76
|
+
r"""使用指定的SM2非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。传入的密文的长度不能超过256字节。
|
|
77
77
|
|
|
78
78
|
:param request: Request instance for AsymmetricSm2Decrypt.
|
|
79
79
|
:type request: :class:`tencentcloud.kms.v20190118.models.AsymmetricSm2DecryptRequest`
|
|
@@ -96,7 +96,7 @@ class KmsClient(AbstractClient):
|
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
def BindCloudResource(self, request):
|
|
99
|
-
"""记录当前key被哪个云产品的那个资源所使用。如果当前key设置了自动过期,则取消该设置,确保当前key不会自动失效。如果当前关联关系已经创建,也返回成功。
|
|
99
|
+
r"""记录当前key被哪个云产品的那个资源所使用。如果当前key设置了自动过期,则取消该设置,确保当前key不会自动失效。如果当前关联关系已经创建,也返回成功。
|
|
100
100
|
|
|
101
101
|
:param request: Request instance for BindCloudResource.
|
|
102
102
|
:type request: :class:`tencentcloud.kms.v20190118.models.BindCloudResourceRequest`
|
|
@@ -119,7 +119,7 @@ class KmsClient(AbstractClient):
|
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
def CancelDataKeyDeletion(self, request):
|
|
122
|
-
"""取消计划删除数据密钥
|
|
122
|
+
r"""取消计划删除数据密钥
|
|
123
123
|
|
|
124
124
|
:param request: Request instance for CancelDataKeyDeletion.
|
|
125
125
|
:type request: :class:`tencentcloud.kms.v20190118.models.CancelDataKeyDeletionRequest`
|
|
@@ -142,7 +142,7 @@ class KmsClient(AbstractClient):
|
|
|
142
142
|
|
|
143
143
|
|
|
144
144
|
def CancelKeyArchive(self, request):
|
|
145
|
-
"""取消密钥归档,取消后密钥的状态变为Enabled。
|
|
145
|
+
r"""取消密钥归档,取消后密钥的状态变为Enabled。
|
|
146
146
|
|
|
147
147
|
:param request: Request instance for CancelKeyArchive.
|
|
148
148
|
:type request: :class:`tencentcloud.kms.v20190118.models.CancelKeyArchiveRequest`
|
|
@@ -165,7 +165,7 @@ class KmsClient(AbstractClient):
|
|
|
165
165
|
|
|
166
166
|
|
|
167
167
|
def CancelKeyDeletion(self, request):
|
|
168
|
-
"""取消CMK的计划删除操作
|
|
168
|
+
r"""取消CMK的计划删除操作
|
|
169
169
|
|
|
170
170
|
:param request: Request instance for CancelKeyDeletion.
|
|
171
171
|
:type request: :class:`tencentcloud.kms.v20190118.models.CancelKeyDeletionRequest`
|
|
@@ -188,7 +188,7 @@ class KmsClient(AbstractClient):
|
|
|
188
188
|
|
|
189
189
|
|
|
190
190
|
def CreateKey(self, request):
|
|
191
|
-
"""创建用户管理数据密钥的主密钥CMK(Custom Master Key)。
|
|
191
|
+
r"""创建用户管理数据密钥的主密钥CMK(Custom Master Key)。
|
|
192
192
|
|
|
193
193
|
:param request: Request instance for CreateKey.
|
|
194
194
|
:type request: :class:`tencentcloud.kms.v20190118.models.CreateKeyRequest`
|
|
@@ -211,7 +211,7 @@ class KmsClient(AbstractClient):
|
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
def CreateWhiteBoxKey(self, request):
|
|
214
|
-
"""创建白盒密钥。 密钥个数的上限为 50。
|
|
214
|
+
r"""创建白盒密钥。 密钥个数的上限为 50。
|
|
215
215
|
|
|
216
216
|
:param request: Request instance for CreateWhiteBoxKey.
|
|
217
217
|
:type request: :class:`tencentcloud.kms.v20190118.models.CreateWhiteBoxKeyRequest`
|
|
@@ -234,7 +234,7 @@ class KmsClient(AbstractClient):
|
|
|
234
234
|
|
|
235
235
|
|
|
236
236
|
def Decrypt(self, request):
|
|
237
|
-
"""本接口用于解密密文,得到明文数据。
|
|
237
|
+
r"""本接口用于解密密文,得到明文数据。
|
|
238
238
|
|
|
239
239
|
:param request: Request instance for Decrypt.
|
|
240
240
|
:type request: :class:`tencentcloud.kms.v20190118.models.DecryptRequest`
|
|
@@ -257,7 +257,7 @@ class KmsClient(AbstractClient):
|
|
|
257
257
|
|
|
258
258
|
|
|
259
259
|
def DeleteImportedKeyMaterial(self, request):
|
|
260
|
-
"""用于删除导入的密钥材料,仅对EXTERNAL类型的CMK有效,该接口将CMK设置为PendingImport 状态,并不会删除CMK,在重新进行密钥导入后可继续使用。彻底删除CMK请使用 ScheduleKeyDeletion 接口。
|
|
260
|
+
r"""用于删除导入的密钥材料,仅对EXTERNAL类型的CMK有效,该接口将CMK设置为PendingImport 状态,并不会删除CMK,在重新进行密钥导入后可继续使用。彻底删除CMK请使用 ScheduleKeyDeletion 接口。
|
|
261
261
|
|
|
262
262
|
:param request: Request instance for DeleteImportedKeyMaterial.
|
|
263
263
|
:type request: :class:`tencentcloud.kms.v20190118.models.DeleteImportedKeyMaterialRequest`
|
|
@@ -280,7 +280,7 @@ class KmsClient(AbstractClient):
|
|
|
280
280
|
|
|
281
281
|
|
|
282
282
|
def DeleteWhiteBoxKey(self, request):
|
|
283
|
-
"""删除白盒密钥, 注意:必须先禁用后,才可以删除。
|
|
283
|
+
r"""删除白盒密钥, 注意:必须先禁用后,才可以删除。
|
|
284
284
|
|
|
285
285
|
:param request: Request instance for DeleteWhiteBoxKey.
|
|
286
286
|
:type request: :class:`tencentcloud.kms.v20190118.models.DeleteWhiteBoxKeyRequest`
|
|
@@ -303,7 +303,7 @@ class KmsClient(AbstractClient):
|
|
|
303
303
|
|
|
304
304
|
|
|
305
305
|
def DescribeDataKey(self, request):
|
|
306
|
-
"""获取数据密钥的详情
|
|
306
|
+
r"""获取数据密钥的详情
|
|
307
307
|
|
|
308
308
|
:param request: Request instance for DescribeDataKey.
|
|
309
309
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeDataKeyRequest`
|
|
@@ -326,7 +326,7 @@ class KmsClient(AbstractClient):
|
|
|
326
326
|
|
|
327
327
|
|
|
328
328
|
def DescribeDataKeys(self, request):
|
|
329
|
-
"""返回数据密钥属性信息列表
|
|
329
|
+
r"""返回数据密钥属性信息列表
|
|
330
330
|
|
|
331
331
|
:param request: Request instance for DescribeDataKeys.
|
|
332
332
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeDataKeysRequest`
|
|
@@ -349,7 +349,7 @@ class KmsClient(AbstractClient):
|
|
|
349
349
|
|
|
350
350
|
|
|
351
351
|
def DescribeKey(self, request):
|
|
352
|
-
"""用于获取指定KeyId的主密钥属性详情信息。
|
|
352
|
+
r"""用于获取指定KeyId的主密钥属性详情信息。
|
|
353
353
|
|
|
354
354
|
:param request: Request instance for DescribeKey.
|
|
355
355
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeKeyRequest`
|
|
@@ -372,7 +372,7 @@ class KmsClient(AbstractClient):
|
|
|
372
372
|
|
|
373
373
|
|
|
374
374
|
def DescribeKeys(self, request):
|
|
375
|
-
"""该接口用于批量获取主密钥属性信息。
|
|
375
|
+
r"""该接口用于批量获取主密钥属性信息。
|
|
376
376
|
|
|
377
377
|
:param request: Request instance for DescribeKeys.
|
|
378
378
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeKeysRequest`
|
|
@@ -395,7 +395,7 @@ class KmsClient(AbstractClient):
|
|
|
395
395
|
|
|
396
396
|
|
|
397
397
|
def DescribeWhiteBoxDecryptKey(self, request):
|
|
398
|
-
"""获取白盒解密密钥
|
|
398
|
+
r"""获取白盒解密密钥
|
|
399
399
|
|
|
400
400
|
:param request: Request instance for DescribeWhiteBoxDecryptKey.
|
|
401
401
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeWhiteBoxDecryptKeyRequest`
|
|
@@ -418,7 +418,7 @@ class KmsClient(AbstractClient):
|
|
|
418
418
|
|
|
419
419
|
|
|
420
420
|
def DescribeWhiteBoxDeviceFingerprints(self, request):
|
|
421
|
-
"""获取指定密钥的设备指纹列表
|
|
421
|
+
r"""获取指定密钥的设备指纹列表
|
|
422
422
|
|
|
423
423
|
:param request: Request instance for DescribeWhiteBoxDeviceFingerprints.
|
|
424
424
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeWhiteBoxDeviceFingerprintsRequest`
|
|
@@ -441,7 +441,7 @@ class KmsClient(AbstractClient):
|
|
|
441
441
|
|
|
442
442
|
|
|
443
443
|
def DescribeWhiteBoxKey(self, request):
|
|
444
|
-
"""展示白盒密钥的信息
|
|
444
|
+
r"""展示白盒密钥的信息
|
|
445
445
|
|
|
446
446
|
:param request: Request instance for DescribeWhiteBoxKey.
|
|
447
447
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeWhiteBoxKeyRequest`
|
|
@@ -464,7 +464,7 @@ class KmsClient(AbstractClient):
|
|
|
464
464
|
|
|
465
465
|
|
|
466
466
|
def DescribeWhiteBoxKeyDetails(self, request):
|
|
467
|
-
"""获取白盒密钥列表
|
|
467
|
+
r"""获取白盒密钥列表
|
|
468
468
|
|
|
469
469
|
:param request: Request instance for DescribeWhiteBoxKeyDetails.
|
|
470
470
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeWhiteBoxKeyDetailsRequest`
|
|
@@ -487,7 +487,7 @@ class KmsClient(AbstractClient):
|
|
|
487
487
|
|
|
488
488
|
|
|
489
489
|
def DescribeWhiteBoxServiceStatus(self, request):
|
|
490
|
-
"""获取白盒密钥服务状态
|
|
490
|
+
r"""获取白盒密钥服务状态
|
|
491
491
|
|
|
492
492
|
:param request: Request instance for DescribeWhiteBoxServiceStatus.
|
|
493
493
|
:type request: :class:`tencentcloud.kms.v20190118.models.DescribeWhiteBoxServiceStatusRequest`
|
|
@@ -510,7 +510,7 @@ class KmsClient(AbstractClient):
|
|
|
510
510
|
|
|
511
511
|
|
|
512
512
|
def DisableDataKey(self, request):
|
|
513
|
-
"""禁用数据密钥
|
|
513
|
+
r"""禁用数据密钥
|
|
514
514
|
|
|
515
515
|
:param request: Request instance for DisableDataKey.
|
|
516
516
|
:type request: :class:`tencentcloud.kms.v20190118.models.DisableDataKeyRequest`
|
|
@@ -533,7 +533,7 @@ class KmsClient(AbstractClient):
|
|
|
533
533
|
|
|
534
534
|
|
|
535
535
|
def DisableDataKeys(self, request):
|
|
536
|
-
"""批量禁用数据密钥
|
|
536
|
+
r"""批量禁用数据密钥
|
|
537
537
|
|
|
538
538
|
:param request: Request instance for DisableDataKeys.
|
|
539
539
|
:type request: :class:`tencentcloud.kms.v20190118.models.DisableDataKeysRequest`
|
|
@@ -556,7 +556,7 @@ class KmsClient(AbstractClient):
|
|
|
556
556
|
|
|
557
557
|
|
|
558
558
|
def DisableKey(self, request):
|
|
559
|
-
"""本接口用于禁用一个主密钥,处于禁用状态的Key无法用于加密、解密操作。
|
|
559
|
+
r"""本接口用于禁用一个主密钥,处于禁用状态的Key无法用于加密、解密操作。
|
|
560
560
|
|
|
561
561
|
:param request: Request instance for DisableKey.
|
|
562
562
|
:type request: :class:`tencentcloud.kms.v20190118.models.DisableKeyRequest`
|
|
@@ -579,7 +579,7 @@ class KmsClient(AbstractClient):
|
|
|
579
579
|
|
|
580
580
|
|
|
581
581
|
def DisableKeyRotation(self, request):
|
|
582
|
-
"""对指定的CMK禁止密钥轮换功能。
|
|
582
|
+
r"""对指定的CMK禁止密钥轮换功能。
|
|
583
583
|
|
|
584
584
|
:param request: Request instance for DisableKeyRotation.
|
|
585
585
|
:type request: :class:`tencentcloud.kms.v20190118.models.DisableKeyRotationRequest`
|
|
@@ -602,7 +602,7 @@ class KmsClient(AbstractClient):
|
|
|
602
602
|
|
|
603
603
|
|
|
604
604
|
def DisableKeys(self, request):
|
|
605
|
-
"""该接口用于批量禁止CMK的使用。
|
|
605
|
+
r"""该接口用于批量禁止CMK的使用。
|
|
606
606
|
|
|
607
607
|
:param request: Request instance for DisableKeys.
|
|
608
608
|
:type request: :class:`tencentcloud.kms.v20190118.models.DisableKeysRequest`
|
|
@@ -625,7 +625,7 @@ class KmsClient(AbstractClient):
|
|
|
625
625
|
|
|
626
626
|
|
|
627
627
|
def DisableWhiteBoxKey(self, request):
|
|
628
|
-
"""禁用白盒密钥
|
|
628
|
+
r"""禁用白盒密钥
|
|
629
629
|
|
|
630
630
|
:param request: Request instance for DisableWhiteBoxKey.
|
|
631
631
|
:type request: :class:`tencentcloud.kms.v20190118.models.DisableWhiteBoxKeyRequest`
|
|
@@ -648,7 +648,7 @@ class KmsClient(AbstractClient):
|
|
|
648
648
|
|
|
649
649
|
|
|
650
650
|
def DisableWhiteBoxKeys(self, request):
|
|
651
|
-
"""批量禁用白盒密钥
|
|
651
|
+
r"""批量禁用白盒密钥
|
|
652
652
|
|
|
653
653
|
:param request: Request instance for DisableWhiteBoxKeys.
|
|
654
654
|
:type request: :class:`tencentcloud.kms.v20190118.models.DisableWhiteBoxKeysRequest`
|
|
@@ -671,7 +671,7 @@ class KmsClient(AbstractClient):
|
|
|
671
671
|
|
|
672
672
|
|
|
673
673
|
def EnableDataKey(self, request):
|
|
674
|
-
"""启用数据密钥
|
|
674
|
+
r"""启用数据密钥
|
|
675
675
|
|
|
676
676
|
:param request: Request instance for EnableDataKey.
|
|
677
677
|
:type request: :class:`tencentcloud.kms.v20190118.models.EnableDataKeyRequest`
|
|
@@ -694,7 +694,7 @@ class KmsClient(AbstractClient):
|
|
|
694
694
|
|
|
695
695
|
|
|
696
696
|
def EnableDataKeys(self, request):
|
|
697
|
-
"""批量启用数据密钥
|
|
697
|
+
r"""批量启用数据密钥
|
|
698
698
|
|
|
699
699
|
:param request: Request instance for EnableDataKeys.
|
|
700
700
|
:type request: :class:`tencentcloud.kms.v20190118.models.EnableDataKeysRequest`
|
|
@@ -717,7 +717,7 @@ class KmsClient(AbstractClient):
|
|
|
717
717
|
|
|
718
718
|
|
|
719
719
|
def EnableKey(self, request):
|
|
720
|
-
"""用于启用一个指定的CMK。
|
|
720
|
+
r"""用于启用一个指定的CMK。
|
|
721
721
|
|
|
722
722
|
:param request: Request instance for EnableKey.
|
|
723
723
|
:type request: :class:`tencentcloud.kms.v20190118.models.EnableKeyRequest`
|
|
@@ -740,7 +740,7 @@ class KmsClient(AbstractClient):
|
|
|
740
740
|
|
|
741
741
|
|
|
742
742
|
def EnableKeyRotation(self, request):
|
|
743
|
-
"""对指定的CMK开启密钥轮换功能。
|
|
743
|
+
r"""对指定的CMK开启密钥轮换功能。
|
|
744
744
|
|
|
745
745
|
:param request: Request instance for EnableKeyRotation.
|
|
746
746
|
:type request: :class:`tencentcloud.kms.v20190118.models.EnableKeyRotationRequest`
|
|
@@ -763,7 +763,7 @@ class KmsClient(AbstractClient):
|
|
|
763
763
|
|
|
764
764
|
|
|
765
765
|
def EnableKeys(self, request):
|
|
766
|
-
"""该接口用于批量启用CMK。
|
|
766
|
+
r"""该接口用于批量启用CMK。
|
|
767
767
|
|
|
768
768
|
:param request: Request instance for EnableKeys.
|
|
769
769
|
:type request: :class:`tencentcloud.kms.v20190118.models.EnableKeysRequest`
|
|
@@ -786,7 +786,7 @@ class KmsClient(AbstractClient):
|
|
|
786
786
|
|
|
787
787
|
|
|
788
788
|
def EnableWhiteBoxKey(self, request):
|
|
789
|
-
"""启用白盒密钥
|
|
789
|
+
r"""启用白盒密钥
|
|
790
790
|
|
|
791
791
|
:param request: Request instance for EnableWhiteBoxKey.
|
|
792
792
|
:type request: :class:`tencentcloud.kms.v20190118.models.EnableWhiteBoxKeyRequest`
|
|
@@ -809,7 +809,7 @@ class KmsClient(AbstractClient):
|
|
|
809
809
|
|
|
810
810
|
|
|
811
811
|
def EnableWhiteBoxKeys(self, request):
|
|
812
|
-
"""批量启用白盒密钥
|
|
812
|
+
r"""批量启用白盒密钥
|
|
813
813
|
|
|
814
814
|
:param request: Request instance for EnableWhiteBoxKeys.
|
|
815
815
|
:type request: :class:`tencentcloud.kms.v20190118.models.EnableWhiteBoxKeysRequest`
|
|
@@ -832,7 +832,7 @@ class KmsClient(AbstractClient):
|
|
|
832
832
|
|
|
833
833
|
|
|
834
834
|
def Encrypt(self, request):
|
|
835
|
-
"""本接口用于加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作
|
|
835
|
+
r"""本接口用于加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作
|
|
836
836
|
|
|
837
837
|
:param request: Request instance for Encrypt.
|
|
838
838
|
:type request: :class:`tencentcloud.kms.v20190118.models.EncryptRequest`
|
|
@@ -855,7 +855,7 @@ class KmsClient(AbstractClient):
|
|
|
855
855
|
|
|
856
856
|
|
|
857
857
|
def EncryptByWhiteBox(self, request):
|
|
858
|
-
"""使用白盒密钥进行加密
|
|
858
|
+
r"""使用白盒密钥进行加密
|
|
859
859
|
|
|
860
860
|
:param request: Request instance for EncryptByWhiteBox.
|
|
861
861
|
:type request: :class:`tencentcloud.kms.v20190118.models.EncryptByWhiteBoxRequest`
|
|
@@ -878,7 +878,7 @@ class KmsClient(AbstractClient):
|
|
|
878
878
|
|
|
879
879
|
|
|
880
880
|
def GenerateDataKey(self, request):
|
|
881
|
-
"""本接口生成一个数据密钥,您可以用这个密钥进行本地数据的加密。
|
|
881
|
+
r"""本接口生成一个数据密钥,您可以用这个密钥进行本地数据的加密。
|
|
882
882
|
|
|
883
883
|
:param request: Request instance for GenerateDataKey.
|
|
884
884
|
:type request: :class:`tencentcloud.kms.v20190118.models.GenerateDataKeyRequest`
|
|
@@ -901,7 +901,7 @@ class KmsClient(AbstractClient):
|
|
|
901
901
|
|
|
902
902
|
|
|
903
903
|
def GenerateRandom(self, request):
|
|
904
|
-
"""随机数生成接口。
|
|
904
|
+
r"""随机数生成接口。
|
|
905
905
|
|
|
906
906
|
:param request: Request instance for GenerateRandom.
|
|
907
907
|
:type request: :class:`tencentcloud.kms.v20190118.models.GenerateRandomRequest`
|
|
@@ -924,7 +924,7 @@ class KmsClient(AbstractClient):
|
|
|
924
924
|
|
|
925
925
|
|
|
926
926
|
def GetDataKeyCiphertextBlob(self, request):
|
|
927
|
-
"""下载数据密钥密文
|
|
927
|
+
r"""下载数据密钥密文
|
|
928
928
|
|
|
929
929
|
:param request: Request instance for GetDataKeyCiphertextBlob.
|
|
930
930
|
:type request: :class:`tencentcloud.kms.v20190118.models.GetDataKeyCiphertextBlobRequest`
|
|
@@ -947,7 +947,7 @@ class KmsClient(AbstractClient):
|
|
|
947
947
|
|
|
948
948
|
|
|
949
949
|
def GetDataKeyPlaintext(self, request):
|
|
950
|
-
"""获取数据密钥明文
|
|
950
|
+
r"""获取数据密钥明文
|
|
951
951
|
|
|
952
952
|
:param request: Request instance for GetDataKeyPlaintext.
|
|
953
953
|
:type request: :class:`tencentcloud.kms.v20190118.models.GetDataKeyPlaintextRequest`
|
|
@@ -970,7 +970,7 @@ class KmsClient(AbstractClient):
|
|
|
970
970
|
|
|
971
971
|
|
|
972
972
|
def GetKeyRotationStatus(self, request):
|
|
973
|
-
"""查询指定的CMK是否开启了密钥轮换功能。
|
|
973
|
+
r"""查询指定的CMK是否开启了密钥轮换功能。
|
|
974
974
|
|
|
975
975
|
:param request: Request instance for GetKeyRotationStatus.
|
|
976
976
|
:type request: :class:`tencentcloud.kms.v20190118.models.GetKeyRotationStatusRequest`
|
|
@@ -993,7 +993,7 @@ class KmsClient(AbstractClient):
|
|
|
993
993
|
|
|
994
994
|
|
|
995
995
|
def GetParametersForImport(self, request):
|
|
996
|
-
"""获取导入主密钥(CMK)材料的参数,返回的Token作为执行ImportKeyMaterial的参数之一,返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效,失效后如需重新导入,需要再次调用该接口获取新的Token和PublicKey。
|
|
996
|
+
r"""获取导入主密钥(CMK)材料的参数,返回的Token作为执行ImportKeyMaterial的参数之一,返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效,失效后如需重新导入,需要再次调用该接口获取新的Token和PublicKey。
|
|
997
997
|
|
|
998
998
|
:param request: Request instance for GetParametersForImport.
|
|
999
999
|
:type request: :class:`tencentcloud.kms.v20190118.models.GetParametersForImportRequest`
|
|
@@ -1016,7 +1016,7 @@ class KmsClient(AbstractClient):
|
|
|
1016
1016
|
|
|
1017
1017
|
|
|
1018
1018
|
def GetPublicKey(self, request):
|
|
1019
|
-
"""该接口用于获取非对称密钥的公钥信息,可用于本地数据加密或验签。只有处于Enabled状态的非对称密钥才可能获取公钥。
|
|
1019
|
+
r"""该接口用于获取非对称密钥的公钥信息,可用于本地数据加密或验签。只有处于Enabled状态的非对称密钥才可能获取公钥。
|
|
1020
1020
|
|
|
1021
1021
|
:param request: Request instance for GetPublicKey.
|
|
1022
1022
|
:type request: :class:`tencentcloud.kms.v20190118.models.GetPublicKeyRequest`
|
|
@@ -1039,7 +1039,7 @@ class KmsClient(AbstractClient):
|
|
|
1039
1039
|
|
|
1040
1040
|
|
|
1041
1041
|
def GetRegions(self, request):
|
|
1042
|
-
"""获取可以提供KMS服务的地域列表
|
|
1042
|
+
r"""获取可以提供KMS服务的地域列表
|
|
1043
1043
|
|
|
1044
1044
|
:param request: Request instance for GetRegions.
|
|
1045
1045
|
:type request: :class:`tencentcloud.kms.v20190118.models.GetRegionsRequest`
|
|
@@ -1062,7 +1062,7 @@ class KmsClient(AbstractClient):
|
|
|
1062
1062
|
|
|
1063
1063
|
|
|
1064
1064
|
def GetServiceStatus(self, request):
|
|
1065
|
-
"""用于查询该用户是否已开通KMS服务
|
|
1065
|
+
r"""用于查询该用户是否已开通KMS服务
|
|
1066
1066
|
|
|
1067
1067
|
:param request: Request instance for GetServiceStatus.
|
|
1068
1068
|
:type request: :class:`tencentcloud.kms.v20190118.models.GetServiceStatusRequest`
|
|
@@ -1085,7 +1085,7 @@ class KmsClient(AbstractClient):
|
|
|
1085
1085
|
|
|
1086
1086
|
|
|
1087
1087
|
def ImportDataKey(self, request):
|
|
1088
|
-
"""数据密钥导入接口,并托管到KMS
|
|
1088
|
+
r"""数据密钥导入接口,并托管到KMS
|
|
1089
1089
|
|
|
1090
1090
|
:param request: Request instance for ImportDataKey.
|
|
1091
1091
|
:type request: :class:`tencentcloud.kms.v20190118.models.ImportDataKeyRequest`
|
|
@@ -1108,7 +1108,7 @@ class KmsClient(AbstractClient):
|
|
|
1108
1108
|
|
|
1109
1109
|
|
|
1110
1110
|
def ImportKeyMaterial(self, request):
|
|
1111
|
-
"""用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入,导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料,并重新指定过期时间,但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后,指定的CMK将无法使用,需要再次导入相同的密钥材料才能正常使用。CMK是独立的,同样的密钥材料可导入不同的 CMK 中,但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。
|
|
1111
|
+
r"""用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入,导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料,并重新指定过期时间,但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后,指定的CMK将无法使用,需要再次导入相同的密钥材料才能正常使用。CMK是独立的,同样的密钥材料可导入不同的 CMK 中,但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。
|
|
1112
1112
|
只有Enabled 和 PendingImport状态的CMK可以导入密钥材料。
|
|
1113
1113
|
|
|
1114
1114
|
:param request: Request instance for ImportKeyMaterial.
|
|
@@ -1132,7 +1132,7 @@ class KmsClient(AbstractClient):
|
|
|
1132
1132
|
|
|
1133
1133
|
|
|
1134
1134
|
def ListAlgorithms(self, request):
|
|
1135
|
-
"""列出当前Region支持的加密方式
|
|
1135
|
+
r"""列出当前Region支持的加密方式
|
|
1136
1136
|
|
|
1137
1137
|
:param request: Request instance for ListAlgorithms.
|
|
1138
1138
|
:type request: :class:`tencentcloud.kms.v20190118.models.ListAlgorithmsRequest`
|
|
@@ -1155,7 +1155,7 @@ class KmsClient(AbstractClient):
|
|
|
1155
1155
|
|
|
1156
1156
|
|
|
1157
1157
|
def ListDataKeyDetail(self, request):
|
|
1158
|
-
"""根据指定Offset和Limit获取数据密钥列表详情。
|
|
1158
|
+
r"""根据指定Offset和Limit获取数据密钥列表详情。
|
|
1159
1159
|
|
|
1160
1160
|
:param request: Request instance for ListDataKeyDetail.
|
|
1161
1161
|
:type request: :class:`tencentcloud.kms.v20190118.models.ListDataKeyDetailRequest`
|
|
@@ -1178,7 +1178,7 @@ class KmsClient(AbstractClient):
|
|
|
1178
1178
|
|
|
1179
1179
|
|
|
1180
1180
|
def ListDataKeys(self, request):
|
|
1181
|
-
"""用于查询数据密钥的列表
|
|
1181
|
+
r"""用于查询数据密钥的列表
|
|
1182
1182
|
|
|
1183
1183
|
:param request: Request instance for ListDataKeys.
|
|
1184
1184
|
:type request: :class:`tencentcloud.kms.v20190118.models.ListDataKeysRequest`
|
|
@@ -1201,7 +1201,7 @@ class KmsClient(AbstractClient):
|
|
|
1201
1201
|
|
|
1202
1202
|
|
|
1203
1203
|
def ListKeyDetail(self, request):
|
|
1204
|
-
"""根据指定Offset和Limit获取主密钥列表详情。
|
|
1204
|
+
r"""根据指定Offset和Limit获取主密钥列表详情。
|
|
1205
1205
|
|
|
1206
1206
|
:param request: Request instance for ListKeyDetail.
|
|
1207
1207
|
:type request: :class:`tencentcloud.kms.v20190118.models.ListKeyDetailRequest`
|
|
@@ -1224,7 +1224,7 @@ class KmsClient(AbstractClient):
|
|
|
1224
1224
|
|
|
1225
1225
|
|
|
1226
1226
|
def ListKeys(self, request):
|
|
1227
|
-
"""列出账号下面状态为Enabled, Disabled 和 PendingImport 的CMK KeyId 列表
|
|
1227
|
+
r"""列出账号下面状态为Enabled, Disabled 和 PendingImport 的CMK KeyId 列表
|
|
1228
1228
|
|
|
1229
1229
|
:param request: Request instance for ListKeys.
|
|
1230
1230
|
:type request: :class:`tencentcloud.kms.v20190118.models.ListKeysRequest`
|
|
@@ -1247,7 +1247,7 @@ class KmsClient(AbstractClient):
|
|
|
1247
1247
|
|
|
1248
1248
|
|
|
1249
1249
|
def OverwriteWhiteBoxDeviceFingerprints(self, request):
|
|
1250
|
-
"""覆盖指定密钥的设备指纹信息
|
|
1250
|
+
r"""覆盖指定密钥的设备指纹信息
|
|
1251
1251
|
|
|
1252
1252
|
:param request: Request instance for OverwriteWhiteBoxDeviceFingerprints.
|
|
1253
1253
|
:type request: :class:`tencentcloud.kms.v20190118.models.OverwriteWhiteBoxDeviceFingerprintsRequest`
|
|
@@ -1270,7 +1270,7 @@ class KmsClient(AbstractClient):
|
|
|
1270
1270
|
|
|
1271
1271
|
|
|
1272
1272
|
def PostQuantumCryptoDecrypt(self, request):
|
|
1273
|
-
"""本接口使用后量子密码算法密钥,解密密文,并得到明文数据。
|
|
1273
|
+
r"""本接口使用后量子密码算法密钥,解密密文,并得到明文数据。
|
|
1274
1274
|
|
|
1275
1275
|
:param request: Request instance for PostQuantumCryptoDecrypt.
|
|
1276
1276
|
:type request: :class:`tencentcloud.kms.v20190118.models.PostQuantumCryptoDecryptRequest`
|
|
@@ -1293,7 +1293,7 @@ class KmsClient(AbstractClient):
|
|
|
1293
1293
|
|
|
1294
1294
|
|
|
1295
1295
|
def PostQuantumCryptoEncrypt(self, request):
|
|
1296
|
-
"""本接口使用后量子密码算法密钥,可加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作。
|
|
1296
|
+
r"""本接口使用后量子密码算法密钥,可加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作。
|
|
1297
1297
|
|
|
1298
1298
|
:param request: Request instance for PostQuantumCryptoEncrypt.
|
|
1299
1299
|
:type request: :class:`tencentcloud.kms.v20190118.models.PostQuantumCryptoEncryptRequest`
|
|
@@ -1316,7 +1316,7 @@ class KmsClient(AbstractClient):
|
|
|
1316
1316
|
|
|
1317
1317
|
|
|
1318
1318
|
def PostQuantumCryptoSign(self, request):
|
|
1319
|
-
"""使用后量子密码算法签名验签密钥进行签名。
|
|
1319
|
+
r"""使用后量子密码算法签名验签密钥进行签名。
|
|
1320
1320
|
|
|
1321
1321
|
:param request: Request instance for PostQuantumCryptoSign.
|
|
1322
1322
|
:type request: :class:`tencentcloud.kms.v20190118.models.PostQuantumCryptoSignRequest`
|
|
@@ -1339,7 +1339,7 @@ class KmsClient(AbstractClient):
|
|
|
1339
1339
|
|
|
1340
1340
|
|
|
1341
1341
|
def PostQuantumCryptoVerify(self, request):
|
|
1342
|
-
"""使用后量子密码算法密钥对签名进行验证。
|
|
1342
|
+
r"""使用后量子密码算法密钥对签名进行验证。
|
|
1343
1343
|
|
|
1344
1344
|
:param request: Request instance for PostQuantumCryptoVerify.
|
|
1345
1345
|
:type request: :class:`tencentcloud.kms.v20190118.models.PostQuantumCryptoVerifyRequest`
|
|
@@ -1362,7 +1362,7 @@ class KmsClient(AbstractClient):
|
|
|
1362
1362
|
|
|
1363
1363
|
|
|
1364
1364
|
def ReEncrypt(self, request):
|
|
1365
|
-
"""使用指定CMK对密文重新加密。
|
|
1365
|
+
r"""使用指定CMK对密文重新加密。
|
|
1366
1366
|
|
|
1367
1367
|
:param request: Request instance for ReEncrypt.
|
|
1368
1368
|
:type request: :class:`tencentcloud.kms.v20190118.models.ReEncryptRequest`
|
|
@@ -1385,7 +1385,7 @@ class KmsClient(AbstractClient):
|
|
|
1385
1385
|
|
|
1386
1386
|
|
|
1387
1387
|
def ScheduleDataKeyDeletion(self, request):
|
|
1388
|
-
"""计划删除数据密钥
|
|
1388
|
+
r"""计划删除数据密钥
|
|
1389
1389
|
|
|
1390
1390
|
:param request: Request instance for ScheduleDataKeyDeletion.
|
|
1391
1391
|
:type request: :class:`tencentcloud.kms.v20190118.models.ScheduleDataKeyDeletionRequest`
|
|
@@ -1408,7 +1408,7 @@ class KmsClient(AbstractClient):
|
|
|
1408
1408
|
|
|
1409
1409
|
|
|
1410
1410
|
def ScheduleKeyDeletion(self, request):
|
|
1411
|
-
"""CMK计划删除接口,用于指定CMK删除的时间,可选时间区间为[7,30]天
|
|
1411
|
+
r"""CMK计划删除接口,用于指定CMK删除的时间,可选时间区间为[7,30]天
|
|
1412
1412
|
|
|
1413
1413
|
:param request: Request instance for ScheduleKeyDeletion.
|
|
1414
1414
|
:type request: :class:`tencentcloud.kms.v20190118.models.ScheduleKeyDeletionRequest`
|
|
@@ -1431,7 +1431,7 @@ class KmsClient(AbstractClient):
|
|
|
1431
1431
|
|
|
1432
1432
|
|
|
1433
1433
|
def SignByAsymmetricKey(self, request):
|
|
1434
|
-
"""非对称密钥签名。
|
|
1434
|
+
r"""非对称密钥签名。
|
|
1435
1435
|
注意:只有 KeyUsage 为 ASYMMETRIC_SIGN_VERIFY_SM2、ASYMMETRIC_SIGN_VERIFY_ECC 或其他支持的 ASYMMETRIC_SIGN_VERIFY_${ALGORITHM} 的密钥才可以使用签名功能。
|
|
1436
1436
|
|
|
1437
1437
|
:param request: Request instance for SignByAsymmetricKey.
|
|
@@ -1455,7 +1455,7 @@ class KmsClient(AbstractClient):
|
|
|
1455
1455
|
|
|
1456
1456
|
|
|
1457
1457
|
def UnbindCloudResource(self, request):
|
|
1458
|
-
"""删除指定(key, 资源,云产品)的记录,以表明:指定的云产品的资源已不再使用当前的key。
|
|
1458
|
+
r"""删除指定(key, 资源,云产品)的记录,以表明:指定的云产品的资源已不再使用当前的key。
|
|
1459
1459
|
|
|
1460
1460
|
:param request: Request instance for UnbindCloudResource.
|
|
1461
1461
|
:type request: :class:`tencentcloud.kms.v20190118.models.UnbindCloudResourceRequest`
|
|
@@ -1478,7 +1478,7 @@ class KmsClient(AbstractClient):
|
|
|
1478
1478
|
|
|
1479
1479
|
|
|
1480
1480
|
def UpdateAlias(self, request):
|
|
1481
|
-
"""用于修改CMK的别名。对于处于PendingDelete状态的CMK禁止修改。
|
|
1481
|
+
r"""用于修改CMK的别名。对于处于PendingDelete状态的CMK禁止修改。
|
|
1482
1482
|
|
|
1483
1483
|
:param request: Request instance for UpdateAlias.
|
|
1484
1484
|
:type request: :class:`tencentcloud.kms.v20190118.models.UpdateAliasRequest`
|
|
@@ -1501,7 +1501,7 @@ class KmsClient(AbstractClient):
|
|
|
1501
1501
|
|
|
1502
1502
|
|
|
1503
1503
|
def UpdateDataKeyDescription(self, request):
|
|
1504
|
-
"""修改数据密钥描述
|
|
1504
|
+
r"""修改数据密钥描述
|
|
1505
1505
|
|
|
1506
1506
|
:param request: Request instance for UpdateDataKeyDescription.
|
|
1507
1507
|
:type request: :class:`tencentcloud.kms.v20190118.models.UpdateDataKeyDescriptionRequest`
|
|
@@ -1524,7 +1524,7 @@ class KmsClient(AbstractClient):
|
|
|
1524
1524
|
|
|
1525
1525
|
|
|
1526
1526
|
def UpdateDataKeyName(self, request):
|
|
1527
|
-
"""修改数据密钥名称
|
|
1527
|
+
r"""修改数据密钥名称
|
|
1528
1528
|
|
|
1529
1529
|
:param request: Request instance for UpdateDataKeyName.
|
|
1530
1530
|
:type request: :class:`tencentcloud.kms.v20190118.models.UpdateDataKeyNameRequest`
|
|
@@ -1547,7 +1547,7 @@ class KmsClient(AbstractClient):
|
|
|
1547
1547
|
|
|
1548
1548
|
|
|
1549
1549
|
def UpdateKeyDescription(self, request):
|
|
1550
|
-
"""该接口用于对指定的cmk修改描述信息。对于处于PendingDelete状态的CMK禁止修改。
|
|
1550
|
+
r"""该接口用于对指定的cmk修改描述信息。对于处于PendingDelete状态的CMK禁止修改。
|
|
1551
1551
|
|
|
1552
1552
|
:param request: Request instance for UpdateKeyDescription.
|
|
1553
1553
|
:type request: :class:`tencentcloud.kms.v20190118.models.UpdateKeyDescriptionRequest`
|
|
@@ -1570,7 +1570,7 @@ class KmsClient(AbstractClient):
|
|
|
1570
1570
|
|
|
1571
1571
|
|
|
1572
1572
|
def VerifyByAsymmetricKey(self, request):
|
|
1573
|
-
"""使用非对称密钥验签
|
|
1573
|
+
r"""使用非对称密钥验签
|
|
1574
1574
|
|
|
1575
1575
|
:param request: Request instance for VerifyByAsymmetricKey.
|
|
1576
1576
|
:type request: :class:`tencentcloud.kms.v20190118.models.VerifyByAsymmetricKeyRequest`
|