tccli 3.0.1339.1__py2.py3-none-any.whl → 3.0.1341.1__py2.py3-none-any.whl

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.
Files changed (55) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/bh/bh_client.py +326 -8
  3. tccli/services/bh/v20230418/api.json +547 -0
  4. tccli/services/bh/v20230418/examples.json +48 -0
  5. tccli/services/ccc/v20200210/api.json +1 -1
  6. tccli/services/cdb/v20170320/api.json +144 -144
  7. tccli/services/cdb/v20170320/examples.json +19 -19
  8. tccli/services/cdn/v20180606/examples.json +1 -1
  9. tccli/services/csip/v20221121/api.json +48 -10
  10. tccli/services/csip/v20221121/examples.json +11 -11
  11. tccli/services/cvm/v20170312/api.json +9 -0
  12. tccli/services/cwp/v20180228/api.json +106 -2
  13. tccli/services/cwp/v20180228/examples.json +12 -0
  14. tccli/services/cynosdb/v20190107/api.json +29 -2
  15. tccli/services/cynosdb/v20190107/examples.json +1 -1
  16. tccli/services/dsgc/v20190723/api.json +215 -17
  17. tccli/services/emr/emr_client.py +363 -310
  18. tccli/services/emr/v20190103/api.json +299 -0
  19. tccli/services/emr/v20190103/examples.json +8 -0
  20. tccli/services/ess/v20201111/api.json +16 -5
  21. tccli/services/essbasic/v20210526/api.json +1 -1
  22. tccli/services/gs/v20191118/api.json +10 -1
  23. tccli/services/ims/v20200713/api.json +1 -1
  24. tccli/services/ims/v20200713/examples.json +1 -1
  25. tccli/services/kms/kms_client.py +915 -120
  26. tccli/services/kms/v20190118/api.json +1104 -27
  27. tccli/services/kms/v20190118/examples.json +126 -0
  28. tccli/services/live/v20180801/api.json +9 -0
  29. tccli/services/live/v20180801/examples.json +4 -4
  30. tccli/services/lke/lke_client.py +228 -16
  31. tccli/services/lke/v20231130/api.json +1490 -217
  32. tccli/services/lke/v20231130/examples.json +33 -1
  33. tccli/services/mqtt/v20240516/api.json +80 -0
  34. tccli/services/mqtt/v20240516/examples.json +6 -0
  35. tccli/services/organization/v20210331/api.json +11 -0
  36. tccli/services/organization/v20210331/examples.json +1 -1
  37. tccli/services/partners/v20180321/api.json +2 -2
  38. tccli/services/postgres/v20170312/api.json +4 -4
  39. tccli/services/ses/v20201002/api.json +8 -8
  40. tccli/services/tcss/v20201101/api.json +10 -0
  41. tccli/services/thpc/v20230321/api.json +32 -2
  42. tccli/services/tione/v20211111/api.json +11 -0
  43. tccli/services/trocket/trocket_client.py +53 -0
  44. tccli/services/trocket/v20230308/api.json +233 -143
  45. tccli/services/trocket/v20230308/examples.json +14 -6
  46. tccli/services/vpc/v20170312/api.json +9 -0
  47. tccli/services/waf/v20180125/api.json +59 -21
  48. tccli/services/wedata/v20210820/api.json +432 -10
  49. tccli/services/wedata/v20210820/examples.json +17 -1
  50. tccli/services/wedata/wedata_client.py +114 -8
  51. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/METADATA +2 -2
  52. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/RECORD +55 -55
  53. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/WHEEL +0 -0
  54. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/entry_points.txt +0 -0
  55. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/license_files/LICENSE +0 -0
@@ -28,6 +28,13 @@
28
28
  "output": "BindCloudResourceResponse",
29
29
  "status": "online"
30
30
  },
31
+ "CancelDataKeyDeletion": {
32
+ "document": "取消计划删除数据密钥",
33
+ "input": "CancelDataKeyDeletionRequest",
34
+ "name": "取消计划删除数据密钥",
35
+ "output": "CancelDataKeyDeletionResponse",
36
+ "status": "online"
37
+ },
31
38
  "CancelKeyArchive": {
32
39
  "document": "取消密钥归档,取消后密钥的状态变为Enabled。",
33
40
  "input": "CancelKeyArchiveRequest",
@@ -77,6 +84,20 @@
77
84
  "output": "DeleteWhiteBoxKeyResponse",
78
85
  "status": "online"
79
86
  },
87
+ "DescribeDataKey": {
88
+ "document": "获取数据密钥的详情",
89
+ "input": "DescribeDataKeyRequest",
90
+ "name": "获取数据密钥的详情",
91
+ "output": "DescribeDataKeyResponse",
92
+ "status": "online"
93
+ },
94
+ "DescribeDataKeys": {
95
+ "document": "返回数据密钥属性信息列表",
96
+ "input": "DescribeDataKeysRequest",
97
+ "name": "获取数据密钥的详情列表",
98
+ "output": "DescribeDataKeysResponse",
99
+ "status": "online"
100
+ },
80
101
  "DescribeKey": {
81
102
  "document": "用于获取指定KeyId的主密钥属性详情信息。",
82
103
  "input": "DescribeKeyRequest",
@@ -126,6 +147,20 @@
126
147
  "output": "DescribeWhiteBoxServiceStatusResponse",
127
148
  "status": "online"
128
149
  },
150
+ "DisableDataKey": {
151
+ "document": "禁用数据密钥",
152
+ "input": "DisableDataKeyRequest",
153
+ "name": "禁用数据密钥",
154
+ "output": "DisableDataKeyResponse",
155
+ "status": "online"
156
+ },
157
+ "DisableDataKeys": {
158
+ "document": "批量禁用数据密钥",
159
+ "input": "DisableDataKeysRequest",
160
+ "name": "批量禁用数据密钥",
161
+ "output": "DisableDataKeysResponse",
162
+ "status": "online"
163
+ },
129
164
  "DisableKey": {
130
165
  "document": "本接口用于禁用一个主密钥,处于禁用状态的Key无法用于加密、解密操作。",
131
166
  "input": "DisableKeyRequest",
@@ -161,6 +196,20 @@
161
196
  "output": "DisableWhiteBoxKeysResponse",
162
197
  "status": "online"
163
198
  },
199
+ "EnableDataKey": {
200
+ "document": "启用数据密钥",
201
+ "input": "EnableDataKeyRequest",
202
+ "name": "启用数据密钥",
203
+ "output": "EnableDataKeyResponse",
204
+ "status": "online"
205
+ },
206
+ "EnableDataKeys": {
207
+ "document": "批量启用数据密钥",
208
+ "input": "EnableDataKeysRequest",
209
+ "name": "批量启用数据密钥",
210
+ "output": "EnableDataKeysResponse",
211
+ "status": "online"
212
+ },
164
213
  "EnableKey": {
165
214
  "document": "用于启用一个指定的CMK。",
166
215
  "input": "EnableKeyRequest",
@@ -224,6 +273,20 @@
224
273
  "output": "GenerateRandomResponse",
225
274
  "status": "online"
226
275
  },
276
+ "GetDataKeyCiphertextBlob": {
277
+ "document": "下载数据密钥密文",
278
+ "input": "GetDataKeyCiphertextBlobRequest",
279
+ "name": "下载数据密钥密文",
280
+ "output": "GetDataKeyCiphertextBlobResponse",
281
+ "status": "online"
282
+ },
283
+ "GetDataKeyPlaintext": {
284
+ "document": "获取数据密钥明文",
285
+ "input": "GetDataKeyPlaintextRequest",
286
+ "name": "获取数据密钥明文",
287
+ "output": "GetDataKeyPlaintextResponse",
288
+ "status": "online"
289
+ },
227
290
  "GetKeyRotationStatus": {
228
291
  "document": "查询指定的CMK是否开启了密钥轮换功能。",
229
292
  "input": "GetKeyRotationStatusRequest",
@@ -259,6 +322,13 @@
259
322
  "output": "GetServiceStatusResponse",
260
323
  "status": "online"
261
324
  },
325
+ "ImportDataKey": {
326
+ "document": "数据密钥导入接口,并托管到KMS",
327
+ "input": "ImportDataKeyRequest",
328
+ "name": "导入数据密钥",
329
+ "output": "ImportDataKeyResponse",
330
+ "status": "online"
331
+ },
262
332
  "ImportKeyMaterial": {
263
333
  "document": "用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入,导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料,并重新指定过期时间,但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后,指定的CMK将无法使用,需要再次导入相同的密钥材料才能正常使用。CMK是独立的,同样的密钥材料可导入不同的 CMK 中,但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。\n只有Enabled 和 PendingImport状态的CMK可以导入密钥材料。",
264
334
  "input": "ImportKeyMaterialRequest",
@@ -273,6 +343,20 @@
273
343
  "output": "ListAlgorithmsResponse",
274
344
  "status": "online"
275
345
  },
346
+ "ListDataKeyDetail": {
347
+ "document": "根据指定Offset和Limit获取数据密钥列表详情。",
348
+ "input": "ListDataKeyDetailRequest",
349
+ "name": "获取数据密钥列表详情",
350
+ "output": "ListDataKeyDetailResponse",
351
+ "status": "online"
352
+ },
353
+ "ListDataKeys": {
354
+ "document": "用于查询数据密钥的列表",
355
+ "input": "ListDataKeysRequest",
356
+ "name": "获取数据密钥的列表",
357
+ "output": "ListDataKeysResponse",
358
+ "status": "online"
359
+ },
276
360
  "ListKeyDetail": {
277
361
  "document": "根据指定Offset和Limit获取主密钥列表详情。",
278
362
  "input": "ListKeyDetailRequest",
@@ -329,6 +413,13 @@
329
413
  "output": "ReEncryptResponse",
330
414
  "status": "online"
331
415
  },
416
+ "ScheduleDataKeyDeletion": {
417
+ "document": "计划删除数据密钥",
418
+ "input": "ScheduleDataKeyDeletionRequest",
419
+ "name": "计划删除数据密钥",
420
+ "output": "ScheduleDataKeyDeletionResponse",
421
+ "status": "online"
422
+ },
332
423
  "ScheduleKeyDeletion": {
333
424
  "document": "CMK计划删除接口,用于指定CMK删除的时间,可选时间区间为[7,30]天",
334
425
  "input": "ScheduleKeyDeletionRequest",
@@ -357,6 +448,20 @@
357
448
  "output": "UpdateAliasResponse",
358
449
  "status": "online"
359
450
  },
451
+ "UpdateDataKeyDescription": {
452
+ "document": "修改数据密钥描述",
453
+ "input": "UpdateDataKeyDescriptionRequest",
454
+ "name": "修改数据密钥描述",
455
+ "output": "UpdateDataKeyDescriptionResponse",
456
+ "status": "online"
457
+ },
458
+ "UpdateDataKeyName": {
459
+ "document": "修改数据密钥名称",
460
+ "input": "UpdateDataKeyNameRequest",
461
+ "name": "修改数据密钥名称",
462
+ "output": "UpdateDataKeyNameResponse",
463
+ "status": "online"
464
+ },
360
465
  "UpdateKeyDescription": {
361
466
  "document": "该接口用于对指定的cmk修改描述信息。对于处于PendingDelete状态的CMK禁止修改。",
362
467
  "input": "UpdateKeyDescriptionRequest",
@@ -598,6 +703,43 @@
598
703
  ],
599
704
  "type": "object"
600
705
  },
706
+ "CancelDataKeyDeletionRequest": {
707
+ "document": "CancelDataKeyDeletion请求参数结构体",
708
+ "members": [
709
+ {
710
+ "disabled": false,
711
+ "document": "数据密钥的唯一标志符",
712
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
713
+ "member": "string",
714
+ "name": "DataKeyId",
715
+ "required": true,
716
+ "type": "string"
717
+ }
718
+ ],
719
+ "type": "object"
720
+ },
721
+ "CancelDataKeyDeletionResponse": {
722
+ "document": "CancelDataKeyDeletion返回参数结构体",
723
+ "members": [
724
+ {
725
+ "disabled": false,
726
+ "document": "唯一标志被计划删除的数据密钥",
727
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
728
+ "member": "string",
729
+ "name": "DataKeyId",
730
+ "output_required": false,
731
+ "type": "string",
732
+ "value_allowed_null": false
733
+ },
734
+ {
735
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
736
+ "member": "string",
737
+ "name": "RequestId",
738
+ "type": "string"
739
+ }
740
+ ],
741
+ "type": "object"
742
+ },
601
743
  "CancelKeyArchiveRequest": {
602
744
  "document": "CancelKeyArchive请求参数结构体",
603
745
  "members": [
@@ -928,6 +1070,159 @@
928
1070
  ],
929
1071
  "type": "object"
930
1072
  },
1073
+ "DataKey": {
1074
+ "document": "数据密钥属性",
1075
+ "members": [
1076
+ {
1077
+ "disabled": false,
1078
+ "document": "DataKey的全局唯一标识。",
1079
+ "example": "\t 5551ef2e-6742-11ef-8133-525400b2f623",
1080
+ "member": "string",
1081
+ "name": "DataKeyId",
1082
+ "output_required": true,
1083
+ "required": false,
1084
+ "type": "string",
1085
+ "value_allowed_null": false
1086
+ }
1087
+ ],
1088
+ "usage": "both"
1089
+ },
1090
+ "DataKeyMetadata": {
1091
+ "document": "数据密钥属性信息",
1092
+ "members": [
1093
+ {
1094
+ "disabled": false,
1095
+ "document": "DataKey的全局唯一标识",
1096
+ "example": "93866e69-9755-11ef-8e65-52540089547t",
1097
+ "member": "string",
1098
+ "name": "DataKeyId",
1099
+ "output_required": true,
1100
+ "type": "string",
1101
+ "value_allowed_null": false
1102
+ },
1103
+ {
1104
+ "disabled": false,
1105
+ "document": "CMK的全局唯一标识",
1106
+ "example": "6cdf26d1-44ff-11eb-841c-5254006d0810",
1107
+ "member": "string",
1108
+ "name": "KeyId",
1109
+ "output_required": true,
1110
+ "type": "string",
1111
+ "value_allowed_null": false
1112
+ },
1113
+ {
1114
+ "disabled": false,
1115
+ "document": "作为密钥更容易辨识,更容易被人看懂的数据密钥名称",
1116
+ "example": "lzctest",
1117
+ "member": "string",
1118
+ "name": "DataKeyName",
1119
+ "output_required": true,
1120
+ "type": "string",
1121
+ "value_allowed_null": false
1122
+ },
1123
+ {
1124
+ "disabled": false,
1125
+ "document": "数据密钥的长度,单位字节",
1126
+ "example": "32",
1127
+ "member": "uint64",
1128
+ "name": "NumberOfBytes",
1129
+ "output_required": true,
1130
+ "type": "int",
1131
+ "value_allowed_null": false
1132
+ },
1133
+ {
1134
+ "disabled": false,
1135
+ "document": "密钥创建时间",
1136
+ "example": "1730357927",
1137
+ "member": "uint64",
1138
+ "name": "CreateTime",
1139
+ "output_required": true,
1140
+ "type": "int",
1141
+ "value_allowed_null": false
1142
+ },
1143
+ {
1144
+ "disabled": false,
1145
+ "document": "DataKey的描述",
1146
+ "example": "desc",
1147
+ "member": "string",
1148
+ "name": "Description",
1149
+ "output_required": true,
1150
+ "type": "string",
1151
+ "value_allowed_null": false
1152
+ },
1153
+ {
1154
+ "disabled": false,
1155
+ "document": "DataKey的状态, 取值为:Enabled | Disabled | PendingDelete",
1156
+ "example": "PendingDelete",
1157
+ "member": "string",
1158
+ "name": "KeyState",
1159
+ "output_required": true,
1160
+ "type": "string",
1161
+ "value_allowed_null": false
1162
+ },
1163
+ {
1164
+ "disabled": false,
1165
+ "document": "创建者",
1166
+ "example": "700001224410",
1167
+ "member": "uint64",
1168
+ "name": "CreatorUin",
1169
+ "output_required": true,
1170
+ "type": "int",
1171
+ "value_allowed_null": false
1172
+ },
1173
+ {
1174
+ "disabled": false,
1175
+ "document": "数据密钥的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名",
1176
+ "example": "user",
1177
+ "member": "string",
1178
+ "name": "Owner",
1179
+ "output_required": true,
1180
+ "type": "string",
1181
+ "value_allowed_null": false
1182
+ },
1183
+ {
1184
+ "disabled": false,
1185
+ "document": "计划删除的时间",
1186
+ "example": "0",
1187
+ "member": "uint64",
1188
+ "name": "DeletionDate",
1189
+ "output_required": false,
1190
+ "type": "int",
1191
+ "value_allowed_null": false
1192
+ },
1193
+ {
1194
+ "disabled": false,
1195
+ "document": "DataKey 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL",
1196
+ "example": "EXTERNAL",
1197
+ "member": "string",
1198
+ "name": "Origin",
1199
+ "output_required": false,
1200
+ "type": "string",
1201
+ "value_allowed_null": false
1202
+ },
1203
+ {
1204
+ "disabled": false,
1205
+ "document": "HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)",
1206
+ "example": "cls-hsm-1a2b3c4d",
1207
+ "member": "string",
1208
+ "name": "HsmClusterId",
1209
+ "output_required": false,
1210
+ "type": "string",
1211
+ "value_allowed_null": false
1212
+ },
1213
+ {
1214
+ "disabled": false,
1215
+ "document": "资源ID,格式:creatorUin/$creatorUin/$dataKeyId",
1216
+ "example": "creatorUin/12345/6cdf26d1-44ff-11eb-841c-5254006d0810",
1217
+ "member": "string",
1218
+ "name": "ResourceId",
1219
+ "output_required": false,
1220
+ "type": "string",
1221
+ "value_allowed_null": false
1222
+ }
1223
+ ],
1224
+ "usage": "out"
1225
+ },
931
1226
  "DecryptRequest": {
932
1227
  "document": "Decrypt请求参数结构体",
933
1228
  "members": [
@@ -1056,6 +1351,80 @@
1056
1351
  ],
1057
1352
  "type": "object"
1058
1353
  },
1354
+ "DescribeDataKeyRequest": {
1355
+ "document": "DescribeDataKey请求参数结构体",
1356
+ "members": [
1357
+ {
1358
+ "disabled": false,
1359
+ "document": "数据密钥全局唯一标识符",
1360
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
1361
+ "member": "string",
1362
+ "name": "DataKeyId",
1363
+ "required": true,
1364
+ "type": "string"
1365
+ }
1366
+ ],
1367
+ "type": "object"
1368
+ },
1369
+ "DescribeDataKeyResponse": {
1370
+ "document": "DescribeDataKey返回参数结构体",
1371
+ "members": [
1372
+ {
1373
+ "disabled": false,
1374
+ "document": "数据密钥属性信息",
1375
+ "example": "无",
1376
+ "member": "DataKeyMetadata",
1377
+ "name": "DataKeyMetadata",
1378
+ "output_required": true,
1379
+ "type": "object",
1380
+ "value_allowed_null": false
1381
+ },
1382
+ {
1383
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1384
+ "member": "string",
1385
+ "name": "RequestId",
1386
+ "type": "string"
1387
+ }
1388
+ ],
1389
+ "type": "object"
1390
+ },
1391
+ "DescribeDataKeysRequest": {
1392
+ "document": "DescribeDataKeys请求参数结构体",
1393
+ "members": [
1394
+ {
1395
+ "disabled": false,
1396
+ "document": "查询DataKey的ID列表,批量查询一次最多支持100个DataKeyId",
1397
+ "example": "[\"87ff856e-973c-11ef-947b-525400d834e5\"]",
1398
+ "member": "string",
1399
+ "name": "DataKeyIds",
1400
+ "required": true,
1401
+ "type": "list"
1402
+ }
1403
+ ],
1404
+ "type": "object"
1405
+ },
1406
+ "DescribeDataKeysResponse": {
1407
+ "document": "DescribeDataKeys返回参数结构体",
1408
+ "members": [
1409
+ {
1410
+ "disabled": false,
1411
+ "document": "返回数据密钥属性信息列表",
1412
+ "example": " { \"DataKeyName\": \"x\", \"CreateTime\": xxx, \"CreatorUin\": xxx, \"DeletionDate\": 0, \"Description\": \"x\", \"HsmClusterId\": \"cls-x-x\",\"NumberOfBytes\":32, \"DataKeyId\": \"xxx\", \"KeyId\": \"xxx\", \"KeyState\": \"xxx\", \"Origin\": \"xxx\",\"ResourceId\": \"creatorUin/xxx/xxx\" } ",
1413
+ "member": "DataKeyMetadata",
1414
+ "name": "DataKeyMetadatas",
1415
+ "output_required": true,
1416
+ "type": "list",
1417
+ "value_allowed_null": false
1418
+ },
1419
+ {
1420
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1421
+ "member": "string",
1422
+ "name": "RequestId",
1423
+ "type": "string"
1424
+ }
1425
+ ],
1426
+ "type": "object"
1427
+ },
1059
1428
  "DescribeKeyRequest": {
1060
1429
  "document": "DescribeKey请求参数结构体",
1061
1430
  "members": [
@@ -1370,23 +1739,23 @@
1370
1739
  ],
1371
1740
  "usage": "both"
1372
1741
  },
1373
- "DisableKeyRequest": {
1374
- "document": "DisableKey请求参数结构体",
1742
+ "DisableDataKeyRequest": {
1743
+ "document": "DisableDataKey请求参数结构体",
1375
1744
  "members": [
1376
1745
  {
1377
1746
  "disabled": false,
1378
- "document": "CMK唯一标识符",
1747
+ "document": "数据密钥唯一标识符",
1379
1748
  "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
1380
1749
  "member": "string",
1381
- "name": "KeyId",
1750
+ "name": "DataKeyId",
1382
1751
  "required": true,
1383
1752
  "type": "string"
1384
1753
  }
1385
1754
  ],
1386
1755
  "type": "object"
1387
1756
  },
1388
- "DisableKeyResponse": {
1389
- "document": "DisableKey返回参数结构体",
1757
+ "DisableDataKeyResponse": {
1758
+ "document": "DisableDataKey返回参数结构体",
1390
1759
  "members": [
1391
1760
  {
1392
1761
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -1397,8 +1766,62 @@
1397
1766
  ],
1398
1767
  "type": "object"
1399
1768
  },
1400
- "DisableKeyRotationRequest": {
1401
- "document": "DisableKeyRotation请求参数结构体",
1769
+ "DisableDataKeysRequest": {
1770
+ "document": "DisableDataKeys请求参数结构体",
1771
+ "members": [
1772
+ {
1773
+ "disabled": false,
1774
+ "document": "需要批量禁用的DataKey Id 列表,数据密钥数量最大支持100",
1775
+ "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]",
1776
+ "member": "string",
1777
+ "name": "DataKeyIds",
1778
+ "required": true,
1779
+ "type": "list"
1780
+ }
1781
+ ],
1782
+ "type": "object"
1783
+ },
1784
+ "DisableDataKeysResponse": {
1785
+ "document": "DisableDataKeys返回参数结构体",
1786
+ "members": [
1787
+ {
1788
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1789
+ "member": "string",
1790
+ "name": "RequestId",
1791
+ "type": "string"
1792
+ }
1793
+ ],
1794
+ "type": "object"
1795
+ },
1796
+ "DisableKeyRequest": {
1797
+ "document": "DisableKey请求参数结构体",
1798
+ "members": [
1799
+ {
1800
+ "disabled": false,
1801
+ "document": "CMK唯一标识符",
1802
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
1803
+ "member": "string",
1804
+ "name": "KeyId",
1805
+ "required": true,
1806
+ "type": "string"
1807
+ }
1808
+ ],
1809
+ "type": "object"
1810
+ },
1811
+ "DisableKeyResponse": {
1812
+ "document": "DisableKey返回参数结构体",
1813
+ "members": [
1814
+ {
1815
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1816
+ "member": "string",
1817
+ "name": "RequestId",
1818
+ "type": "string"
1819
+ }
1820
+ ],
1821
+ "type": "object"
1822
+ },
1823
+ "DisableKeyRotationRequest": {
1824
+ "document": "DisableKeyRotation请求参数结构体",
1402
1825
  "members": [
1403
1826
  {
1404
1827
  "disabled": false,
@@ -1505,6 +1928,60 @@
1505
1928
  ],
1506
1929
  "type": "object"
1507
1930
  },
1931
+ "EnableDataKeyRequest": {
1932
+ "document": "EnableDataKey请求参数结构体",
1933
+ "members": [
1934
+ {
1935
+ "disabled": false,
1936
+ "document": "数据密钥唯一标识符",
1937
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
1938
+ "member": "string",
1939
+ "name": "DataKeyId",
1940
+ "required": true,
1941
+ "type": "string"
1942
+ }
1943
+ ],
1944
+ "type": "object"
1945
+ },
1946
+ "EnableDataKeyResponse": {
1947
+ "document": "EnableDataKey返回参数结构体",
1948
+ "members": [
1949
+ {
1950
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1951
+ "member": "string",
1952
+ "name": "RequestId",
1953
+ "type": "string"
1954
+ }
1955
+ ],
1956
+ "type": "object"
1957
+ },
1958
+ "EnableDataKeysRequest": {
1959
+ "document": "EnableDataKeys请求参数结构体",
1960
+ "members": [
1961
+ {
1962
+ "disabled": false,
1963
+ "document": "需要批量启用的DataKey Id 列表, 数据密钥数量最大支持100",
1964
+ "example": "\t [\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]",
1965
+ "member": "string",
1966
+ "name": "DataKeyIds",
1967
+ "required": true,
1968
+ "type": "list"
1969
+ }
1970
+ ],
1971
+ "type": "object"
1972
+ },
1973
+ "EnableDataKeysResponse": {
1974
+ "document": "EnableDataKeys返回参数结构体",
1975
+ "members": [
1976
+ {
1977
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1978
+ "member": "string",
1979
+ "name": "RequestId",
1980
+ "type": "string"
1981
+ }
1982
+ ],
1983
+ "type": "object"
1984
+ },
1508
1985
  "EnableKeyRequest": {
1509
1986
  "document": "EnableKey请求参数结构体",
1510
1987
  "members": [
@@ -1861,6 +2338,42 @@
1861
2338
  "name": "EncryptionAlgorithm",
1862
2339
  "required": false,
1863
2340
  "type": "string"
2341
+ },
2342
+ {
2343
+ "disabled": false,
2344
+ "document": "表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。",
2345
+ "example": "0",
2346
+ "member": "uint64",
2347
+ "name": "IsHostedByKms",
2348
+ "required": false,
2349
+ "type": "int"
2350
+ },
2351
+ {
2352
+ "disabled": false,
2353
+ "document": "数据密钥的名称,当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填,KMS不托管。",
2354
+ "example": "testdataKey",
2355
+ "member": "string",
2356
+ "name": "DataKeyName",
2357
+ "required": false,
2358
+ "type": "string"
2359
+ },
2360
+ {
2361
+ "disabled": false,
2362
+ "document": "数据密钥 的描述,最大100字节",
2363
+ "example": "Description",
2364
+ "member": "string",
2365
+ "name": "Description",
2366
+ "required": false,
2367
+ "type": "string"
2368
+ },
2369
+ {
2370
+ "disabled": false,
2371
+ "document": "KMS 独享版对应的 HSM 集群 ID。\n当KeyId 没有传入时有效,如果指定HsmClusterId,会默认在此集群下生成根密钥,然后利用创建的根密钥产生数据密钥。\n如果没有指定HsmClusterId,则会在公有云共享集群下创建一个根密钥,然后利用创建的根密钥产生数据密钥。",
2372
+ "example": "cluster-123",
2373
+ "member": "string",
2374
+ "name": "HsmClusterId",
2375
+ "required": false,
2376
+ "type": "string"
1864
2377
  }
1865
2378
  ],
1866
2379
  "type": "object"
@@ -1898,6 +2411,16 @@
1898
2411
  "type": "string",
1899
2412
  "value_allowed_null": false
1900
2413
  },
2414
+ {
2415
+ "disabled": false,
2416
+ "document": "DataKey的全局唯一标识,当KMS托管数据密钥时返回。",
2417
+ "example": "93866e69-9755-11ef-8e65-52540089547t",
2418
+ "member": "string",
2419
+ "name": "DataKeyId",
2420
+ "output_required": false,
2421
+ "type": "string",
2422
+ "value_allowed_null": false
2423
+ },
1901
2424
  {
1902
2425
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1903
2426
  "member": "string",
@@ -1944,6 +2467,98 @@
1944
2467
  ],
1945
2468
  "type": "object"
1946
2469
  },
2470
+ "GetDataKeyCiphertextBlobRequest": {
2471
+ "document": "GetDataKeyCiphertextBlob请求参数结构体",
2472
+ "members": [
2473
+ {
2474
+ "disabled": false,
2475
+ "document": "数据密钥的唯一标志符",
2476
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
2477
+ "member": "string",
2478
+ "name": "DataKeyId",
2479
+ "required": true,
2480
+ "type": "string"
2481
+ }
2482
+ ],
2483
+ "type": "object"
2484
+ },
2485
+ "GetDataKeyCiphertextBlobResponse": {
2486
+ "document": "GetDataKeyCiphertextBlob返回参数结构体",
2487
+ "members": [
2488
+ {
2489
+ "disabled": false,
2490
+ "document": "数据密钥的密文",
2491
+ "example": "GPJUsGlmPcSjHKIktXGyzn33yestz+7NteW36M6FuL8hPfJ1xVfdO6Akr8sF69x3yBXMwto4njumJMIsi9WKow==-k-XqqalxTyNKIC1rITRePFGQ==-k-xAL9z9eXIHV/p+WT1RsHP3dm6f43bkomXjwmvWdMXH+JQoFORTThfXgcRh1f9lPNLENK4+fCOiQVG1VvLdA0RvcuRvU=",
2492
+ "member": "string",
2493
+ "name": "CiphertextBlob",
2494
+ "output_required": true,
2495
+ "type": "string",
2496
+ "value_allowed_null": false
2497
+ },
2498
+ {
2499
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2500
+ "member": "string",
2501
+ "name": "RequestId",
2502
+ "type": "string"
2503
+ }
2504
+ ],
2505
+ "type": "object"
2506
+ },
2507
+ "GetDataKeyPlaintextRequest": {
2508
+ "document": "GetDataKeyPlaintext请求参数结构体",
2509
+ "members": [
2510
+ {
2511
+ "disabled": false,
2512
+ "document": "数据密钥的唯一标志符",
2513
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
2514
+ "member": "string",
2515
+ "name": "DataKeyId",
2516
+ "required": true,
2517
+ "type": "string"
2518
+ },
2519
+ {
2520
+ "disabled": false,
2521
+ "document": "PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。",
2522
+ "example": "-----BEGIN PUBLIC KEY----- MFkwEwY*****fJiHQuh2Jr9lMspgK58UVMJTvQCAU+Hztyhd6Aw== -----END PUBLIC KEY-----",
2523
+ "member": "string",
2524
+ "name": "EncryptionPublicKey",
2525
+ "required": false,
2526
+ "type": "string"
2527
+ },
2528
+ {
2529
+ "disabled": false,
2530
+ "document": "非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。",
2531
+ "example": "SM2",
2532
+ "member": "string",
2533
+ "name": "EncryptionAlgorithm",
2534
+ "required": false,
2535
+ "type": "string"
2536
+ }
2537
+ ],
2538
+ "type": "object"
2539
+ },
2540
+ "GetDataKeyPlaintextResponse": {
2541
+ "document": "GetDataKeyPlaintext返回参数结构体",
2542
+ "members": [
2543
+ {
2544
+ "disabled": false,
2545
+ "document": "若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。 若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。",
2546
+ "example": "dGVzdAo=",
2547
+ "member": "string",
2548
+ "name": "Plaintext",
2549
+ "output_required": true,
2550
+ "type": "string",
2551
+ "value_allowed_null": false
2552
+ },
2553
+ {
2554
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2555
+ "member": "string",
2556
+ "name": "RequestId",
2557
+ "type": "string"
2558
+ }
2559
+ ],
2560
+ "type": "object"
2561
+ },
1947
2562
  "GetKeyRotationStatusRequest": {
1948
2563
  "document": "GetKeyRotationStatus请求参数结构体",
1949
2564
  "members": [
@@ -2210,7 +2825,7 @@
2210
2825
  },
2211
2826
  {
2212
2827
  "disabled": false,
2213
- "document": "旗舰版购买记录的唯一性标识。如果为开通旗舰版,则返回值为空",
2828
+ "document": "旗舰版购买记录的唯一性标识。如果未开通旗舰版,则返回值为空",
2214
2829
  "example": "kms_pro_12345",
2215
2830
  "member": "string",
2216
2831
  "name": "ProResourceId",
@@ -2278,6 +2893,46 @@
2278
2893
  "type": "list",
2279
2894
  "value_allowed_null": false
2280
2895
  },
2896
+ {
2897
+ "disabled": false,
2898
+ "document": "是否支持数据密钥托管。1:支持,0:不支持。",
2899
+ "example": "0",
2900
+ "member": "bool",
2901
+ "name": "IsAllowedDataKeyHosted",
2902
+ "output_required": false,
2903
+ "type": "bool",
2904
+ "value_allowed_null": false
2905
+ },
2906
+ {
2907
+ "disabled": false,
2908
+ "document": "IsAllowedDataKeyHosted为1时有效,数据密钥的购买额度",
2909
+ "example": "0",
2910
+ "member": "uint64",
2911
+ "name": "DataKeyLimit",
2912
+ "output_required": false,
2913
+ "type": "int",
2914
+ "value_allowed_null": false
2915
+ },
2916
+ {
2917
+ "disabled": false,
2918
+ "document": "IsAllowedDataKeyHosted为1时有效,数据密钥免费额度。",
2919
+ "example": "0",
2920
+ "member": "uint64",
2921
+ "name": "FreeDataKeyLimit",
2922
+ "output_required": false,
2923
+ "type": "int",
2924
+ "value_allowed_null": false
2925
+ },
2926
+ {
2927
+ "disabled": false,
2928
+ "document": "IsAllowedDataKeyHosted为1时有效,已使用的数据密钥数量。",
2929
+ "example": "0",
2930
+ "member": "uint64",
2931
+ "name": "DataKeyUsedCount",
2932
+ "output_required": false,
2933
+ "type": "int",
2934
+ "value_allowed_null": false
2935
+ },
2281
2936
  {
2282
2937
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2283
2938
  "member": "string",
@@ -2287,42 +2942,134 @@
2287
2942
  ],
2288
2943
  "type": "object"
2289
2944
  },
2290
- "ImportKeyMaterialRequest": {
2291
- "document": "ImportKeyMaterial请求参数结构体",
2945
+ "ImportDataKeyRequest": {
2946
+ "document": "ImportDataKey请求参数结构体",
2292
2947
  "members": [
2293
2948
  {
2294
2949
  "disabled": false,
2295
- "document": "使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS,导入的密钥材料长度要求为 128 bit,FIPS版本region的KMS, 导入的密钥材料长度要求为 256 bit。",
2296
- "example": "YLbjnjPPIYjPb1XhyBYNmcr7yv1YMnfDmuHX8D0qCmUAP3Qi+2URkLJvZ/zCWuJK0Y23/QHX8a8lrKz4WVgUVuoleOriQMNx+AcRkjCegkcqkdJ8BNlaXsNJ67zjSZWDu9qI+bHXEqSIcXcz/l5jdBEum6tYViIDrNKIY6FaLC0Ex7y3eoN5A3YFhQoL7F7upNXZHhogP+YXqLqD7fKzsM8qgMW25qSddlhW4H1s1zOfwfobLAQDXofu9OAZ58Xf8KjnqEoA1Bn60kuJBoqqUV4BqOG3egTqCQaCdcn98oZFPTQpB/SVCE4hENncEV3tNihv2IwjFxSCjZHcJzhYuQ==",
2950
+ "document": "数据密钥的名称",
2951
+ "example": "testDataKey",
2297
2952
  "member": "string",
2298
- "name": "EncryptedKeyMaterial",
2953
+ "name": "DataKeyName",
2299
2954
  "required": true,
2300
2955
  "type": "string"
2301
2956
  },
2302
2957
  {
2303
2958
  "disabled": false,
2304
- "document": "通过调用GetParametersForImport获得的导入令牌。",
2305
- "example": "+b1d61DykcbWNoKUIjj+OQA5M+Iu5BiXfxldNy/wDbZL31mB2+SAA29TZgXBKYXbCts9ULktWZxU6X81O4jRrvmKwKET2gEg4A6koZrJW+KMAzqTazyWtP464EV4/6Gp",
2959
+ "document": "如果导入的是明文数据密钥,则是base64 转换后的明文数据密钥, 如果导入的是密文数据密钥,则是由KMS GenerateDataKey接口生成的密文数据密钥。",
2960
+ "example": "YLbjnjPPIYjPb1XhyBYNmcx",
2306
2961
  "member": "string",
2307
- "name": "ImportToken",
2962
+ "name": "ImportKeyMaterial",
2308
2963
  "required": true,
2309
2964
  "type": "string"
2310
2965
  },
2311
2966
  {
2312
2967
  "disabled": false,
2313
- "document": "指定导入密钥材料的CMK,需要和GetParametersForImport 指定的CMK相同。",
2314
- "example": "93866e69-9755-11ef-8e65-52540089bc41",
2315
- "member": "string",
2316
- "name": "KeyId",
2968
+ "document": "1:密文导入(由KMS接口生成的密文数据密钥),2:明文导入。",
2969
+ "example": "1",
2970
+ "member": "uint64",
2971
+ "name": "ImportType",
2317
2972
  "required": true,
2318
- "type": "string"
2973
+ "type": "int"
2319
2974
  },
2320
2975
  {
2321
2976
  "disabled": false,
2322
- "document": "密钥材料过期时间 unix 时间戳,不指定或者 0 表示密钥材料不会过期,若指定过期时间,需要大于当前时间点,最大支持 2147443200。",
2323
- "example": "0",
2324
- "member": "uint64",
2325
- "name": "ValidTo",
2977
+ "document": "数据密钥 的描述,最大100字节",
2978
+ "example": "描述信息",
2979
+ "member": "string",
2980
+ "name": "Description",
2981
+ "required": false,
2982
+ "type": "string"
2983
+ },
2984
+ {
2985
+ "disabled": false,
2986
+ "document": "当导入密文数据密钥时,无需传入根密钥,如果传入也会忽略。\n当KeyId 为空,如果指定了独享集群HsmClusterId,则会在独享集群下创建一个根密钥,根据生成的根密钥加密数据密钥。\n如果没有指定独享集群HsmClusterId,则会在公有云共享集群下创建一个根密钥,根据生成的根密钥加密数据密钥。\n如果KeyId 不为空,根据指定的根密钥加密数据密钥。",
2987
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
2988
+ "member": "string",
2989
+ "name": "KeyId",
2990
+ "required": false,
2991
+ "type": "string"
2992
+ },
2993
+ {
2994
+ "disabled": false,
2995
+ "document": "KMS 独享版对应的 HSM 集群 ID。\n当KeyId 没有传入时有效,如果指定了独享集群HsmClusterId,则会在独享集群下创建一个根密钥,根据产生的根密钥加密数据密钥。\n如果没有指定独享集群HsmClusterId,则会在公有云共享集群下创建一个根密钥,根据产生的根密钥加密数据密钥。",
2996
+ "example": "hsm-cluster-123",
2997
+ "member": "string",
2998
+ "name": "HsmClusterId",
2999
+ "required": false,
3000
+ "type": "string"
3001
+ }
3002
+ ],
3003
+ "type": "object"
3004
+ },
3005
+ "ImportDataKeyResponse": {
3006
+ "document": "ImportDataKey返回参数结构体",
3007
+ "members": [
3008
+ {
3009
+ "disabled": false,
3010
+ "document": "CMK的全局唯一标识",
3011
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
3012
+ "member": "string",
3013
+ "name": "KeyId",
3014
+ "output_required": true,
3015
+ "type": "string",
3016
+ "value_allowed_null": false
3017
+ },
3018
+ {
3019
+ "disabled": false,
3020
+ "document": "DataKey的全局唯一标识 否 官网/国内&国际站展示",
3021
+ "example": "93866e69-9755-11ef-8e65-52540089547t",
3022
+ "member": "string",
3023
+ "name": "DataKeyId",
3024
+ "output_required": true,
3025
+ "type": "string",
3026
+ "value_allowed_null": false
3027
+ },
3028
+ {
3029
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3030
+ "member": "string",
3031
+ "name": "RequestId",
3032
+ "type": "string"
3033
+ }
3034
+ ],
3035
+ "type": "object"
3036
+ },
3037
+ "ImportKeyMaterialRequest": {
3038
+ "document": "ImportKeyMaterial请求参数结构体",
3039
+ "members": [
3040
+ {
3041
+ "disabled": false,
3042
+ "document": "使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS,导入的密钥材料长度要求为 128 bit,FIPS版本region的KMS, 导入的密钥材料长度要求为 256 bit。",
3043
+ "example": "YLbjnjPPIYjPb1XhyBYNmcr7yv1YMnfDmuHX8D0qCmUAP3Qi+2URkLJvZ/zCWuJK0Y23/QHX8a8lrKz4WVgUVuoleOriQMNx+AcRkjCegkcqkdJ8BNlaXsNJ67zjSZWDu9qI+bHXEqSIcXcz/l5jdBEum6tYViIDrNKIY6FaLC0Ex7y3eoN5A3YFhQoL7F7upNXZHhogP+YXqLqD7fKzsM8qgMW25qSddlhW4H1s1zOfwfobLAQDXofu9OAZ58Xf8KjnqEoA1Bn60kuJBoqqUV4BqOG3egTqCQaCdcn98oZFPTQpB/SVCE4hENncEV3tNihv2IwjFxSCjZHcJzhYuQ==",
3044
+ "member": "string",
3045
+ "name": "EncryptedKeyMaterial",
3046
+ "required": true,
3047
+ "type": "string"
3048
+ },
3049
+ {
3050
+ "disabled": false,
3051
+ "document": "通过调用GetParametersForImport获得的导入令牌。",
3052
+ "example": "+b1d61DykcbWNoKUIjj+OQA5M+Iu5BiXfxldNy/wDbZL31mB2+SAA29TZgXBKYXbCts9ULktWZxU6X81O4jRrvmKwKET2gEg4A6koZrJW+KMAzqTazyWtP464EV4/6Gp",
3053
+ "member": "string",
3054
+ "name": "ImportToken",
3055
+ "required": true,
3056
+ "type": "string"
3057
+ },
3058
+ {
3059
+ "disabled": false,
3060
+ "document": "指定导入密钥材料的CMK,需要和GetParametersForImport 指定的CMK相同。",
3061
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
3062
+ "member": "string",
3063
+ "name": "KeyId",
3064
+ "required": true,
3065
+ "type": "string"
3066
+ },
3067
+ {
3068
+ "disabled": false,
3069
+ "document": "密钥材料过期时间 unix 时间戳,不指定或者 0 表示密钥材料不会过期,若指定过期时间,需要大于当前时间点,最大支持 2147443200。",
3070
+ "example": "0",
3071
+ "member": "uint64",
3072
+ "name": "ValidTo",
2326
3073
  "required": false,
2327
3074
  "type": "int"
2328
3075
  }
@@ -2590,6 +3337,208 @@
2590
3337
  ],
2591
3338
  "type": "object"
2592
3339
  },
3340
+ "ListDataKeyDetailRequest": {
3341
+ "document": "ListDataKeyDetail请求参数结构体",
3342
+ "members": [
3343
+ {
3344
+ "disabled": false,
3345
+ "document": "含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0",
3346
+ "example": "0",
3347
+ "member": "uint64",
3348
+ "name": "Offset",
3349
+ "required": false,
3350
+ "type": "int"
3351
+ },
3352
+ {
3353
+ "disabled": false,
3354
+ "document": "含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为10,最大值为200",
3355
+ "example": "10",
3356
+ "member": "uint64",
3357
+ "name": "Limit",
3358
+ "required": false,
3359
+ "type": "int"
3360
+ },
3361
+ {
3362
+ "disabled": false,
3363
+ "document": "根据创建者角色筛选,默认 0 表示用户自己创建的数据密钥, 1 表示授权其它云产品自动创建的数据密钥",
3364
+ "example": "0",
3365
+ "member": "uint64",
3366
+ "name": "Role",
3367
+ "required": false,
3368
+ "type": "int"
3369
+ },
3370
+ {
3371
+ "disabled": false,
3372
+ "document": "根据DataKey创建时间排序, 0 表示按照降序排序,1表示按照升序排序",
3373
+ "example": "0",
3374
+ "member": "uint64",
3375
+ "name": "OrderType",
3376
+ "required": false,
3377
+ "type": "int"
3378
+ },
3379
+ {
3380
+ "disabled": false,
3381
+ "document": "根据DataKey状态筛选, 0表示全部DataKey, 1 表示仅查询Enabled DataKey, 2 表示仅查询Disabled DataKey,3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。",
3382
+ "example": "0",
3383
+ "member": "uint64",
3384
+ "name": "KeyState",
3385
+ "required": false,
3386
+ "type": "int"
3387
+ },
3388
+ {
3389
+ "disabled": false,
3390
+ "document": "根据DataKeyId或者DataKeyName进行模糊匹配查询",
3391
+ "example": "lzctest",
3392
+ "member": "string",
3393
+ "name": "SearchKeyAlias",
3394
+ "required": false,
3395
+ "type": "string"
3396
+ },
3397
+ {
3398
+ "disabled": false,
3399
+ "document": "根据DateKey类型筛选, \"TENCENT_KMS\" 表示筛选密钥材料由KMS创建的数据密钥, \"EXTERNAL\" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥,\"ALL\" 或者不设置表示两种类型都查询,大小写敏感。",
3400
+ "example": "ALL",
3401
+ "member": "string",
3402
+ "name": "Origin",
3403
+ "required": false,
3404
+ "type": "string"
3405
+ },
3406
+ {
3407
+ "disabled": false,
3408
+ "document": "KMS 高级版对应的 HSM 集群 ID。",
3409
+ "example": "cls-hsm-3dflmo9g",
3410
+ "member": "string",
3411
+ "name": "HsmClusterId",
3412
+ "required": false,
3413
+ "type": "string"
3414
+ },
3415
+ {
3416
+ "disabled": false,
3417
+ "document": "根密钥全局唯一标识符",
3418
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
3419
+ "member": "string",
3420
+ "name": "KeyId",
3421
+ "required": false,
3422
+ "type": "string"
3423
+ },
3424
+ {
3425
+ "disabled": false,
3426
+ "document": "数据密钥的长度",
3427
+ "example": "16",
3428
+ "member": "uint64",
3429
+ "name": "DataKeyLen",
3430
+ "required": false,
3431
+ "type": "int"
3432
+ }
3433
+ ],
3434
+ "type": "object"
3435
+ },
3436
+ "ListDataKeyDetailResponse": {
3437
+ "document": "ListDataKeyDetail返回参数结构体",
3438
+ "members": [
3439
+ {
3440
+ "disabled": false,
3441
+ "document": "返回的属性信息列表。",
3442
+ "example": "无",
3443
+ "member": "DataKeyMetadata",
3444
+ "name": "DataKeyMetadatas",
3445
+ "output_required": false,
3446
+ "type": "list",
3447
+ "value_allowed_null": false
3448
+ },
3449
+ {
3450
+ "disabled": false,
3451
+ "document": "DataKey的总数量",
3452
+ "example": "10",
3453
+ "member": "uint64",
3454
+ "name": "TotalCount",
3455
+ "output_required": true,
3456
+ "type": "int",
3457
+ "value_allowed_null": false
3458
+ },
3459
+ {
3460
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3461
+ "member": "string",
3462
+ "name": "RequestId",
3463
+ "type": "string"
3464
+ }
3465
+ ],
3466
+ "type": "object"
3467
+ },
3468
+ "ListDataKeysRequest": {
3469
+ "document": "ListDataKeys请求参数结构体",
3470
+ "members": [
3471
+ {
3472
+ "disabled": false,
3473
+ "document": "含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0",
3474
+ "example": "0",
3475
+ "member": "uint64",
3476
+ "name": "Offset",
3477
+ "required": false,
3478
+ "type": "int"
3479
+ },
3480
+ {
3481
+ "disabled": false,
3482
+ "document": "含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为10,最大值为200",
3483
+ "example": "2",
3484
+ "member": "uint64",
3485
+ "name": "Limit",
3486
+ "required": false,
3487
+ "type": "int"
3488
+ },
3489
+ {
3490
+ "disabled": false,
3491
+ "document": "根据创建者角色筛选,默认 0 表示用户自己创建的数据密钥, 1 表示授权其它云产品自动创建的数据密钥",
3492
+ "example": "0",
3493
+ "member": "uint64",
3494
+ "name": "Role",
3495
+ "required": false,
3496
+ "type": "int"
3497
+ },
3498
+ {
3499
+ "disabled": false,
3500
+ "document": "KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)",
3501
+ "example": "cls-hsm-3dflmo9g",
3502
+ "member": "string",
3503
+ "name": "HsmClusterId",
3504
+ "required": false,
3505
+ "type": "string"
3506
+ }
3507
+ ],
3508
+ "type": "object"
3509
+ },
3510
+ "ListDataKeysResponse": {
3511
+ "document": "ListDataKeys返回参数结构体",
3512
+ "members": [
3513
+ {
3514
+ "disabled": false,
3515
+ "document": "数据密钥Id列表数组",
3516
+ "example": "无",
3517
+ "member": "DataKey",
3518
+ "name": "DataKeys",
3519
+ "output_required": false,
3520
+ "type": "list",
3521
+ "value_allowed_null": false
3522
+ },
3523
+ {
3524
+ "disabled": false,
3525
+ "document": "数据密钥的总数量",
3526
+ "example": "100",
3527
+ "member": "uint64",
3528
+ "name": "TotalCount",
3529
+ "output_required": true,
3530
+ "type": "int",
3531
+ "value_allowed_null": false
3532
+ },
3533
+ {
3534
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3535
+ "member": "string",
3536
+ "name": "RequestId",
3537
+ "type": "string"
3538
+ }
3539
+ ],
3540
+ "type": "object"
3541
+ },
2593
3542
  "ListKeyDetailRequest": {
2594
3543
  "document": "ListKeyDetail请求参数结构体",
2595
3544
  "members": [
@@ -2702,7 +3651,7 @@
2702
3651
  {
2703
3652
  "disabled": false,
2704
3653
  "document": "返回的属性信息列表。",
2705
- "example": "[ { \"Alias\": \"Weijiali_test_000000005\", \"CreateTime\": 1725354067, \"CreatorUin\": 700001028674, \"DeletionDate\": 0, \"Description\": \"weijiali_test_00000000000005\", \"HsmClusterId\": \"cls-hsm-3dflmo9g\", \"KeyId\": \"0ed49d3e-69d3-11ef-9841-52540089bc41\", \"KeyRotationEnabled\": false, \"KeyState\": \"Enabled\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_SM2\", \"LastRotateTime\": 1725354067, \"NextRotateTime\": 1756890067, \"Origin\": \"TENCENT_KMS\", \"Owner\": \"user\", \"ResourceId\": \"creatorUin/700001028674/0ed49d3e-69d3-11ef-9841-52540089bc41\", \"RotateDays\": 365, \"Type\": 4, \"ValidTo\": 0 }, { \"Alias\": \"Weijiali_test_00000000000004\", \"CreateTime\": 1725354055, \"CreatorUin\": 700001028674, \"DeletionDate\": 0, \"Description\": \"Weijiali_test_00000000000004\", \"HsmClusterId\": \"cls-hsm-3dflmo9g\", \"KeyId\": \"07ad2031-69d3-11ef-9841-52540089bc41\", \"KeyRotationEnabled\": false, \"KeyState\": \"Enabled\", \"KeyUsage\": \"ASYMMETRIC_DECRYPT_SM2\", \"LastRotateTime\": 1725354055, \"NextRotateTime\": 1756890055, \"Origin\": \"TENCENT_KMS\", \"Owner\": \"user\", \"ResourceId\": \"creatorUin/700001028674/07ad2031-69d3-11ef-9841-52540089bc41\", \"RotateDays\": 365, \"Type\": 4, \"ValidTo\": 0 }, { \"Alias\": \"weijiali_test_00000000000003\", \"CreateTime\": 1725354040, \"CreatorUin\": 700001028674, \"DeletionDate\": 0, \"Description\": \"weijiali_test_00000000000003\", \"HsmClusterId\": \"cls-hsm-3dflmo9g\", \"KeyId\": \"fea98175-69d2-11ef-910d-525400d834e5\", \"KeyRotationEnabled\": false, \"KeyState\": \"Enabled\", \"KeyUsage\": \"ENCRYPT_DECRYPT\", \"LastRotateTime\": 1725354040, \"NextRotateTime\": 1756890040, \"Origin\": \"TENCENT_KMS\", \"Owner\": \"user\", \"ResourceId\": \"creatorUin/700001028674/fea98175-69d2-11ef-910d-525400d834e5\", \"RotateDays\": 365, \"Type\": 4, \"ValidTo\": 0 } ]",
3654
+ "example": "",
2706
3655
  "member": "KeyMetadata",
2707
3656
  "name": "KeyMetadatas",
2708
3657
  "output_required": false,
@@ -3144,6 +4093,62 @@
3144
4093
  ],
3145
4094
  "type": "object"
3146
4095
  },
4096
+ "ScheduleDataKeyDeletionRequest": {
4097
+ "document": "ScheduleDataKeyDeletion请求参数结构体",
4098
+ "members": [
4099
+ {
4100
+ "disabled": false,
4101
+ "document": "数据密钥的唯一标志符",
4102
+ "example": "\t 93866e69-9755-11ef-8e65-52540089bc41",
4103
+ "member": "string",
4104
+ "name": "DataKeyId",
4105
+ "required": true,
4106
+ "type": "string"
4107
+ },
4108
+ {
4109
+ "disabled": false,
4110
+ "document": "计划删除时间区间[7,30]",
4111
+ "example": "7",
4112
+ "member": "uint64",
4113
+ "name": "PendingWindowInDays",
4114
+ "required": true,
4115
+ "type": "int"
4116
+ }
4117
+ ],
4118
+ "type": "object"
4119
+ },
4120
+ "ScheduleDataKeyDeletionResponse": {
4121
+ "document": "ScheduleDataKeyDeletion返回参数结构体",
4122
+ "members": [
4123
+ {
4124
+ "disabled": false,
4125
+ "document": "计划删除执行时间",
4126
+ "example": "1559318399",
4127
+ "member": "uint64",
4128
+ "name": "DeletionDate",
4129
+ "output_required": true,
4130
+ "type": "int",
4131
+ "value_allowed_null": false
4132
+ },
4133
+ {
4134
+ "disabled": false,
4135
+ "document": "唯一标志被计划删除的数据密钥",
4136
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
4137
+ "member": "string",
4138
+ "name": "DataKeyId",
4139
+ "output_required": true,
4140
+ "type": "string",
4141
+ "value_allowed_null": false
4142
+ },
4143
+ {
4144
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4145
+ "member": "string",
4146
+ "name": "RequestId",
4147
+ "type": "string"
4148
+ }
4149
+ ],
4150
+ "type": "object"
4151
+ },
3147
4152
  "ScheduleKeyDeletionRequest": {
3148
4153
  "document": "ScheduleKeyDeletion请求参数结构体",
3149
4154
  "members": [
@@ -3393,6 +4398,78 @@
3393
4398
  ],
3394
4399
  "type": "object"
3395
4400
  },
4401
+ "UpdateDataKeyDescriptionRequest": {
4402
+ "document": "UpdateDataKeyDescription请求参数结构体",
4403
+ "members": [
4404
+ {
4405
+ "disabled": false,
4406
+ "document": "数据密钥的唯一标志符",
4407
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
4408
+ "member": "string",
4409
+ "name": "DataKeyId",
4410
+ "required": true,
4411
+ "type": "string"
4412
+ },
4413
+ {
4414
+ "disabled": false,
4415
+ "document": "数据密钥 的描述,最大100字节",
4416
+ "example": "描述信息",
4417
+ "member": "string",
4418
+ "name": "Description",
4419
+ "required": true,
4420
+ "type": "string"
4421
+ }
4422
+ ],
4423
+ "type": "object"
4424
+ },
4425
+ "UpdateDataKeyDescriptionResponse": {
4426
+ "document": "UpdateDataKeyDescription返回参数结构体",
4427
+ "members": [
4428
+ {
4429
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4430
+ "member": "string",
4431
+ "name": "RequestId",
4432
+ "type": "string"
4433
+ }
4434
+ ],
4435
+ "type": "object"
4436
+ },
4437
+ "UpdateDataKeyNameRequest": {
4438
+ "document": "UpdateDataKeyName请求参数结构体",
4439
+ "members": [
4440
+ {
4441
+ "disabled": false,
4442
+ "document": "数据密钥的唯一标志符",
4443
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
4444
+ "member": "string",
4445
+ "name": "DataKeyId",
4446
+ "required": true,
4447
+ "type": "string"
4448
+ },
4449
+ {
4450
+ "disabled": false,
4451
+ "document": "数据密钥的名称",
4452
+ "example": "test",
4453
+ "member": "string",
4454
+ "name": "DataKeyName",
4455
+ "required": true,
4456
+ "type": "string"
4457
+ }
4458
+ ],
4459
+ "type": "object"
4460
+ },
4461
+ "UpdateDataKeyNameResponse": {
4462
+ "document": "UpdateDataKeyName返回参数结构体",
4463
+ "members": [
4464
+ {
4465
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
4466
+ "member": "string",
4467
+ "name": "RequestId",
4468
+ "type": "string"
4469
+ }
4470
+ ],
4471
+ "type": "object"
4472
+ },
3396
4473
  "UpdateKeyDescriptionRequest": {
3397
4474
  "document": "UpdateKeyDescription请求参数结构体",
3398
4475
  "members": [