tencentcloud-sdk-nodejs-kms 4.0.618 → 4.0.620
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.
- package/CHANGELOG.md +487 -0
- package/SERVICE_CHANGELOG.md +478 -156
- package/package.json +1 -1
- package/products.md +30 -30
- package/src/services/kms/v20190118/kms_models.ts +56 -230
- package/tencentcloud/services/kms/v20190118/kms_models.d.ts +56 -56
|
@@ -23,7 +23,6 @@ export interface UpdateAliasRequest {
|
|
|
23
23
|
* 新的别名,1-60个字符或数字的组合
|
|
24
24
|
*/
|
|
25
25
|
Alias: string
|
|
26
|
-
|
|
27
26
|
/**
|
|
28
27
|
* CMK的全局唯一标识符
|
|
29
28
|
*/
|
|
@@ -48,12 +47,10 @@ export interface AsymmetricRsaDecryptRequest {
|
|
|
48
47
|
* CMK的唯一标识
|
|
49
48
|
*/
|
|
50
49
|
KeyId: string
|
|
51
|
-
|
|
52
50
|
/**
|
|
53
51
|
* 使用PublicKey加密的密文,Base64编码
|
|
54
52
|
*/
|
|
55
53
|
Ciphertext: string
|
|
56
|
-
|
|
57
54
|
/**
|
|
58
55
|
* 在使用公钥加密时对应的算法:当前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256
|
|
59
56
|
*/
|
|
@@ -68,7 +65,6 @@ export interface EnableKeyRotationRequest {
|
|
|
68
65
|
* CMK唯一标识符
|
|
69
66
|
*/
|
|
70
67
|
KeyId: string
|
|
71
|
-
|
|
72
68
|
/**
|
|
73
69
|
* 密钥轮转周期,单位天,允许范围 7 ~ 365,默认值 365。
|
|
74
70
|
*/
|
|
@@ -83,13 +79,11 @@ export interface DescribeWhiteBoxKeyDetailsResponse {
|
|
|
83
79
|
* 白盒密钥信息列表。
|
|
84
80
|
*/
|
|
85
81
|
KeyInfos: Array<WhiteboxKeyInfo>
|
|
86
|
-
|
|
87
82
|
/**
|
|
88
|
-
|
|
83
|
+
* 白盒密钥总数。
|
|
89
84
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
90
|
-
|
|
85
|
+
*/
|
|
91
86
|
TotalCount: number
|
|
92
|
-
|
|
93
87
|
/**
|
|
94
88
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
95
89
|
*/
|
|
@@ -104,27 +98,22 @@ export interface CreateKeyRequest {
|
|
|
104
98
|
* 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。以 kms- 作为前缀的用于云产品使用,Alias 不可重复。
|
|
105
99
|
*/
|
|
106
100
|
Alias: string
|
|
107
|
-
|
|
108
101
|
/**
|
|
109
102
|
* CMK 的描述,最大1024字节
|
|
110
103
|
*/
|
|
111
104
|
Description?: string
|
|
112
|
-
|
|
113
105
|
/**
|
|
114
106
|
* 指定key的用途,默认为 "ENCRYPT_DECRYPT" 表示创建对称加解密密钥,其它支持用途 “ASYMMETRIC_DECRYPT_RSA_2048” 表示创建用于加解密的RSA2048非对称密钥,“ASYMMETRIC_DECRYPT_SM2” 表示创建用于加解密的SM2非对称密钥,“ASYMMETRIC_SIGN_VERIFY_SM2” 表示创建用于签名验签的SM2非对称密钥,“ASYMMETRIC_SIGN_VERIFY_ECC” 表示创建用于签名验签的ECC非对称密钥,“ASYMMETRIC_SIGN_VERIFY_RSA_2048” 表示创建用于签名验签的RSA_2048非对称密钥,“ASYMMETRIC_SIGN_VERIFY_ECDSA384”表示创建用于签名验签的 ECDSA384 非对称秘钥。完整的秘钥用途与算法支持列表可通过 ListAlgorithms 接口获取。
|
|
115
107
|
*/
|
|
116
108
|
KeyUsage?: string
|
|
117
|
-
|
|
118
109
|
/**
|
|
119
110
|
* 指定key类型,默认为1,1表示默认类型,由KMS创建CMK密钥,2 表示EXTERNAL 类型,该类型需要用户导入密钥材料,参考 GetParametersForImport 和 ImportKeyMaterial 接口
|
|
120
111
|
*/
|
|
121
112
|
Type?: number
|
|
122
|
-
|
|
123
113
|
/**
|
|
124
114
|
* 标签列表
|
|
125
115
|
*/
|
|
126
116
|
Tags?: Array<Tag>
|
|
127
|
-
|
|
128
117
|
/**
|
|
129
118
|
* KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
|
|
130
119
|
*/
|
|
@@ -164,22 +153,18 @@ export interface VerifyByAsymmetricKeyRequest {
|
|
|
164
153
|
* 密钥的唯一标识
|
|
165
154
|
*/
|
|
166
155
|
KeyId: string
|
|
167
|
-
|
|
168
156
|
/**
|
|
169
157
|
* 签名值,通过调用KMS签名接口生成
|
|
170
158
|
*/
|
|
171
159
|
SignatureValue: string
|
|
172
|
-
|
|
173
160
|
/**
|
|
174
161
|
* 消息原文或消息摘要。如果提供的是消息原文,则消息原文的长度(Base64编码前的长度)不超过4096字节。如果提供的是消息摘要,则消息摘要长度(Base64编码前的长度)必须等于32字节
|
|
175
162
|
*/
|
|
176
163
|
Message: string
|
|
177
|
-
|
|
178
164
|
/**
|
|
179
165
|
* 签名算法,支持的算法:SM2DSA,ECC_P256_R1,RSA_PSS_SHA_256,RSA_PKCS1_SHA_256 等。更多支持的算法可通过 ListAlgorithms 接口进行查询。
|
|
180
166
|
*/
|
|
181
167
|
Algorithm: string
|
|
182
|
-
|
|
183
168
|
/**
|
|
184
169
|
* 消息类型:RAW,DIGEST,如果不传,默认为RAW,表示消息原文。
|
|
185
170
|
*/
|
|
@@ -204,61 +189,50 @@ export interface WhiteboxKeyInfo {
|
|
|
204
189
|
* 白盒密钥的全局唯一标识符
|
|
205
190
|
*/
|
|
206
191
|
KeyId: string
|
|
207
|
-
|
|
208
192
|
/**
|
|
209
193
|
* 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字. 不可重复
|
|
210
194
|
*/
|
|
211
195
|
Alias: string
|
|
212
|
-
|
|
213
196
|
/**
|
|
214
197
|
* 创建者
|
|
215
198
|
*/
|
|
216
199
|
CreatorUin: number
|
|
217
|
-
|
|
218
200
|
/**
|
|
219
201
|
* 密钥的描述信息
|
|
220
202
|
*/
|
|
221
203
|
Description: string
|
|
222
|
-
|
|
223
204
|
/**
|
|
224
205
|
* 密钥创建时间,Unix时间戳
|
|
225
206
|
*/
|
|
226
207
|
CreateTime: number
|
|
227
|
-
|
|
228
208
|
/**
|
|
229
209
|
* 白盒密钥的状态, 取值为:Enabled | Disabled
|
|
230
210
|
*/
|
|
231
211
|
Status: string
|
|
232
|
-
|
|
233
212
|
/**
|
|
234
213
|
* 创建者
|
|
235
214
|
*/
|
|
236
215
|
OwnerUin: number
|
|
237
|
-
|
|
238
216
|
/**
|
|
239
217
|
* 密钥所用的算法类型
|
|
240
218
|
*/
|
|
241
219
|
Algorithm: string
|
|
242
|
-
|
|
243
220
|
/**
|
|
244
221
|
* 白盒加密密钥,base64编码
|
|
245
222
|
*/
|
|
246
223
|
EncryptKey: string
|
|
247
|
-
|
|
248
224
|
/**
|
|
249
225
|
* 白盒解密密钥,base64编码
|
|
250
226
|
*/
|
|
251
227
|
DecryptKey: string
|
|
252
|
-
|
|
253
228
|
/**
|
|
254
229
|
* 资源ID,格式:creatorUin/$creatorUin/$keyId
|
|
255
230
|
*/
|
|
256
231
|
ResourceId: string
|
|
257
|
-
|
|
258
232
|
/**
|
|
259
|
-
|
|
233
|
+
* 是否有设备指纹与当前密钥绑定
|
|
260
234
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
261
|
-
|
|
235
|
+
*/
|
|
262
236
|
DeviceFingerprintBind: boolean
|
|
263
237
|
}
|
|
264
238
|
|
|
@@ -270,17 +244,14 @@ export interface ListAlgorithmsResponse {
|
|
|
270
244
|
* 本地区支持的对称加密算法
|
|
271
245
|
*/
|
|
272
246
|
SymmetricAlgorithms: Array<AlgorithmInfo>
|
|
273
|
-
|
|
274
247
|
/**
|
|
275
248
|
* 本地区支持的非对称加密算法
|
|
276
249
|
*/
|
|
277
250
|
AsymmetricAlgorithms: Array<AlgorithmInfo>
|
|
278
|
-
|
|
279
251
|
/**
|
|
280
252
|
* 本地区支持的非对称签名验签算法
|
|
281
253
|
*/
|
|
282
254
|
AsymmetricSignVerifyAlgorithms: Array<AlgorithmInfo>
|
|
283
|
-
|
|
284
255
|
/**
|
|
285
256
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
286
257
|
*/
|
|
@@ -305,7 +276,6 @@ export interface DescribeWhiteBoxKeyResponse {
|
|
|
305
276
|
* 白盒密钥信息
|
|
306
277
|
*/
|
|
307
278
|
KeyInfo: WhiteboxKeyInfo
|
|
308
|
-
|
|
309
279
|
/**
|
|
310
280
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
311
281
|
*/
|
|
@@ -330,7 +300,6 @@ export interface DescribeWhiteBoxServiceStatusResponse {
|
|
|
330
300
|
* 用户的白盒密钥服务是否可用
|
|
331
301
|
*/
|
|
332
302
|
ServiceEnabled: boolean
|
|
333
|
-
|
|
334
303
|
/**
|
|
335
304
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
336
305
|
*/
|
|
@@ -345,17 +314,14 @@ export interface ImportKeyMaterialRequest {
|
|
|
345
314
|
* 使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS,导入的密钥材料长度要求为 128 bit,FIPS版本region的KMS, 导入的密钥材料长度要求为 256 bit。
|
|
346
315
|
*/
|
|
347
316
|
EncryptedKeyMaterial: string
|
|
348
|
-
|
|
349
317
|
/**
|
|
350
318
|
* 通过调用GetParametersForImport获得的导入令牌。
|
|
351
319
|
*/
|
|
352
320
|
ImportToken: string
|
|
353
|
-
|
|
354
321
|
/**
|
|
355
322
|
* 指定导入密钥材料的CMK,需要和GetParametersForImport 指定的CMK相同。
|
|
356
323
|
*/
|
|
357
324
|
KeyId: string
|
|
358
|
-
|
|
359
325
|
/**
|
|
360
326
|
* 密钥材料过期时间 unix 时间戳,不指定或者 0 表示密钥材料不会过期,若指定过期时间,需要大于当前时间点,最大支持 2147443200。
|
|
361
327
|
*/
|
|
@@ -395,7 +361,6 @@ export interface Tag {
|
|
|
395
361
|
* 标签键
|
|
396
362
|
*/
|
|
397
363
|
TagKey: string
|
|
398
|
-
|
|
399
364
|
/**
|
|
400
365
|
* 标签值
|
|
401
366
|
*/
|
|
@@ -410,13 +375,11 @@ export interface ListKeyDetailResponse {
|
|
|
410
375
|
* CMK的总数量
|
|
411
376
|
*/
|
|
412
377
|
TotalCount: number
|
|
413
|
-
|
|
414
378
|
/**
|
|
415
|
-
|
|
379
|
+
* 返回的属性信息列表。
|
|
416
380
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
417
|
-
|
|
381
|
+
*/
|
|
418
382
|
KeyMetadatas: Array<KeyMetadata>
|
|
419
|
-
|
|
420
383
|
/**
|
|
421
384
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
422
385
|
*/
|
|
@@ -431,27 +394,22 @@ export interface GenerateDataKeyRequest {
|
|
|
431
394
|
* CMK全局唯一标识符
|
|
432
395
|
*/
|
|
433
396
|
KeyId: string
|
|
434
|
-
|
|
435
397
|
/**
|
|
436
398
|
* 指定生成Datakey的加密算法以及Datakey大小,AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
|
|
437
399
|
*/
|
|
438
400
|
KeySpec?: string
|
|
439
|
-
|
|
440
401
|
/**
|
|
441
402
|
* 生成的DataKey的长度,同时指定NumberOfBytes和KeySpec时,以NumberOfBytes为准。最小值为1, 最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
|
|
442
403
|
*/
|
|
443
404
|
NumberOfBytes?: number
|
|
444
|
-
|
|
445
405
|
/**
|
|
446
406
|
* key/value对的json字符串,如果使用该字段,则返回的DataKey在解密时需要填入相同的字符串
|
|
447
407
|
*/
|
|
448
408
|
EncryptionContext?: string
|
|
449
|
-
|
|
450
409
|
/**
|
|
451
410
|
* PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
|
|
452
411
|
*/
|
|
453
412
|
EncryptionPublicKey?: string
|
|
454
|
-
|
|
455
413
|
/**
|
|
456
414
|
* 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
|
|
457
415
|
*/
|
|
@@ -476,12 +434,10 @@ export interface ScheduleKeyDeletionResponse {
|
|
|
476
434
|
* 计划删除执行时间
|
|
477
435
|
*/
|
|
478
436
|
DeletionDate: number
|
|
479
|
-
|
|
480
437
|
/**
|
|
481
438
|
* 唯一标志被计划删除的CMK
|
|
482
439
|
*/
|
|
483
440
|
KeyId: string
|
|
484
|
-
|
|
485
441
|
/**
|
|
486
442
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
487
443
|
*/
|
|
@@ -496,12 +452,10 @@ export interface PostQuantumCryptoVerifyRequest {
|
|
|
496
452
|
* 密钥的唯一标识
|
|
497
453
|
*/
|
|
498
454
|
KeyId: string
|
|
499
|
-
|
|
500
455
|
/**
|
|
501
456
|
* 签名值,通过调用KMS PostQuantumCryptoSign签名接口生成
|
|
502
457
|
*/
|
|
503
458
|
SignatureValue: string
|
|
504
|
-
|
|
505
459
|
/**
|
|
506
460
|
* Base64 编码的消息原文,消息原文的长度(Base64编码前的长度)不超过4096字节。
|
|
507
461
|
*/
|
|
@@ -516,7 +470,6 @@ export interface GenerateRandomResponse {
|
|
|
516
470
|
* 生成的随机数的明文,该明文使用base64编码,用户需要使用base64解码得到明文。
|
|
517
471
|
*/
|
|
518
472
|
Plaintext: string
|
|
519
|
-
|
|
520
473
|
/**
|
|
521
474
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
522
475
|
*/
|
|
@@ -576,7 +529,6 @@ export interface VerifyByAsymmetricKeyResponse {
|
|
|
576
529
|
* 签名是否有效。true:签名有效,false:签名无效。
|
|
577
530
|
*/
|
|
578
531
|
SignatureValid: boolean
|
|
579
|
-
|
|
580
532
|
/**
|
|
581
533
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
582
534
|
*/
|
|
@@ -601,22 +553,18 @@ export interface GetParametersForImportResponse {
|
|
|
601
553
|
* CMK的唯一标识,用于指定目标导入密钥材料的CMK。
|
|
602
554
|
*/
|
|
603
555
|
KeyId: string
|
|
604
|
-
|
|
605
556
|
/**
|
|
606
557
|
* 导入密钥材料需要的token,用于作为 ImportKeyMaterial 的参数。
|
|
607
558
|
*/
|
|
608
559
|
ImportToken: string
|
|
609
|
-
|
|
610
560
|
/**
|
|
611
561
|
* 用于加密密钥材料的RSA公钥,base64编码。使用PublicKey base64解码后的公钥将导入密钥进行加密后作为 ImportKeyMaterial 的参数。
|
|
612
562
|
*/
|
|
613
563
|
PublicKey: string
|
|
614
|
-
|
|
615
564
|
/**
|
|
616
565
|
* 该导出token和公钥的有效期,超过该时间后无法导入,需要重新调用GetParametersForImport获取。
|
|
617
566
|
*/
|
|
618
567
|
ParametersValidTo: number
|
|
619
|
-
|
|
620
568
|
/**
|
|
621
569
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
622
570
|
*/
|
|
@@ -631,13 +579,11 @@ export interface DecryptResponse {
|
|
|
631
579
|
* CMK的全局唯一标识
|
|
632
580
|
*/
|
|
633
581
|
KeyId: string
|
|
634
|
-
|
|
635
582
|
/**
|
|
636
|
-
|
|
583
|
+
* 若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。
|
|
637
584
|
若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。
|
|
638
|
-
|
|
585
|
+
*/
|
|
639
586
|
Plaintext: string
|
|
640
|
-
|
|
641
587
|
/**
|
|
642
588
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
643
589
|
*/
|
|
@@ -652,29 +598,24 @@ export interface CreateWhiteBoxKeyResponse {
|
|
|
652
598
|
* 用于加密的密钥,base64编码
|
|
653
599
|
*/
|
|
654
600
|
EncryptKey: string
|
|
655
|
-
|
|
656
601
|
/**
|
|
657
602
|
* 用于解密的密钥,base64编码
|
|
658
603
|
*/
|
|
659
604
|
DecryptKey: string
|
|
660
|
-
|
|
661
605
|
/**
|
|
662
606
|
* 白盒密钥的全局唯一标识符
|
|
663
607
|
*/
|
|
664
608
|
KeyId: string
|
|
665
|
-
|
|
666
609
|
/**
|
|
667
|
-
|
|
610
|
+
* 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误
|
|
668
611
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
669
|
-
|
|
612
|
+
*/
|
|
670
613
|
TagCode: number
|
|
671
|
-
|
|
672
614
|
/**
|
|
673
|
-
|
|
615
|
+
* 标签操作的返回信息
|
|
674
616
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
675
|
-
|
|
617
|
+
*/
|
|
676
618
|
TagMsg: string
|
|
677
|
-
|
|
678
619
|
/**
|
|
679
620
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
680
621
|
*/
|
|
@@ -729,12 +670,10 @@ export interface EncryptByWhiteBoxResponse {
|
|
|
729
670
|
* 初始化向量,加密算法会使用到, base64编码。如果由调用方在入参中传入,则原样返回。如果调用方没有传入,则后端服务随机生成,并返回
|
|
730
671
|
*/
|
|
731
672
|
InitializationVector: string
|
|
732
|
-
|
|
733
673
|
/**
|
|
734
674
|
* 加密后的密文,base64编码
|
|
735
675
|
*/
|
|
736
676
|
CipherText: string
|
|
737
|
-
|
|
738
677
|
/**
|
|
739
678
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
740
679
|
*/
|
|
@@ -746,11 +685,10 @@ export interface EncryptByWhiteBoxResponse {
|
|
|
746
685
|
*/
|
|
747
686
|
export interface DescribeKeysResponse {
|
|
748
687
|
/**
|
|
749
|
-
|
|
688
|
+
* 返回的属性信息列表
|
|
750
689
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
751
|
-
|
|
690
|
+
*/
|
|
752
691
|
KeyMetadatas: Array<KeyMetadata>
|
|
753
|
-
|
|
754
692
|
/**
|
|
755
693
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
756
694
|
*/
|
|
@@ -775,17 +713,14 @@ export interface ReEncryptRequest {
|
|
|
775
713
|
* 需要重新加密的密文
|
|
776
714
|
*/
|
|
777
715
|
CiphertextBlob: string
|
|
778
|
-
|
|
779
716
|
/**
|
|
780
717
|
* 重新加密使用的CMK,如果为空,则使用密文原有的CMK重新加密(若密钥没有轮换则密文不会刷新)
|
|
781
718
|
*/
|
|
782
719
|
DestinationKeyId?: string
|
|
783
|
-
|
|
784
720
|
/**
|
|
785
721
|
* CiphertextBlob 密文加密时使用的key/value对的json字符串。如果加密时未使用,则为空
|
|
786
722
|
*/
|
|
787
723
|
SourceEncryptionContext?: string
|
|
788
|
-
|
|
789
724
|
/**
|
|
790
725
|
* 重新加密使用的key/value对的json字符串,如果使用该字段,则返回的新密文在解密时需要填入相同的字符串
|
|
791
726
|
*/
|
|
@@ -797,16 +732,14 @@ export interface ReEncryptRequest {
|
|
|
797
732
|
*/
|
|
798
733
|
export interface ListKeysResponse {
|
|
799
734
|
/**
|
|
800
|
-
|
|
735
|
+
* CMK列表数组
|
|
801
736
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
802
|
-
|
|
737
|
+
*/
|
|
803
738
|
Keys: Array<Key>
|
|
804
|
-
|
|
805
739
|
/**
|
|
806
740
|
* CMK的总数量
|
|
807
741
|
*/
|
|
808
742
|
TotalCount: number
|
|
809
|
-
|
|
810
743
|
/**
|
|
811
744
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
812
745
|
*/
|
|
@@ -821,12 +754,10 @@ export interface AsymmetricSm2DecryptResponse {
|
|
|
821
754
|
* CMK的唯一标识
|
|
822
755
|
*/
|
|
823
756
|
KeyId: string
|
|
824
|
-
|
|
825
757
|
/**
|
|
826
758
|
* 解密后的明文,base64编码
|
|
827
759
|
*/
|
|
828
760
|
Plaintext: string
|
|
829
|
-
|
|
830
761
|
/**
|
|
831
762
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
832
763
|
*/
|
|
@@ -861,47 +792,38 @@ export interface ListKeyDetailRequest {
|
|
|
861
792
|
* 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
|
|
862
793
|
*/
|
|
863
794
|
Offset?: number
|
|
864
|
-
|
|
865
795
|
/**
|
|
866
796
|
* 含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为10,最大值为200
|
|
867
797
|
*/
|
|
868
798
|
Limit?: number
|
|
869
|
-
|
|
870
799
|
/**
|
|
871
800
|
* 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk
|
|
872
801
|
*/
|
|
873
802
|
Role?: number
|
|
874
|
-
|
|
875
803
|
/**
|
|
876
804
|
* 根据CMK创建时间排序, 0 表示按照降序排序,1表示按照升序排序
|
|
877
805
|
*/
|
|
878
806
|
OrderType?: number
|
|
879
|
-
|
|
880
807
|
/**
|
|
881
808
|
* 根据CMK状态筛选, 0表示全部CMK, 1 表示仅查询Enabled CMK, 2 表示仅查询Disabled CMK,3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key),4 表示查询 PendingImport 状态的CMK,5 表示查询 Archived 状态的 CMK
|
|
882
809
|
*/
|
|
883
810
|
KeyState?: number
|
|
884
|
-
|
|
885
811
|
/**
|
|
886
812
|
* 根据KeyId或者Alias进行模糊匹配查询
|
|
887
813
|
*/
|
|
888
814
|
SearchKeyAlias?: string
|
|
889
|
-
|
|
890
815
|
/**
|
|
891
816
|
* 根据CMK类型筛选, "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK, "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK,"ALL" 或者不设置表示两种类型都查询,大小写敏感。
|
|
892
817
|
*/
|
|
893
818
|
Origin?: string
|
|
894
|
-
|
|
895
819
|
/**
|
|
896
820
|
* 根据CMK的KeyUsage筛选,ALL表示筛选全部,可使用的参数为:ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC,为空则默认筛选ENCRYPT_DECRYPT类型
|
|
897
821
|
*/
|
|
898
822
|
KeyUsage?: string
|
|
899
|
-
|
|
900
823
|
/**
|
|
901
824
|
* 标签过滤条件
|
|
902
825
|
*/
|
|
903
826
|
TagFilters?: Array<TagFilter>
|
|
904
|
-
|
|
905
827
|
/**
|
|
906
828
|
* KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
|
|
907
829
|
*/
|
|
@@ -926,7 +848,6 @@ export interface AlgorithmInfo {
|
|
|
926
848
|
* 算法的标识
|
|
927
849
|
*/
|
|
928
850
|
KeyUsage: string
|
|
929
|
-
|
|
930
851
|
/**
|
|
931
852
|
* 算法的名称
|
|
932
853
|
*/
|
|
@@ -938,11 +859,10 @@ export interface AlgorithmInfo {
|
|
|
938
859
|
*/
|
|
939
860
|
export interface GetRegionsResponse {
|
|
940
861
|
/**
|
|
941
|
-
|
|
862
|
+
* 可用region列表
|
|
942
863
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
943
|
-
|
|
864
|
+
*/
|
|
944
865
|
Regions: Array<string>
|
|
945
|
-
|
|
946
866
|
/**
|
|
947
867
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
948
868
|
*/
|
|
@@ -957,18 +877,15 @@ export interface GenerateDataKeyResponse {
|
|
|
957
877
|
* CMK的全局唯一标识
|
|
958
878
|
*/
|
|
959
879
|
KeyId: string
|
|
960
|
-
|
|
961
880
|
/**
|
|
962
|
-
|
|
881
|
+
* 若调用时未提供 EncryptionPublicKey,该字段值为生成的数据密钥 DataKey 的 Base64 编码的明文,需进行 Base64 解码以获取 DataKey 明文。
|
|
963
882
|
若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取 DataKey 明文。
|
|
964
|
-
|
|
883
|
+
*/
|
|
965
884
|
Plaintext: string
|
|
966
|
-
|
|
967
885
|
/**
|
|
968
886
|
* 数据密钥DataKey加密后的密文,用户需要自行保存该密文,KMS不托管用户的数据密钥。可以通过Decrypt接口从CiphertextBlob中获取数据密钥DataKey明文
|
|
969
887
|
*/
|
|
970
888
|
CiphertextBlob: string
|
|
971
|
-
|
|
972
889
|
/**
|
|
973
890
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
974
891
|
*/
|
|
@@ -983,17 +900,14 @@ export interface CreateWhiteBoxKeyRequest {
|
|
|
983
900
|
* 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。Alias不可重复。
|
|
984
901
|
*/
|
|
985
902
|
Alias: string
|
|
986
|
-
|
|
987
903
|
/**
|
|
988
904
|
* 创建密钥所有的算法类型,支持的取值:AES_256,SM4
|
|
989
905
|
*/
|
|
990
906
|
Algorithm: string
|
|
991
|
-
|
|
992
907
|
/**
|
|
993
908
|
* 密钥的描述,最大1024字节
|
|
994
909
|
*/
|
|
995
910
|
Description?: string
|
|
996
|
-
|
|
997
911
|
/**
|
|
998
912
|
* 标签列表
|
|
999
913
|
*/
|
|
@@ -1038,12 +952,10 @@ export interface GetParametersForImportRequest {
|
|
|
1038
952
|
* CMK的唯一标识,获取密钥参数的CMK必须是EXTERNAL类型,即在CreateKey时指定Type=2 类型的CMK。
|
|
1039
953
|
*/
|
|
1040
954
|
KeyId: string
|
|
1041
|
-
|
|
1042
955
|
/**
|
|
1043
956
|
* 指定加密密钥材料的算法,目前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256
|
|
1044
957
|
*/
|
|
1045
958
|
WrappingAlgorithm: string
|
|
1046
|
-
|
|
1047
959
|
/**
|
|
1048
960
|
* 指定加密密钥材料的类型,目前只支持RSA_2048
|
|
1049
961
|
*/
|
|
@@ -1058,51 +970,42 @@ export interface CreateKeyResponse {
|
|
|
1058
970
|
* CMK的全局唯一标识符
|
|
1059
971
|
*/
|
|
1060
972
|
KeyId: string
|
|
1061
|
-
|
|
1062
973
|
/**
|
|
1063
974
|
* 作为密钥更容易辨识,更容易被人看懂的别名
|
|
1064
975
|
*/
|
|
1065
976
|
Alias: string
|
|
1066
|
-
|
|
1067
977
|
/**
|
|
1068
978
|
* 密钥创建时间,unix时间戳
|
|
1069
979
|
*/
|
|
1070
980
|
CreateTime: number
|
|
1071
|
-
|
|
1072
981
|
/**
|
|
1073
|
-
|
|
982
|
+
* CMK的描述
|
|
1074
983
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1075
|
-
|
|
984
|
+
*/
|
|
1076
985
|
Description: string
|
|
1077
|
-
|
|
1078
986
|
/**
|
|
1079
987
|
* CMK的状态
|
|
1080
988
|
*/
|
|
1081
989
|
KeyState: string
|
|
1082
|
-
|
|
1083
990
|
/**
|
|
1084
991
|
* CMK的用途
|
|
1085
992
|
*/
|
|
1086
993
|
KeyUsage: string
|
|
1087
|
-
|
|
1088
994
|
/**
|
|
1089
|
-
|
|
995
|
+
* 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误
|
|
1090
996
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1091
|
-
|
|
997
|
+
*/
|
|
1092
998
|
TagCode: number
|
|
1093
|
-
|
|
1094
999
|
/**
|
|
1095
|
-
|
|
1000
|
+
* 标签操作的返回信息
|
|
1096
1001
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1097
|
-
|
|
1002
|
+
*/
|
|
1098
1003
|
TagMsg: string
|
|
1099
|
-
|
|
1100
1004
|
/**
|
|
1101
|
-
|
|
1005
|
+
* HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)
|
|
1102
1006
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1103
|
-
|
|
1007
|
+
*/
|
|
1104
1008
|
HsmClusterId: string
|
|
1105
|
-
|
|
1106
1009
|
/**
|
|
1107
1010
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1108
1011
|
*/
|
|
@@ -1117,22 +1020,18 @@ export interface ReEncryptResponse {
|
|
|
1117
1020
|
* 重新加密后的密文
|
|
1118
1021
|
*/
|
|
1119
1022
|
CiphertextBlob: string
|
|
1120
|
-
|
|
1121
1023
|
/**
|
|
1122
1024
|
* 重新加密使用的CMK
|
|
1123
1025
|
*/
|
|
1124
1026
|
KeyId: string
|
|
1125
|
-
|
|
1126
1027
|
/**
|
|
1127
1028
|
* 重新加密前密文使用的CMK
|
|
1128
1029
|
*/
|
|
1129
1030
|
SourceKeyId: string
|
|
1130
|
-
|
|
1131
1031
|
/**
|
|
1132
1032
|
* true表示密文已经重新加密。同一个CMK进行重加密,在密钥没有发生轮换的情况下不会进行实际重新加密操作,返回原密文
|
|
1133
1033
|
*/
|
|
1134
1034
|
ReEncrypted: boolean
|
|
1135
|
-
|
|
1136
1035
|
/**
|
|
1137
1036
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1138
1037
|
*/
|
|
@@ -1147,12 +1046,10 @@ export interface EncryptResponse {
|
|
|
1147
1046
|
* 加密后的密文,base64编码。注意:本字段中打包了密文和密钥的相关信息,不是对明文的直接加密结果,只有将该字段作为Decrypt接口的输入参数,才可以解密出原文。
|
|
1148
1047
|
*/
|
|
1149
1048
|
CiphertextBlob: string
|
|
1150
|
-
|
|
1151
1049
|
/**
|
|
1152
1050
|
* 加密使用的CMK的全局唯一标识
|
|
1153
1051
|
*/
|
|
1154
1052
|
KeyId: string
|
|
1155
|
-
|
|
1156
1053
|
/**
|
|
1157
1054
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1158
1055
|
*/
|
|
@@ -1197,54 +1094,45 @@ export interface GetServiceStatusResponse {
|
|
|
1197
1094
|
* KMS服务是否开通, true 表示已开通
|
|
1198
1095
|
*/
|
|
1199
1096
|
ServiceEnabled?: boolean
|
|
1200
|
-
|
|
1201
1097
|
/**
|
|
1202
|
-
|
|
1098
|
+
* 服务不可用类型: 0-未购买,1-正常, 2-欠费停服, 3-资源释放
|
|
1203
1099
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1204
|
-
|
|
1100
|
+
*/
|
|
1205
1101
|
InvalidType?: number
|
|
1206
|
-
|
|
1207
1102
|
/**
|
|
1208
1103
|
* 0-普通版,1-旗舰版
|
|
1209
1104
|
*/
|
|
1210
1105
|
UserLevel?: number
|
|
1211
|
-
|
|
1212
1106
|
/**
|
|
1213
|
-
|
|
1107
|
+
* 旗舰版到期时间(Epoch Unix Timestamp)。
|
|
1214
1108
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1215
|
-
|
|
1109
|
+
*/
|
|
1216
1110
|
ProExpireTime?: number
|
|
1217
|
-
|
|
1218
1111
|
/**
|
|
1219
|
-
|
|
1112
|
+
* 旗舰版是否自动续费:0-不自动续费,1-自动续费
|
|
1220
1113
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1221
|
-
|
|
1114
|
+
*/
|
|
1222
1115
|
ProRenewFlag?: number
|
|
1223
|
-
|
|
1224
1116
|
/**
|
|
1225
|
-
|
|
1117
|
+
* 旗舰版购买记录的唯一性标识。如果为开通旗舰版,则返回值为空
|
|
1226
1118
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1227
|
-
|
|
1119
|
+
*/
|
|
1228
1120
|
ProResourceId?: string
|
|
1229
|
-
|
|
1230
1121
|
/**
|
|
1231
|
-
|
|
1122
|
+
* 是否开通 KMS 托管版
|
|
1232
1123
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1233
|
-
|
|
1124
|
+
*/
|
|
1234
1125
|
ExclusiveVSMEnabled?: boolean
|
|
1235
|
-
|
|
1236
1126
|
/**
|
|
1237
|
-
|
|
1127
|
+
* 是否开通 KMS 独享版
|
|
1238
1128
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1239
|
-
|
|
1129
|
+
*/
|
|
1240
1130
|
ExclusiveHSMEnabled?: boolean
|
|
1241
|
-
|
|
1242
1131
|
/**
|
|
1243
|
-
|
|
1132
|
+
* KMS 订阅信息。
|
|
1244
1133
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1245
|
-
|
|
1134
|
+
*/
|
|
1246
1135
|
SubscriptionInfo?: string
|
|
1247
|
-
|
|
1248
1136
|
/**
|
|
1249
1137
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1250
1138
|
*/
|
|
@@ -1259,11 +1147,10 @@ export interface DeviceFingerprint {
|
|
|
1259
1147
|
* 指纹信息,由设备指纹采集工具采集获得,格式满足正则表达式:^[0-9a-f]{8}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{16}$
|
|
1260
1148
|
*/
|
|
1261
1149
|
Identity: string
|
|
1262
|
-
|
|
1263
1150
|
/**
|
|
1264
|
-
|
|
1151
|
+
* 描述信息,如:IP,设备名称等,最大1024字节
|
|
1265
1152
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1266
|
-
|
|
1153
|
+
*/
|
|
1267
1154
|
Description?: string
|
|
1268
1155
|
}
|
|
1269
1156
|
|
|
@@ -1275,7 +1162,6 @@ export interface GetKeyRotationStatusResponse {
|
|
|
1275
1162
|
* 密钥轮换是否开启
|
|
1276
1163
|
*/
|
|
1277
1164
|
KeyRotationEnabled: boolean
|
|
1278
|
-
|
|
1279
1165
|
/**
|
|
1280
1166
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1281
1167
|
*/
|
|
@@ -1290,12 +1176,10 @@ export interface EncryptRequest {
|
|
|
1290
1176
|
* 调用CreateKey生成的CMK全局唯一标识符
|
|
1291
1177
|
*/
|
|
1292
1178
|
KeyId: string
|
|
1293
|
-
|
|
1294
1179
|
/**
|
|
1295
1180
|
* 被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K
|
|
1296
1181
|
*/
|
|
1297
1182
|
Plaintext: string
|
|
1298
|
-
|
|
1299
1183
|
/**
|
|
1300
1184
|
* key/value对的json字符串,如果指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024个字符
|
|
1301
1185
|
*/
|
|
@@ -1310,7 +1194,6 @@ export interface AsymmetricSm2DecryptRequest {
|
|
|
1310
1194
|
* CMK的唯一标识
|
|
1311
1195
|
*/
|
|
1312
1196
|
KeyId: string
|
|
1313
|
-
|
|
1314
1197
|
/**
|
|
1315
1198
|
* 使用PublicKey加密的密文,Base64编码。密文长度不能超过256字节。
|
|
1316
1199
|
*/
|
|
@@ -1335,17 +1218,14 @@ export interface ListKeysRequest {
|
|
|
1335
1218
|
* 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
|
|
1336
1219
|
*/
|
|
1337
1220
|
Offset?: number
|
|
1338
|
-
|
|
1339
1221
|
/**
|
|
1340
1222
|
* 含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200
|
|
1341
1223
|
*/
|
|
1342
1224
|
Limit?: number
|
|
1343
|
-
|
|
1344
1225
|
/**
|
|
1345
1226
|
* 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk
|
|
1346
1227
|
*/
|
|
1347
1228
|
Role?: number
|
|
1348
|
-
|
|
1349
1229
|
/**
|
|
1350
1230
|
* KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
|
|
1351
1231
|
*/
|
|
@@ -1370,84 +1250,69 @@ export interface KeyMetadata {
|
|
|
1370
1250
|
* CMK的全局唯一标识
|
|
1371
1251
|
*/
|
|
1372
1252
|
KeyId: string
|
|
1373
|
-
|
|
1374
1253
|
/**
|
|
1375
1254
|
* 作为密钥更容易辨识,更容易被人看懂的别名
|
|
1376
1255
|
*/
|
|
1377
1256
|
Alias: string
|
|
1378
|
-
|
|
1379
1257
|
/**
|
|
1380
1258
|
* 密钥创建时间
|
|
1381
1259
|
*/
|
|
1382
1260
|
CreateTime: number
|
|
1383
|
-
|
|
1384
1261
|
/**
|
|
1385
1262
|
* CMK的描述
|
|
1386
1263
|
*/
|
|
1387
1264
|
Description: string
|
|
1388
|
-
|
|
1389
1265
|
/**
|
|
1390
1266
|
* CMK的状态, 取值为:Enabled | Disabled | PendingDelete | PendingImport | Archived
|
|
1391
1267
|
*/
|
|
1392
1268
|
KeyState: string
|
|
1393
|
-
|
|
1394
1269
|
/**
|
|
1395
1270
|
* CMK用途,取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC
|
|
1396
1271
|
*/
|
|
1397
1272
|
KeyUsage: string
|
|
1398
|
-
|
|
1399
1273
|
/**
|
|
1400
1274
|
* CMK类型,2 表示符合FIPS标准,4表示符合国密标准
|
|
1401
1275
|
*/
|
|
1402
1276
|
Type: number
|
|
1403
|
-
|
|
1404
1277
|
/**
|
|
1405
1278
|
* 创建者
|
|
1406
1279
|
*/
|
|
1407
1280
|
CreatorUin: number
|
|
1408
|
-
|
|
1409
1281
|
/**
|
|
1410
1282
|
* 是否开启了密钥轮换功能
|
|
1411
1283
|
*/
|
|
1412
1284
|
KeyRotationEnabled: boolean
|
|
1413
|
-
|
|
1414
1285
|
/**
|
|
1415
1286
|
* CMK的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名
|
|
1416
1287
|
*/
|
|
1417
1288
|
Owner: string
|
|
1418
|
-
|
|
1419
1289
|
/**
|
|
1420
1290
|
* 在密钥轮换开启状态下,下次轮换的时间
|
|
1421
1291
|
*/
|
|
1422
1292
|
NextRotateTime: number
|
|
1423
|
-
|
|
1424
1293
|
/**
|
|
1425
|
-
|
|
1294
|
+
* 计划删除的时间
|
|
1426
1295
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1427
|
-
|
|
1296
|
+
*/
|
|
1428
1297
|
DeletionDate: number
|
|
1429
|
-
|
|
1430
1298
|
/**
|
|
1431
|
-
|
|
1299
|
+
* CMK 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL
|
|
1432
1300
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1433
|
-
|
|
1301
|
+
*/
|
|
1434
1302
|
Origin: string
|
|
1435
|
-
|
|
1436
1303
|
/**
|
|
1437
|
-
|
|
1304
|
+
* 在Origin为 EXTERNAL 时有效,表示密钥材料的有效日期, 0 表示不过期
|
|
1438
1305
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1439
|
-
|
|
1306
|
+
*/
|
|
1440
1307
|
ValidTo: number
|
|
1441
|
-
|
|
1442
1308
|
/**
|
|
1443
1309
|
* 资源ID,格式:creatorUin/$creatorUin/$keyId
|
|
1444
1310
|
*/
|
|
1445
1311
|
ResourceId: string
|
|
1446
|
-
|
|
1447
1312
|
/**
|
|
1448
|
-
|
|
1313
|
+
* HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)
|
|
1449
1314
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1450
|
-
|
|
1315
|
+
*/
|
|
1451
1316
|
HsmClusterId: string
|
|
1452
1317
|
}
|
|
1453
1318
|
|
|
@@ -1469,17 +1334,14 @@ export interface DecryptRequest {
|
|
|
1469
1334
|
* 待解密的密文数据
|
|
1470
1335
|
*/
|
|
1471
1336
|
CiphertextBlob: string
|
|
1472
|
-
|
|
1473
1337
|
/**
|
|
1474
1338
|
* key/value对的json字符串,如果Encrypt指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024字符
|
|
1475
1339
|
*/
|
|
1476
1340
|
EncryptionContext?: string
|
|
1477
|
-
|
|
1478
1341
|
/**
|
|
1479
1342
|
* PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
|
|
1480
1343
|
*/
|
|
1481
1344
|
EncryptionPublicKey?: string
|
|
1482
|
-
|
|
1483
1345
|
/**
|
|
1484
1346
|
* 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
|
|
1485
1347
|
*/
|
|
@@ -1494,17 +1356,14 @@ export interface DescribeWhiteBoxKeyDetailsRequest {
|
|
|
1494
1356
|
* 过滤条件:密钥的状态,0:disabled,1:enabled
|
|
1495
1357
|
*/
|
|
1496
1358
|
KeyStatus?: number
|
|
1497
|
-
|
|
1498
1359
|
/**
|
|
1499
1360
|
* 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
|
|
1500
1361
|
*/
|
|
1501
1362
|
Offset?: number
|
|
1502
|
-
|
|
1503
1363
|
/**
|
|
1504
1364
|
* 含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为0, 表示不分页
|
|
1505
1365
|
*/
|
|
1506
1366
|
Limit?: number
|
|
1507
|
-
|
|
1508
1367
|
/**
|
|
1509
1368
|
* 标签过滤条件
|
|
1510
1369
|
*/
|
|
@@ -1519,7 +1378,6 @@ export interface PostQuantumCryptoSignRequest {
|
|
|
1519
1378
|
* Base64 编码的消息原文。消息原文的长度(Base64编码前的长度)不超过4096字节。
|
|
1520
1379
|
*/
|
|
1521
1380
|
Message: string
|
|
1522
|
-
|
|
1523
1381
|
/**
|
|
1524
1382
|
* 密钥的唯一标识
|
|
1525
1383
|
*/
|
|
@@ -1534,12 +1392,10 @@ export interface PostQuantumCryptoDecryptRequest {
|
|
|
1534
1392
|
* 待解密的密文数据
|
|
1535
1393
|
*/
|
|
1536
1394
|
CiphertextBlob: string
|
|
1537
|
-
|
|
1538
1395
|
/**
|
|
1539
1396
|
* PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
|
|
1540
1397
|
*/
|
|
1541
1398
|
EncryptionPublicKey?: string
|
|
1542
|
-
|
|
1543
1399
|
/**
|
|
1544
1400
|
* 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
|
|
1545
1401
|
*/
|
|
@@ -1554,12 +1410,10 @@ export interface AsymmetricRsaDecryptResponse {
|
|
|
1554
1410
|
* CMK的唯一标识
|
|
1555
1411
|
*/
|
|
1556
1412
|
KeyId: string
|
|
1557
|
-
|
|
1558
1413
|
/**
|
|
1559
1414
|
* 解密后的明文,base64编码
|
|
1560
1415
|
*/
|
|
1561
1416
|
Plaintext: string
|
|
1562
|
-
|
|
1563
1417
|
/**
|
|
1564
1418
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1565
1419
|
*/
|
|
@@ -1574,7 +1428,6 @@ export interface CancelKeyDeletionResponse {
|
|
|
1574
1428
|
* 唯一标志被取消删除的CMK。
|
|
1575
1429
|
*/
|
|
1576
1430
|
KeyId: string
|
|
1577
|
-
|
|
1578
1431
|
/**
|
|
1579
1432
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1580
1433
|
*/
|
|
@@ -1609,12 +1462,10 @@ export interface UnbindCloudResourceRequest {
|
|
|
1609
1462
|
* cmk的ID
|
|
1610
1463
|
*/
|
|
1611
1464
|
KeyId: string
|
|
1612
|
-
|
|
1613
1465
|
/**
|
|
1614
1466
|
* 云产品的唯一性标识符
|
|
1615
1467
|
*/
|
|
1616
1468
|
ProductId: string
|
|
1617
|
-
|
|
1618
1469
|
/**
|
|
1619
1470
|
* 资源/实例ID,由调用方根据自己的云产品特征来定义,以字符串形式做存储。
|
|
1620
1471
|
*/
|
|
@@ -1629,7 +1480,6 @@ export interface OverwriteWhiteBoxDeviceFingerprintsRequest {
|
|
|
1629
1480
|
* 白盒密钥ID
|
|
1630
1481
|
*/
|
|
1631
1482
|
KeyId: string
|
|
1632
|
-
|
|
1633
1483
|
/**
|
|
1634
1484
|
* 设备指纹列表,如果列表为空,则表示删除该密钥对应的所有指纹信息。列表最大长度不超过200。
|
|
1635
1485
|
*/
|
|
@@ -1674,17 +1524,14 @@ export interface SignByAsymmetricKeyRequest {
|
|
|
1674
1524
|
* 签名算法,支持的算法:SM2DSA,ECC_P256_R1,RSA_PSS_SHA_256,RSA_PKCS1_SHA_256 等。更多支持的算法可通过 ListAlgorithms 接口进行查询。
|
|
1675
1525
|
*/
|
|
1676
1526
|
Algorithm: string
|
|
1677
|
-
|
|
1678
1527
|
/**
|
|
1679
1528
|
* 消息原文或消息摘要。如果提供的是消息原文,则消息原文的长度(Base64编码前的长度)不超过4096字节。如果提供的是消息摘要,消息摘要长度(Base64编码前的长度)必须等于32字节
|
|
1680
1529
|
*/
|
|
1681
1530
|
Message: string
|
|
1682
|
-
|
|
1683
1531
|
/**
|
|
1684
1532
|
* 密钥的唯一标识
|
|
1685
1533
|
*/
|
|
1686
1534
|
KeyId: string
|
|
1687
|
-
|
|
1688
1535
|
/**
|
|
1689
1536
|
* 消息类型:RAW,DIGEST,如果不传,默认为RAW,表示消息原文。
|
|
1690
1537
|
*/
|
|
@@ -1714,12 +1561,10 @@ export interface PostQuantumCryptoEncryptResponse {
|
|
|
1714
1561
|
* 加密后的密文,base64编码。注意:本字段中打包了密文和密钥的相关信息,不是对明文的直接加密结果,只有将该字段作为PostQuantumCryptoDecrypt接口的输入参数,才可以解密出原文。
|
|
1715
1562
|
*/
|
|
1716
1563
|
CiphertextBlob?: string
|
|
1717
|
-
|
|
1718
1564
|
/**
|
|
1719
1565
|
* 加密使用的CMK的全局唯一标识
|
|
1720
1566
|
*/
|
|
1721
1567
|
KeyId?: string
|
|
1722
|
-
|
|
1723
1568
|
/**
|
|
1724
1569
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1725
1570
|
*/
|
|
@@ -1734,12 +1579,10 @@ export interface EncryptByWhiteBoxRequest {
|
|
|
1734
1579
|
* 白盒密钥的全局唯一标识符
|
|
1735
1580
|
*/
|
|
1736
1581
|
KeyId: string
|
|
1737
|
-
|
|
1738
1582
|
/**
|
|
1739
1583
|
* 待加密的文本, base64编码,文本的原始长度最大不超过4KB
|
|
1740
1584
|
*/
|
|
1741
1585
|
PlainText: string
|
|
1742
|
-
|
|
1743
1586
|
/**
|
|
1744
1587
|
* 初始化向量,大小为 16 Bytes,加密算法会使用到, base64编码;如果不传,则由后端服务随机生成。用户需要自行保存该值,作为解密的参数。
|
|
1745
1588
|
*/
|
|
@@ -1764,7 +1607,6 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
1764
1607
|
* CMK的唯一标志
|
|
1765
1608
|
*/
|
|
1766
1609
|
KeyId: string
|
|
1767
|
-
|
|
1768
1610
|
/**
|
|
1769
1611
|
* 计划删除时间区间[7,30]
|
|
1770
1612
|
*/
|
|
@@ -1779,7 +1621,6 @@ export interface PostQuantumCryptoEncryptRequest {
|
|
|
1779
1621
|
* 调用CreateKey生成的CMK全局唯一标识符
|
|
1780
1622
|
*/
|
|
1781
1623
|
KeyId: string
|
|
1782
|
-
|
|
1783
1624
|
/**
|
|
1784
1625
|
* 被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K
|
|
1785
1626
|
*/
|
|
@@ -1814,17 +1655,14 @@ export interface GetPublicKeyResponse {
|
|
|
1814
1655
|
* CMK的唯一标识。
|
|
1815
1656
|
*/
|
|
1816
1657
|
KeyId: string
|
|
1817
|
-
|
|
1818
1658
|
/**
|
|
1819
1659
|
* 经过base64编码的公钥内容。
|
|
1820
1660
|
*/
|
|
1821
1661
|
PublicKey: string
|
|
1822
|
-
|
|
1823
1662
|
/**
|
|
1824
1663
|
* PEM格式的公钥内容。
|
|
1825
1664
|
*/
|
|
1826
1665
|
PublicKeyPem: string
|
|
1827
|
-
|
|
1828
1666
|
/**
|
|
1829
1667
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1830
1668
|
*/
|
|
@@ -1839,12 +1677,10 @@ export interface BindCloudResourceRequest {
|
|
|
1839
1677
|
* cmk的ID
|
|
1840
1678
|
*/
|
|
1841
1679
|
KeyId: string
|
|
1842
|
-
|
|
1843
1680
|
/**
|
|
1844
1681
|
* 云产品的唯一性标识符
|
|
1845
1682
|
*/
|
|
1846
1683
|
ProductId: string
|
|
1847
|
-
|
|
1848
1684
|
/**
|
|
1849
1685
|
* 资源/实例ID,由调用方根据自己的云产品特征来定义,以字符串形式做存储。
|
|
1850
1686
|
*/
|
|
@@ -1859,7 +1695,6 @@ export interface TagFilter {
|
|
|
1859
1695
|
* 标签键
|
|
1860
1696
|
*/
|
|
1861
1697
|
TagKey: string
|
|
1862
|
-
|
|
1863
1698
|
/**
|
|
1864
1699
|
* 标签值
|
|
1865
1700
|
*/
|
|
@@ -1874,7 +1709,6 @@ export interface PostQuantumCryptoSignResponse {
|
|
|
1874
1709
|
* 签名值,Base64编码。可使用 PostQuantumCryptoVerify接口对签名值进行验证。
|
|
1875
1710
|
*/
|
|
1876
1711
|
Signature?: string
|
|
1877
|
-
|
|
1878
1712
|
/**
|
|
1879
1713
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1880
1714
|
*/
|
|
@@ -1889,7 +1723,6 @@ export interface SignByAsymmetricKeyResponse {
|
|
|
1889
1723
|
* 签名,Base64编码
|
|
1890
1724
|
*/
|
|
1891
1725
|
Signature: string
|
|
1892
|
-
|
|
1893
1726
|
/**
|
|
1894
1727
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1895
1728
|
*/
|
|
@@ -1904,7 +1737,6 @@ export interface PostQuantumCryptoVerifyResponse {
|
|
|
1904
1737
|
* 签名是否有效。true:签名有效,false:签名无效。
|
|
1905
1738
|
*/
|
|
1906
1739
|
SignatureValid?: boolean
|
|
1907
|
-
|
|
1908
1740
|
/**
|
|
1909
1741
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1910
1742
|
*/
|
|
@@ -1919,7 +1751,6 @@ export interface DescribeWhiteBoxDecryptKeyResponse {
|
|
|
1919
1751
|
* 白盒解密密钥,base64编码
|
|
1920
1752
|
*/
|
|
1921
1753
|
DecryptKey: string
|
|
1922
|
-
|
|
1923
1754
|
/**
|
|
1924
1755
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1925
1756
|
*/
|
|
@@ -1934,7 +1765,6 @@ export interface DescribeWhiteBoxDeviceFingerprintsResponse {
|
|
|
1934
1765
|
* 设备指纹列表
|
|
1935
1766
|
*/
|
|
1936
1767
|
DeviceFingerprints: Array<DeviceFingerprint>
|
|
1937
|
-
|
|
1938
1768
|
/**
|
|
1939
1769
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1940
1770
|
*/
|
|
@@ -1949,13 +1779,11 @@ export interface PostQuantumCryptoDecryptResponse {
|
|
|
1949
1779
|
* CMK的全局唯一标识
|
|
1950
1780
|
*/
|
|
1951
1781
|
KeyId?: string
|
|
1952
|
-
|
|
1953
1782
|
/**
|
|
1954
|
-
|
|
1783
|
+
* 若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。
|
|
1955
1784
|
若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。
|
|
1956
|
-
|
|
1785
|
+
*/
|
|
1957
1786
|
PlainText?: string
|
|
1958
|
-
|
|
1959
1787
|
/**
|
|
1960
1788
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1961
1789
|
*/
|
|
@@ -1970,7 +1798,6 @@ export interface UpdateKeyDescriptionRequest {
|
|
|
1970
1798
|
* 新的描述信息,最大支持1024字节
|
|
1971
1799
|
*/
|
|
1972
1800
|
Description: string
|
|
1973
|
-
|
|
1974
1801
|
/**
|
|
1975
1802
|
* 需要修改描述信息的CMK ID
|
|
1976
1803
|
*/
|
|
@@ -1992,11 +1819,10 @@ export interface UnbindCloudResourceResponse {
|
|
|
1992
1819
|
*/
|
|
1993
1820
|
export interface DescribeKeyResponse {
|
|
1994
1821
|
/**
|
|
1995
|
-
|
|
1822
|
+
* 密钥属性信息
|
|
1996
1823
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1997
|
-
|
|
1824
|
+
*/
|
|
1998
1825
|
KeyMetadata: KeyMetadata
|
|
1999
|
-
|
|
2000
1826
|
/**
|
|
2001
1827
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2002
1828
|
*/
|