tccli 3.0.875.1__py2.py3-none-any.whl → 3.0.877.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/aa/v20200224/api.json +39 -0
- tccli/services/acp/v20220105/api.json +115 -0
- tccli/services/advisor/v20200721/api.json +30 -0
- tccli/services/af/v20200226/api.json +114 -0
- tccli/services/afc/v20200226/api.json +83 -0
- tccli/services/aiart/v20221229/api.json +25 -0
- tccli/services/ame/v20190916/api.json +329 -0
- tccli/services/ams/v20201229/api.json +151 -0
- tccli/services/anicloud/v20220923/api.json +36 -0
- tccli/services/antiddos/v20200309/api.json +928 -0
- tccli/services/apigateway/v20180808/api.json +1115 -0
- tccli/services/apm/v20210622/api.json +130 -0
- tccli/services/asr/v20190614/api.json +161 -2
- tccli/services/asw/v20200722/api.json +84 -0
- tccli/services/autoscaling/v20180419/api.json +564 -0
- tccli/services/ba/v20200720/api.json +10 -0
- tccli/services/batch/v20170312/api.json +514 -6
- tccli/services/bda/v20200324/api.json +186 -0
- tccli/services/bi/v20220105/api.json +28 -0
- tccli/services/billing/v20180709/api.json +515 -0
- tccli/services/bm/v20180423/api.json +542 -0
- tccli/services/bma/v20210624/api.json +322 -1
- tccli/services/bma/v20221115/api.json +137 -1
- tccli/services/bmeip/v20180625/api.json +134 -0
- tccli/services/bmlb/v20180625/api.json +633 -0
- tccli/services/bmvpc/v20180625/api.json +454 -0
- tccli/services/bpaas/v20181217/api.json +54 -0
- tccli/services/bsca/v20210811/api.json +86 -0
- tccli/services/btoe/v20210514/api.json +75 -0
- tccli/services/cam/v20190116/api.json +531 -5
- tccli/services/cam/v20190116/examples.json +4 -4
- tccli/services/captcha/v20190722/api.json +220 -0
- tccli/services/car/v20220110/api.json +15 -0
- tccli/services/cat/v20180409/api.json +135 -0
- tccli/services/cbs/v20170312/api.json +376 -0
- tccli/services/ccc/v20200210/api.json +497 -0
- tccli/services/cdb/cdb_client.py +53 -0
- tccli/services/cdb/v20170320/api.json +1574 -13
- tccli/services/cdb/v20170320/examples.json +10 -2
- tccli/services/cdc/v20201214/api.json +266 -0
- tccli/services/cdn/v20180606/api.json +1591 -171
- tccli/services/cds/v20180420/api.json +45 -0
- tccli/services/cdwch/v20200915/api.json +241 -0
- tccli/services/cfg/v20210820/api.json +203 -11
- tccli/services/cfg/v20210820/examples.json +2 -2
- tccli/services/cfs/v20190719/api.json +358 -0
- tccli/services/cfw/v20190904/api.json +764 -27
- tccli/services/cfw/v20190904/examples.json +7 -7
- tccli/services/chdfs/v20201112/api.json +128 -0
- tccli/services/ciam/v20220331/api.json +211 -0
- tccli/services/cii/v20210408/api.json +155 -0
- tccli/services/ckafka/v20190819/api.json +1388 -0
- tccli/services/clb/v20180317/api.json +873 -7
- tccli/services/cloudaudit/v20190319/api.json +158 -0
- tccli/services/cloudhsm/v20191112/api.json +159 -0
- tccli/services/cloudstudio/v20210524/api.json +201 -0
- tccli/services/cls/v20201016/api.json +719 -6
- tccli/services/cme/v20191029/api.json +736 -0
- tccli/services/cmq/v20190304/api.json +155 -0
- tccli/services/cpdp/v20190820/api.json +4099 -0
- tccli/services/csip/v20221121/api.json +207 -0
- tccli/services/cvm/v20170312/api.json +905 -6
- tccli/services/cwp/cwp_client.py +163 -4
- tccli/services/cwp/v20180228/api.json +3090 -0
- tccli/services/cwp/v20180228/examples.json +24 -0
- tccli/services/cynosdb/v20190107/api.json +936 -0
- tccli/services/dasb/v20191018/api.json +538 -0
- tccli/services/dayu/v20180709/api.json +1067 -0
- tccli/services/dbbrain/v20191016/api.json +353 -0
- tccli/services/dbbrain/v20210527/api.json +594 -0
- tccli/services/dbdc/v20201029/api.json +173 -0
- tccli/services/dc/v20180410/api.json +274 -0
- tccli/services/dcdb/v20180411/api.json +714 -0
- tccli/services/dlc/v20210125/api.json +987 -0
- tccli/services/dnspod/v20210323/api.json +622 -0
- tccli/services/domain/v20180808/api.json +229 -0
- tccli/services/drm/v20181115/api.json +76 -0
- tccli/services/ds/v20180523/api.json +99 -0
- tccli/services/dts/v20180330/api.json +228 -0
- tccli/services/dts/v20211206/api.json +548 -0
- tccli/services/eb/v20210416/api.json +256 -0
- tccli/services/ecc/v20181213/api.json +70 -0
- tccli/services/ecdn/v20191012/api.json +217 -0
- tccli/services/ecm/v20190719/api.json +1127 -0
- tccli/services/eiam/v20210420/api.json +348 -0
- tccli/services/eis/v20210601/api.json +86 -0
- tccli/services/emr/v20190103/api.json +754 -0
- tccli/services/es/v20180416/api.json +582 -0
- tccli/services/ess/v20201111/api.json +624 -1
- tccli/services/essbasic/v20210526/api.json +625 -3
- tccli/services/facefusion/v20181201/api.json +66 -0
- tccli/services/facefusion/v20220927/api.json +38 -0
- tccli/services/faceid/v20180301/api.json +370 -0
- tccli/services/fmu/v20191213/api.json +72 -0
- tccli/services/ft/v20200304/api.json +45 -0
- tccli/services/gaap/v20180529/api.json +880 -0
- tccli/services/gme/v20180711/api.json +267 -0
- tccli/services/goosefs/v20220519/api.json +14 -0
- tccli/services/gs/v20191118/api.json +45 -1
- tccli/services/hasim/v20210716/api.json +261 -0
- tccli/services/hcm/v20181106/api.json +27 -0
- tccli/services/iai/v20180301/api.json +363 -0
- tccli/services/iai/v20200303/api.json +376 -0
- tccli/services/icr/v20211014/api.json +49 -0
- tccli/services/ie/v20200304/api.json +401 -0
- tccli/services/iecp/v20210914/api.json +923 -0
- tccli/services/ims/v20200713/api.json +102 -0
- tccli/services/ims/v20201229/api.json +110 -0
- tccli/services/iot/v20180123/api.json +322 -0
- tccli/services/iotcloud/v20210408/api.json +508 -0
- tccli/services/iotexplorer/v20190423/api.json +660 -0
- tccli/services/iottid/v20190411/api.json +38 -0
- tccli/services/iotvideo/v20191126/api.json +398 -0
- tccli/services/iotvideo/v20201215/api.json +583 -0
- tccli/services/iotvideo/v20211125/api.json +692 -0
- tccli/services/iotvideoindustry/v20201201/api.json +639 -0
- tccli/services/irp/v20220805/api.json +152 -0
- tccli/services/ivld/v20210903/api.json +258 -0
- tccli/services/keewidb/v20220308/api.json +424 -0
- tccli/services/kms/v20190118/api.json +230 -0
- tccli/services/lcic/v20220817/api.json +414 -0
- tccli/services/lighthouse/v20200324/api.json +541 -2
- tccli/services/lighthouse/v20200324/examples.json +1 -1
- tccli/services/live/v20180801/api.json +1253 -66
- tccli/services/live/v20180801/examples.json +16 -16
- tccli/services/mariadb/v20170312/api.json +643 -0
- tccli/services/market/v20191010/api.json +13 -0
- tccli/services/memcached/v20190318/api.json +39 -0
- tccli/services/mmps/v20200710/api.json +175 -0
- tccli/services/mna/v20210119/api.json +120 -0
- tccli/services/mongodb/v20190725/api.json +440 -0
- tccli/services/monitor/v20180724/api.json +1599 -3
- tccli/services/monitor/v20180724/examples.json +1 -1
- tccli/services/mps/v20190612/api.json +2136 -115
- tccli/services/mps/v20190612/examples.json +2 -2
- tccli/services/mrs/v20200910/api.json +1016 -0
- tccli/services/ms/v20180408/api.json +183 -0
- tccli/services/msp/v20180319/api.json +54 -0
- tccli/services/nlp/v20190408/api.json +189 -0
- tccli/services/nlp/v20190408/examples.json +1 -1
- tccli/services/oceanus/v20190422/api.json +373 -0
- tccli/services/ocr/v20181119/api.json +1585 -7
- tccli/services/omics/v20221128/api.json +176 -0
- tccli/services/organization/v20181225/api.json +75 -0
- tccli/services/organization/v20210331/api.json +155 -0
- tccli/services/partners/v20180321/api.json +281 -0
- tccli/services/pds/v20210701/api.json +12 -0
- tccli/services/postgres/v20170312/api.json +823 -0
- tccli/services/privatedns/v20201028/api.json +162 -0
- tccli/services/pts/v20210728/api.json +620 -0
- tccli/services/rce/v20201103/api.json +85 -0
- tccli/services/redis/v20180412/api.json +867 -14
- tccli/services/redis/v20180412/examples.json +2 -2
- tccli/services/region/v20220627/api.json +30 -0
- tccli/services/rkp/v20191209/api.json +50 -0
- tccli/services/rum/v20210622/api.json +706 -0
- tccli/services/scf/v20180416/api.json +583 -0
- tccli/services/ses/v20201002/api.json +178 -0
- tccli/services/smh/v20210712/api.json +99 -0
- tccli/services/smop/v20201203/api.json +24 -0
- tccli/services/smpn/v20190822/api.json +32 -0
- tccli/services/sms/v20190711/api.json +153 -0
- tccli/services/sms/v20210111/api.json +168 -0
- tccli/services/soe/v20180724/api.json +114 -0
- tccli/services/sqlserver/v20180328/api.json +1012 -0
- tccli/services/ssa/v20180608/api.json +580 -0
- tccli/services/ssl/v20191205/api.json +412 -0
- tccli/services/sslpod/v20190605/api.json +75 -0
- tccli/services/ssm/v20190923/api.json +168 -0
- tccli/services/sts/v20180813/api.json +47 -0
- tccli/services/taf/v20200210/api.json +55 -0
- tccli/services/tag/v20180813/api.json +217 -0
- tccli/services/tan/v20220420/api.json +3 -0
- tccli/services/tat/v20201028/api.json +213 -0
- tccli/services/tbaas/v20180416/api.json +353 -0
- tccli/services/tbp/v20190311/api.json +41 -0
- tccli/services/tbp/v20190627/api.json +34 -0
- tccli/services/tcaplusdb/v20190823/api.json +554 -0
- tccli/services/tcbr/v20220217/api.json +188 -0
- tccli/services/tcm/v20210413/api.json +235 -0
- tccli/services/tcr/v20190924/api.json +711 -0
- tccli/services/tcss/v20201101/api.json +3101 -24
- tccli/services/tcss/v20201101/examples.json +6 -6
- tccli/services/tdcpg/v20211118/api.json +179 -0
- tccli/services/tdid/v20210519/api.json +369 -0
- tccli/services/tdmq/v20200217/api.json +1166 -0
- tccli/services/tds/v20220801/api.json +61 -0
- tccli/services/tem/v20210701/api.json +747 -0
- tccli/services/teo/v20220106/api.json +81 -0
- tccli/services/teo/v20220901/api.json +1234 -17
- tccli/services/thpc/v20211109/api.json +93 -0
- tccli/services/thpc/v20220401/api.json +216 -0
- tccli/services/thpc/v20230321/api.json +222 -0
- tccli/services/tic/v20201117/api.json +76 -0
- tccli/services/tics/v20181115/api.json +60 -0
- tccli/services/tiia/v20190529/api.json +229 -0
- tccli/services/tione/v20191022/api.json +228 -0
- tccli/services/tione/v20211111/api.json +945 -0
- tccli/services/tiw/v20190919/api.json +472 -0
- tccli/services/tke/v20180525/api.json +1751 -0
- tccli/services/tms/v20201229/api.json +49 -0
- tccli/services/tmt/v20180321/api.json +70 -0
- tccli/services/tourism/v20230215/api.json +16 -0
- tccli/services/trdp/v20220726/api.json +77 -0
- tccli/services/trp/v20210515/api.json +468 -0
- tccli/services/trro/v20220325/api.json +187 -0
- tccli/services/trtc/v20190722/api.json +501 -0
- tccli/services/tse/v20201207/api.json +185 -0
- tccli/services/tsf/tsf_client.py +57 -4
- tccli/services/tsf/v20180326/api.json +2409 -0
- tccli/services/tsf/v20180326/examples.json +8 -0
- tccli/services/tsw/v20210412/api.json +2 -0
- tccli/services/tts/v20190823/api.json +43 -0
- tccli/services/ump/v20200918/api.json +168 -0
- tccli/services/vm/v20201229/api.json +147 -0
- tccli/services/vm/v20210922/api.json +154 -0
- tccli/services/vms/v20200902/api.json +15 -0
- tccli/services/vod/v20180717/api.json +2787 -0
- tccli/services/vpc/v20170312/api.json +2175 -0
- tccli/services/vpc/v20170312/examples.json +16 -0
- tccli/services/vpc/vpc_client.py +114 -8
- tccli/services/vrs/v20200824/api.json +35 -0
- tccli/services/waf/v20180125/api.json +607 -0
- tccli/services/wav/v20210129/api.json +395 -0
- tccli/services/wedata/v20210820/api.json +2154 -0
- tccli/services/yinsuda/v20220527/api.json +194 -0
- tccli/services/yunsou/v20191115/api.json +50 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/METADATA +2 -2
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/RECORD +234 -234
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/LICENSE +0 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.875.1.dist-info → tccli-3.0.877.1.dist-info}/top_level.txt +0 -0
@@ -384,6 +384,7 @@
|
|
384
384
|
"members": [
|
385
385
|
{
|
386
386
|
"default": "",
|
387
|
+
"disabled": false,
|
387
388
|
"document": "算法的标识",
|
388
389
|
"member": "string",
|
389
390
|
"name": "KeyUsage",
|
@@ -393,6 +394,7 @@
|
|
393
394
|
},
|
394
395
|
{
|
395
396
|
"default": "",
|
397
|
+
"disabled": false,
|
396
398
|
"document": "算法的名称",
|
397
399
|
"member": "string",
|
398
400
|
"name": "Algorithm",
|
@@ -408,6 +410,7 @@
|
|
408
410
|
"members": [
|
409
411
|
{
|
410
412
|
"default": "",
|
413
|
+
"disabled": false,
|
411
414
|
"document": "CMK唯一标识符",
|
412
415
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
413
416
|
"member": "string",
|
@@ -435,6 +438,7 @@
|
|
435
438
|
"members": [
|
436
439
|
{
|
437
440
|
"default": "",
|
441
|
+
"disabled": false,
|
438
442
|
"document": "CMK的唯一标识",
|
439
443
|
"example": "554ef4b3-3071-11ea-a86a-5254006d0810",
|
440
444
|
"member": "string",
|
@@ -444,6 +448,7 @@
|
|
444
448
|
},
|
445
449
|
{
|
446
450
|
"default": "",
|
451
|
+
"disabled": false,
|
447
452
|
"document": "使用PublicKey加密的密文,Base64编码",
|
448
453
|
"example": "无",
|
449
454
|
"member": "string",
|
@@ -453,6 +458,7 @@
|
|
453
458
|
},
|
454
459
|
{
|
455
460
|
"default": "",
|
461
|
+
"disabled": false,
|
456
462
|
"document": "在使用公钥加密时对应的算法:当前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256",
|
457
463
|
"example": "RSAES_OAEP_SHA_1",
|
458
464
|
"member": "string",
|
@@ -467,6 +473,7 @@
|
|
467
473
|
"document": "AsymmetricRsaDecrypt返回参数结构体",
|
468
474
|
"members": [
|
469
475
|
{
|
476
|
+
"disabled": false,
|
470
477
|
"document": "CMK的唯一标识",
|
471
478
|
"example": "554ef4b3-3071-11ea-a86a-5254006d0810",
|
472
479
|
"member": "string",
|
@@ -476,6 +483,7 @@
|
|
476
483
|
"value_allowed_null": false
|
477
484
|
},
|
478
485
|
{
|
486
|
+
"disabled": false,
|
479
487
|
"document": "解密后的明文,base64编码",
|
480
488
|
"example": "dGVzdA==",
|
481
489
|
"member": "string",
|
@@ -498,6 +506,7 @@
|
|
498
506
|
"members": [
|
499
507
|
{
|
500
508
|
"default": "",
|
509
|
+
"disabled": false,
|
501
510
|
"document": "CMK的唯一标识",
|
502
511
|
"example": "554ef4b3-3071-11ea-a86a-5254006d0810",
|
503
512
|
"member": "string",
|
@@ -507,6 +516,7 @@
|
|
507
516
|
},
|
508
517
|
{
|
509
518
|
"default": "",
|
519
|
+
"disabled": false,
|
510
520
|
"document": "使用PublicKey加密的密文,Base64编码。密文长度不能超过256字节。",
|
511
521
|
"example": "无",
|
512
522
|
"member": "string",
|
@@ -521,6 +531,7 @@
|
|
521
531
|
"document": "AsymmetricSm2Decrypt返回参数结构体",
|
522
532
|
"members": [
|
523
533
|
{
|
534
|
+
"disabled": false,
|
524
535
|
"document": "CMK的唯一标识",
|
525
536
|
"example": "554ef4b3-3071-11ea-a86a-5254006d0810",
|
526
537
|
"member": "string",
|
@@ -530,6 +541,7 @@
|
|
530
541
|
"value_allowed_null": false
|
531
542
|
},
|
532
543
|
{
|
544
|
+
"disabled": false,
|
533
545
|
"document": "解密后的明文,base64编码",
|
534
546
|
"example": "dGVzdA==",
|
535
547
|
"member": "string",
|
@@ -552,6 +564,7 @@
|
|
552
564
|
"members": [
|
553
565
|
{
|
554
566
|
"default": "",
|
567
|
+
"disabled": false,
|
555
568
|
"document": "cmk的ID",
|
556
569
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
557
570
|
"member": "string",
|
@@ -561,6 +574,7 @@
|
|
561
574
|
},
|
562
575
|
{
|
563
576
|
"default": "",
|
577
|
+
"disabled": false,
|
564
578
|
"document": "云产品的唯一性标识符",
|
565
579
|
"example": "ssm",
|
566
580
|
"member": "string",
|
@@ -570,6 +584,7 @@
|
|
570
584
|
},
|
571
585
|
{
|
572
586
|
"default": "",
|
587
|
+
"disabled": false,
|
573
588
|
"document": "资源/实例ID,由调用方根据自己的云产品特征来定义,以字符串形式做存储。",
|
574
589
|
"example": "resourceId",
|
575
590
|
"member": "string",
|
@@ -597,6 +612,7 @@
|
|
597
612
|
"members": [
|
598
613
|
{
|
599
614
|
"default": "",
|
615
|
+
"disabled": false,
|
600
616
|
"document": "CMK唯一标识符",
|
601
617
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
602
618
|
"member": "string",
|
@@ -624,6 +640,7 @@
|
|
624
640
|
"members": [
|
625
641
|
{
|
626
642
|
"default": "",
|
643
|
+
"disabled": false,
|
627
644
|
"document": "需要被取消删除的CMK的唯一标志",
|
628
645
|
"example": "无",
|
629
646
|
"member": "string",
|
@@ -638,6 +655,7 @@
|
|
638
655
|
"document": "CancelKeyDeletion返回参数结构体",
|
639
656
|
"members": [
|
640
657
|
{
|
658
|
+
"disabled": false,
|
641
659
|
"document": "唯一标志被取消删除的CMK。",
|
642
660
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
643
661
|
"member": "string",
|
@@ -660,6 +678,7 @@
|
|
660
678
|
"members": [
|
661
679
|
{
|
662
680
|
"default": "",
|
681
|
+
"disabled": false,
|
663
682
|
"document": "作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。以 kms- 作为前缀的用于云产品使用,Alias 不可重复。",
|
664
683
|
"example": "test",
|
665
684
|
"member": "string",
|
@@ -669,6 +688,7 @@
|
|
669
688
|
},
|
670
689
|
{
|
671
690
|
"default": "",
|
691
|
+
"disabled": false,
|
672
692
|
"document": "CMK 的描述,最大1024字节",
|
673
693
|
"example": "test",
|
674
694
|
"member": "string",
|
@@ -678,6 +698,7 @@
|
|
678
698
|
},
|
679
699
|
{
|
680
700
|
"default": "",
|
701
|
+
"disabled": false,
|
681
702
|
"document": "指定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 接口获取。",
|
682
703
|
"example": "ASYMMETRIC_DECRYPT_SM2",
|
683
704
|
"member": "string",
|
@@ -687,6 +708,7 @@
|
|
687
708
|
},
|
688
709
|
{
|
689
710
|
"default": "",
|
711
|
+
"disabled": false,
|
690
712
|
"document": "指定key类型,默认为1,1表示默认类型,由KMS创建CMK密钥,2 表示EXTERNAL 类型,该类型需要用户导入密钥材料,参考 GetParametersForImport 和 ImportKeyMaterial 接口",
|
691
713
|
"example": "1",
|
692
714
|
"member": "uint64",
|
@@ -696,6 +718,7 @@
|
|
696
718
|
},
|
697
719
|
{
|
698
720
|
"default": "",
|
721
|
+
"disabled": false,
|
699
722
|
"document": "标签列表",
|
700
723
|
"example": "tags",
|
701
724
|
"member": "Tag",
|
@@ -705,6 +728,7 @@
|
|
705
728
|
},
|
706
729
|
{
|
707
730
|
"default": "",
|
731
|
+
"disabled": false,
|
708
732
|
"document": "KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。",
|
709
733
|
"example": "cluster-123",
|
710
734
|
"member": "string",
|
@@ -719,6 +743,7 @@
|
|
719
743
|
"document": "CreateKey返回参数结构体",
|
720
744
|
"members": [
|
721
745
|
{
|
746
|
+
"disabled": false,
|
722
747
|
"document": "CMK的全局唯一标识符",
|
723
748
|
"example": "9999aed0-4956-11e9-bc70-5254005e86b4",
|
724
749
|
"member": "string",
|
@@ -728,6 +753,7 @@
|
|
728
753
|
"value_allowed_null": false
|
729
754
|
},
|
730
755
|
{
|
756
|
+
"disabled": false,
|
731
757
|
"document": "作为密钥更容易辨识,更容易被人看懂的别名",
|
732
758
|
"example": "test",
|
733
759
|
"member": "string",
|
@@ -737,6 +763,7 @@
|
|
737
763
|
"value_allowed_null": false
|
738
764
|
},
|
739
765
|
{
|
766
|
+
"disabled": false,
|
740
767
|
"document": "密钥创建时间,unix时间戳",
|
741
768
|
"example": "1552897190",
|
742
769
|
"member": "uint64",
|
@@ -746,6 +773,7 @@
|
|
746
773
|
"value_allowed_null": false
|
747
774
|
},
|
748
775
|
{
|
776
|
+
"disabled": false,
|
749
777
|
"document": "CMK的描述\n注意:此字段可能返回 null,表示取不到有效值。",
|
750
778
|
"example": "test",
|
751
779
|
"member": "string",
|
@@ -755,6 +783,7 @@
|
|
755
783
|
"value_allowed_null": true
|
756
784
|
},
|
757
785
|
{
|
786
|
+
"disabled": false,
|
758
787
|
"document": "CMK的状态",
|
759
788
|
"example": "Enabled",
|
760
789
|
"member": "string",
|
@@ -764,6 +793,7 @@
|
|
764
793
|
"value_allowed_null": false
|
765
794
|
},
|
766
795
|
{
|
796
|
+
"disabled": false,
|
767
797
|
"document": "CMK的用途",
|
768
798
|
"example": "ENCRYPT_DECRYPT",
|
769
799
|
"member": "string",
|
@@ -773,6 +803,7 @@
|
|
773
803
|
"value_allowed_null": false
|
774
804
|
},
|
775
805
|
{
|
806
|
+
"disabled": false,
|
776
807
|
"document": "标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误\n注意:此字段可能返回 null,表示取不到有效值。",
|
777
808
|
"example": "1",
|
778
809
|
"member": "uint64",
|
@@ -782,6 +813,7 @@
|
|
782
813
|
"value_allowed_null": true
|
783
814
|
},
|
784
815
|
{
|
816
|
+
"disabled": false,
|
785
817
|
"document": "标签操作的返回信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
786
818
|
"example": "success",
|
787
819
|
"member": "string",
|
@@ -791,6 +823,7 @@
|
|
791
823
|
"value_allowed_null": true
|
792
824
|
},
|
793
825
|
{
|
826
|
+
"disabled": false,
|
794
827
|
"document": "HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)\n注意:此字段可能返回 null,表示取不到有效值。",
|
795
828
|
"example": "cls-hsm-1234abcd",
|
796
829
|
"member": "string",
|
@@ -813,6 +846,7 @@
|
|
813
846
|
"members": [
|
814
847
|
{
|
815
848
|
"default": "",
|
849
|
+
"disabled": false,
|
816
850
|
"document": "作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。Alias不可重复。",
|
817
851
|
"example": "test_alias",
|
818
852
|
"member": "string",
|
@@ -822,6 +856,7 @@
|
|
822
856
|
},
|
823
857
|
{
|
824
858
|
"default": "",
|
859
|
+
"disabled": false,
|
825
860
|
"document": "创建密钥所有的算法类型,支持的取值:AES_256,SM4",
|
826
861
|
"example": "SM4",
|
827
862
|
"member": "string",
|
@@ -831,6 +866,7 @@
|
|
831
866
|
},
|
832
867
|
{
|
833
868
|
"default": "",
|
869
|
+
"disabled": false,
|
834
870
|
"document": "密钥的描述,最大1024字节",
|
835
871
|
"example": "test_description",
|
836
872
|
"member": "string",
|
@@ -840,6 +876,7 @@
|
|
840
876
|
},
|
841
877
|
{
|
842
878
|
"default": "",
|
879
|
+
"disabled": false,
|
843
880
|
"document": "标签列表",
|
844
881
|
"example": "无",
|
845
882
|
"member": "Tag",
|
@@ -854,6 +891,7 @@
|
|
854
891
|
"document": "CreateWhiteBoxKey返回参数结构体",
|
855
892
|
"members": [
|
856
893
|
{
|
894
|
+
"disabled": false,
|
857
895
|
"document": "用于加密的密钥,base64编码",
|
858
896
|
"example": "无",
|
859
897
|
"member": "string",
|
@@ -863,6 +901,7 @@
|
|
863
901
|
"value_allowed_null": false
|
864
902
|
},
|
865
903
|
{
|
904
|
+
"disabled": false,
|
866
905
|
"document": "用于解密的密钥,base64编码",
|
867
906
|
"example": "无",
|
868
907
|
"member": "string",
|
@@ -872,6 +911,7 @@
|
|
872
911
|
"value_allowed_null": false
|
873
912
|
},
|
874
913
|
{
|
914
|
+
"disabled": false,
|
875
915
|
"document": "白盒密钥的全局唯一标识符",
|
876
916
|
"example": "无",
|
877
917
|
"member": "string",
|
@@ -881,6 +921,7 @@
|
|
881
921
|
"value_allowed_null": false
|
882
922
|
},
|
883
923
|
{
|
924
|
+
"disabled": false,
|
884
925
|
"document": "标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误\n注意:此字段可能返回 null,表示取不到有效值。",
|
885
926
|
"example": "无",
|
886
927
|
"member": "uint64",
|
@@ -890,6 +931,7 @@
|
|
890
931
|
"value_allowed_null": true
|
891
932
|
},
|
892
933
|
{
|
934
|
+
"disabled": false,
|
893
935
|
"document": "标签操作的返回信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
894
936
|
"example": "无",
|
895
937
|
"member": "string",
|
@@ -912,6 +954,7 @@
|
|
912
954
|
"members": [
|
913
955
|
{
|
914
956
|
"default": "",
|
957
|
+
"disabled": false,
|
915
958
|
"document": "待解密的密文数据",
|
916
959
|
"example": "Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL",
|
917
960
|
"member": "string",
|
@@ -921,6 +964,7 @@
|
|
921
964
|
},
|
922
965
|
{
|
923
966
|
"default": "",
|
967
|
+
"disabled": false,
|
924
968
|
"document": "key/value对的json字符串,如果Encrypt指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024字符",
|
925
969
|
"example": "无",
|
926
970
|
"member": "string",
|
@@ -930,6 +974,7 @@
|
|
930
974
|
},
|
931
975
|
{
|
932
976
|
"default": "",
|
977
|
+
"disabled": false,
|
933
978
|
"document": "PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。",
|
934
979
|
"example": "无",
|
935
980
|
"member": "string",
|
@@ -939,6 +984,7 @@
|
|
939
984
|
},
|
940
985
|
{
|
941
986
|
"default": "",
|
987
|
+
"disabled": false,
|
942
988
|
"document": "非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。",
|
943
989
|
"example": "SM2",
|
944
990
|
"member": "string",
|
@@ -953,6 +999,7 @@
|
|
953
999
|
"document": "Decrypt返回参数结构体",
|
954
1000
|
"members": [
|
955
1001
|
{
|
1002
|
+
"disabled": false,
|
956
1003
|
"document": "CMK的全局唯一标识",
|
957
1004
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
958
1005
|
"member": "string",
|
@@ -962,6 +1009,7 @@
|
|
962
1009
|
"value_allowed_null": false
|
963
1010
|
},
|
964
1011
|
{
|
1012
|
+
"disabled": false,
|
965
1013
|
"document": "若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。\n若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。",
|
966
1014
|
"example": "dGVzdCUyMHBsYWluJTIwdGV4dA==",
|
967
1015
|
"member": "string",
|
@@ -984,6 +1032,7 @@
|
|
984
1032
|
"members": [
|
985
1033
|
{
|
986
1034
|
"default": "",
|
1035
|
+
"disabled": false,
|
987
1036
|
"document": "指定需要删除密钥材料的EXTERNAL CMK。",
|
988
1037
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
989
1038
|
"member": "string",
|
@@ -1011,6 +1060,7 @@
|
|
1011
1060
|
"members": [
|
1012
1061
|
{
|
1013
1062
|
"default": "",
|
1063
|
+
"disabled": false,
|
1014
1064
|
"document": "白盒密钥的全局唯一标识符",
|
1015
1065
|
"example": "244dab8c-6dad-11ea-80c6-5254006d0810",
|
1016
1066
|
"member": "string",
|
@@ -1038,6 +1088,7 @@
|
|
1038
1088
|
"members": [
|
1039
1089
|
{
|
1040
1090
|
"default": "",
|
1091
|
+
"disabled": false,
|
1041
1092
|
"document": "CMK全局唯一标识符",
|
1042
1093
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1043
1094
|
"member": "string",
|
@@ -1052,6 +1103,7 @@
|
|
1052
1103
|
"document": "DescribeKey返回参数结构体",
|
1053
1104
|
"members": [
|
1054
1105
|
{
|
1106
|
+
"disabled": false,
|
1055
1107
|
"document": "密钥属性信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
1056
1108
|
"example": "无",
|
1057
1109
|
"member": "KeyMetadata",
|
@@ -1074,6 +1126,7 @@
|
|
1074
1126
|
"members": [
|
1075
1127
|
{
|
1076
1128
|
"default": "",
|
1129
|
+
"disabled": false,
|
1077
1130
|
"document": "查询CMK的ID列表,批量查询一次最多支持100个KeyId",
|
1078
1131
|
"example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b03\\r\\n\"]",
|
1079
1132
|
"member": "string",
|
@@ -1088,6 +1141,7 @@
|
|
1088
1141
|
"document": "DescribeKeys返回参数结构体",
|
1089
1142
|
"members": [
|
1090
1143
|
{
|
1144
|
+
"disabled": false,
|
1091
1145
|
"document": "返回的属性信息列表\n注意:此字段可能返回 null,表示取不到有效值。",
|
1092
1146
|
"example": "无",
|
1093
1147
|
"member": "KeyMetadata",
|
@@ -1110,6 +1164,7 @@
|
|
1110
1164
|
"members": [
|
1111
1165
|
{
|
1112
1166
|
"default": "",
|
1167
|
+
"disabled": false,
|
1113
1168
|
"document": "白盒密钥的全局唯一标识符",
|
1114
1169
|
"example": "244dab8c-6dad-11ea-80c6-5254006d0810",
|
1115
1170
|
"member": "string",
|
@@ -1124,6 +1179,7 @@
|
|
1124
1179
|
"document": "DescribeWhiteBoxDecryptKey返回参数结构体",
|
1125
1180
|
"members": [
|
1126
1181
|
{
|
1182
|
+
"disabled": false,
|
1127
1183
|
"document": "白盒解密密钥,base64编码",
|
1128
1184
|
"example": "无",
|
1129
1185
|
"member": "string",
|
@@ -1146,6 +1202,7 @@
|
|
1146
1202
|
"members": [
|
1147
1203
|
{
|
1148
1204
|
"default": "",
|
1205
|
+
"disabled": false,
|
1149
1206
|
"document": "白盒密钥ID",
|
1150
1207
|
"example": "cd850a3d-9b1b-11ea-a96a-5254006d0810",
|
1151
1208
|
"member": "string",
|
@@ -1160,6 +1217,7 @@
|
|
1160
1217
|
"document": "DescribeWhiteBoxDeviceFingerprints返回参数结构体",
|
1161
1218
|
"members": [
|
1162
1219
|
{
|
1220
|
+
"disabled": false,
|
1163
1221
|
"document": "设备指纹列表",
|
1164
1222
|
"example": "无",
|
1165
1223
|
"member": "DeviceFingerprint",
|
@@ -1182,6 +1240,7 @@
|
|
1182
1240
|
"members": [
|
1183
1241
|
{
|
1184
1242
|
"default": "",
|
1243
|
+
"disabled": false,
|
1185
1244
|
"document": "过滤条件:密钥的状态,0:disabled,1:enabled",
|
1186
1245
|
"example": "无",
|
1187
1246
|
"member": "int64",
|
@@ -1191,6 +1250,7 @@
|
|
1191
1250
|
},
|
1192
1251
|
{
|
1193
1252
|
"default": "",
|
1253
|
+
"disabled": false,
|
1194
1254
|
"document": "含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0",
|
1195
1255
|
"example": "无",
|
1196
1256
|
"member": "uint64",
|
@@ -1200,6 +1260,7 @@
|
|
1200
1260
|
},
|
1201
1261
|
{
|
1202
1262
|
"default": "",
|
1263
|
+
"disabled": false,
|
1203
1264
|
"document": "含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为0, 表示不分页",
|
1204
1265
|
"example": "无",
|
1205
1266
|
"member": "uint64",
|
@@ -1209,6 +1270,7 @@
|
|
1209
1270
|
},
|
1210
1271
|
{
|
1211
1272
|
"default": "",
|
1273
|
+
"disabled": false,
|
1212
1274
|
"document": "标签过滤条件",
|
1213
1275
|
"example": "无",
|
1214
1276
|
"member": "TagFilter",
|
@@ -1223,6 +1285,7 @@
|
|
1223
1285
|
"document": "DescribeWhiteBoxKeyDetails返回参数结构体",
|
1224
1286
|
"members": [
|
1225
1287
|
{
|
1288
|
+
"disabled": false,
|
1226
1289
|
"document": "白盒密钥信息列表。",
|
1227
1290
|
"example": "无",
|
1228
1291
|
"member": "WhiteboxKeyInfo",
|
@@ -1232,6 +1295,7 @@
|
|
1232
1295
|
"value_allowed_null": false
|
1233
1296
|
},
|
1234
1297
|
{
|
1298
|
+
"disabled": false,
|
1235
1299
|
"document": "白盒密钥总数。\n注意:此字段可能返回 null,表示取不到有效值。",
|
1236
1300
|
"example": "无",
|
1237
1301
|
"member": "uint64",
|
@@ -1254,6 +1318,7 @@
|
|
1254
1318
|
"members": [
|
1255
1319
|
{
|
1256
1320
|
"default": "",
|
1321
|
+
"disabled": false,
|
1257
1322
|
"document": "白盒密钥的全局唯一标识符",
|
1258
1323
|
"example": "244dab8c-6dad-11ea-80c6-5254006d0810",
|
1259
1324
|
"member": "string",
|
@@ -1268,6 +1333,7 @@
|
|
1268
1333
|
"document": "DescribeWhiteBoxKey返回参数结构体",
|
1269
1334
|
"members": [
|
1270
1335
|
{
|
1336
|
+
"disabled": false,
|
1271
1337
|
"document": "白盒密钥信息",
|
1272
1338
|
"example": "无",
|
1273
1339
|
"member": "WhiteboxKeyInfo",
|
@@ -1294,6 +1360,7 @@
|
|
1294
1360
|
"document": "DescribeWhiteBoxServiceStatus返回参数结构体",
|
1295
1361
|
"members": [
|
1296
1362
|
{
|
1363
|
+
"disabled": false,
|
1297
1364
|
"document": "用户的白盒密钥服务是否可用",
|
1298
1365
|
"example": "1",
|
1299
1366
|
"member": "bool",
|
@@ -1316,6 +1383,7 @@
|
|
1316
1383
|
"members": [
|
1317
1384
|
{
|
1318
1385
|
"default": "",
|
1386
|
+
"disabled": false,
|
1319
1387
|
"document": "指纹信息,由设备指纹采集工具采集获得,格式满足正则表达式:^[0-9a-f]{8}[\\-][0-9a-f]{14}[\\-][0-9a-f]{14}[\\-][0-9a-f]{14}[\\-][0-9a-f]{16}$",
|
1320
1388
|
"member": "string",
|
1321
1389
|
"name": "Identity",
|
@@ -1325,6 +1393,7 @@
|
|
1325
1393
|
},
|
1326
1394
|
{
|
1327
1395
|
"default": "",
|
1396
|
+
"disabled": false,
|
1328
1397
|
"document": "描述信息,如:IP,设备名称等,最大1024字节\n注意:此字段可能返回 null,表示取不到有效值。",
|
1329
1398
|
"member": "string",
|
1330
1399
|
"name": "Description",
|
@@ -1340,6 +1409,7 @@
|
|
1340
1409
|
"members": [
|
1341
1410
|
{
|
1342
1411
|
"default": "",
|
1412
|
+
"disabled": false,
|
1343
1413
|
"document": "CMK唯一标识符",
|
1344
1414
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1345
1415
|
"member": "string",
|
@@ -1367,6 +1437,7 @@
|
|
1367
1437
|
"members": [
|
1368
1438
|
{
|
1369
1439
|
"default": "",
|
1440
|
+
"disabled": false,
|
1370
1441
|
"document": "CMK唯一标识符",
|
1371
1442
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1372
1443
|
"member": "string",
|
@@ -1394,6 +1465,7 @@
|
|
1394
1465
|
"members": [
|
1395
1466
|
{
|
1396
1467
|
"default": "",
|
1468
|
+
"disabled": false,
|
1397
1469
|
"document": "需要批量禁用的CMK Id 列表,CMK数量最大支持100",
|
1398
1470
|
"example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\\r\\n\"]",
|
1399
1471
|
"member": "string",
|
@@ -1421,6 +1493,7 @@
|
|
1421
1493
|
"members": [
|
1422
1494
|
{
|
1423
1495
|
"default": "",
|
1496
|
+
"disabled": false,
|
1424
1497
|
"document": "白盒密钥的全局唯一标识符",
|
1425
1498
|
"example": "244dab8c-6dad-11ea-80c6-5254006d0810",
|
1426
1499
|
"member": "string",
|
@@ -1448,6 +1521,7 @@
|
|
1448
1521
|
"members": [
|
1449
1522
|
{
|
1450
1523
|
"default": "",
|
1524
|
+
"disabled": false,
|
1451
1525
|
"document": "白盒密钥的全局唯一标识符列表。注意:要确保所有提供的KeyId是格式有效的,没有重复,个数不超过50个,并且都是有效存在的。",
|
1452
1526
|
"example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\\r\\n\"]",
|
1453
1527
|
"member": "string",
|
@@ -1475,6 +1549,7 @@
|
|
1475
1549
|
"members": [
|
1476
1550
|
{
|
1477
1551
|
"default": "",
|
1552
|
+
"disabled": false,
|
1478
1553
|
"document": "CMK唯一标识符",
|
1479
1554
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1480
1555
|
"member": "string",
|
@@ -1502,6 +1577,7 @@
|
|
1502
1577
|
"members": [
|
1503
1578
|
{
|
1504
1579
|
"default": "",
|
1580
|
+
"disabled": false,
|
1505
1581
|
"document": "CMK唯一标识符",
|
1506
1582
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1507
1583
|
"member": "string",
|
@@ -1511,6 +1587,7 @@
|
|
1511
1587
|
},
|
1512
1588
|
{
|
1513
1589
|
"default": "",
|
1590
|
+
"disabled": false,
|
1514
1591
|
"document": "密钥轮转周期,单位天,允许范围 7 ~ 365,默认值 365。",
|
1515
1592
|
"example": "365",
|
1516
1593
|
"member": "uint64",
|
@@ -1538,6 +1615,7 @@
|
|
1538
1615
|
"members": [
|
1539
1616
|
{
|
1540
1617
|
"default": "",
|
1618
|
+
"disabled": false,
|
1541
1619
|
"document": "需要批量启用的CMK Id 列表, CMK数量最大支持100",
|
1542
1620
|
"example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]",
|
1543
1621
|
"member": "string",
|
@@ -1565,6 +1643,7 @@
|
|
1565
1643
|
"members": [
|
1566
1644
|
{
|
1567
1645
|
"default": "",
|
1646
|
+
"disabled": false,
|
1568
1647
|
"document": "白盒密钥的全局唯一标识符",
|
1569
1648
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1570
1649
|
"member": "string",
|
@@ -1592,6 +1671,7 @@
|
|
1592
1671
|
"members": [
|
1593
1672
|
{
|
1594
1673
|
"default": "",
|
1674
|
+
"disabled": false,
|
1595
1675
|
"document": "白盒密钥的全局唯一标识符列表。注意:要确保所有提供的KeyId是格式有效的,没有重复,个数不超过50个,并且都是有效存在的。",
|
1596
1676
|
"example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\\r\\n\"]",
|
1597
1677
|
"member": "string",
|
@@ -1619,6 +1699,7 @@
|
|
1619
1699
|
"members": [
|
1620
1700
|
{
|
1621
1701
|
"default": "",
|
1702
|
+
"disabled": false,
|
1622
1703
|
"document": "白盒密钥的全局唯一标识符",
|
1623
1704
|
"example": "244dab8c-6dad-11ea-80c6-5254006d0810",
|
1624
1705
|
"member": "string",
|
@@ -1628,6 +1709,7 @@
|
|
1628
1709
|
},
|
1629
1710
|
{
|
1630
1711
|
"default": "",
|
1712
|
+
"disabled": false,
|
1631
1713
|
"document": "待加密的文本, base64编码,文本的原始长度最大不超过4KB",
|
1632
1714
|
"example": "UGxhaW5UZXh0",
|
1633
1715
|
"member": "string",
|
@@ -1637,6 +1719,7 @@
|
|
1637
1719
|
},
|
1638
1720
|
{
|
1639
1721
|
"default": "",
|
1722
|
+
"disabled": false,
|
1640
1723
|
"document": "初始化向量,大小为 16 Bytes,加密算法会使用到, base64编码;如果不传,则由后端服务随机生成。用户需要自行保存该值,作为解密的参数。",
|
1641
1724
|
"example": "无",
|
1642
1725
|
"member": "string",
|
@@ -1651,6 +1734,7 @@
|
|
1651
1734
|
"document": "EncryptByWhiteBox返回参数结构体",
|
1652
1735
|
"members": [
|
1653
1736
|
{
|
1737
|
+
"disabled": false,
|
1654
1738
|
"document": "初始化向量,加密算法会使用到, base64编码。如果由调用方在入参中传入,则原样返回。如果调用方没有传入,则后端服务随机生成,并返回",
|
1655
1739
|
"example": "BQbVImt3p_xr8VQebZaXGQ==",
|
1656
1740
|
"member": "string",
|
@@ -1660,6 +1744,7 @@
|
|
1660
1744
|
"value_allowed_null": false
|
1661
1745
|
},
|
1662
1746
|
{
|
1747
|
+
"disabled": false,
|
1663
1748
|
"document": "加密后的密文,base64编码",
|
1664
1749
|
"example": "ZKHH2la4DpwlkwjANQ5hgw==",
|
1665
1750
|
"member": "string",
|
@@ -1682,6 +1767,7 @@
|
|
1682
1767
|
"members": [
|
1683
1768
|
{
|
1684
1769
|
"default": "",
|
1770
|
+
"disabled": false,
|
1685
1771
|
"document": "调用CreateKey生成的CMK全局唯一标识符",
|
1686
1772
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1687
1773
|
"member": "string",
|
@@ -1691,6 +1777,7 @@
|
|
1691
1777
|
},
|
1692
1778
|
{
|
1693
1779
|
"default": "",
|
1780
|
+
"disabled": false,
|
1694
1781
|
"document": "被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K",
|
1695
1782
|
"example": "testName",
|
1696
1783
|
"member": "string",
|
@@ -1700,6 +1787,7 @@
|
|
1700
1787
|
},
|
1701
1788
|
{
|
1702
1789
|
"default": "",
|
1790
|
+
"disabled": false,
|
1703
1791
|
"document": "key/value对的json字符串,如果指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024个字符",
|
1704
1792
|
"example": "testName",
|
1705
1793
|
"member": "string",
|
@@ -1714,6 +1802,7 @@
|
|
1714
1802
|
"document": "Encrypt返回参数结构体",
|
1715
1803
|
"members": [
|
1716
1804
|
{
|
1805
|
+
"disabled": false,
|
1717
1806
|
"document": "加密后的密文,base64编码。注意:本字段中打包了密文和密钥的相关信息,不是对明文的直接加密结果,只有将该字段作为Decrypt接口的输入参数,才可以解密出原文。",
|
1718
1807
|
"example": "ss",
|
1719
1808
|
"member": "string",
|
@@ -1723,6 +1812,7 @@
|
|
1723
1812
|
"value_allowed_null": false
|
1724
1813
|
},
|
1725
1814
|
{
|
1815
|
+
"disabled": false,
|
1726
1816
|
"document": "加密使用的CMK的全局唯一标识",
|
1727
1817
|
"example": "9999aed0-4956-11e9-bc70-5254005e86b4",
|
1728
1818
|
"member": "string",
|
@@ -1745,6 +1835,7 @@
|
|
1745
1835
|
"members": [
|
1746
1836
|
{
|
1747
1837
|
"default": "",
|
1838
|
+
"disabled": false,
|
1748
1839
|
"document": "CMK全局唯一标识符",
|
1749
1840
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1750
1841
|
"member": "string",
|
@@ -1754,6 +1845,7 @@
|
|
1754
1845
|
},
|
1755
1846
|
{
|
1756
1847
|
"default": "",
|
1848
|
+
"disabled": false,
|
1757
1849
|
"document": "指定生成Datakey的加密算法以及Datakey大小,AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个",
|
1758
1850
|
"example": "AES_256",
|
1759
1851
|
"member": "string",
|
@@ -1763,6 +1855,7 @@
|
|
1763
1855
|
},
|
1764
1856
|
{
|
1765
1857
|
"default": "",
|
1858
|
+
"disabled": false,
|
1766
1859
|
"document": "生成的DataKey的长度,同时指定NumberOfBytes和KeySpec时,以NumberOfBytes为准。最小值为1, 最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个",
|
1767
1860
|
"example": "无",
|
1768
1861
|
"member": "uint64",
|
@@ -1772,6 +1865,7 @@
|
|
1772
1865
|
},
|
1773
1866
|
{
|
1774
1867
|
"default": "",
|
1868
|
+
"disabled": false,
|
1775
1869
|
"document": "key/value对的json字符串,如果使用该字段,则返回的DataKey在解密时需要填入相同的字符串",
|
1776
1870
|
"example": "无",
|
1777
1871
|
"member": "string",
|
@@ -1781,6 +1875,7 @@
|
|
1781
1875
|
},
|
1782
1876
|
{
|
1783
1877
|
"default": "",
|
1878
|
+
"disabled": false,
|
1784
1879
|
"document": "PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。",
|
1785
1880
|
"example": "无",
|
1786
1881
|
"member": "string",
|
@@ -1790,6 +1885,7 @@
|
|
1790
1885
|
},
|
1791
1886
|
{
|
1792
1887
|
"default": "",
|
1888
|
+
"disabled": false,
|
1793
1889
|
"document": "非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。",
|
1794
1890
|
"example": "SM2",
|
1795
1891
|
"member": "string",
|
@@ -1804,6 +1900,7 @@
|
|
1804
1900
|
"document": "GenerateDataKey返回参数结构体",
|
1805
1901
|
"members": [
|
1806
1902
|
{
|
1903
|
+
"disabled": false,
|
1807
1904
|
"document": "CMK的全局唯一标识",
|
1808
1905
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1809
1906
|
"member": "string",
|
@@ -1813,6 +1910,7 @@
|
|
1813
1910
|
"value_allowed_null": false
|
1814
1911
|
},
|
1815
1912
|
{
|
1913
|
+
"disabled": false,
|
1816
1914
|
"document": "若调用时未提供 EncryptionPublicKey,该字段值为生成的数据密钥 DataKey 的 Base64 编码的明文,需进行 Base64 解码以获取 DataKey 明文。\n若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取 DataKey 明文。",
|
1817
1915
|
"example": "uW9wqntw+FAgnfsIrxOpOA==",
|
1818
1916
|
"member": "string",
|
@@ -1822,6 +1920,7 @@
|
|
1822
1920
|
"value_allowed_null": false
|
1823
1921
|
},
|
1824
1922
|
{
|
1923
|
+
"disabled": false,
|
1825
1924
|
"document": "数据密钥DataKey加密后的密文,用户需要自行保存该密文,KMS不托管用户的数据密钥。可以通过Decrypt接口从CiphertextBlob中获取数据密钥DataKey明文",
|
1826
1925
|
"example": "g2F8eQk44QrTbfj09TL17AZyFPgs8BTtZe2j27Wuw1YzTBCxnd0T/gwFQSasmtzxZi6mmvD7DCjCE+LxJmdhXQ==-k-fKVP3WIlGpg8m9LMW4jEkQ==-k-h/nUfRbaTUY7/KWXwuSK1Py+ZFRTK5WQiUz6yQE5XBFUN3UwPOUbl8P3A3caow2rlqTjUw==",
|
1827
1926
|
"member": "string",
|
@@ -1844,6 +1943,7 @@
|
|
1844
1943
|
"members": [
|
1845
1944
|
{
|
1846
1945
|
"default": "",
|
1946
|
+
"disabled": false,
|
1847
1947
|
"document": "生成的随机数的长度。最小值为1, 最大值为1024。",
|
1848
1948
|
"example": "16",
|
1849
1949
|
"member": "uint64",
|
@@ -1858,6 +1958,7 @@
|
|
1858
1958
|
"document": "GenerateRandom返回参数结构体",
|
1859
1959
|
"members": [
|
1860
1960
|
{
|
1961
|
+
"disabled": false,
|
1861
1962
|
"document": "生成的随机数的明文,该明文使用base64编码,用户需要使用base64解码得到明文。",
|
1862
1963
|
"example": "17mvQgMl0sbM7OAJ7fpLsA==",
|
1863
1964
|
"member": "string",
|
@@ -1880,6 +1981,7 @@
|
|
1880
1981
|
"members": [
|
1881
1982
|
{
|
1882
1983
|
"default": "",
|
1984
|
+
"disabled": false,
|
1883
1985
|
"document": "CMK唯一标识符",
|
1884
1986
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
1885
1987
|
"member": "string",
|
@@ -1894,6 +1996,7 @@
|
|
1894
1996
|
"document": "GetKeyRotationStatus返回参数结构体",
|
1895
1997
|
"members": [
|
1896
1998
|
{
|
1999
|
+
"disabled": false,
|
1897
2000
|
"document": "密钥轮换是否开启",
|
1898
2001
|
"example": "无",
|
1899
2002
|
"member": "bool",
|
@@ -1916,6 +2019,7 @@
|
|
1916
2019
|
"members": [
|
1917
2020
|
{
|
1918
2021
|
"default": "",
|
2022
|
+
"disabled": false,
|
1919
2023
|
"document": "CMK的唯一标识,获取密钥参数的CMK必须是EXTERNAL类型,即在CreateKey时指定Type=2 类型的CMK。",
|
1920
2024
|
"example": "1ff78c0d-c54b-11e9-9cc9-5254006d0810",
|
1921
2025
|
"member": "string",
|
@@ -1925,6 +2029,7 @@
|
|
1925
2029
|
},
|
1926
2030
|
{
|
1927
2031
|
"default": "",
|
2032
|
+
"disabled": false,
|
1928
2033
|
"document": "指定加密密钥材料的算法,目前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256",
|
1929
2034
|
"example": "RSAES_OAEP_SHA_1",
|
1930
2035
|
"member": "string",
|
@@ -1934,6 +2039,7 @@
|
|
1934
2039
|
},
|
1935
2040
|
{
|
1936
2041
|
"default": "",
|
2042
|
+
"disabled": false,
|
1937
2043
|
"document": "指定加密密钥材料的类型,目前只支持RSA_2048",
|
1938
2044
|
"example": "RSA_2048",
|
1939
2045
|
"member": "string",
|
@@ -1948,6 +2054,7 @@
|
|
1948
2054
|
"document": "GetParametersForImport返回参数结构体",
|
1949
2055
|
"members": [
|
1950
2056
|
{
|
2057
|
+
"disabled": false,
|
1951
2058
|
"document": "CMK的唯一标识,用于指定目标导入密钥材料的CMK。",
|
1952
2059
|
"example": "1ff78c0d-c54b-11e9-9cc9-5254006d0810",
|
1953
2060
|
"member": "string",
|
@@ -1957,6 +2064,7 @@
|
|
1957
2064
|
"value_allowed_null": false
|
1958
2065
|
},
|
1959
2066
|
{
|
2067
|
+
"disabled": false,
|
1960
2068
|
"document": "导入密钥材料需要的token,用于作为 ImportKeyMaterial 的参数。",
|
1961
2069
|
"example": "Sy+GF4f+XxUan1sfSBfqWQmyJeVO30wcqLEMoW4REpw3adjEFXyCP2yqzV8xdD5GMY4gIZoDfJ33SnnbxDMRND8lzh4mZjzFNM8PsjhYrgVSxIiJOCHupZvD4QcoGco8",
|
1962
2070
|
"member": "string",
|
@@ -1966,6 +2074,7 @@
|
|
1966
2074
|
"value_allowed_null": false
|
1967
2075
|
},
|
1968
2076
|
{
|
2077
|
+
"disabled": false,
|
1969
2078
|
"document": "用于加密密钥材料的RSA公钥,base64编码。使用PublicKey base64解码后的公钥将导入密钥进行加密后作为 ImportKeyMaterial 的参数。",
|
1970
2079
|
"example": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1IjpYRubNKn97lPU0/eR8UBaV11glfQLNqlub+YspXwBsvVqcnSvu5c8GoLTEYGSTVbvsREDCq6VfFoSeoIqbv8aWukxbPGWgI1nu55ocvWwthzROFA5UPGC8LOuH0ftZ5Z7cIaigEenS3ngfo4MYTJtg6/Bl1jJVWvjnKzgswsZeFclSURedSXUcMxfSI344s6I17DTNAQ/vQqyjFGIyo2+JctaxVlY2XuBZf7tPimNdoxAoJ14QxAl1gQGu959xnRJ4rwZbxsklJnEivQqTBeFIiv3KTzFJS6bkz2eqRJ1p4jTBDWbHEWTVt6tdXPj4+4D21RFGAt3706vf4PIrwIDAQAB",
|
1971
2080
|
"member": "string",
|
@@ -1975,6 +2084,7 @@
|
|
1975
2084
|
"value_allowed_null": false
|
1976
2085
|
},
|
1977
2086
|
{
|
2087
|
+
"disabled": false,
|
1978
2088
|
"document": "该导出token和公钥的有效期,超过该时间后无法导入,需要重新调用GetParametersForImport获取。",
|
1979
2089
|
"example": "1566614716",
|
1980
2090
|
"member": "uint64",
|
@@ -1997,6 +2107,7 @@
|
|
1997
2107
|
"members": [
|
1998
2108
|
{
|
1999
2109
|
"default": "",
|
2110
|
+
"disabled": false,
|
2000
2111
|
"document": "CMK的唯一标识。",
|
2001
2112
|
"example": "554ef4b3-3071-11ea-a86a-5254006d0810",
|
2002
2113
|
"member": "string",
|
@@ -2011,6 +2122,7 @@
|
|
2011
2122
|
"document": "GetPublicKey返回参数结构体",
|
2012
2123
|
"members": [
|
2013
2124
|
{
|
2125
|
+
"disabled": false,
|
2014
2126
|
"document": "CMK的唯一标识。",
|
2015
2127
|
"example": "554ef4b3-3071-11ea-a86a-5254006d0810",
|
2016
2128
|
"member": "string",
|
@@ -2020,6 +2132,7 @@
|
|
2020
2132
|
"value_allowed_null": false
|
2021
2133
|
},
|
2022
2134
|
{
|
2135
|
+
"disabled": false,
|
2023
2136
|
"document": "经过base64编码的公钥内容。",
|
2024
2137
|
"example": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAz0OTVMh28VCjOE5DMlBM8a2qIjgipYByb7WE/GyTRLUiIGDUq44VIM5fNI9nVeIf2D+4pIiU0s4LUYnLxkGcFKUVWkz3nubUzbNdSHRbNjKhbFyyRGT6YYxqMfvCmNXMA3OE56EmvsWU9VwVXqRPOFTaODCx8bRd+R6O+Aho9GaRfwLKHtlX7dochdDs9SWC6iybRISgpLEh4tvzcSlBemEuyx5U/X/BoL+sVnSsC/XT8J9w0EvJVHZaBW7OhIbBOolhzWTF8TpL/7ncZZUbtfP4SrAkvKgoEIEfRhv5vh5LfSxiS2zQzIShrT6JYqh5IgDIHTdCcPiYmTsk/lmM2wIDAQAB",
|
2025
2138
|
"member": "string",
|
@@ -2029,6 +2142,7 @@
|
|
2029
2142
|
"value_allowed_null": false
|
2030
2143
|
},
|
2031
2144
|
{
|
2145
|
+
"disabled": false,
|
2032
2146
|
"document": "PEM格式的公钥内容。",
|
2033
2147
|
"example": "-----BEGIN PUBLIC KEY-----TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF6ME9UVk1oMjhWQ2pPRTVETWxCTThhMnFJamdpcFlCeWI3V0UvR3lUUkxVaUlHRFVxNDRWSU01Zk5JOW5WZUlmMkQrNHBJaVUwczRMVVluTHhrR2NGS1VWV2t6M251YlV6Yk5kU0hSYk5qS2hiRnl5UkdUNllZeHFNZnZDbU5YTUEzT0U1NkVtdnNXVTlWd1ZYcVJQT0ZUYU9EQ3g4YlJkK1I2TytBaG85R2FSZndMS0h0bFg3ZG9jaGREczlTV0M2aXliUklTZ3BMRWg0dHZ6Y1NsQmVtRXV5eDVVL1gvQm9MK3NWblNzQy9YVDhKOXcwRXZKVkhaYUJXN09oSWJCT29saHpXVEY4VHBMLzduY1paVWJ0ZlA0U3JBa3ZLZ29FSUVmUmh2NXZoNUxmU3hpUzJ6UXpJU2hyVDZKWXFoNUlnRElIVGRDY1BpWW1Uc2svbG1NMndJREFRQUI=-----END PUBLIC KEY-----",
|
2034
2148
|
"member": "string",
|
@@ -2055,6 +2169,7 @@
|
|
2055
2169
|
"document": "GetRegions返回参数结构体",
|
2056
2170
|
"members": [
|
2057
2171
|
{
|
2172
|
+
"disabled": false,
|
2058
2173
|
"document": "可用region列表\n注意:此字段可能返回 null,表示取不到有效值。",
|
2059
2174
|
"example": "ap-hongkong",
|
2060
2175
|
"member": "string",
|
@@ -2081,6 +2196,7 @@
|
|
2081
2196
|
"document": "GetServiceStatus返回参数结构体",
|
2082
2197
|
"members": [
|
2083
2198
|
{
|
2199
|
+
"disabled": false,
|
2084
2200
|
"document": "KMS服务是否开通, true 表示已开通",
|
2085
2201
|
"example": "1",
|
2086
2202
|
"member": "bool",
|
@@ -2089,6 +2205,7 @@
|
|
2089
2205
|
"value_allowed_null": false
|
2090
2206
|
},
|
2091
2207
|
{
|
2208
|
+
"disabled": false,
|
2092
2209
|
"document": "服务不可用类型: 0-未购买,1-正常, 2-欠费停服, 3-资源释放\n注意:此字段可能返回 null,表示取不到有效值。",
|
2093
2210
|
"example": "1",
|
2094
2211
|
"member": "int64",
|
@@ -2097,6 +2214,7 @@
|
|
2097
2214
|
"value_allowed_null": true
|
2098
2215
|
},
|
2099
2216
|
{
|
2217
|
+
"disabled": false,
|
2100
2218
|
"document": "0-普通版,1-旗舰版",
|
2101
2219
|
"example": "0",
|
2102
2220
|
"member": "uint64",
|
@@ -2105,6 +2223,7 @@
|
|
2105
2223
|
"value_allowed_null": false
|
2106
2224
|
},
|
2107
2225
|
{
|
2226
|
+
"disabled": false,
|
2108
2227
|
"document": "旗舰版到期时间(Epoch Unix Timestamp)。\n注意:此字段可能返回 null,表示取不到有效值。",
|
2109
2228
|
"example": "1603701385",
|
2110
2229
|
"member": "uint64",
|
@@ -2113,6 +2232,7 @@
|
|
2113
2232
|
"value_allowed_null": true
|
2114
2233
|
},
|
2115
2234
|
{
|
2235
|
+
"disabled": false,
|
2116
2236
|
"document": "旗舰版是否自动续费:0-不自动续费,1-自动续费\n注意:此字段可能返回 null,表示取不到有效值。",
|
2117
2237
|
"example": "1",
|
2118
2238
|
"member": "uint64",
|
@@ -2121,6 +2241,7 @@
|
|
2121
2241
|
"value_allowed_null": true
|
2122
2242
|
},
|
2123
2243
|
{
|
2244
|
+
"disabled": false,
|
2124
2245
|
"document": "旗舰版购买记录的唯一性标识。如果为开通旗舰版,则返回值为空\n注意:此字段可能返回 null,表示取不到有效值。",
|
2125
2246
|
"example": "kms_pro_12345",
|
2126
2247
|
"member": "string",
|
@@ -2129,6 +2250,7 @@
|
|
2129
2250
|
"value_allowed_null": true
|
2130
2251
|
},
|
2131
2252
|
{
|
2253
|
+
"disabled": false,
|
2132
2254
|
"document": "是否开通 KMS 托管版\n注意:此字段可能返回 null,表示取不到有效值。",
|
2133
2255
|
"example": "false",
|
2134
2256
|
"member": "bool",
|
@@ -2137,6 +2259,7 @@
|
|
2137
2259
|
"value_allowed_null": true
|
2138
2260
|
},
|
2139
2261
|
{
|
2262
|
+
"disabled": false,
|
2140
2263
|
"document": "是否开通 KMS 独享版\n注意:此字段可能返回 null,表示取不到有效值。",
|
2141
2264
|
"example": "false",
|
2142
2265
|
"member": "bool",
|
@@ -2145,6 +2268,7 @@
|
|
2145
2268
|
"value_allowed_null": true
|
2146
2269
|
},
|
2147
2270
|
{
|
2271
|
+
"disabled": false,
|
2148
2272
|
"document": "KMS 订阅信息。\n注意:此字段可能返回 null,表示取不到有效值。",
|
2149
2273
|
"example": "Prepaid_KMS",
|
2150
2274
|
"member": "string",
|
@@ -2166,6 +2290,7 @@
|
|
2166
2290
|
"members": [
|
2167
2291
|
{
|
2168
2292
|
"default": "",
|
2293
|
+
"disabled": false,
|
2169
2294
|
"document": "使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS,导入的密钥材料长度要求为 128 bit,FIPS版本region的KMS, 导入的密钥材料长度要求为 256 bit。",
|
2170
2295
|
"example": "无",
|
2171
2296
|
"member": "string",
|
@@ -2175,6 +2300,7 @@
|
|
2175
2300
|
},
|
2176
2301
|
{
|
2177
2302
|
"default": "",
|
2303
|
+
"disabled": false,
|
2178
2304
|
"document": "通过调用GetParametersForImport获得的导入令牌。",
|
2179
2305
|
"example": "Sy+GF4f+XxUan1sfSBfqWQmyJeVO30wcqLEMoW4REpxBApJqYG9zc37OM0Z3qT/mvLofzM3hwVJSTzIITcAo6ew3LidOJ3nwNoVNOM2wnrL+g9puwP0GpbbSwTd16X9E",
|
2180
2306
|
"member": "string",
|
@@ -2184,6 +2310,7 @@
|
|
2184
2310
|
},
|
2185
2311
|
{
|
2186
2312
|
"default": "",
|
2313
|
+
"disabled": false,
|
2187
2314
|
"document": "指定导入密钥材料的CMK,需要和GetParametersForImport 指定的CMK相同。",
|
2188
2315
|
"example": "1ff78c0d-c54b-11e9-9cc9-5254006d0800",
|
2189
2316
|
"member": "string",
|
@@ -2193,6 +2320,7 @@
|
|
2193
2320
|
},
|
2194
2321
|
{
|
2195
2322
|
"default": "",
|
2323
|
+
"disabled": false,
|
2196
2324
|
"document": "密钥材料过期时间 unix 时间戳,不指定或者 0 表示密钥材料不会过期,若指定过期时间,需要大于当前时间点,最大支持 2147443200。",
|
2197
2325
|
"example": "0",
|
2198
2326
|
"member": "uint64",
|
@@ -2220,6 +2348,7 @@
|
|
2220
2348
|
"members": [
|
2221
2349
|
{
|
2222
2350
|
"default": "",
|
2351
|
+
"disabled": false,
|
2223
2352
|
"document": "CMK的全局唯一标识。",
|
2224
2353
|
"member": "string",
|
2225
2354
|
"name": "KeyId",
|
@@ -2235,6 +2364,7 @@
|
|
2235
2364
|
"members": [
|
2236
2365
|
{
|
2237
2366
|
"default": "",
|
2367
|
+
"disabled": false,
|
2238
2368
|
"document": "CMK的全局唯一标识",
|
2239
2369
|
"example": "6cdf26d1-44ff-11eb-841c-5254006d0810",
|
2240
2370
|
"member": "string",
|
@@ -2245,6 +2375,7 @@
|
|
2245
2375
|
},
|
2246
2376
|
{
|
2247
2377
|
"default": "",
|
2378
|
+
"disabled": false,
|
2248
2379
|
"document": "作为密钥更容易辨识,更容易被人看懂的别名",
|
2249
2380
|
"example": "test",
|
2250
2381
|
"member": "string",
|
@@ -2255,6 +2386,7 @@
|
|
2255
2386
|
},
|
2256
2387
|
{
|
2257
2388
|
"default": "",
|
2389
|
+
"disabled": false,
|
2258
2390
|
"document": "密钥创建时间",
|
2259
2391
|
"example": "11",
|
2260
2392
|
"member": "uint64",
|
@@ -2265,6 +2397,7 @@
|
|
2265
2397
|
},
|
2266
2398
|
{
|
2267
2399
|
"default": "",
|
2400
|
+
"disabled": false,
|
2268
2401
|
"document": "CMK的描述",
|
2269
2402
|
"example": "desc",
|
2270
2403
|
"member": "string",
|
@@ -2275,6 +2408,7 @@
|
|
2275
2408
|
},
|
2276
2409
|
{
|
2277
2410
|
"default": "",
|
2411
|
+
"disabled": false,
|
2278
2412
|
"document": "CMK的状态, 取值为:Enabled | Disabled | PendingDelete | PendingImport | Archived",
|
2279
2413
|
"example": "PendingDelete",
|
2280
2414
|
"member": "string",
|
@@ -2285,6 +2419,7 @@
|
|
2285
2419
|
},
|
2286
2420
|
{
|
2287
2421
|
"default": "",
|
2422
|
+
"disabled": false,
|
2288
2423
|
"document": "CMK用途,取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC",
|
2289
2424
|
"example": "ASYMMETRIC_DECRYPT_RSA_2048",
|
2290
2425
|
"member": "string",
|
@@ -2295,6 +2430,7 @@
|
|
2295
2430
|
},
|
2296
2431
|
{
|
2297
2432
|
"default": "",
|
2433
|
+
"disabled": false,
|
2298
2434
|
"document": "CMK类型,2 表示符合FIPS标准,4表示符合国密标准",
|
2299
2435
|
"example": "3",
|
2300
2436
|
"member": "int64",
|
@@ -2305,6 +2441,7 @@
|
|
2305
2441
|
},
|
2306
2442
|
{
|
2307
2443
|
"default": "",
|
2444
|
+
"disabled": false,
|
2308
2445
|
"document": "创建者",
|
2309
2446
|
"example": "12345678",
|
2310
2447
|
"member": "uint64",
|
@@ -2315,6 +2452,7 @@
|
|
2315
2452
|
},
|
2316
2453
|
{
|
2317
2454
|
"default": "",
|
2455
|
+
"disabled": false,
|
2318
2456
|
"document": "是否开启了密钥轮换功能",
|
2319
2457
|
"example": "true",
|
2320
2458
|
"member": "bool",
|
@@ -2325,6 +2463,7 @@
|
|
2325
2463
|
},
|
2326
2464
|
{
|
2327
2465
|
"default": "",
|
2466
|
+
"disabled": false,
|
2328
2467
|
"document": "CMK的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名",
|
2329
2468
|
"example": "user",
|
2330
2469
|
"member": "string",
|
@@ -2335,6 +2474,7 @@
|
|
2335
2474
|
},
|
2336
2475
|
{
|
2337
2476
|
"default": "",
|
2477
|
+
"disabled": false,
|
2338
2478
|
"document": "在密钥轮换开启状态下,下次轮换的时间",
|
2339
2479
|
"example": "1234567",
|
2340
2480
|
"member": "uint64",
|
@@ -2345,6 +2485,7 @@
|
|
2345
2485
|
},
|
2346
2486
|
{
|
2347
2487
|
"default": "",
|
2488
|
+
"disabled": false,
|
2348
2489
|
"document": "计划删除的时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
2349
2490
|
"example": "123456",
|
2350
2491
|
"member": "uint64",
|
@@ -2355,6 +2496,7 @@
|
|
2355
2496
|
},
|
2356
2497
|
{
|
2357
2498
|
"default": "",
|
2499
|
+
"disabled": false,
|
2358
2500
|
"document": "CMK 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL\n注意:此字段可能返回 null,表示取不到有效值。",
|
2359
2501
|
"example": "EXTERNAL",
|
2360
2502
|
"member": "string",
|
@@ -2365,6 +2507,7 @@
|
|
2365
2507
|
},
|
2366
2508
|
{
|
2367
2509
|
"default": "",
|
2510
|
+
"disabled": false,
|
2368
2511
|
"document": "在Origin为 EXTERNAL 时有效,表示密钥材料的有效日期, 0 表示不过期\n注意:此字段可能返回 null,表示取不到有效值。",
|
2369
2512
|
"example": "12345",
|
2370
2513
|
"member": "uint64",
|
@@ -2375,6 +2518,7 @@
|
|
2375
2518
|
},
|
2376
2519
|
{
|
2377
2520
|
"default": "",
|
2521
|
+
"disabled": false,
|
2378
2522
|
"document": "资源ID,格式:creatorUin/$creatorUin/$keyId",
|
2379
2523
|
"example": "creatorUin/12345/6cdf26d1-44ff-11eb-841c-5254006d0810",
|
2380
2524
|
"member": "string",
|
@@ -2385,6 +2529,7 @@
|
|
2385
2529
|
},
|
2386
2530
|
{
|
2387
2531
|
"default": "",
|
2532
|
+
"disabled": false,
|
2388
2533
|
"document": "HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)\n注意:此字段可能返回 null,表示取不到有效值。",
|
2389
2534
|
"example": "cls-hsm-1a2b3c4d",
|
2390
2535
|
"member": "string",
|
@@ -2405,6 +2550,7 @@
|
|
2405
2550
|
"document": "ListAlgorithms返回参数结构体",
|
2406
2551
|
"members": [
|
2407
2552
|
{
|
2553
|
+
"disabled": false,
|
2408
2554
|
"document": "本地区支持的对称加密算法",
|
2409
2555
|
"example": "无",
|
2410
2556
|
"member": "AlgorithmInfo",
|
@@ -2414,6 +2560,7 @@
|
|
2414
2560
|
"value_allowed_null": false
|
2415
2561
|
},
|
2416
2562
|
{
|
2563
|
+
"disabled": false,
|
2417
2564
|
"document": "本地区支持的非对称加密算法",
|
2418
2565
|
"example": "无",
|
2419
2566
|
"member": "AlgorithmInfo",
|
@@ -2423,6 +2570,7 @@
|
|
2423
2570
|
"value_allowed_null": false
|
2424
2571
|
},
|
2425
2572
|
{
|
2573
|
+
"disabled": false,
|
2426
2574
|
"document": "本地区支持的非对称签名验签算法",
|
2427
2575
|
"example": "无",
|
2428
2576
|
"member": "AlgorithmInfo",
|
@@ -2445,6 +2593,7 @@
|
|
2445
2593
|
"members": [
|
2446
2594
|
{
|
2447
2595
|
"default": "",
|
2596
|
+
"disabled": false,
|
2448
2597
|
"document": "含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0",
|
2449
2598
|
"example": "0",
|
2450
2599
|
"member": "uint64",
|
@@ -2454,6 +2603,7 @@
|
|
2454
2603
|
},
|
2455
2604
|
{
|
2456
2605
|
"default": "",
|
2606
|
+
"disabled": false,
|
2457
2607
|
"document": "含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为10,最大值为200",
|
2458
2608
|
"example": "10",
|
2459
2609
|
"member": "uint64",
|
@@ -2463,6 +2613,7 @@
|
|
2463
2613
|
},
|
2464
2614
|
{
|
2465
2615
|
"default": "",
|
2616
|
+
"disabled": false,
|
2466
2617
|
"document": "根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk",
|
2467
2618
|
"example": "0",
|
2468
2619
|
"member": "uint64",
|
@@ -2472,6 +2623,7 @@
|
|
2472
2623
|
},
|
2473
2624
|
{
|
2474
2625
|
"default": "",
|
2626
|
+
"disabled": false,
|
2475
2627
|
"document": "根据CMK创建时间排序, 0 表示按照降序排序,1表示按照升序排序",
|
2476
2628
|
"example": "0",
|
2477
2629
|
"member": "uint64",
|
@@ -2481,6 +2633,7 @@
|
|
2481
2633
|
},
|
2482
2634
|
{
|
2483
2635
|
"default": "",
|
2636
|
+
"disabled": false,
|
2484
2637
|
"document": "根据CMK状态筛选, 0表示全部CMK, 1 表示仅查询Enabled CMK, 2 表示仅查询Disabled CMK,3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key),4 表示查询 PendingImport 状态的CMK,5 表示查询 Archived 状态的 CMK",
|
2485
2638
|
"example": "0",
|
2486
2639
|
"member": "uint64",
|
@@ -2490,6 +2643,7 @@
|
|
2490
2643
|
},
|
2491
2644
|
{
|
2492
2645
|
"default": "",
|
2646
|
+
"disabled": false,
|
2493
2647
|
"document": "根据KeyId或者Alias进行模糊匹配查询",
|
2494
2648
|
"example": "test",
|
2495
2649
|
"member": "string",
|
@@ -2499,6 +2653,7 @@
|
|
2499
2653
|
},
|
2500
2654
|
{
|
2501
2655
|
"default": "",
|
2656
|
+
"disabled": false,
|
2502
2657
|
"document": "根据CMK类型筛选, \"TENCENT_KMS\" 表示筛选密钥材料由KMS创建的CMK, \"EXTERNAL\" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK,\"ALL\" 或者不设置表示两种类型都查询,大小写敏感。",
|
2503
2658
|
"example": "ALL",
|
2504
2659
|
"member": "string",
|
@@ -2508,6 +2663,7 @@
|
|
2508
2663
|
},
|
2509
2664
|
{
|
2510
2665
|
"default": "",
|
2666
|
+
"disabled": false,
|
2511
2667
|
"document": "根据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类型",
|
2512
2668
|
"example": "ASYMMETRIC_SIGN_VERIFY_RSA_2048",
|
2513
2669
|
"member": "string",
|
@@ -2517,6 +2673,7 @@
|
|
2517
2673
|
},
|
2518
2674
|
{
|
2519
2675
|
"default": "",
|
2676
|
+
"disabled": false,
|
2520
2677
|
"document": "标签过滤条件",
|
2521
2678
|
"example": "test",
|
2522
2679
|
"member": "TagFilter",
|
@@ -2526,6 +2683,7 @@
|
|
2526
2683
|
},
|
2527
2684
|
{
|
2528
2685
|
"default": "",
|
2686
|
+
"disabled": false,
|
2529
2687
|
"document": "KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。",
|
2530
2688
|
"example": "无",
|
2531
2689
|
"member": "string",
|
@@ -2540,6 +2698,7 @@
|
|
2540
2698
|
"document": "ListKeyDetail返回参数结构体",
|
2541
2699
|
"members": [
|
2542
2700
|
{
|
2701
|
+
"disabled": false,
|
2543
2702
|
"document": "CMK的总数量",
|
2544
2703
|
"example": "10",
|
2545
2704
|
"member": "uint64",
|
@@ -2549,6 +2708,7 @@
|
|
2549
2708
|
"value_allowed_null": false
|
2550
2709
|
},
|
2551
2710
|
{
|
2711
|
+
"disabled": false,
|
2552
2712
|
"document": "返回的属性信息列表。\n注意:此字段可能返回 null,表示取不到有效值。",
|
2553
2713
|
"example": "test",
|
2554
2714
|
"member": "KeyMetadata",
|
@@ -2571,6 +2731,7 @@
|
|
2571
2731
|
"members": [
|
2572
2732
|
{
|
2573
2733
|
"default": "",
|
2734
|
+
"disabled": false,
|
2574
2735
|
"document": "含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0",
|
2575
2736
|
"example": "0",
|
2576
2737
|
"member": "uint64",
|
@@ -2580,6 +2741,7 @@
|
|
2580
2741
|
},
|
2581
2742
|
{
|
2582
2743
|
"default": "",
|
2744
|
+
"disabled": false,
|
2583
2745
|
"document": "含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200",
|
2584
2746
|
"example": "2",
|
2585
2747
|
"member": "uint64",
|
@@ -2589,6 +2751,7 @@
|
|
2589
2751
|
},
|
2590
2752
|
{
|
2591
2753
|
"default": "",
|
2754
|
+
"disabled": false,
|
2592
2755
|
"document": "根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk",
|
2593
2756
|
"example": "无",
|
2594
2757
|
"member": "uint64",
|
@@ -2598,6 +2761,7 @@
|
|
2598
2761
|
},
|
2599
2762
|
{
|
2600
2763
|
"default": "",
|
2764
|
+
"disabled": false,
|
2601
2765
|
"document": "KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。",
|
2602
2766
|
"example": "无",
|
2603
2767
|
"member": "string",
|
@@ -2612,6 +2776,7 @@
|
|
2612
2776
|
"document": "ListKeys返回参数结构体",
|
2613
2777
|
"members": [
|
2614
2778
|
{
|
2779
|
+
"disabled": false,
|
2615
2780
|
"document": "CMK列表数组\n注意:此字段可能返回 null,表示取不到有效值。",
|
2616
2781
|
"example": "无",
|
2617
2782
|
"member": "Key",
|
@@ -2621,6 +2786,7 @@
|
|
2621
2786
|
"value_allowed_null": true
|
2622
2787
|
},
|
2623
2788
|
{
|
2789
|
+
"disabled": false,
|
2624
2790
|
"document": "CMK的总数量",
|
2625
2791
|
"example": "100",
|
2626
2792
|
"member": "uint64",
|
@@ -2643,6 +2809,7 @@
|
|
2643
2809
|
"members": [
|
2644
2810
|
{
|
2645
2811
|
"default": "",
|
2812
|
+
"disabled": false,
|
2646
2813
|
"document": "白盒密钥ID",
|
2647
2814
|
"example": "cd850a3d-9b1b-11ea-a96a-5254006d0810",
|
2648
2815
|
"member": "string",
|
@@ -2652,6 +2819,7 @@
|
|
2652
2819
|
},
|
2653
2820
|
{
|
2654
2821
|
"default": "",
|
2822
|
+
"disabled": false,
|
2655
2823
|
"document": "设备指纹列表,如果列表为空,则表示删除该密钥对应的所有指纹信息。列表最大长度不超过200。",
|
2656
2824
|
"example": "无",
|
2657
2825
|
"member": "DeviceFingerprint",
|
@@ -2678,6 +2846,7 @@
|
|
2678
2846
|
"document": "PostQuantumCryptoDecrypt请求参数结构体",
|
2679
2847
|
"members": [
|
2680
2848
|
{
|
2849
|
+
"disabled": false,
|
2681
2850
|
"document": "待解密的密文数据",
|
2682
2851
|
"example": "Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL",
|
2683
2852
|
"member": "string",
|
@@ -2686,6 +2855,7 @@
|
|
2686
2855
|
"type": "string"
|
2687
2856
|
},
|
2688
2857
|
{
|
2858
|
+
"disabled": false,
|
2689
2859
|
"document": "PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。",
|
2690
2860
|
"example": "无",
|
2691
2861
|
"member": "string",
|
@@ -2694,6 +2864,7 @@
|
|
2694
2864
|
"type": "string"
|
2695
2865
|
},
|
2696
2866
|
{
|
2867
|
+
"disabled": false,
|
2697
2868
|
"document": "非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。",
|
2698
2869
|
"example": "SM2",
|
2699
2870
|
"member": "string",
|
@@ -2708,6 +2879,7 @@
|
|
2708
2879
|
"document": "PostQuantumCryptoDecrypt返回参数结构体",
|
2709
2880
|
"members": [
|
2710
2881
|
{
|
2882
|
+
"disabled": false,
|
2711
2883
|
"document": "CMK的全局唯一标识",
|
2712
2884
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
2713
2885
|
"member": "string",
|
@@ -2716,6 +2888,7 @@
|
|
2716
2888
|
"value_allowed_null": false
|
2717
2889
|
},
|
2718
2890
|
{
|
2891
|
+
"disabled": false,
|
2719
2892
|
"document": "若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。\n若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。",
|
2720
2893
|
"example": "dGVzdCUyMHBsYWluJTIwdGV4dA==",
|
2721
2894
|
"member": "string",
|
@@ -2736,6 +2909,7 @@
|
|
2736
2909
|
"document": "PostQuantumCryptoEncrypt请求参数结构体",
|
2737
2910
|
"members": [
|
2738
2911
|
{
|
2912
|
+
"disabled": false,
|
2739
2913
|
"document": "调用CreateKey生成的CMK全局唯一标识符",
|
2740
2914
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
2741
2915
|
"member": "string",
|
@@ -2744,6 +2918,7 @@
|
|
2744
2918
|
"type": "string"
|
2745
2919
|
},
|
2746
2920
|
{
|
2921
|
+
"disabled": false,
|
2747
2922
|
"document": "被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K",
|
2748
2923
|
"example": "testName",
|
2749
2924
|
"member": "string",
|
@@ -2758,6 +2933,7 @@
|
|
2758
2933
|
"document": "PostQuantumCryptoEncrypt返回参数结构体",
|
2759
2934
|
"members": [
|
2760
2935
|
{
|
2936
|
+
"disabled": false,
|
2761
2937
|
"document": "加密后的密文,base64编码。注意:本字段中打包了密文和密钥的相关信息,不是对明文的直接加密结果,只有将该字段作为PostQuantumCryptoDecrypt接口的输入参数,才可以解密出原文。",
|
2762
2938
|
"example": "ss",
|
2763
2939
|
"member": "string",
|
@@ -2766,6 +2942,7 @@
|
|
2766
2942
|
"value_allowed_null": false
|
2767
2943
|
},
|
2768
2944
|
{
|
2945
|
+
"disabled": false,
|
2769
2946
|
"document": "加密使用的CMK的全局唯一标识",
|
2770
2947
|
"example": "9999aed0-4956-11e9-bc70-5254005e86b4",
|
2771
2948
|
"member": "string",
|
@@ -2786,6 +2963,7 @@
|
|
2786
2963
|
"document": "PostQuantumCryptoSign请求参数结构体",
|
2787
2964
|
"members": [
|
2788
2965
|
{
|
2966
|
+
"disabled": false,
|
2789
2967
|
"document": "Base64 编码的消息原文。消息原文的长度(Base64编码前的长度)不超过4096字节。",
|
2790
2968
|
"example": "abc",
|
2791
2969
|
"member": "string",
|
@@ -2794,6 +2972,7 @@
|
|
2794
2972
|
"type": "string"
|
2795
2973
|
},
|
2796
2974
|
{
|
2975
|
+
"disabled": false,
|
2797
2976
|
"document": "密钥的唯一标识",
|
2798
2977
|
"example": "6cdf26d1-44ff-11eb-841c-5254006d0810",
|
2799
2978
|
"member": "string",
|
@@ -2808,6 +2987,7 @@
|
|
2808
2987
|
"document": "PostQuantumCryptoSign返回参数结构体",
|
2809
2988
|
"members": [
|
2810
2989
|
{
|
2990
|
+
"disabled": false,
|
2811
2991
|
"document": "签名值,Base64编码。可使用 PostQuantumCryptoVerify接口对签名值进行验证。",
|
2812
2992
|
"example": "MEUCICr/JCV52BqGvI0iYxdZ1eL8zzJjx39mWNv2ZWdLOMvRAiEApO6os3Wj0Tg3",
|
2813
2993
|
"member": "string",
|
@@ -2828,6 +3008,7 @@
|
|
2828
3008
|
"document": "PostQuantumCryptoVerify请求参数结构体",
|
2829
3009
|
"members": [
|
2830
3010
|
{
|
3011
|
+
"disabled": false,
|
2831
3012
|
"document": "密钥的唯一标识",
|
2832
3013
|
"example": "6cdf26d1-44ff-11eb-841c-5254006d0810",
|
2833
3014
|
"member": "string",
|
@@ -2836,6 +3017,7 @@
|
|
2836
3017
|
"type": "string"
|
2837
3018
|
},
|
2838
3019
|
{
|
3020
|
+
"disabled": false,
|
2839
3021
|
"document": "签名值,通过调用KMS PostQuantumCryptoSign签名接口生成",
|
2840
3022
|
"example": "MEUCICr/JCV52BqGvI0iYxdZ1eL8zzJjx39mWNv2ZWdLOMvRAiEApO6os3Wj0Tg3",
|
2841
3023
|
"member": "string",
|
@@ -2844,6 +3026,7 @@
|
|
2844
3026
|
"type": "string"
|
2845
3027
|
},
|
2846
3028
|
{
|
3029
|
+
"disabled": false,
|
2847
3030
|
"document": "Base64 编码的消息原文,消息原文的长度(Base64编码前的长度)不超过4096字节。",
|
2848
3031
|
"example": "abc",
|
2849
3032
|
"member": "string",
|
@@ -2858,6 +3041,7 @@
|
|
2858
3041
|
"document": "PostQuantumCryptoVerify返回参数结构体",
|
2859
3042
|
"members": [
|
2860
3043
|
{
|
3044
|
+
"disabled": false,
|
2861
3045
|
"document": "签名是否有效。true:签名有效,false:签名无效。",
|
2862
3046
|
"example": "true",
|
2863
3047
|
"member": "bool",
|
@@ -2879,6 +3063,7 @@
|
|
2879
3063
|
"members": [
|
2880
3064
|
{
|
2881
3065
|
"default": "",
|
3066
|
+
"disabled": false,
|
2882
3067
|
"document": "需要重新加密的密文",
|
2883
3068
|
"example": "Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL",
|
2884
3069
|
"member": "string",
|
@@ -2888,6 +3073,7 @@
|
|
2888
3073
|
},
|
2889
3074
|
{
|
2890
3075
|
"default": "",
|
3076
|
+
"disabled": false,
|
2891
3077
|
"document": "重新加密使用的CMK,如果为空,则使用密文原有的CMK重新加密(若密钥没有轮换则密文不会刷新)",
|
2892
3078
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
2893
3079
|
"member": "string",
|
@@ -2897,6 +3083,7 @@
|
|
2897
3083
|
},
|
2898
3084
|
{
|
2899
3085
|
"default": "",
|
3086
|
+
"disabled": false,
|
2900
3087
|
"document": "CiphertextBlob 密文加密时使用的key/value对的json字符串。如果加密时未使用,则为空",
|
2901
3088
|
"example": "无",
|
2902
3089
|
"member": "string",
|
@@ -2906,6 +3093,7 @@
|
|
2906
3093
|
},
|
2907
3094
|
{
|
2908
3095
|
"default": "",
|
3096
|
+
"disabled": false,
|
2909
3097
|
"document": "重新加密使用的key/value对的json字符串,如果使用该字段,则返回的新密文在解密时需要填入相同的字符串",
|
2910
3098
|
"example": "无",
|
2911
3099
|
"member": "string",
|
@@ -2920,6 +3108,7 @@
|
|
2920
3108
|
"document": "ReEncrypt返回参数结构体",
|
2921
3109
|
"members": [
|
2922
3110
|
{
|
3111
|
+
"disabled": false,
|
2923
3112
|
"document": "重新加密后的密文",
|
2924
3113
|
"example": "无",
|
2925
3114
|
"member": "string",
|
@@ -2929,6 +3118,7 @@
|
|
2929
3118
|
"value_allowed_null": false
|
2930
3119
|
},
|
2931
3120
|
{
|
3121
|
+
"disabled": false,
|
2932
3122
|
"document": "重新加密使用的CMK",
|
2933
3123
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
2934
3124
|
"member": "string",
|
@@ -2938,6 +3128,7 @@
|
|
2938
3128
|
"value_allowed_null": false
|
2939
3129
|
},
|
2940
3130
|
{
|
3131
|
+
"disabled": false,
|
2941
3132
|
"document": "重新加密前密文使用的CMK",
|
2942
3133
|
"example": "23e80852-1e38-11e9-b129-5cb9019b0000",
|
2943
3134
|
"member": "string",
|
@@ -2947,6 +3138,7 @@
|
|
2947
3138
|
"value_allowed_null": false
|
2948
3139
|
},
|
2949
3140
|
{
|
3141
|
+
"disabled": false,
|
2950
3142
|
"document": "true表示密文已经重新加密。同一个CMK进行重加密,在密钥没有发生轮换的情况下不会进行实际重新加密操作,返回原密文",
|
2951
3143
|
"example": "1",
|
2952
3144
|
"member": "bool",
|
@@ -2969,6 +3161,7 @@
|
|
2969
3161
|
"members": [
|
2970
3162
|
{
|
2971
3163
|
"default": "",
|
3164
|
+
"disabled": false,
|
2972
3165
|
"document": "CMK的唯一标志",
|
2973
3166
|
"example": "无",
|
2974
3167
|
"member": "string",
|
@@ -2978,6 +3171,7 @@
|
|
2978
3171
|
},
|
2979
3172
|
{
|
2980
3173
|
"default": "",
|
3174
|
+
"disabled": false,
|
2981
3175
|
"document": "计划删除时间区间[7,30]",
|
2982
3176
|
"example": "无",
|
2983
3177
|
"member": "uint64",
|
@@ -2992,6 +3186,7 @@
|
|
2992
3186
|
"document": "ScheduleKeyDeletion返回参数结构体",
|
2993
3187
|
"members": [
|
2994
3188
|
{
|
3189
|
+
"disabled": false,
|
2995
3190
|
"document": "计划删除执行时间",
|
2996
3191
|
"example": "1559318399",
|
2997
3192
|
"member": "uint64",
|
@@ -3001,6 +3196,7 @@
|
|
3001
3196
|
"value_allowed_null": false
|
3002
3197
|
},
|
3003
3198
|
{
|
3199
|
+
"disabled": false,
|
3004
3200
|
"document": "唯一标志被计划删除的CMK",
|
3005
3201
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
3006
3202
|
"member": "string",
|
@@ -3023,6 +3219,7 @@
|
|
3023
3219
|
"members": [
|
3024
3220
|
{
|
3025
3221
|
"default": "",
|
3222
|
+
"disabled": false,
|
3026
3223
|
"document": "签名算法,支持的算法:SM2DSA,ECC_P256_R1,RSA_PSS_SHA_256,RSA_PKCS1_SHA_256 等。更多支持的算法可通过 ListAlgorithms 接口进行查询。",
|
3027
3224
|
"example": "SM2DSA",
|
3028
3225
|
"member": "string",
|
@@ -3032,6 +3229,7 @@
|
|
3032
3229
|
},
|
3033
3230
|
{
|
3034
3231
|
"default": "",
|
3232
|
+
"disabled": false,
|
3035
3233
|
"document": "消息原文或消息摘要。如果提供的是消息原文,则消息原文的长度(Base64编码前的长度)不超过4096字节。如果提供的是消息摘要,消息摘要长度(Base64编码前的长度)必须等于32字节",
|
3036
3234
|
"example": "abc",
|
3037
3235
|
"member": "string",
|
@@ -3041,6 +3239,7 @@
|
|
3041
3239
|
},
|
3042
3240
|
{
|
3043
3241
|
"default": "",
|
3242
|
+
"disabled": false,
|
3044
3243
|
"document": "密钥的唯一标识",
|
3045
3244
|
"example": "6cdf26d1-44ff-11eb-841c-5254006d0810",
|
3046
3245
|
"member": "string",
|
@@ -3050,6 +3249,7 @@
|
|
3050
3249
|
},
|
3051
3250
|
{
|
3052
3251
|
"default": "",
|
3252
|
+
"disabled": false,
|
3053
3253
|
"document": "消息类型:RAW,DIGEST,如果不传,默认为RAW,表示消息原文。",
|
3054
3254
|
"example": "RAW",
|
3055
3255
|
"member": "string",
|
@@ -3064,6 +3264,7 @@
|
|
3064
3264
|
"document": "SignByAsymmetricKey返回参数结构体",
|
3065
3265
|
"members": [
|
3066
3266
|
{
|
3267
|
+
"disabled": false,
|
3067
3268
|
"document": "签名,Base64编码",
|
3068
3269
|
"example": "MEUCICr/JCV52BqGvI0iYxdZ1eL8zzJjx39mWNv2ZWdLOMvRAiEApO6os3Wj0Tg3",
|
3069
3270
|
"member": "string",
|
@@ -3086,6 +3287,7 @@
|
|
3086
3287
|
"members": [
|
3087
3288
|
{
|
3088
3289
|
"default": "",
|
3290
|
+
"disabled": false,
|
3089
3291
|
"document": "标签键",
|
3090
3292
|
"member": "string",
|
3091
3293
|
"name": "TagKey",
|
@@ -3095,6 +3297,7 @@
|
|
3095
3297
|
},
|
3096
3298
|
{
|
3097
3299
|
"default": "",
|
3300
|
+
"disabled": false,
|
3098
3301
|
"document": "标签值",
|
3099
3302
|
"member": "string",
|
3100
3303
|
"name": "TagValue",
|
@@ -3110,6 +3313,7 @@
|
|
3110
3313
|
"members": [
|
3111
3314
|
{
|
3112
3315
|
"default": "",
|
3316
|
+
"disabled": false,
|
3113
3317
|
"document": "标签键",
|
3114
3318
|
"member": "string",
|
3115
3319
|
"name": "TagKey",
|
@@ -3119,6 +3323,7 @@
|
|
3119
3323
|
},
|
3120
3324
|
{
|
3121
3325
|
"default": "",
|
3326
|
+
"disabled": false,
|
3122
3327
|
"document": "标签值",
|
3123
3328
|
"member": "string",
|
3124
3329
|
"name": "TagValue",
|
@@ -3134,6 +3339,7 @@
|
|
3134
3339
|
"members": [
|
3135
3340
|
{
|
3136
3341
|
"default": "",
|
3342
|
+
"disabled": false,
|
3137
3343
|
"document": "cmk的ID",
|
3138
3344
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
3139
3345
|
"member": "string",
|
@@ -3143,6 +3349,7 @@
|
|
3143
3349
|
},
|
3144
3350
|
{
|
3145
3351
|
"default": "",
|
3352
|
+
"disabled": false,
|
3146
3353
|
"document": "云产品的唯一性标识符",
|
3147
3354
|
"example": "ssm",
|
3148
3355
|
"member": "string",
|
@@ -3152,6 +3359,7 @@
|
|
3152
3359
|
},
|
3153
3360
|
{
|
3154
3361
|
"default": "",
|
3362
|
+
"disabled": false,
|
3155
3363
|
"document": "资源/实例ID,由调用方根据自己的云产品特征来定义,以字符串形式做存储。",
|
3156
3364
|
"example": "resourceId",
|
3157
3365
|
"member": "string",
|
@@ -3179,6 +3387,7 @@
|
|
3179
3387
|
"members": [
|
3180
3388
|
{
|
3181
3389
|
"default": "",
|
3390
|
+
"disabled": false,
|
3182
3391
|
"document": "新的别名,1-60个字符或数字的组合",
|
3183
3392
|
"example": "NewAlias",
|
3184
3393
|
"member": "string",
|
@@ -3188,6 +3397,7 @@
|
|
3188
3397
|
},
|
3189
3398
|
{
|
3190
3399
|
"default": "",
|
3400
|
+
"disabled": false,
|
3191
3401
|
"document": "CMK的全局唯一标识符",
|
3192
3402
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
3193
3403
|
"member": "string",
|
@@ -3215,6 +3425,7 @@
|
|
3215
3425
|
"members": [
|
3216
3426
|
{
|
3217
3427
|
"default": "",
|
3428
|
+
"disabled": false,
|
3218
3429
|
"document": "新的描述信息,最大支持1024字节",
|
3219
3430
|
"example": "NewDescription",
|
3220
3431
|
"member": "string",
|
@@ -3224,6 +3435,7 @@
|
|
3224
3435
|
},
|
3225
3436
|
{
|
3226
3437
|
"default": "",
|
3438
|
+
"disabled": false,
|
3227
3439
|
"document": "需要修改描述信息的CMK ID",
|
3228
3440
|
"example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
|
3229
3441
|
"member": "string",
|
@@ -3251,6 +3463,7 @@
|
|
3251
3463
|
"members": [
|
3252
3464
|
{
|
3253
3465
|
"default": "",
|
3466
|
+
"disabled": false,
|
3254
3467
|
"document": "密钥的唯一标识",
|
3255
3468
|
"example": "6cdf26d1-44ff-11eb-841c-5254006d0810",
|
3256
3469
|
"member": "string",
|
@@ -3260,6 +3473,7 @@
|
|
3260
3473
|
},
|
3261
3474
|
{
|
3262
3475
|
"default": "",
|
3476
|
+
"disabled": false,
|
3263
3477
|
"document": "签名值,通过调用KMS签名接口生成",
|
3264
3478
|
"example": "MEUCICr/JCV52BqGvI0iYxdZ1eL8zzJjx39mWNv2ZWdLOMvRAiEApO6os3Wj0Tg3",
|
3265
3479
|
"member": "string",
|
@@ -3269,6 +3483,7 @@
|
|
3269
3483
|
},
|
3270
3484
|
{
|
3271
3485
|
"default": "",
|
3486
|
+
"disabled": false,
|
3272
3487
|
"document": "消息原文或消息摘要。如果提供的是消息原文,则消息原文的长度(Base64编码前的长度)不超过4096字节。如果提供的是消息摘要,则消息摘要长度(Base64编码前的长度)必须等于32字节",
|
3273
3488
|
"example": "abc",
|
3274
3489
|
"member": "string",
|
@@ -3278,6 +3493,7 @@
|
|
3278
3493
|
},
|
3279
3494
|
{
|
3280
3495
|
"default": "",
|
3496
|
+
"disabled": false,
|
3281
3497
|
"document": "签名算法,支持的算法:SM2DSA,ECC_P256_R1,RSA_PSS_SHA_256,RSA_PKCS1_SHA_256 等。更多支持的算法可通过 ListAlgorithms 接口进行查询。",
|
3282
3498
|
"example": "SM2DSA",
|
3283
3499
|
"member": "string",
|
@@ -3287,6 +3503,7 @@
|
|
3287
3503
|
},
|
3288
3504
|
{
|
3289
3505
|
"default": "",
|
3506
|
+
"disabled": false,
|
3290
3507
|
"document": "消息类型:RAW,DIGEST,如果不传,默认为RAW,表示消息原文。",
|
3291
3508
|
"example": "RAW",
|
3292
3509
|
"member": "string",
|
@@ -3301,6 +3518,7 @@
|
|
3301
3518
|
"document": "VerifyByAsymmetricKey返回参数结构体",
|
3302
3519
|
"members": [
|
3303
3520
|
{
|
3521
|
+
"disabled": false,
|
3304
3522
|
"document": "签名是否有效。true:签名有效,false:签名无效。",
|
3305
3523
|
"example": "true",
|
3306
3524
|
"member": "bool",
|
@@ -3323,6 +3541,7 @@
|
|
3323
3541
|
"members": [
|
3324
3542
|
{
|
3325
3543
|
"default": "",
|
3544
|
+
"disabled": false,
|
3326
3545
|
"document": "白盒密钥的全局唯一标识符",
|
3327
3546
|
"member": "string",
|
3328
3547
|
"name": "KeyId",
|
@@ -3332,6 +3551,7 @@
|
|
3332
3551
|
},
|
3333
3552
|
{
|
3334
3553
|
"default": "",
|
3554
|
+
"disabled": false,
|
3335
3555
|
"document": "作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字. 不可重复",
|
3336
3556
|
"member": "string",
|
3337
3557
|
"name": "Alias",
|
@@ -3341,6 +3561,7 @@
|
|
3341
3561
|
},
|
3342
3562
|
{
|
3343
3563
|
"default": "",
|
3564
|
+
"disabled": false,
|
3344
3565
|
"document": "创建者",
|
3345
3566
|
"member": "uint64",
|
3346
3567
|
"name": "CreatorUin",
|
@@ -3350,6 +3571,7 @@
|
|
3350
3571
|
},
|
3351
3572
|
{
|
3352
3573
|
"default": "",
|
3574
|
+
"disabled": false,
|
3353
3575
|
"document": "密钥的描述信息",
|
3354
3576
|
"member": "string",
|
3355
3577
|
"name": "Description",
|
@@ -3359,6 +3581,7 @@
|
|
3359
3581
|
},
|
3360
3582
|
{
|
3361
3583
|
"default": "",
|
3584
|
+
"disabled": false,
|
3362
3585
|
"document": "密钥创建时间,Unix时间戳",
|
3363
3586
|
"member": "uint64",
|
3364
3587
|
"name": "CreateTime",
|
@@ -3368,6 +3591,7 @@
|
|
3368
3591
|
},
|
3369
3592
|
{
|
3370
3593
|
"default": "",
|
3594
|
+
"disabled": false,
|
3371
3595
|
"document": "白盒密钥的状态, 取值为:Enabled | Disabled",
|
3372
3596
|
"member": "string",
|
3373
3597
|
"name": "Status",
|
@@ -3377,6 +3601,7 @@
|
|
3377
3601
|
},
|
3378
3602
|
{
|
3379
3603
|
"default": "",
|
3604
|
+
"disabled": false,
|
3380
3605
|
"document": "创建者",
|
3381
3606
|
"member": "uint64",
|
3382
3607
|
"name": "OwnerUin",
|
@@ -3386,6 +3611,7 @@
|
|
3386
3611
|
},
|
3387
3612
|
{
|
3388
3613
|
"default": "",
|
3614
|
+
"disabled": false,
|
3389
3615
|
"document": "密钥所用的算法类型",
|
3390
3616
|
"member": "string",
|
3391
3617
|
"name": "Algorithm",
|
@@ -3395,6 +3621,7 @@
|
|
3395
3621
|
},
|
3396
3622
|
{
|
3397
3623
|
"default": "",
|
3624
|
+
"disabled": false,
|
3398
3625
|
"document": "白盒加密密钥,base64编码",
|
3399
3626
|
"member": "string",
|
3400
3627
|
"name": "EncryptKey",
|
@@ -3404,6 +3631,7 @@
|
|
3404
3631
|
},
|
3405
3632
|
{
|
3406
3633
|
"default": "",
|
3634
|
+
"disabled": false,
|
3407
3635
|
"document": "白盒解密密钥,base64编码",
|
3408
3636
|
"member": "string",
|
3409
3637
|
"name": "DecryptKey",
|
@@ -3413,6 +3641,7 @@
|
|
3413
3641
|
},
|
3414
3642
|
{
|
3415
3643
|
"default": "",
|
3644
|
+
"disabled": false,
|
3416
3645
|
"document": "资源ID,格式:creatorUin/$creatorUin/$keyId",
|
3417
3646
|
"member": "string",
|
3418
3647
|
"name": "ResourceId",
|
@@ -3422,6 +3651,7 @@
|
|
3422
3651
|
},
|
3423
3652
|
{
|
3424
3653
|
"default": "",
|
3654
|
+
"disabled": false,
|
3425
3655
|
"document": "是否有设备指纹与当前密钥绑定\n注意:此字段可能返回 null,表示取不到有效值。",
|
3426
3656
|
"member": "bool",
|
3427
3657
|
"name": "DeviceFingerprintBind",
|