tccli-intl-en 3.0.1168.1__py2.py3-none-any.whl → 3.1.16.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 (294) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argument.py +1 -1
  3. tccli/plugins/sso/__init__.py +14 -0
  4. tccli/plugins/sso/login.py +23 -6
  5. tccli/plugins/sso/texts.py +4 -0
  6. tccli/services/__init__.py +49 -2
  7. tccli/services/advisor/advisor_client.py +10 -4
  8. tccli/services/ai3d/__init__.py +4 -0
  9. tccli/services/ai3d/ai3d_client.py +266 -0
  10. tccli/services/ai3d/v20250513/api.json +264 -0
  11. tccli/services/ai3d/v20250513/examples.json +20 -0
  12. tccli/services/aiart/aiart_client.py +5 -2
  13. tccli/services/ams/ams_client.py +20 -8
  14. tccli/services/antiddos/antiddos_client.py +350 -140
  15. tccli/services/apigateway/apigateway_client.py +465 -186
  16. tccli/services/apm/apm_client.py +835 -68
  17. tccli/services/apm/v20210622/api.json +3936 -1145
  18. tccli/services/apm/v20210622/examples.json +133 -23
  19. tccli/services/asr/asr_client.py +10 -4
  20. tccli/services/autoscaling/autoscaling_client.py +341 -114
  21. tccli/services/autoscaling/v20180419/api.json +514 -333
  22. tccli/services/autoscaling/v20180419/examples.json +46 -38
  23. tccli/services/batch/batch_client.py +140 -56
  24. tccli/services/bi/__init__.py +4 -0
  25. tccli/services/bi/bi_client.py +1498 -0
  26. tccli/services/bi/v20220105/api.json +5769 -0
  27. tccli/services/bi/v20220105/examples.json +215 -0
  28. tccli/services/billing/billing_client.py +1055 -134
  29. tccli/services/billing/v20180709/api.json +1654 -243
  30. tccli/services/billing/v20180709/examples.json +169 -25
  31. tccli/services/cam/cam_client.py +405 -162
  32. tccli/services/captcha/captcha_client.py +5 -2
  33. tccli/services/captcha/v20190722/api.json +16 -6
  34. tccli/services/captcha/v20190722/examples.json +3 -3
  35. tccli/services/car/car_client.py +165 -66
  36. tccli/services/cbs/cbs_client.py +190 -76
  37. tccli/services/ccc/ccc_client.py +1167 -268
  38. tccli/services/ccc/v20200210/api.json +2263 -202
  39. tccli/services/ccc/v20200210/examples.json +116 -12
  40. tccli/services/cdb/cdb_client.py +665 -266
  41. tccli/services/cdb/v20170320/api.json +426 -173
  42. tccli/services/cdb/v20170320/examples.json +6 -6
  43. tccli/services/cdc/cdc_client.py +100 -40
  44. tccli/services/cdc/v20201214/api.json +2 -2
  45. tccli/services/cdc/v20201214/examples.json +4 -4
  46. tccli/services/cdn/cdn_client.py +220 -88
  47. tccli/services/cdwdoris/cdwdoris_client.py +385 -154
  48. tccli/services/cdwpg/cdwpg_client.py +120 -48
  49. tccli/services/cdz/__init__.py +4 -0
  50. tccli/services/cdz/cdz_client.py +210 -0
  51. tccli/services/cdz/v20221123/api.json +233 -0
  52. tccli/services/cdz/v20221123/examples.json +12 -0
  53. tccli/services/cfg/cfg_client.py +80 -32
  54. tccli/services/cfg/v20210820/api.json +30 -10
  55. tccli/services/cfg/v20210820/examples.json +1 -1
  56. tccli/services/cfs/cfs_client.py +195 -78
  57. tccli/services/cfw/cfw_client.py +330 -132
  58. tccli/services/chdfs/chdfs_client.py +145 -58
  59. tccli/services/ciam/ciam_client.py +80 -32
  60. tccli/services/ckafka/ckafka_client.py +1033 -255
  61. tccli/services/ckafka/v20190819/api.json +3378 -1681
  62. tccli/services/ckafka/v20190819/examples.json +254 -160
  63. tccli/services/clb/clb_client.py +1054 -469
  64. tccli/services/clb/v20180317/api.json +2307 -1024
  65. tccli/services/clb/v20180317/examples.json +186 -126
  66. tccli/services/cloudaudit/cloudaudit_client.py +90 -36
  67. tccli/services/cls/cls_client.py +434 -173
  68. tccli/services/cmq/cmq_client.py +14 -803
  69. tccli/services/cmq/v20190304/api.json +173 -1367
  70. tccli/services/cmq/v20190304/examples.json +0 -120
  71. tccli/services/config/config_client.py +30 -12
  72. tccli/services/controlcenter/controlcenter_client.py +229 -2
  73. tccli/services/controlcenter/v20230110/api.json +528 -5
  74. tccli/services/controlcenter/v20230110/examples.json +32 -0
  75. tccli/services/csip/csip_client.py +339 -78
  76. tccli/services/csip/v20221121/api.json +1011 -38
  77. tccli/services/csip/v20221121/examples.json +24 -0
  78. tccli/services/ctsdb/__init__.py +4 -0
  79. tccli/services/ctsdb/ctsdb_client.py +266 -0
  80. tccli/services/ctsdb/v20230202/api.json +677 -0
  81. tccli/services/ctsdb/v20230202/examples.json +20 -0
  82. tccli/services/cvm/cvm_client.py +706 -189
  83. tccli/services/cvm/v20170312/api.json +1141 -510
  84. tccli/services/cvm/v20170312/examples.json +174 -128
  85. tccli/services/cwp/cwp_client.py +2325 -930
  86. tccli/services/cynosdb/cynosdb_client.py +3051 -575
  87. tccli/services/cynosdb/v20190107/api.json +14074 -7139
  88. tccli/services/cynosdb/v20190107/examples.json +597 -287
  89. tccli/services/dataintegration/dataintegration_client.py +5 -2
  90. tccli/services/dayu/dayu_client.py +515 -206
  91. tccli/services/dbbrain/dbbrain_client.py +210 -84
  92. tccli/services/dc/dc_client.py +90 -36
  93. tccli/services/dcdb/dcdb_client.py +310 -124
  94. tccli/services/dlc/dlc_client.py +859 -214
  95. tccli/services/dlc/v20210125/api.json +637 -13
  96. tccli/services/dlc/v20210125/examples.json +48 -0
  97. tccli/services/dms/dms_client.py +10 -4
  98. tccli/services/dnspod/dnspod_client.py +390 -111
  99. tccli/services/dnspod/v20210323/api.json +196 -0
  100. tccli/services/dnspod/v20210323/examples.json +24 -0
  101. tccli/services/domain/domain_client.py +120 -48
  102. tccli/services/dts/dts_client.py +415 -166
  103. tccli/services/eb/eb_client.py +130 -52
  104. tccli/services/ecdn/ecdn_client.py +75 -30
  105. tccli/services/ecm/ecm_client.py +620 -248
  106. tccli/services/eiam/eiam_client.py +200 -80
  107. tccli/services/emr/emr_client.py +3104 -117
  108. tccli/services/emr/v20190103/api.json +15311 -4361
  109. tccli/services/emr/v20190103/examples.json +452 -42
  110. tccli/services/es/es_client.py +105 -42
  111. tccli/services/facefusion/facefusion_client.py +15 -6
  112. tccli/services/faceid/faceid_client.py +95 -38
  113. tccli/services/faceid/v20180301/api.json +172 -45
  114. tccli/services/faceid/v20180301/examples.json +3 -3
  115. tccli/services/gaap/gaap_client.py +440 -176
  116. tccli/services/gme/gme_client.py +50 -20
  117. tccli/services/gpm/gpm_client.py +90 -36
  118. tccli/services/gse/gse_client.py +110 -44
  119. tccli/services/gwlb/gwlb_client.py +90 -36
  120. tccli/services/hunyuan/__init__.py +4 -0
  121. tccli/services/hunyuan/hunyuan_client.py +266 -0
  122. tccli/services/hunyuan/v20230901/api.json +270 -0
  123. tccli/services/hunyuan/v20230901/examples.json +20 -0
  124. tccli/services/iai/iai_client.py +145 -58
  125. tccli/services/iai/v20200303/api.json +187 -51
  126. tccli/services/iai/v20200303/examples.json +30 -12
  127. tccli/services/iap/iap_client.py +30 -12
  128. tccli/services/ims/ims_client.py +5 -2
  129. tccli/services/ims/v20201229/api.json +133 -141
  130. tccli/services/ims/v20201229/examples.json +3 -3
  131. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +516 -72
  132. tccli/services/intlpartnersmgt/v20220928/api.json +976 -60
  133. tccli/services/intlpartnersmgt/v20220928/examples.json +50 -2
  134. tccli/services/iotcloud/iotcloud_client.py +100 -40
  135. tccli/services/iotcloud/v20210408/api.json +216 -107
  136. tccli/services/iotcloud/v20210408/examples.json +9 -9
  137. tccli/services/ip/ip_client.py +30 -12
  138. tccli/services/kms/kms_client.py +1226 -227
  139. tccli/services/kms/v20190118/api.json +1562 -144
  140. tccli/services/kms/v20190118/examples.json +204 -78
  141. tccli/services/lcic/lcic_client.py +265 -106
  142. tccli/services/lighthouse/lighthouse_client.py +370 -148
  143. tccli/services/lighthouse/v20200324/api.json +14 -14
  144. tccli/services/lighthouse/v20200324/examples.json +5 -5
  145. tccli/services/live/live_client.py +804 -232
  146. tccli/services/live/v20180801/api.json +272 -0
  147. tccli/services/live/v20180801/examples.json +32 -0
  148. tccli/services/lke/__init__.py +4 -0
  149. tccli/services/lke/lke_client.py +5194 -0
  150. tccli/services/lke/v20231130/api.json +14803 -0
  151. tccli/services/lke/v20231130/examples.json +736 -0
  152. tccli/services/lkeap/__init__.py +4 -0
  153. tccli/services/lkeap/lkeap_client.py +602 -0
  154. tccli/services/lkeap/v20240522/api.json +953 -0
  155. tccli/services/lkeap/v20240522/examples.json +92 -0
  156. tccli/services/mariadb/mariadb_client.py +250 -100
  157. tccli/services/mdc/mdc_client.py +90 -36
  158. tccli/services/mdl/mdl_client.py +402 -82
  159. tccli/services/mdl/v20200326/api.json +1144 -58
  160. tccli/services/mdl/v20200326/examples.json +48 -16
  161. tccli/services/mdp/mdp_client.py +785 -122
  162. tccli/services/mdp/v20200527/api.json +1168 -44
  163. tccli/services/mdp/v20200527/examples.json +151 -79
  164. tccli/services/message/__init__.py +4 -0
  165. tccli/services/message/message_client.py +210 -0
  166. tccli/services/message/v20181225/api.json +72 -0
  167. tccli/services/message/v20181225/examples.json +13 -0
  168. tccli/services/mongodb/mongodb_client.py +1452 -136
  169. tccli/services/mongodb/v20190725/api.json +4393 -1462
  170. tccli/services/mongodb/v20190725/examples.json +265 -71
  171. tccli/services/monitor/monitor_client.py +1008 -296
  172. tccli/services/monitor/v20180724/api.json +660 -11
  173. tccli/services/monitor/v20180724/examples.json +152 -4
  174. tccli/services/mps/mps_client.py +1573 -354
  175. tccli/services/mps/v20190612/api.json +12394 -7243
  176. tccli/services/mps/v20190612/examples.json +244 -84
  177. tccli/services/msp/msp_client.py +35 -14
  178. tccli/services/ocr/ocr_client.py +596 -102
  179. tccli/services/ocr/v20181119/api.json +2271 -181
  180. tccli/services/ocr/v20181119/examples.json +70 -8
  181. tccli/services/omics/omics_client.py +100 -40
  182. tccli/services/organization/organization_client.py +580 -232
  183. tccli/services/postgres/postgres_client.py +455 -182
  184. tccli/services/postgres/v20170312/api.json +134 -109
  185. tccli/services/postgres/v20170312/examples.json +14 -14
  186. tccli/services/privatedns/privatedns_client.py +206 -60
  187. tccli/services/privatedns/v20201028/api.json +179 -0
  188. tccli/services/privatedns/v20201028/examples.json +8 -0
  189. tccli/services/pts/pts_client.py +240 -96
  190. tccli/services/quota/__init__.py +4 -0
  191. tccli/services/quota/quota_client.py +434 -0
  192. tccli/services/quota/v20241204/api.json +548 -0
  193. tccli/services/quota/v20241204/examples.json +51 -0
  194. tccli/services/rce/rce_client.py +5 -2
  195. tccli/services/redis/redis_client.py +698 -212
  196. tccli/services/redis/v20180412/api.json +968 -563
  197. tccli/services/redis/v20180412/examples.json +98 -56
  198. tccli/services/region/__init__.py +4 -0
  199. tccli/services/region/region_client.py +322 -0
  200. tccli/services/region/v20220627/api.json +399 -0
  201. tccli/services/region/v20220627/examples.json +29 -0
  202. tccli/services/rum/rum_client.py +300 -120
  203. tccli/services/scf/scf_client.py +210 -84
  204. tccli/services/ses/ses_client.py +368 -69
  205. tccli/services/ses/v20201002/api.json +240 -0
  206. tccli/services/ses/v20201002/examples.json +32 -0
  207. tccli/services/smh/__init__.py +4 -0
  208. tccli/services/smh/smh_client.py +714 -0
  209. tccli/services/smh/v20210712/api.json +1287 -0
  210. tccli/services/smh/v20210712/examples.json +85 -0
  211. tccli/services/sms/sms_client.py +90 -36
  212. tccli/services/sqlserver/sqlserver_client.py +3855 -470
  213. tccli/services/sqlserver/v20180328/api.json +9757 -3347
  214. tccli/services/sqlserver/v20180328/examples.json +480 -20
  215. tccli/services/ssl/ssl_client.py +504 -72
  216. tccli/services/ssl/v20191205/api.json +789 -21
  217. tccli/services/ssl/v20191205/examples.json +54 -0
  218. tccli/services/ssm/ssm_client.py +120 -48
  219. tccli/services/sts/sts_client.py +25 -10
  220. tccli/services/tag/tag_client.py +150 -60
  221. tccli/services/tat/tat_client.py +95 -38
  222. tccli/services/tbaas/__init__.py +4 -0
  223. tccli/services/tbaas/tbaas_client.py +378 -0
  224. tccli/services/tbaas/v20180416/api.json +551 -0
  225. tccli/services/tbaas/v20180416/examples.json +37 -0
  226. tccli/services/tcaplusdb/tcaplusdb_client.py +260 -104
  227. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  228. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  229. tccli/services/tchd/tchd_client.py +5 -2
  230. tccli/services/tcmpp/tcmpp_client.py +520 -208
  231. tccli/services/tcr/tcr_client.py +380 -152
  232. tccli/services/tcsas/tcsas_client.py +295 -118
  233. tccli/services/tcsas/v20250106/api.json +155 -79
  234. tccli/services/tcsas/v20250106/examples.json +3 -3
  235. tccli/services/tcss/tcss_client.py +1650 -660
  236. tccli/services/tdid/tdid_client.py +240 -96
  237. tccli/services/tdmq/tdmq_client.py +2876 -466
  238. tccli/services/tdmq/v20200217/api.json +11607 -3958
  239. tccli/services/tdmq/v20200217/examples.json +562 -264
  240. tccli/services/tem/tem_client.py +280 -112
  241. tccli/services/teo/teo_client.py +4507 -966
  242. tccli/services/teo/v20220901/api.json +7341 -1405
  243. tccli/services/teo/v20220901/examples.json +679 -99
  244. tccli/services/tione/__init__.py +4 -0
  245. tccli/services/tione/tione_client.py +210 -0
  246. tccli/services/tione/v20211111/api.json +3074 -0
  247. tccli/services/tione/v20211111/examples.json +12 -0
  248. tccli/services/tiw/tiw_client.py +255 -102
  249. tccli/services/tke/tke_client.py +741 -274
  250. tccli/services/tke/v20180525/api.json +132 -7
  251. tccli/services/tke/v20180525/examples.json +42 -16
  252. tccli/services/tms/tms_client.py +5 -2
  253. tccli/services/tms/v20201229/api.json +91 -100
  254. tccli/services/tmt/tmt_client.py +5 -2
  255. tccli/services/trabbit/__init__.py +4 -0
  256. tccli/services/trabbit/trabbit_client.py +1778 -0
  257. tccli/services/trabbit/v20230418/api.json +4772 -0
  258. tccli/services/trabbit/v20230418/examples.json +237 -0
  259. tccli/services/trocket/__init__.py +4 -0
  260. tccli/services/trocket/trocket_client.py +2450 -0
  261. tccli/services/trocket/v20230308/api.json +6062 -0
  262. tccli/services/trocket/v20230308/examples.json +339 -0
  263. tccli/services/trro/trro_client.py +95 -38
  264. tccli/services/trtc/trtc_client.py +928 -192
  265. tccli/services/trtc/v20190722/api.json +1810 -256
  266. tccli/services/trtc/v20190722/examples.json +100 -6
  267. tccli/services/tts/tts_client.py +5 -2
  268. tccli/services/vclm/vclm_client.py +10 -4
  269. tccli/services/vm/v20210922/api.json +61 -30
  270. tccli/services/vm/v20210922/examples.json +0 -12
  271. tccli/services/vm/vm_client.py +20 -8
  272. tccli/services/vod/v20180717/api.json +332 -52
  273. tccli/services/vod/v20180717/examples.json +9 -1
  274. tccli/services/vod/v20240718/api.json +1105 -0
  275. tccli/services/vod/v20240718/examples.json +97 -0
  276. tccli/services/vod/vod_client.py +1316 -350
  277. tccli/services/vpc/v20170312/api.json +1166 -106
  278. tccli/services/vpc/v20170312/examples.json +197 -23
  279. tccli/services/vpc/vpc_client.py +2413 -739
  280. tccli/services/waf/v20180125/api.json +1372 -194
  281. tccli/services/waf/v20180125/examples.json +89 -1
  282. tccli/services/waf/waf_client.py +1149 -245
  283. tccli/services/wedata/v20210820/api.json +1577 -231
  284. tccli/services/wedata/v20210820/examples.json +74 -12
  285. tccli/services/wedata/v20250806/api.json +13644 -0
  286. tccli/services/wedata/v20250806/examples.json +621 -0
  287. tccli/services/wedata/wedata_client.py +6366 -1191
  288. tccli/services/yunjing/yunjing_client.py +355 -142
  289. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/METADATA +4 -7
  290. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/RECORD +294 -230
  291. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/WHEEL +1 -1
  292. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/entry_points.txt +0 -1
  293. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/LICENSE +0 -0
  294. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/top_level.txt +0 -0
@@ -28,6 +28,13 @@
28
28
  "output": "BindCloudResourceResponse",
29
29
  "status": "online"
30
30
  },
31
+ "CancelDataKeyDeletion": {
32
+ "document": "This API is used to cancel scheduled deletion for a data key.",
33
+ "input": "CancelDataKeyDeletionRequest",
34
+ "name": "Cancel scheduled deletion of a data key",
35
+ "output": "CancelDataKeyDeletionResponse",
36
+ "status": "online"
37
+ },
31
38
  "CancelKeyArchive": {
32
39
  "document": "This API is used to unarchive keys. If a key is unarchived, its status will be `Enabled`.",
33
40
  "input": "CancelKeyArchiveRequest",
@@ -77,6 +84,20 @@
77
84
  "output": "DeleteWhiteBoxKeyResponse",
78
85
  "status": "online"
79
86
  },
87
+ "DescribeDataKey": {
88
+ "document": "This API is used to retrieve data key details.",
89
+ "input": "DescribeDataKeyRequest",
90
+ "name": "Retrieve data key details",
91
+ "output": "DescribeDataKeyResponse",
92
+ "status": "online"
93
+ },
94
+ "DescribeDataKeys": {
95
+ "document": "This API is used to return the key attribute information list.",
96
+ "input": "DescribeDataKeysRequest",
97
+ "name": "Retrieve key details",
98
+ "output": "DescribeDataKeysResponse",
99
+ "status": "online"
100
+ },
80
101
  "DescribeKey": {
81
102
  "document": "This API is used to get the attribute details of the CMK with a specified `KeyId`.",
82
103
  "input": "DescribeKeyRequest",
@@ -126,6 +147,20 @@
126
147
  "output": "DescribeWhiteBoxServiceStatusResponse",
127
148
  "status": "online"
128
149
  },
150
+ "DisableDataKey": {
151
+ "document": "This API is used to disable the data key.",
152
+ "input": "DisableDataKeyRequest",
153
+ "name": "Disabling a data key",
154
+ "output": "DisableDataKeyResponse",
155
+ "status": "online"
156
+ },
157
+ "DisableDataKeys": {
158
+ "document": "This API is used to batch disable data keys.",
159
+ "input": "DisableDataKeysRequest",
160
+ "name": "Bulk disable data keys",
161
+ "output": "DisableDataKeysResponse",
162
+ "status": "online"
163
+ },
129
164
  "DisableKey": {
130
165
  "document": "This API is used to disable a master key. The disabled key cannot be used for encryption and decryption operations.",
131
166
  "input": "DisableKeyRequest",
@@ -161,6 +196,20 @@
161
196
  "output": "DisableWhiteBoxKeysResponse",
162
197
  "status": "online"
163
198
  },
199
+ "EnableDataKey": {
200
+ "document": "This API is used to enable the data key.",
201
+ "input": "EnableDataKeyRequest",
202
+ "name": "Enables the data key",
203
+ "output": "EnableDataKeyResponse",
204
+ "status": "online"
205
+ },
206
+ "EnableDataKeys": {
207
+ "document": "This API is used to batch enable data keys.",
208
+ "input": "EnableDataKeysRequest",
209
+ "name": "Batch enable data keys",
210
+ "output": "EnableDataKeysResponse",
211
+ "status": "online"
212
+ },
164
213
  "EnableKey": {
165
214
  "document": "Enable a specified CMK.",
166
215
  "input": "EnableKeyRequest",
@@ -224,6 +273,20 @@
224
273
  "output": "GenerateRandomResponse",
225
274
  "status": "online"
226
275
  },
276
+ "GetDataKeyCiphertextBlob": {
277
+ "document": "This API is used to download the encrypted data key.",
278
+ "input": "GetDataKeyCiphertextBlobRequest",
279
+ "name": "Download the ciphertext of the data key",
280
+ "output": "GetDataKeyCiphertextBlobResponse",
281
+ "status": "online"
282
+ },
283
+ "GetDataKeyPlaintext": {
284
+ "document": "This API is used to retrieve the key plaintext.",
285
+ "input": "GetDataKeyPlaintextRequest",
286
+ "name": "Retrieve the plaintext of the data key",
287
+ "output": "GetDataKeyPlaintextResponse",
288
+ "status": "online"
289
+ },
227
290
  "GetKeyRotationStatus": {
228
291
  "document": "Query whether the specified CMK has the key rotation function.",
229
292
  "input": "GetKeyRotationStatusRequest",
@@ -259,6 +322,13 @@
259
322
  "output": "GetServiceStatusResponse",
260
323
  "status": "online"
261
324
  },
325
+ "ImportDataKey": {
326
+ "document": "Data key import API, managed by KMS.",
327
+ "input": "ImportDataKeyRequest",
328
+ "name": "Import a data key",
329
+ "output": "ImportDataKeyResponse",
330
+ "status": "online"
331
+ },
262
332
  "ImportKeyMaterial": {
263
333
  "document": "This API is used to import key material into an EXTERNAL CMK. The key obtained through the `GetParametersForImport` API is used to encrypt the key material. You can only reimport the same key material into the specified CMK and set a new expiration time. After the CMK key material is imported, it cannot be replaced. After the key material is expired or deleted, the CMK will remain unavailable until the same key material is reimported. CMKs are independent, which means that the same key material can be imported into different CMKs, but data encrypted by one CMK cannot be decrypted by another one.\nKey material can only be imported into CMKs in `Enabled` and `PendingImport` status.",
264
334
  "input": "ImportKeyMaterialRequest",
@@ -273,6 +343,20 @@
273
343
  "output": "ListAlgorithmsResponse",
274
344
  "status": "online"
275
345
  },
346
+ "ListDataKeyDetail": {
347
+ "document": "This API is used to retrieve data key list details based on specified Offset and Limit.",
348
+ "input": "ListDataKeyDetailRequest",
349
+ "name": "Retrieve data key list details",
350
+ "output": "ListDataKeyDetailResponse",
351
+ "status": "online"
352
+ },
353
+ "ListDataKeys": {
354
+ "document": "This API is used to query the list of data keys.",
355
+ "input": "ListDataKeysRequest",
356
+ "name": "Retrieve data key list",
357
+ "output": "ListDataKeysResponse",
358
+ "status": "online"
359
+ },
276
360
  "ListKeyDetail": {
277
361
  "document": "Get the master key list details according to the specified Offset and Limit.",
278
362
  "input": "ListKeyDetailRequest",
@@ -329,6 +413,13 @@
329
413
  "output": "ReEncryptResponse",
330
414
  "status": "online"
331
415
  },
416
+ "ScheduleDataKeyDeletion": {
417
+ "document": "Schedule deletion for a data key.",
418
+ "input": "ScheduleDataKeyDeletionRequest",
419
+ "name": "Schedule deletion of a data key",
420
+ "output": "ScheduleDataKeyDeletionResponse",
421
+ "status": "online"
422
+ },
332
423
  "ScheduleKeyDeletion": {
333
424
  "document": "CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days",
334
425
  "input": "ScheduleKeyDeletionRequest",
@@ -357,6 +448,20 @@
357
448
  "output": "UpdateAliasResponse",
358
449
  "status": "online"
359
450
  },
451
+ "UpdateDataKeyDescription": {
452
+ "document": "This API is used to modify the description of a data key.",
453
+ "input": "UpdateDataKeyDescriptionRequest",
454
+ "name": "Modify data key description",
455
+ "output": "UpdateDataKeyDescriptionResponse",
456
+ "status": "online"
457
+ },
458
+ "UpdateDataKeyName": {
459
+ "document": "This API is used to modify the data key name.",
460
+ "input": "UpdateDataKeyNameRequest",
461
+ "name": "Modify the data key name",
462
+ "output": "UpdateDataKeyNameResponse",
463
+ "status": "online"
464
+ },
360
465
  "UpdateKeyDescription": {
361
466
  "document": "This API is used to modify the description of the specified CMK. CMKs in `PendingDelete` status cannot be modified.",
362
467
  "input": "UpdateKeyDescriptionRequest",
@@ -510,7 +615,7 @@
510
615
  },
511
616
  {
512
617
  "disabled": false,
513
- "document": "Base64-encoded ciphertext encrypted with `PublicKey`, whose length cannot exceed 256 bytes.",
618
+ "document": "Specifies that the ciphertext encrypted with PublicKey is Base64 encoded. the original ciphertext format needs to be C1C3C2_ASN1. the length of the original ciphertext cannot exceed 256 bytes.",
514
619
  "example": "MG0CICuRefoqE7g5bpsZNYq+9d909cZl7nFuYFHiDhOqz8GAAiEA4lqmt3nGqpbu0qhbWsStkexXA2cA12nVWjgruFP5WKkEIG6JwYejm9gEr7CPOOhbirsGhga3W7J6C7kwdmf6VebRBATH1o2G",
515
620
  "member": "string",
516
621
  "name": "Ciphertext",
@@ -575,7 +680,7 @@
575
680
  },
576
681
  {
577
682
  "disabled": false,
578
- "document": "Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud services features.",
683
+ "document": "Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service's features.",
579
684
  "example": "resourceId",
580
685
  "member": "string",
581
686
  "name": "ResourceId",
@@ -597,6 +702,43 @@
597
702
  ],
598
703
  "type": "object"
599
704
  },
705
+ "CancelDataKeyDeletionRequest": {
706
+ "document": "CancelDataKeyDeletion request structure.",
707
+ "members": [
708
+ {
709
+ "disabled": false,
710
+ "document": "Unique id of a data key.",
711
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
712
+ "member": "string",
713
+ "name": "DataKeyId",
714
+ "required": true,
715
+ "type": "string"
716
+ }
717
+ ],
718
+ "type": "object"
719
+ },
720
+ "CancelDataKeyDeletionResponse": {
721
+ "document": "CancelDataKeyDeletion response structure.",
722
+ "members": [
723
+ {
724
+ "disabled": false,
725
+ "document": "The unique identifier of the data key scheduled for deletion.",
726
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
727
+ "member": "string",
728
+ "name": "DataKeyId",
729
+ "output_required": false,
730
+ "type": "string",
731
+ "value_allowed_null": false
732
+ },
733
+ {
734
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
735
+ "member": "string",
736
+ "name": "RequestId",
737
+ "type": "string"
738
+ }
739
+ ],
740
+ "type": "object"
741
+ },
600
742
  "CancelKeyArchiveRequest": {
601
743
  "document": "CancelKeyArchive request structure.",
602
744
  "members": [
@@ -684,7 +826,7 @@
684
826
  },
685
827
  {
686
828
  "disabled": false,
687
- "document": "Defines the purpose of the key. The valid values are as follows: `ENCRYPT_DECRYPT` (default): creates a symmetric encryption/decryption key; `ASYMMETRIC_DECRYPT_RSA_2048`: creates an asymmetric encryption/decryption 2048-bit RSA key; `ASYMMETRIC_DECRYPT_SM2`: creates an asymmetric encryption/decryption SM2 key; `ASYMMETRIC_SIGN_VERIFY_SM2`: creates an asymmetric SM2 key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECC`: creates an asymmetric 2048-bit RSA key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECDSA384`: creates an asymmetric ECDSA384 key for signature verification. You can get a full list of supported key purposes and algorithms using the ListAlgorithms API.",
829
+ "document": "Specifies the key purpose, defaults to \"ENCRYPT_DECRYPT\" indicating the creation of a symmetric encryption/decryption key. other supported purposes include \"ASYMMETRIC_DECRYPT_RSA_2048\" for RSA2048 ASYMMETRIC keys used to ENCRYPT and DECRYPT, \"ASYMMETRIC_DECRYPT_SM2\" for SM2 ASYMMETRIC keys used to ENCRYPT and DECRYPT, \"ASYMMETRIC_SIGN_VERIFY_SM2\" for SM2 ASYMMETRIC keys used for signature verification, \"ASYMMETRIC_SIGN_VERIFY_ECC\" for ECC ASYMMETRIC keys used for signature verification, \"ASYMMETRIC_SIGN_VERIFY_RSA_2048\" for RSA_2048 ASYMMETRIC keys used for signature verification, and \"ASYMMETRIC_SIGN_VERIFY_ECDSA384\" for ECDSA384 ASYMMETRIC keys used for signature verification. the complete list of key purposes and algorithm support can be obtained through the ListAlgorithms api.",
688
830
  "example": "ENCRYPT_DECRYPT",
689
831
  "member": "string",
690
832
  "name": "KeyUsage",
@@ -756,7 +898,7 @@
756
898
  },
757
899
  {
758
900
  "disabled": false,
759
- "document": "CMK description",
901
+ "document": "Specifies the description of the CMK.",
760
902
  "example": "这是一个test描述",
761
903
  "member": "string",
762
904
  "name": "Description",
@@ -786,7 +928,7 @@
786
928
  },
787
929
  {
788
930
  "disabled": false,
789
- "document": "Tag operation return code. 0: success; 1: internal error; 2: business processing error",
931
+ "document": "Return code of Tag operation. `0`: success; `1`: cls internal error; `2`: business processing error.",
790
932
  "example": "0",
791
933
  "member": "uint64",
792
934
  "name": "TagCode",
@@ -796,7 +938,7 @@
796
938
  },
797
939
  {
798
940
  "disabled": false,
799
- "document": "Tag operation return information",
941
+ "document": "Response information of Tag operation.",
800
942
  "example": "ok",
801
943
  "member": "string",
802
944
  "name": "TagMsg",
@@ -806,7 +948,7 @@
806
948
  },
807
949
  {
808
950
  "disabled": false,
809
- "document": "ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.\nNote: This field may return `null`, indicating that no valid value can be obtained.",
951
+ "document": "HSM cluster ID (valid only for exclusive or managed version KMS service instances).",
810
952
  "example": "cls-hsm-1234abcd",
811
953
  "member": "string",
812
954
  "name": "HsmClusterId",
@@ -900,7 +1042,7 @@
900
1042
  },
901
1043
  {
902
1044
  "disabled": false,
903
- "document": "Tag operation return code. 0: success; 1: internal error; 2: business processing error",
1045
+ "document": "Return code of Tag operation. `0`: success; `1`: internal error; `2`: business processing error.",
904
1046
  "example": "0",
905
1047
  "member": "uint64",
906
1048
  "name": "TagCode",
@@ -910,7 +1052,7 @@
910
1052
  },
911
1053
  {
912
1054
  "disabled": false,
913
- "document": "Tag operation return message",
1055
+ "document": "Response information of Tag operation.",
914
1056
  "example": "ok",
915
1057
  "member": "string",
916
1058
  "name": "TagMsg",
@@ -927,6 +1069,239 @@
927
1069
  ],
928
1070
  "type": "object"
929
1071
  },
1072
+ "DataKey": {
1073
+ "document": "Specifies the data key attribute.",
1074
+ "members": [
1075
+ {
1076
+ "disabled": false,
1077
+ "document": "Globally unique id of DataKey.",
1078
+ "example": "\t 5551ef2e-6742-11ef-8133-525400b2f623",
1079
+ "member": "string",
1080
+ "name": "DataKeyId",
1081
+ "output_required": true,
1082
+ "required": false,
1083
+ "type": "string",
1084
+ "value_allowed_null": false
1085
+ }
1086
+ ],
1087
+ "usage": "both"
1088
+ },
1089
+ "DataKeyMetadata": {
1090
+ "document": "Specifies the data key attribute information.",
1091
+ "members": [
1092
+ {
1093
+ "disabled": false,
1094
+ "document": "DataKey globally unique id.",
1095
+ "example": "93866e69-9755-11ef-8e65-52540089547t",
1096
+ "member": "string",
1097
+ "name": "DataKeyId",
1098
+ "output_required": true,
1099
+ "type": "string",
1100
+ "value_allowed_null": false
1101
+ },
1102
+ {
1103
+ "disabled": false,
1104
+ "document": "Globally unique id of the CMK.",
1105
+ "example": "6cdf26d1-44ff-11eb-841c-5254006d0810",
1106
+ "member": "string",
1107
+ "name": "KeyId",
1108
+ "output_required": true,
1109
+ "type": "string",
1110
+ "value_allowed_null": false
1111
+ },
1112
+ {
1113
+ "disabled": false,
1114
+ "document": "CMK name.",
1115
+ "example": "测试根密钥",
1116
+ "member": "string",
1117
+ "name": "KeyName",
1118
+ "output_required": false,
1119
+ "type": "string",
1120
+ "value_allowed_null": false
1121
+ },
1122
+ {
1123
+ "disabled": false,
1124
+ "document": "Key name as a more recognizable and understandable data key.",
1125
+ "example": "lzctest",
1126
+ "member": "string",
1127
+ "name": "DataKeyName",
1128
+ "output_required": true,
1129
+ "type": "string",
1130
+ "value_allowed_null": false
1131
+ },
1132
+ {
1133
+ "disabled": false,
1134
+ "document": "Specifies the length of the data key in bytes.",
1135
+ "example": "32",
1136
+ "member": "uint64",
1137
+ "name": "NumberOfBytes",
1138
+ "output_required": true,
1139
+ "type": "int",
1140
+ "value_allowed_null": false
1141
+ },
1142
+ {
1143
+ "disabled": false,
1144
+ "document": "Key key creation time.",
1145
+ "example": "1730357927",
1146
+ "member": "uint64",
1147
+ "name": "CreateTime",
1148
+ "output_required": true,
1149
+ "type": "int",
1150
+ "value_allowed_null": false
1151
+ },
1152
+ {
1153
+ "disabled": false,
1154
+ "document": "DataKey description.",
1155
+ "example": "desc",
1156
+ "member": "string",
1157
+ "name": "Description",
1158
+ "output_required": true,
1159
+ "type": "string",
1160
+ "value_allowed_null": false
1161
+ },
1162
+ {
1163
+ "disabled": false,
1164
+ "document": "DataKey status. valid values: Enabled, Disabled, PendingDelete.",
1165
+ "example": "PendingDelete",
1166
+ "member": "string",
1167
+ "name": "KeyState",
1168
+ "output_required": true,
1169
+ "type": "string",
1170
+ "value_allowed_null": false
1171
+ },
1172
+ {
1173
+ "disabled": false,
1174
+ "document": "Creator.",
1175
+ "example": "700001224410",
1176
+ "member": "uint64",
1177
+ "name": "CreatorUin",
1178
+ "output_required": true,
1179
+ "type": "int",
1180
+ "value_allowed_null": false
1181
+ },
1182
+ {
1183
+ "disabled": false,
1184
+ "document": "Specifies the creator of the data key. valid values: user (user-created) or product name (auto-created by authorized cloud services).",
1185
+ "example": "user",
1186
+ "member": "string",
1187
+ "name": "Owner",
1188
+ "output_required": true,
1189
+ "type": "string",
1190
+ "value_allowed_null": false
1191
+ },
1192
+ {
1193
+ "disabled": false,
1194
+ "document": "The time when schedule deletion.",
1195
+ "example": "0",
1196
+ "member": "uint64",
1197
+ "name": "DeletionDate",
1198
+ "output_required": false,
1199
+ "type": "int",
1200
+ "value_allowed_null": false
1201
+ },
1202
+ {
1203
+ "disabled": false,
1204
+ "document": "Specifies the key material type of DataKey. valid values: TENCENT_KMS (created by KMS), EXTERNAL (user import).",
1205
+ "example": "EXTERNAL",
1206
+ "member": "string",
1207
+ "name": "Origin",
1208
+ "output_required": false,
1209
+ "type": "string",
1210
+ "value_allowed_null": false
1211
+ },
1212
+ {
1213
+ "disabled": false,
1214
+ "document": "HSM cluster ID (only applicable to KMS exclusive/managed service instance).",
1215
+ "example": "cls-hsm-1a2b3c4d",
1216
+ "member": "string",
1217
+ "name": "HsmClusterId",
1218
+ "output_required": false,
1219
+ "type": "string",
1220
+ "value_allowed_null": false
1221
+ },
1222
+ {
1223
+ "disabled": false,
1224
+ "document": "Resource ID in the format of `creatorUin/$creatorUin/$dataKeyId`.",
1225
+ "example": "creatorUin/12345/6cdf26d1-44ff-11eb-841c-5254006d0810",
1226
+ "member": "string",
1227
+ "name": "ResourceId",
1228
+ "output_required": false,
1229
+ "type": "string",
1230
+ "value_allowed_null": false
1231
+ },
1232
+ {
1233
+ "disabled": false,
1234
+ "document": "Whether the key is a primary replica. valid values: `0` (primary), `1` (synced replica).",
1235
+ "example": "0",
1236
+ "member": "int64",
1237
+ "name": "IsSyncReplica",
1238
+ "output_required": false,
1239
+ "type": "int",
1240
+ "value_allowed_null": false
1241
+ },
1242
+ {
1243
+ "disabled": false,
1244
+ "document": "Synchronous original region.",
1245
+ "example": "ap-guangzhou",
1246
+ "member": "string",
1247
+ "name": "SourceRegion",
1248
+ "output_required": false,
1249
+ "type": "string",
1250
+ "value_allowed_null": false
1251
+ },
1252
+ {
1253
+ "disabled": false,
1254
+ "document": "The state of key synchronization. valid values: 0 (unsynced), 1 (synchronization successful), 2 (synchronization failed), 3 (synchronizing).",
1255
+ "example": "1",
1256
+ "member": "int64",
1257
+ "name": "SyncStatus",
1258
+ "output_required": false,
1259
+ "type": "int",
1260
+ "value_allowed_null": false
1261
+ },
1262
+ {
1263
+ "disabled": false,
1264
+ "document": "Sresult description}.",
1265
+ "example": "success",
1266
+ "member": "string",
1267
+ "name": "SyncMessages",
1268
+ "output_required": false,
1269
+ "type": "string",
1270
+ "value_allowed_null": false
1271
+ },
1272
+ {
1273
+ "disabled": false,
1274
+ "document": "Start time of synchronization.",
1275
+ "example": "1730357927",
1276
+ "member": "uint64",
1277
+ "name": "SyncStartTime",
1278
+ "output_required": false,
1279
+ "type": "int",
1280
+ "value_allowed_null": false
1281
+ },
1282
+ {
1283
+ "disabled": false,
1284
+ "document": "Specifies the synchronous end time.",
1285
+ "example": "1730357927",
1286
+ "member": "uint64",
1287
+ "name": "SyncEndTime",
1288
+ "output_required": false,
1289
+ "type": "int",
1290
+ "value_allowed_null": false
1291
+ },
1292
+ {
1293
+ "disabled": false,
1294
+ "document": "Synchronous original cluster. if empty, it is a public cloud public cluster.",
1295
+ "example": "hsm-a1b2c3",
1296
+ "member": "string",
1297
+ "name": "SourceHsmClusterId",
1298
+ "output_required": false,
1299
+ "type": "string",
1300
+ "value_allowed_null": false
1301
+ }
1302
+ ],
1303
+ "usage": "out"
1304
+ },
930
1305
  "DecryptRequest": {
931
1306
  "document": "Decrypt request structure.",
932
1307
  "members": [
@@ -1055,28 +1430,102 @@
1055
1430
  ],
1056
1431
  "type": "object"
1057
1432
  },
1058
- "DescribeKeyRequest": {
1059
- "document": "DescribeKey request structure.",
1433
+ "DescribeDataKeyRequest": {
1434
+ "document": "DescribeDataKey request structure.",
1060
1435
  "members": [
1061
1436
  {
1062
1437
  "disabled": false,
1063
- "document": "Globally unique CMK ID",
1438
+ "document": "Data key globally unique id.",
1064
1439
  "example": "93866e69-9755-11ef-8e65-52540089bc41",
1065
1440
  "member": "string",
1066
- "name": "KeyId",
1441
+ "name": "DataKeyId",
1067
1442
  "required": true,
1068
1443
  "type": "string"
1069
1444
  }
1070
1445
  ],
1071
1446
  "type": "object"
1072
1447
  },
1073
- "DescribeKeyResponse": {
1074
- "document": "DescribeKey response structure.",
1448
+ "DescribeDataKeyResponse": {
1449
+ "document": "DescribeDataKey response structure.",
1075
1450
  "members": [
1076
1451
  {
1077
1452
  "disabled": false,
1078
- "document": "Key attribute information\nNote: this field may return null, indicating that no valid values can be obtained.",
1079
- "example": "{\"Alias\":\"test11lzc\",\"CreateTime\":1730357927,\"CreatorUin\":700001224419,\"DeletionDate\":0,\"Description\":\"倒入外部密钥\",\"HsmClusterId\":\"\",\"KeyId\":\"93866e69-9755-11ef-8e65-52540089bc41\",\"KeyRotationEnabled\":false}",
1453
+ "document": "Specifies the data key attribute information.",
1454
+ "example": "",
1455
+ "member": "DataKeyMetadata",
1456
+ "name": "DataKeyMetadata",
1457
+ "output_required": true,
1458
+ "type": "object",
1459
+ "value_allowed_null": false
1460
+ },
1461
+ {
1462
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
1463
+ "member": "string",
1464
+ "name": "RequestId",
1465
+ "type": "string"
1466
+ }
1467
+ ],
1468
+ "type": "object"
1469
+ },
1470
+ "DescribeDataKeysRequest": {
1471
+ "document": "DescribeDataKeys request structure.",
1472
+ "members": [
1473
+ {
1474
+ "disabled": false,
1475
+ "document": "Specifies the ID list of datakeys to query. supports up to 100 DataKey ids in a batch query.",
1476
+ "example": "[\"87ff856e-973c-11ef-947b-525400d834e5\"]",
1477
+ "member": "string",
1478
+ "name": "DataKeyIds",
1479
+ "required": true,
1480
+ "type": "list"
1481
+ }
1482
+ ],
1483
+ "type": "object"
1484
+ },
1485
+ "DescribeDataKeysResponse": {
1486
+ "document": "DescribeDataKeys response structure.",
1487
+ "members": [
1488
+ {
1489
+ "disabled": false,
1490
+ "document": "Response data key attribute information list.",
1491
+ "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\" } ",
1492
+ "member": "DataKeyMetadata",
1493
+ "name": "DataKeyMetadatas",
1494
+ "output_required": true,
1495
+ "type": "list",
1496
+ "value_allowed_null": false
1497
+ },
1498
+ {
1499
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
1500
+ "member": "string",
1501
+ "name": "RequestId",
1502
+ "type": "string"
1503
+ }
1504
+ ],
1505
+ "type": "object"
1506
+ },
1507
+ "DescribeKeyRequest": {
1508
+ "document": "DescribeKey request structure.",
1509
+ "members": [
1510
+ {
1511
+ "disabled": false,
1512
+ "document": "Globally unique CMK ID",
1513
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
1514
+ "member": "string",
1515
+ "name": "KeyId",
1516
+ "required": true,
1517
+ "type": "string"
1518
+ }
1519
+ ],
1520
+ "type": "object"
1521
+ },
1522
+ "DescribeKeyResponse": {
1523
+ "document": "DescribeKey response structure.",
1524
+ "members": [
1525
+ {
1526
+ "disabled": false,
1527
+ "document": "Specifies the key attribute information.",
1528
+ "example": "无",
1080
1529
  "member": "KeyMetadata",
1081
1530
  "name": "KeyMetadata",
1082
1531
  "output_required": true,
@@ -1112,7 +1561,7 @@
1112
1561
  "members": [
1113
1562
  {
1114
1563
  "disabled": false,
1115
- "document": "List of returned attribute information\nNote: this field may return null, indicating that no valid values can be obtained.",
1564
+ "document": "The attribute information list returned.",
1116
1565
  "example": "{\"Alias\":\"test11lzc\",\"CreateTime\":1730357927,\"CreatorUin\":700001224419,\"DeletionDate\":0,\"Description\":\"倒入外部密钥\",\"HsmClusterId\":\"\",\"KeyId\":\"93866e69-9755-11ef-8e65-52540089bc41\",\"KeyRotationEnabled\":false}",
1117
1566
  "member": "KeyMetadata",
1118
1567
  "name": "KeyMetadatas",
@@ -1260,7 +1709,7 @@
1260
1709
  },
1261
1710
  {
1262
1711
  "disabled": false,
1263
- "document": "Total white-box keys.\nNote: This field may return null, indicating that no valid values can be obtained.",
1712
+ "document": "Total number of white-box keys.",
1264
1713
  "example": "4",
1265
1714
  "member": "uint64",
1266
1715
  "name": "TotalCount",
@@ -1341,6 +1790,34 @@
1341
1790
  ],
1342
1791
  "type": "object"
1343
1792
  },
1793
+ "DestinationSyncConfig": {
1794
+ "document": "Target region list of the sync task, including region and cluster information. if the cluster is empty, it means public cloud shared cluster. if the cluster is not empty, it means dedicated cluster.",
1795
+ "members": [
1796
+ {
1797
+ "disabled": false,
1798
+ "document": "Specifies the target region of the synchronization task.",
1799
+ "example": "ap-guangzhou",
1800
+ "member": "string",
1801
+ "name": "DestinationRegion",
1802
+ "output_required": false,
1803
+ "required": false,
1804
+ "type": "string",
1805
+ "value_allowed_null": false
1806
+ },
1807
+ {
1808
+ "disabled": false,
1809
+ "document": "HsmClusterId being empty indicates public cloud shared version. if not empty, it indicates exclusive edition cluster in the region.",
1810
+ "example": "cls-hsm-a1b2c3d5",
1811
+ "member": "string",
1812
+ "name": "HsmClusterId",
1813
+ "output_required": false,
1814
+ "required": false,
1815
+ "type": "string",
1816
+ "value_allowed_null": false
1817
+ }
1818
+ ],
1819
+ "usage": "both"
1820
+ },
1344
1821
  "DeviceFingerprint": {
1345
1822
  "document": "Device fingerprint",
1346
1823
  "members": [
@@ -1357,7 +1834,7 @@
1357
1834
  },
1358
1835
  {
1359
1836
  "disabled": false,
1360
- "document": "Description, such as IP and device name. Length limit: 1,024 bytes\nNote: this field may return null, indicating that no valid values can be obtained.",
1837
+ "document": "Description information, such as IP and device name, with a maximum of 1024 bytes.",
1361
1838
  "example": "lzctest",
1362
1839
  "member": "string",
1363
1840
  "name": "Description",
@@ -1369,6 +1846,60 @@
1369
1846
  ],
1370
1847
  "usage": "both"
1371
1848
  },
1849
+ "DisableDataKeyRequest": {
1850
+ "document": "DisableDataKey request structure.",
1851
+ "members": [
1852
+ {
1853
+ "disabled": false,
1854
+ "document": "Specifies the unique identifier of the data key.",
1855
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
1856
+ "member": "string",
1857
+ "name": "DataKeyId",
1858
+ "required": true,
1859
+ "type": "string"
1860
+ }
1861
+ ],
1862
+ "type": "object"
1863
+ },
1864
+ "DisableDataKeyResponse": {
1865
+ "document": "DisableDataKey response structure.",
1866
+ "members": [
1867
+ {
1868
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
1869
+ "member": "string",
1870
+ "name": "RequestId",
1871
+ "type": "string"
1872
+ }
1873
+ ],
1874
+ "type": "object"
1875
+ },
1876
+ "DisableDataKeysRequest": {
1877
+ "document": "DisableDataKeys request structure.",
1878
+ "members": [
1879
+ {
1880
+ "disabled": false,
1881
+ "document": "Specifies the Id list of datakeys to be bulk disabled. supports a maximum of 100 data keys.",
1882
+ "example": "[\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]",
1883
+ "member": "string",
1884
+ "name": "DataKeyIds",
1885
+ "required": true,
1886
+ "type": "list"
1887
+ }
1888
+ ],
1889
+ "type": "object"
1890
+ },
1891
+ "DisableDataKeysResponse": {
1892
+ "document": "DisableDataKeys response structure.",
1893
+ "members": [
1894
+ {
1895
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
1896
+ "member": "string",
1897
+ "name": "RequestId",
1898
+ "type": "string"
1899
+ }
1900
+ ],
1901
+ "type": "object"
1902
+ },
1372
1903
  "DisableKeyRequest": {
1373
1904
  "document": "DisableKey request structure.",
1374
1905
  "members": [
@@ -1504,6 +2035,60 @@
1504
2035
  ],
1505
2036
  "type": "object"
1506
2037
  },
2038
+ "EnableDataKeyRequest": {
2039
+ "document": "EnableDataKey request structure.",
2040
+ "members": [
2041
+ {
2042
+ "disabled": false,
2043
+ "document": "Unique id of a data key.",
2044
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
2045
+ "member": "string",
2046
+ "name": "DataKeyId",
2047
+ "required": true,
2048
+ "type": "string"
2049
+ }
2050
+ ],
2051
+ "type": "object"
2052
+ },
2053
+ "EnableDataKeyResponse": {
2054
+ "document": "EnableDataKey response structure.",
2055
+ "members": [
2056
+ {
2057
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
2058
+ "member": "string",
2059
+ "name": "RequestId",
2060
+ "type": "string"
2061
+ }
2062
+ ],
2063
+ "type": "object"
2064
+ },
2065
+ "EnableDataKeysRequest": {
2066
+ "document": "EnableDataKeys request structure.",
2067
+ "members": [
2068
+ {
2069
+ "disabled": false,
2070
+ "document": "The Id list of datakeys that need to be batch enabled supports a maximum of 100 data keys.",
2071
+ "example": "\t [\"23e80852-1e38-11e9-b129-5cb9019b4b02\"]",
2072
+ "member": "string",
2073
+ "name": "DataKeyIds",
2074
+ "required": true,
2075
+ "type": "list"
2076
+ }
2077
+ ],
2078
+ "type": "object"
2079
+ },
2080
+ "EnableDataKeysResponse": {
2081
+ "document": "EnableDataKeys response structure.",
2082
+ "members": [
2083
+ {
2084
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
2085
+ "member": "string",
2086
+ "name": "RequestId",
2087
+ "type": "string"
2088
+ }
2089
+ ],
2090
+ "type": "object"
2091
+ },
1507
2092
  "EnableKeyRequest": {
1508
2093
  "document": "EnableKey request structure.",
1509
2094
  "members": [
@@ -1778,6 +2363,32 @@
1778
2363
  ],
1779
2364
  "type": "object"
1780
2365
  },
2366
+ "ExclusiveHSM": {
2367
+ "document": "Exclusive edition cluster.",
2368
+ "members": [
2369
+ {
2370
+ "disabled": false,
2371
+ "document": "Dedicated cluster Id.",
2372
+ "example": "cls-hsm-3dflmo9g",
2373
+ "member": "string",
2374
+ "name": "HsmClusterId",
2375
+ "output_required": true,
2376
+ "type": "string",
2377
+ "value_allowed_null": false
2378
+ },
2379
+ {
2380
+ "disabled": false,
2381
+ "document": "Dedicated cluster name.",
2382
+ "example": "cls-hsm-3dflmo9g-name",
2383
+ "member": "string",
2384
+ "name": "HsmClusterName",
2385
+ "output_required": true,
2386
+ "type": "string",
2387
+ "value_allowed_null": false
2388
+ }
2389
+ ],
2390
+ "usage": "out"
2391
+ },
1781
2392
  "GenerateDataKeyRequest": {
1782
2393
  "document": "GenerateDataKey request structure.",
1783
2394
  "members": [
@@ -1834,6 +2445,51 @@
1834
2445
  "name": "EncryptionAlgorithm",
1835
2446
  "required": false,
1836
2447
  "type": "string"
2448
+ },
2449
+ {
2450
+ "disabled": false,
2451
+ "document": "Indicates whether the data generated key is managed by KMS. 1 means the key is managed and saved by KMS. 0 means the key is not managed by KMS.",
2452
+ "example": "0",
2453
+ "member": "uint64",
2454
+ "name": "IsHostedByKms",
2455
+ "required": false,
2456
+ "type": "int"
2457
+ },
2458
+ {
2459
+ "disabled": false,
2460
+ "document": "Name of the data key. required when IsHostedByKms is 1. optional when IsHostedByKms is 0 as KMS does not manage it.",
2461
+ "example": "testdataKey",
2462
+ "member": "string",
2463
+ "name": "DataKeyName",
2464
+ "required": false,
2465
+ "type": "string"
2466
+ },
2467
+ {
2468
+ "disabled": false,
2469
+ "document": "Describes the data key. maximum 100 bytes.",
2470
+ "example": "Description",
2471
+ "member": "string",
2472
+ "name": "Description",
2473
+ "required": false,
2474
+ "type": "string"
2475
+ },
2476
+ {
2477
+ "disabled": false,
2478
+ "document": "HSM cluster ID corresponding to the KMS exclusive edition. if HsmClusterId is specified, it indicates the root key is in this cluster and verifies whether KeyId corresponds to HsmClusterId.",
2479
+ "example": "cluster-123",
2480
+ "member": "string",
2481
+ "name": "HsmClusterId",
2482
+ "required": false,
2483
+ "type": "string"
2484
+ },
2485
+ {
2486
+ "disabled": false,
2487
+ "document": "Tag list. valid at that time when parameter IsHostedByKms=1 and the data key is hosted by kms.",
2488
+ "example": "无",
2489
+ "member": "Tag",
2490
+ "name": "Tags",
2491
+ "required": false,
2492
+ "type": "list"
1837
2493
  }
1838
2494
  ],
1839
2495
  "type": "object"
@@ -1871,6 +2527,36 @@
1871
2527
  "type": "string",
1872
2528
  "value_allowed_null": false
1873
2529
  },
2530
+ {
2531
+ "disabled": false,
2532
+ "document": "Globally unique id of the data key, returned when KMS hosting is enabled.",
2533
+ "example": "93866e69-9755-11ef-8e65-52540089547t",
2534
+ "member": "string",
2535
+ "name": "DataKeyId",
2536
+ "output_required": false,
2537
+ "type": "string",
2538
+ "value_allowed_null": false
2539
+ },
2540
+ {
2541
+ "disabled": false,
2542
+ "document": "Response code of the Tag operation. 0: success; 1: internal error; 2: business processing error.",
2543
+ "example": "0",
2544
+ "member": "uint64",
2545
+ "name": "TagCode",
2546
+ "output_required": false,
2547
+ "type": "int",
2548
+ "value_allowed_null": false
2549
+ },
2550
+ {
2551
+ "disabled": false,
2552
+ "document": "Response of the Tag operation.",
2553
+ "example": "ok",
2554
+ "member": "string",
2555
+ "name": "TagMsg",
2556
+ "output_required": false,
2557
+ "type": "string",
2558
+ "value_allowed_null": false
2559
+ },
1874
2560
  {
1875
2561
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
1876
2562
  "member": "string",
@@ -1917,29 +2603,121 @@
1917
2603
  ],
1918
2604
  "type": "object"
1919
2605
  },
1920
- "GetKeyRotationStatusRequest": {
1921
- "document": "GetKeyRotationStatus request structure.",
2606
+ "GetDataKeyCiphertextBlobRequest": {
2607
+ "document": "GetDataKeyCiphertextBlob request structure.",
1922
2608
  "members": [
1923
2609
  {
1924
2610
  "disabled": false,
1925
- "document": "Unique CMK ID",
1926
- "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
2611
+ "document": "Unique id of a data key.",
2612
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
1927
2613
  "member": "string",
1928
- "name": "KeyId",
2614
+ "name": "DataKeyId",
1929
2615
  "required": true,
1930
2616
  "type": "string"
1931
2617
  }
1932
2618
  ],
1933
2619
  "type": "object"
1934
2620
  },
1935
- "GetKeyRotationStatusResponse": {
1936
- "document": "GetKeyRotationStatus response structure.",
2621
+ "GetDataKeyCiphertextBlobResponse": {
2622
+ "document": "GetDataKeyCiphertextBlob response structure.",
1937
2623
  "members": [
1938
2624
  {
1939
2625
  "disabled": false,
1940
- "document": "Whether key rotation is enabled",
1941
- "example": "false",
1942
- "member": "bool",
2626
+ "document": "Specifies the ciphertext of the data key.",
2627
+ "example": "GPJUsGlmPcSjHKIktXGyzn33yestz+7NteW36M6FuL8hPfJ1xVfdO6Akr8sF69x3yBXMwto4njumJMIsi9WKow==-k-XqqalxTyNKIC1rITRePFGQ==-k-xAL9z9eXIHV/p+WT1RsHP3dm6f43bkomXjwmvWdMXH+JQoFORTThfXgcRh1f9lPNLENK4+fCOiQVG1VvLdA0RvcuRvU=",
2628
+ "member": "string",
2629
+ "name": "CiphertextBlob",
2630
+ "output_required": true,
2631
+ "type": "string",
2632
+ "value_allowed_null": false
2633
+ },
2634
+ {
2635
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
2636
+ "member": "string",
2637
+ "name": "RequestId",
2638
+ "type": "string"
2639
+ }
2640
+ ],
2641
+ "type": "object"
2642
+ },
2643
+ "GetDataKeyPlaintextRequest": {
2644
+ "document": "GetDataKeyPlaintext request structure.",
2645
+ "members": [
2646
+ {
2647
+ "disabled": false,
2648
+ "document": "Unique id of a data key.",
2649
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
2650
+ "member": "string",
2651
+ "name": "DataKeyId",
2652
+ "required": true,
2653
+ "type": "string"
2654
+ },
2655
+ {
2656
+ "disabled": false,
2657
+ "document": "PEM formatted public key string, supporting RSA2048 and SM2 public keys, and used to encrypt the plaintext value in the returned data. If it is empty, plaintext value will not be encrypted.",
2658
+ "example": "-----BEGIN PUBLIC KEY----- MFkwEwY*****fJiHQuh2Jr9lMspgK58UVMJTvQCAU+Hztyhd6Aw== -----END PUBLIC KEY-----",
2659
+ "member": "string",
2660
+ "name": "EncryptionPublicKey",
2661
+ "required": false,
2662
+ "type": "string"
2663
+ },
2664
+ {
2665
+ "disabled": false,
2666
+ "document": "Asymmetric encryption algorithm, used in conjunction with EncryptionPublicKey to encrypt the returned data. It currently supports SM2 (returns ciphertext in C1C3C2 format), SM2_C1C3C2_ASN1 (returns ciphertext in C1C3C2 ASN1 format), RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, and RSAES_OAEP_SHA_256. If it is empty, the default value SM2 is used.",
2667
+ "example": "SM2",
2668
+ "member": "string",
2669
+ "name": "EncryptionAlgorithm",
2670
+ "required": false,
2671
+ "type": "string"
2672
+ }
2673
+ ],
2674
+ "type": "object"
2675
+ },
2676
+ "GetDataKeyPlaintextResponse": {
2677
+ "document": "GetDataKeyPlaintext response structure.",
2678
+ "members": [
2679
+ {
2680
+ "disabled": false,
2681
+ "document": "If EncryptionPublicKey is not provided during the call, the field value is the plaintext encoded in Base64, and the Base64 decoding is required to obtain the plaintext. If EncryptionPublicKey is provided during the call, the field value is the ciphertext asymmetrically encrypted with the EncryptionPublicKey and encoded in Base64. After Base64 decoding, the private key corresponding to the user-uploaded public key is used for further decryption to obtain the plaintext.",
2682
+ "example": "dGVzdAo=",
2683
+ "member": "string",
2684
+ "name": "Plaintext",
2685
+ "output_required": true,
2686
+ "type": "string",
2687
+ "value_allowed_null": false
2688
+ },
2689
+ {
2690
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
2691
+ "member": "string",
2692
+ "name": "RequestId",
2693
+ "type": "string"
2694
+ }
2695
+ ],
2696
+ "type": "object"
2697
+ },
2698
+ "GetKeyRotationStatusRequest": {
2699
+ "document": "GetKeyRotationStatus request structure.",
2700
+ "members": [
2701
+ {
2702
+ "disabled": false,
2703
+ "document": "Unique CMK ID",
2704
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
2705
+ "member": "string",
2706
+ "name": "KeyId",
2707
+ "required": true,
2708
+ "type": "string"
2709
+ }
2710
+ ],
2711
+ "type": "object"
2712
+ },
2713
+ "GetKeyRotationStatusResponse": {
2714
+ "document": "GetKeyRotationStatus response structure.",
2715
+ "members": [
2716
+ {
2717
+ "disabled": false,
2718
+ "document": "Whether key rotation is enabled",
2719
+ "example": "false",
2720
+ "member": "bool",
1943
2721
  "name": "KeyRotationEnabled",
1944
2722
  "output_required": true,
1945
2723
  "type": "bool",
@@ -2106,7 +2884,7 @@
2106
2884
  "members": [
2107
2885
  {
2108
2886
  "disabled": false,
2109
- "document": "The list of supported regions\nNote: this field may return null, indicating that no valid values can be obtained.",
2887
+ "document": "Available region list.",
2110
2888
  "example": "[ \"ap-guangzhou\", \"ap-hongkong\", \"ap-taipei\", \"ap-shanghai\", \"ap-jakarta\" ]",
2111
2889
  "member": "string",
2112
2890
  "name": "Regions",
@@ -2143,7 +2921,7 @@
2143
2921
  },
2144
2922
  {
2145
2923
  "disabled": false,
2146
- "document": "Service unavailability type. 0: not purchased; 1: normal; 2: suspended due to arrears; 3: resource released",
2924
+ "document": "Service unavailability type: 0-not purchased, 1-normal, 2-service suspended due to overdue payments, 3-resource release.",
2147
2925
  "example": "1",
2148
2926
  "member": "int64",
2149
2927
  "name": "InvalidType",
@@ -2163,7 +2941,7 @@
2163
2941
  },
2164
2942
  {
2165
2943
  "disabled": false,
2166
- "document": "Expiration time of the KMS Ultimate edition. It’s represented in a Unix Epoch timestamp.\nNote: This field may return null, indicating that no valid values can be obtained.",
2944
+ "document": "Specifies the expiry time (Epoch Unix Timestamp) of the flagship edition.",
2167
2945
  "example": "1603701385",
2168
2946
  "member": "uint64",
2169
2947
  "name": "ProExpireTime",
@@ -2173,7 +2951,7 @@
2173
2951
  },
2174
2952
  {
2175
2953
  "disabled": false,
2176
- "document": "Whether to automatically renew Ultimate Edition. 0: no, 1: yes\nNote: this field may return null, indicating that no valid values can be obtained.",
2954
+ "document": "Specifies whether the flagship edition is automatically renewed: 0 - no automatic renewal, 1 - automatic renewal.",
2177
2955
  "example": "1",
2178
2956
  "member": "uint64",
2179
2957
  "name": "ProRenewFlag",
@@ -2183,7 +2961,7 @@
2183
2961
  },
2184
2962
  {
2185
2963
  "disabled": false,
2186
- "document": "Unique ID of the Ultimate Edition purchase record. If the Ultimate Edition is not activated, the returned value will be null.\nNote: this field may return null, indicating that no valid values can be obtained.",
2964
+ "document": "Flagship edition purchase record unique identifier. if not activated, the return value is empty.",
2187
2965
  "example": "kms_pro_12345",
2188
2966
  "member": "string",
2189
2967
  "name": "ProResourceId",
@@ -2193,7 +2971,7 @@
2193
2971
  },
2194
2972
  {
2195
2973
  "disabled": false,
2196
- "document": "Whether to activate Managed KMS\nNote: This field may return `null`, indicating that no valid value can be obtained.",
2974
+ "document": "Whether to enable the KMS-managed version.",
2197
2975
  "example": "false",
2198
2976
  "member": "bool",
2199
2977
  "name": "ExclusiveVSMEnabled",
@@ -2203,7 +2981,7 @@
2203
2981
  },
2204
2982
  {
2205
2983
  "disabled": false,
2206
- "document": "Whether to activate Exclusive KMS\nNote: This field may return `null`, indicating that no valid value can be obtained.",
2984
+ "document": "Whether to enable the exclusive edition of KMS.",
2207
2985
  "example": "false",
2208
2986
  "member": "bool",
2209
2987
  "name": "ExclusiveHSMEnabled",
@@ -2213,7 +2991,7 @@
2213
2991
  },
2214
2992
  {
2215
2993
  "disabled": false,
2216
- "document": "KMS subscription information.\nNote: This field may return null, indicating that no valid values can be obtained.",
2994
+ "document": "Specifies the KMS subscription information.",
2217
2995
  "example": "Prepaid_KMS",
2218
2996
  "member": "string",
2219
2997
  "name": "SubscriptionInfo",
@@ -2221,6 +2999,217 @@
2221
2999
  "type": "string",
2222
3000
  "value_allowed_null": false
2223
3001
  },
3002
+ {
3003
+ "disabled": false,
3004
+ "document": "Returns the amount of KMS user secret keys used.",
3005
+ "example": "10",
3006
+ "member": "uint64",
3007
+ "name": "CmkUserCount",
3008
+ "output_required": false,
3009
+ "type": "int",
3010
+ "value_allowed_null": false
3011
+ },
3012
+ {
3013
+ "disabled": false,
3014
+ "document": "Returns the specification quantity of KMS user secret keys.",
3015
+ "example": "200",
3016
+ "member": "uint64",
3017
+ "name": "CmkLimit",
3018
+ "output_required": false,
3019
+ "type": "int",
3020
+ "value_allowed_null": false
3021
+ },
3022
+ {
3023
+ "disabled": false,
3024
+ "document": "Return dedicated cluster group.",
3025
+ "example": "[{\"HsmClusterId\":\"cls-hsm-a1b2c3d4\",\"HsmClusterName\":\"cls-hsm-a1b2c3d4-name\"},{\"HsmClusterId\":\"cls-hsm-a1b2cd5\",\"HsmClusterName\":\"cls-hsm-a1b2c3d5-name\"}]",
3026
+ "member": "ExclusiveHSM",
3027
+ "name": "ExclusiveHSMList",
3028
+ "output_required": false,
3029
+ "type": "list",
3030
+ "value_allowed_null": false
3031
+ },
3032
+ {
3033
+ "disabled": false,
3034
+ "document": "Whether data key management is supported. valid values: 1 (supported), 0 (unsupported).",
3035
+ "example": "0",
3036
+ "member": "bool",
3037
+ "name": "IsAllowedDataKeyHosted",
3038
+ "output_required": false,
3039
+ "type": "bool",
3040
+ "value_allowed_null": false
3041
+ },
3042
+ {
3043
+ "disabled": false,
3044
+ "document": "Valid when IsAllowedDataKeyHosted is 1. specifies the purchase quota for data keys.",
3045
+ "example": "0",
3046
+ "member": "uint64",
3047
+ "name": "DataKeyLimit",
3048
+ "output_required": false,
3049
+ "type": "int",
3050
+ "value_allowed_null": false
3051
+ },
3052
+ {
3053
+ "disabled": false,
3054
+ "document": "Valid when IsAllowedDataKeyHosted is 1. data key free quota.",
3055
+ "example": "0",
3056
+ "member": "uint64",
3057
+ "name": "FreeDataKeyLimit",
3058
+ "output_required": false,
3059
+ "type": "int",
3060
+ "value_allowed_null": false
3061
+ },
3062
+ {
3063
+ "disabled": false,
3064
+ "document": "Valid at that time when IsAllowedDataKeyHosted is 1. specifies the number of keys used.",
3065
+ "example": "0",
3066
+ "member": "uint64",
3067
+ "name": "DataKeyUsedCount",
3068
+ "output_required": false,
3069
+ "type": "int",
3070
+ "value_allowed_null": false
3071
+ },
3072
+ {
3073
+ "disabled": false,
3074
+ "document": "Specifies the target region of the sync task.",
3075
+ "example": "无",
3076
+ "member": "DestinationSyncConfig",
3077
+ "name": "SyncTaskList",
3078
+ "output_required": false,
3079
+ "type": "list",
3080
+ "value_allowed_null": false
3081
+ },
3082
+ {
3083
+ "disabled": false,
3084
+ "document": "Whether synchronization task is supported. true: supported; false: unsupported.",
3085
+ "example": "true",
3086
+ "member": "bool",
3087
+ "name": "IsAllowedSync",
3088
+ "output_required": false,
3089
+ "type": "bool",
3090
+ "value_allowed_null": false
3091
+ },
3092
+ {
3093
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
3094
+ "member": "string",
3095
+ "name": "RequestId",
3096
+ "type": "string"
3097
+ }
3098
+ ],
3099
+ "type": "object"
3100
+ },
3101
+ "ImportDataKeyRequest": {
3102
+ "document": "ImportDataKey request structure.",
3103
+ "members": [
3104
+ {
3105
+ "disabled": false,
3106
+ "document": "Name of the data key.",
3107
+ "example": "testDataKey",
3108
+ "member": "string",
3109
+ "name": "DataKeyName",
3110
+ "required": true,
3111
+ "type": "string"
3112
+ },
3113
+ {
3114
+ "disabled": false,
3115
+ "document": "If the imported key is plaintext data key, it is the base64 plaintext data key after conversion. if the imported key is ciphertext data key, it is the ciphertext data key generated by the KMS GenerateDataKey interface.",
3116
+ "example": "YLbjnjPPIYjPb1XhyBYNmcx",
3117
+ "member": "string",
3118
+ "name": "ImportKeyMaterial",
3119
+ "required": true,
3120
+ "type": "string"
3121
+ },
3122
+ {
3123
+ "disabled": false,
3124
+ "document": "1: ciphertext import (data key generated by KMS api) 2: plaintext import.",
3125
+ "example": "1",
3126
+ "member": "uint64",
3127
+ "name": "ImportType",
3128
+ "required": true,
3129
+ "type": "int"
3130
+ },
3131
+ {
3132
+ "disabled": false,
3133
+ "document": "Describes the data key. maximum 100 bytes.",
3134
+ "example": "描述信息",
3135
+ "member": "string",
3136
+ "name": "Description",
3137
+ "required": false,
3138
+ "type": "string"
3139
+ },
3140
+ {
3141
+ "disabled": false,
3142
+ "document": "When importing an encrypted data key, no need to input the root key. if the input is provided, validate whether the KeyId matches the one in the ciphertext.\nWhen importing plaintext data key, KeyId cannot be empty. the data key is encrypted with the specified root key.",
3143
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
3144
+ "member": "string",
3145
+ "name": "KeyId",
3146
+ "required": false,
3147
+ "type": "string"
3148
+ },
3149
+ {
3150
+ "disabled": false,
3151
+ "document": "HSM cluster ID corresponding to the KMS exclusive edition. if HsmClusterId is specified, it indicates the root key is in this cluster and verifies whether KeyId corresponds to HsmClusterId.",
3152
+ "example": "hsm-cluster-123",
3153
+ "member": "string",
3154
+ "name": "HsmClusterId",
3155
+ "required": false,
3156
+ "type": "string"
3157
+ },
3158
+ {
3159
+ "disabled": false,
3160
+ "document": "Tag list",
3161
+ "example": "无",
3162
+ "member": "Tag",
3163
+ "name": "Tags",
3164
+ "required": false,
3165
+ "type": "list"
3166
+ }
3167
+ ],
3168
+ "type": "object"
3169
+ },
3170
+ "ImportDataKeyResponse": {
3171
+ "document": "ImportDataKey response structure.",
3172
+ "members": [
3173
+ {
3174
+ "disabled": false,
3175
+ "document": "Globally unique CMK id.",
3176
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
3177
+ "member": "string",
3178
+ "name": "KeyId",
3179
+ "output_required": true,
3180
+ "type": "string",
3181
+ "value_allowed_null": false
3182
+ },
3183
+ {
3184
+ "disabled": false,
3185
+ "document": "Globally unique id of DataKey. no. show on portal/domestic and international sites.",
3186
+ "example": "93866e69-9755-11ef-8e65-52540089547t",
3187
+ "member": "string",
3188
+ "name": "DataKeyId",
3189
+ "output_required": true,
3190
+ "type": "string",
3191
+ "value_allowed_null": false
3192
+ },
3193
+ {
3194
+ "disabled": false,
3195
+ "document": "Response code of the Tag operation. 0: success; 1: internal error; 2: business processing error.",
3196
+ "example": "0",
3197
+ "member": "uint64",
3198
+ "name": "TagCode",
3199
+ "output_required": false,
3200
+ "type": "int",
3201
+ "value_allowed_null": false
3202
+ },
3203
+ {
3204
+ "disabled": false,
3205
+ "document": "Response of the Tag operation.",
3206
+ "example": "ok",
3207
+ "member": "string",
3208
+ "name": "TagMsg",
3209
+ "output_required": false,
3210
+ "type": "string",
3211
+ "value_allowed_null": false
3212
+ },
2224
3213
  {
2225
3214
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
2226
3215
  "member": "string",
@@ -2345,163 +3334,464 @@
2345
3334
  },
2346
3335
  {
2347
3336
  "disabled": false,
2348
- "document": "CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport, Archived.",
2349
- "example": "PendingDelete",
3337
+ "document": "CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport, Archived.",
3338
+ "example": "PendingDelete",
3339
+ "member": "string",
3340
+ "name": "KeyState",
3341
+ "output_required": true,
3342
+ "type": "string",
3343
+ "value_allowed_null": false
3344
+ },
3345
+ {
3346
+ "disabled": false,
3347
+ "document": "CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.",
3348
+ "example": "ASYMMETRIC_DECRYPT_RSA_2048",
3349
+ "member": "string",
3350
+ "name": "KeyUsage",
3351
+ "output_required": true,
3352
+ "type": "string",
3353
+ "value_allowed_null": false
3354
+ },
3355
+ {
3356
+ "disabled": false,
3357
+ "document": "CMK type. 2: FIPS-compliant; 4: SM-CRYPTO",
3358
+ "example": "3",
3359
+ "member": "int64",
3360
+ "name": "Type",
3361
+ "output_required": true,
3362
+ "type": "int",
3363
+ "value_allowed_null": false
3364
+ },
3365
+ {
3366
+ "disabled": false,
3367
+ "document": "Creator",
3368
+ "example": "700001224410",
3369
+ "member": "uint64",
3370
+ "name": "CreatorUin",
3371
+ "output_required": true,
3372
+ "type": "int",
3373
+ "value_allowed_null": false
3374
+ },
3375
+ {
3376
+ "disabled": false,
3377
+ "document": "Whether key rotation is enabled",
3378
+ "example": "true",
3379
+ "member": "bool",
3380
+ "name": "KeyRotationEnabled",
3381
+ "output_required": true,
3382
+ "type": "bool",
3383
+ "value_allowed_null": false
3384
+ },
3385
+ {
3386
+ "disabled": false,
3387
+ "document": "CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.",
3388
+ "example": "user",
3389
+ "member": "string",
3390
+ "name": "Owner",
3391
+ "output_required": true,
3392
+ "type": "string",
3393
+ "value_allowed_null": false
3394
+ },
3395
+ {
3396
+ "disabled": false,
3397
+ "document": "Time of next rotation if key rotation is enabled",
3398
+ "example": "1761893927",
3399
+ "member": "uint64",
3400
+ "name": "NextRotateTime",
3401
+ "output_required": true,
3402
+ "type": "int",
3403
+ "value_allowed_null": false
3404
+ },
3405
+ {
3406
+ "disabled": false,
3407
+ "document": "The time when scheduled deletion occurs.",
3408
+ "example": "0",
3409
+ "member": "uint64",
3410
+ "name": "DeletionDate",
3411
+ "output_required": false,
3412
+ "type": "int",
3413
+ "value_allowed_null": false
3414
+ },
3415
+ {
3416
+ "disabled": false,
3417
+ "document": "CMK key material type. the type created by KMS is TENCENT_KMS. the user-imported type is EXTERNAL.",
3418
+ "example": "EXTERNAL",
3419
+ "member": "string",
3420
+ "name": "Origin",
3421
+ "output_required": false,
3422
+ "type": "string",
3423
+ "value_allowed_null": false
3424
+ },
3425
+ {
3426
+ "disabled": false,
3427
+ "document": "Valid when Origin is EXTERNAL. indicates the validity date of the key material. 0 means no expiration.",
3428
+ "example": "0",
3429
+ "member": "uint64",
3430
+ "name": "ValidTo",
3431
+ "output_required": false,
3432
+ "type": "int",
3433
+ "value_allowed_null": false
3434
+ },
3435
+ {
3436
+ "disabled": false,
3437
+ "document": "Resource ID in the format of `creatorUin/$creatorUin/$keyId`.",
3438
+ "example": "creatorUin/12345/6cdf26d1-44ff-11eb-841c-5254006d0810",
3439
+ "member": "string",
3440
+ "name": "ResourceId",
3441
+ "output_required": true,
3442
+ "type": "string",
3443
+ "value_allowed_null": false
3444
+ },
3445
+ {
3446
+ "disabled": false,
3447
+ "document": "HSM cluster ID (valid only for exclusive or managed version KMS service instances).",
3448
+ "example": "cls-hsm-1a2b3c4d",
3449
+ "member": "string",
3450
+ "name": "HsmClusterId",
3451
+ "output_required": false,
3452
+ "type": "string",
3453
+ "value_allowed_null": false
3454
+ },
3455
+ {
3456
+ "disabled": false,
3457
+ "document": "Key rotation period (days).",
3458
+ "example": "365",
3459
+ "member": "uint64",
3460
+ "name": "RotateDays",
3461
+ "output_required": false,
3462
+ "type": "int",
3463
+ "value_allowed_null": false
3464
+ },
3465
+ {
3466
+ "disabled": false,
3467
+ "document": "Last disorderly rotation time (Unix timestamp).",
3468
+ "example": "1730716649",
3469
+ "member": "uint64",
3470
+ "name": "LastRotateTime",
3471
+ "output_required": false,
3472
+ "type": "int",
3473
+ "value_allowed_null": false
3474
+ },
3475
+ {
3476
+ "disabled": false,
3477
+ "document": "Specifies whether the key is a primary replica. valid values: 0 (primary replica), 1 (synced replica).",
3478
+ "example": "0",
3479
+ "member": "int64",
3480
+ "name": "IsSyncReplica",
3481
+ "output_required": false,
3482
+ "type": "int",
3483
+ "value_allowed_null": false
3484
+ },
3485
+ {
3486
+ "disabled": false,
3487
+ "document": "Synchronous original region.",
3488
+ "example": "ap-guangzhou",
3489
+ "member": "string",
3490
+ "name": "SourceRegion",
3491
+ "output_required": false,
3492
+ "type": "string",
3493
+ "value_allowed_null": false
3494
+ },
3495
+ {
3496
+ "disabled": false,
3497
+ "document": "The state of key synchronization. valid values: 0 (unsynced), 1 (synchronization successful), 2 (synchronization failed), 3 (synchronizing).",
3498
+ "example": "1",
3499
+ "member": "int64",
3500
+ "name": "SyncStatus",
3501
+ "output_required": false,
3502
+ "type": "int",
3503
+ "value_allowed_null": false
3504
+ },
3505
+ {
3506
+ "disabled": false,
3507
+ "document": "Describes the synchronous result.",
3508
+ "example": "success",
3509
+ "member": "string",
3510
+ "name": "SyncMessages",
3511
+ "output_required": false,
3512
+ "type": "string",
3513
+ "value_allowed_null": false
3514
+ },
3515
+ {
3516
+ "disabled": false,
3517
+ "document": "Start time of synchronization.",
3518
+ "example": "1730357927",
3519
+ "member": "uint64",
3520
+ "name": "SyncStartTime",
3521
+ "output_required": false,
3522
+ "type": "int",
3523
+ "value_allowed_null": false
3524
+ },
3525
+ {
3526
+ "disabled": false,
3527
+ "document": "Specifies the synchronous end time.",
3528
+ "example": "1730357927",
3529
+ "member": "uint64",
3530
+ "name": "SyncEndTime",
3531
+ "output_required": false,
3532
+ "type": "int",
3533
+ "value_allowed_null": false
3534
+ },
3535
+ {
3536
+ "disabled": false,
3537
+ "document": "Synchronous original cluster. if empty, it is a public cloud public cluster.",
3538
+ "example": "hsm-a1b2c3",
3539
+ "member": "string",
3540
+ "name": "SourceHsmClusterId",
3541
+ "output_required": false,
3542
+ "type": "string",
3543
+ "value_allowed_null": false
3544
+ }
3545
+ ],
3546
+ "usage": "out"
3547
+ },
3548
+ "ListAlgorithmsRequest": {
3549
+ "document": "ListAlgorithms request structure.",
3550
+ "members": [],
3551
+ "type": "object"
3552
+ },
3553
+ "ListAlgorithmsResponse": {
3554
+ "document": "ListAlgorithms response structure.",
3555
+ "members": [
3556
+ {
3557
+ "disabled": false,
3558
+ "document": "Symmetric encryption algorithms supported in this region",
3559
+ "example": "[ { \"Algorithm\": \"SM4\", \"KeyUsage\": \"ENCRYPT_DECRYPT\" } ]",
3560
+ "member": "AlgorithmInfo",
3561
+ "name": "SymmetricAlgorithms",
3562
+ "output_required": true,
3563
+ "type": "list",
3564
+ "value_allowed_null": false
3565
+ },
3566
+ {
3567
+ "disabled": false,
3568
+ "document": "Asymmetric encryption algorithms supported in this region",
3569
+ "example": " [ { \"Algorithm\": \"SM2\", \"KeyUsage\": \"ASYMMETRIC_DECRYPT_SM2\" }, { \"Algorithm\": \"RSA_2048\", \"KeyUsage\": \"ASYMMETRIC_DECRYPT_RSA_2048\" }, { \"Algorithm\": \"Kyber_AES\", \"KeyUsage\": \"ASYMMETRIC_Encrypt_Decrypt_Kyber_AES\" } ]",
3570
+ "member": "AlgorithmInfo",
3571
+ "name": "AsymmetricAlgorithms",
3572
+ "output_required": true,
3573
+ "type": "list",
3574
+ "value_allowed_null": false
3575
+ },
3576
+ {
3577
+ "disabled": false,
3578
+ "document": "Asymmetric signature verification algorithms supported in the current region",
3579
+ "example": "[ { \"Algorithm\": \"SM2\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_SM2\" }, { \"Algorithm\": \"RSA_2048\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_RSA_2048\" }, { \"Algorithm\": \"ECC\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_ECC\" }, { \"Algorithm\": \"ECDSA384_SHA384\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_ECDSA384\" }, { \"Algorithm\": \"RSA_3072\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_RSA_3072\" }, { \"Algorithm\": \"Dilithium\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_DILITHIUM\" } ]",
3580
+ "member": "AlgorithmInfo",
3581
+ "name": "AsymmetricSignVerifyAlgorithms",
3582
+ "output_required": true,
3583
+ "type": "list",
3584
+ "value_allowed_null": false
3585
+ },
3586
+ {
3587
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
3588
+ "member": "string",
3589
+ "name": "RequestId",
3590
+ "type": "string"
3591
+ }
3592
+ ],
3593
+ "type": "object"
3594
+ },
3595
+ "ListDataKeyDetailRequest": {
3596
+ "document": "ListDataKeyDetail request structure.",
3597
+ "members": [
3598
+ {
3599
+ "disabled": false,
3600
+ "document": "Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.",
3601
+ "example": "0",
3602
+ "member": "uint64",
3603
+ "name": "Offset",
3604
+ "required": false,
3605
+ "type": "int"
3606
+ },
3607
+ {
3608
+ "disabled": false,
3609
+ "document": "Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries. default value is 10. maximum value is 200.",
3610
+ "example": "10",
3611
+ "member": "uint64",
3612
+ "name": "Limit",
3613
+ "required": false,
3614
+ "type": "int"
3615
+ },
3616
+ {
3617
+ "disabled": false,
3618
+ "document": "Filter by creator role. default 0 means data keys created by the user, 1 means data keys automatically created by authorized cloud services.",
3619
+ "example": "0",
3620
+ "member": "uint64",
3621
+ "name": "Role",
3622
+ "required": false,
3623
+ "type": "int"
3624
+ },
3625
+ {
3626
+ "disabled": false,
3627
+ "document": "Sorts according to the creation time of DataKey. 0 indicates descending sort. 1 indicates ascending sort.",
3628
+ "example": "0",
3629
+ "member": "uint64",
3630
+ "name": "OrderType",
3631
+ "required": false,
3632
+ "type": "int"
3633
+ },
3634
+ {
3635
+ "disabled": false,
3636
+ "document": "Filter based on DataKey state. 0 means all datakeys, 1 means querying only Enabled datakeys, 2 means querying only Disabled datakeys, 3 means querying datakeys in PendingDelete state (keys in scheduled deletion status).",
3637
+ "example": "0",
3638
+ "member": "uint64",
3639
+ "name": "KeyState",
3640
+ "required": false,
3641
+ "type": "int"
3642
+ },
3643
+ {
3644
+ "disabled": false,
3645
+ "document": "Performs a fuzzy match query based on DataKeyId or DataKeyName.",
3646
+ "example": "lzctest",
3647
+ "member": "string",
3648
+ "name": "SearchKeyAlias",
3649
+ "required": false,
3650
+ "type": "string"
3651
+ },
3652
+ {
3653
+ "disabled": false,
3654
+ "document": "Filters data keys by DateKey type. \"TENCENT_KMS\" filters data keys with key material created by KMS. \"EXTERNAL\" filters EXTERNAL type data keys requiring user-imported key material. \"ALL\" or leave unset queries both types. case-sensitive.",
3655
+ "example": "ALL",
2350
3656
  "member": "string",
2351
- "name": "KeyState",
2352
- "output_required": true,
2353
- "type": "string",
2354
- "value_allowed_null": false
3657
+ "name": "Origin",
3658
+ "required": false,
3659
+ "type": "string"
2355
3660
  },
2356
3661
  {
2357
3662
  "disabled": false,
2358
- "document": "CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.",
2359
- "example": "ASYMMETRIC_DECRYPT_RSA_2048",
3663
+ "document": "HSM cluster ID corresponding to KMS advanced edition.",
3664
+ "example": "cls-hsm-3dflmo9g",
2360
3665
  "member": "string",
2361
- "name": "KeyUsage",
2362
- "output_required": true,
2363
- "type": "string",
2364
- "value_allowed_null": false
3666
+ "name": "HsmClusterId",
3667
+ "required": false,
3668
+ "type": "string"
2365
3669
  },
2366
3670
  {
2367
3671
  "disabled": false,
2368
- "document": "CMK type. 2: FIPS-compliant; 4: SM-CRYPTO",
2369
- "example": "3",
2370
- "member": "int64",
2371
- "name": "Type",
2372
- "output_required": true,
2373
- "type": "int",
2374
- "value_allowed_null": false
3672
+ "document": "Specifies the globally unique identifier of the root key.",
3673
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
3674
+ "member": "string",
3675
+ "name": "KeyId",
3676
+ "required": false,
3677
+ "type": "string"
2375
3678
  },
2376
3679
  {
2377
3680
  "disabled": false,
2378
- "document": "Creator",
2379
- "example": "700001224410",
3681
+ "document": "Length of the data key.",
3682
+ "example": "16",
2380
3683
  "member": "uint64",
2381
- "name": "CreatorUin",
2382
- "output_required": true,
2383
- "type": "int",
2384
- "value_allowed_null": false
3684
+ "name": "DataKeyLen",
3685
+ "required": false,
3686
+ "type": "int"
2385
3687
  },
2386
3688
  {
2387
3689
  "disabled": false,
2388
- "document": "Whether key rotation is enabled",
2389
- "example": "true",
2390
- "member": "bool",
2391
- "name": "KeyRotationEnabled",
2392
- "output_required": true,
2393
- "type": "bool",
2394
- "value_allowed_null": false
2395
- },
3690
+ "document": "Tag filtering conditions.",
3691
+ "example": "",
3692
+ "member": "TagFilter",
3693
+ "name": "TagFilters",
3694
+ "required": false,
3695
+ "type": "list"
3696
+ }
3697
+ ],
3698
+ "type": "object"
3699
+ },
3700
+ "ListDataKeyDetailResponse": {
3701
+ "document": "ListDataKeyDetail response structure.",
3702
+ "members": [
2396
3703
  {
2397
3704
  "disabled": false,
2398
- "document": "CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.",
2399
- "example": "user",
2400
- "member": "string",
2401
- "name": "Owner",
2402
- "output_required": true,
2403
- "type": "string",
3705
+ "document": "Returns the attribute information list.",
3706
+ "example": "",
3707
+ "member": "DataKeyMetadata",
3708
+ "name": "DataKeyMetadatas",
3709
+ "output_required": false,
3710
+ "type": "list",
2404
3711
  "value_allowed_null": false
2405
3712
  },
2406
3713
  {
2407
3714
  "disabled": false,
2408
- "document": "Time of next rotation if key rotation is enabled",
2409
- "example": "1761893927",
3715
+ "document": "Total number of datakeys.",
3716
+ "example": "10",
2410
3717
  "member": "uint64",
2411
- "name": "NextRotateTime",
3718
+ "name": "TotalCount",
2412
3719
  "output_required": true,
2413
3720
  "type": "int",
2414
3721
  "value_allowed_null": false
2415
3722
  },
3723
+ {
3724
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
3725
+ "member": "string",
3726
+ "name": "RequestId",
3727
+ "type": "string"
3728
+ }
3729
+ ],
3730
+ "type": "object"
3731
+ },
3732
+ "ListDataKeysRequest": {
3733
+ "document": "ListDataKeys request structure.",
3734
+ "members": [
2416
3735
  {
2417
3736
  "disabled": false,
2418
- "document": "Scheduled deletion time",
3737
+ "document": "Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.",
2419
3738
  "example": "0",
2420
3739
  "member": "uint64",
2421
- "name": "DeletionDate",
2422
- "output_required": false,
2423
- "type": "int",
2424
- "value_allowed_null": false
3740
+ "name": "Offset",
3741
+ "required": false,
3742
+ "type": "int"
2425
3743
  },
2426
3744
  {
2427
3745
  "disabled": false,
2428
- "document": "CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user.\nNote: This field may return null, indicating that no valid values can be obtained.",
2429
- "example": "EXTERNAL",
2430
- "member": "string",
2431
- "name": "Origin",
2432
- "output_required": false,
2433
- "type": "string",
2434
- "value_allowed_null": false
3746
+ "document": "Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries. default value is 10. maximum value is 200.",
3747
+ "example": "2",
3748
+ "member": "uint64",
3749
+ "name": "Limit",
3750
+ "required": false,
3751
+ "type": "int"
2435
3752
  },
2436
3753
  {
2437
3754
  "disabled": false,
2438
- "document": "It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material. 0 means valid forever.\nNote: This field may return null, indicating that no valid values can be obtained.",
3755
+ "document": "Filter criteria based on the creator role. default 0 means data key created by oneself, 1 means data key automatically created by other cloud services.",
2439
3756
  "example": "0",
2440
3757
  "member": "uint64",
2441
- "name": "ValidTo",
2442
- "output_required": false,
2443
- "type": "int",
2444
- "value_allowed_null": false
2445
- },
2446
- {
2447
- "disabled": false,
2448
- "document": "Resource ID in the format of `creatorUin/$creatorUin/$keyId`.",
2449
- "example": "creatorUin/12345/6cdf26d1-44ff-11eb-841c-5254006d0810",
2450
- "member": "string",
2451
- "name": "ResourceId",
2452
- "output_required": true,
2453
- "type": "string",
2454
- "value_allowed_null": false
3758
+ "name": "Role",
3759
+ "required": false,
3760
+ "type": "int"
2455
3761
  },
2456
3762
  {
2457
3763
  "disabled": false,
2458
- "document": "ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.\nNote: This field may return `null`, indicating that no valid value can be obtained.",
2459
- "example": "cls-hsm-1a2b3c4d",
3764
+ "document": "HSM cluster ID corresponding to KMS advanced edition (only applicable to KMS exclusive/managed service instance).",
3765
+ "example": "cls-hsm-3dflmo9g",
2460
3766
  "member": "string",
2461
3767
  "name": "HsmClusterId",
2462
- "output_required": false,
2463
- "type": "string",
2464
- "value_allowed_null": false
3768
+ "required": false,
3769
+ "type": "string"
2465
3770
  }
2466
3771
  ],
2467
- "usage": "out"
2468
- },
2469
- "ListAlgorithmsRequest": {
2470
- "document": "ListAlgorithms request structure.",
2471
- "members": [],
2472
3772
  "type": "object"
2473
3773
  },
2474
- "ListAlgorithmsResponse": {
2475
- "document": "ListAlgorithms response structure.",
3774
+ "ListDataKeysResponse": {
3775
+ "document": "ListDataKeys response structure.",
2476
3776
  "members": [
2477
3777
  {
2478
3778
  "disabled": false,
2479
- "document": "Symmetric encryption algorithms supported in this region",
2480
- "example": "[ { \"Algorithm\": \"SM4\", \"KeyUsage\": \"ENCRYPT_DECRYPT\" } ]",
2481
- "member": "AlgorithmInfo",
2482
- "name": "SymmetricAlgorithms",
2483
- "output_required": true,
2484
- "type": "list",
2485
- "value_allowed_null": false
2486
- },
2487
- {
2488
- "disabled": false,
2489
- "document": "Asymmetric encryption algorithms supported in this region",
2490
- "example": " [ { \"Algorithm\": \"SM2\", \"KeyUsage\": \"ASYMMETRIC_DECRYPT_SM2\" }, { \"Algorithm\": \"RSA_2048\", \"KeyUsage\": \"ASYMMETRIC_DECRYPT_RSA_2048\" }, { \"Algorithm\": \"Kyber_AES\", \"KeyUsage\": \"ASYMMETRIC_Encrypt_Decrypt_Kyber_AES\" } ]",
2491
- "member": "AlgorithmInfo",
2492
- "name": "AsymmetricAlgorithms",
2493
- "output_required": true,
3779
+ "document": "Specifies the list array of data key ids.",
3780
+ "example": "",
3781
+ "member": "DataKey",
3782
+ "name": "DataKeys",
3783
+ "output_required": false,
2494
3784
  "type": "list",
2495
3785
  "value_allowed_null": false
2496
3786
  },
2497
3787
  {
2498
3788
  "disabled": false,
2499
- "document": "Asymmetric signature verification algorithms supported in the current region",
2500
- "example": "[ { \"Algorithm\": \"SM2\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_SM2\" }, { \"Algorithm\": \"RSA_2048\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_RSA_2048\" }, { \"Algorithm\": \"ECC\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_ECC\" }, { \"Algorithm\": \"ECDSA384_SHA384\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_ECDSA384\" }, { \"Algorithm\": \"RSA_3072\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_RSA_3072\" }, { \"Algorithm\": \"Dilithium\", \"KeyUsage\": \"ASYMMETRIC_SIGN_VERIFY_DILITHIUM\" } ]",
2501
- "member": "AlgorithmInfo",
2502
- "name": "AsymmetricSignVerifyAlgorithms",
3789
+ "document": "Total number of data keys.",
3790
+ "example": "100",
3791
+ "member": "uint64",
3792
+ "name": "TotalCount",
2503
3793
  "output_required": true,
2504
- "type": "list",
3794
+ "type": "int",
2505
3795
  "value_allowed_null": false
2506
3796
  },
2507
3797
  {
@@ -2624,8 +3914,8 @@
2624
3914
  },
2625
3915
  {
2626
3916
  "disabled": false,
2627
- "document": "List of returned attribute information.\nNote: this field may return null, indicating that no valid values can be obtained.",
2628
- "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 } ]",
3917
+ "document": "Specifies the returned attribute information list.",
3918
+ "example": "",
2629
3919
  "member": "KeyMetadata",
2630
3920
  "name": "KeyMetadatas",
2631
3921
  "output_required": false,
@@ -2688,7 +3978,7 @@
2688
3978
  "members": [
2689
3979
  {
2690
3980
  "disabled": false,
2691
- "document": "CMK list array",
3981
+ "document": "CMK list array.",
2692
3982
  "example": "[ { \"KeyId\": \"515d337d-70b4-11ef-bc87-02ac442a5a1f\" }, { \"KeyId\": \"0ed49d3e-69d3-11ef-9841-52540089bc41\" } ]",
2693
3983
  "member": "Key",
2694
3984
  "name": "Keys",
@@ -3067,6 +4357,62 @@
3067
4357
  ],
3068
4358
  "type": "object"
3069
4359
  },
4360
+ "ScheduleDataKeyDeletionRequest": {
4361
+ "document": "ScheduleDataKeyDeletion request structure.",
4362
+ "members": [
4363
+ {
4364
+ "disabled": false,
4365
+ "document": "Unique id of a data key.",
4366
+ "example": "\t 93866e69-9755-11ef-8e65-52540089bc41",
4367
+ "member": "string",
4368
+ "name": "DataKeyId",
4369
+ "required": true,
4370
+ "type": "string"
4371
+ },
4372
+ {
4373
+ "disabled": false,
4374
+ "document": "Schedule deletion time range: [7,30].",
4375
+ "example": "7",
4376
+ "member": "uint64",
4377
+ "name": "PendingWindowInDays",
4378
+ "required": true,
4379
+ "type": "int"
4380
+ }
4381
+ ],
4382
+ "type": "object"
4383
+ },
4384
+ "ScheduleDataKeyDeletionResponse": {
4385
+ "document": "ScheduleDataKeyDeletion response structure.",
4386
+ "members": [
4387
+ {
4388
+ "disabled": false,
4389
+ "document": "Schedule deletion execution time.",
4390
+ "example": "1559318399",
4391
+ "member": "uint64",
4392
+ "name": "DeletionDate",
4393
+ "output_required": true,
4394
+ "type": "int",
4395
+ "value_allowed_null": false
4396
+ },
4397
+ {
4398
+ "disabled": false,
4399
+ "document": "Unique identifier of the data key scheduled for deletion.",
4400
+ "example": "23e80852-1e38-11e9-b129-5cb9019b4b01",
4401
+ "member": "string",
4402
+ "name": "DataKeyId",
4403
+ "output_required": true,
4404
+ "type": "string",
4405
+ "value_allowed_null": false
4406
+ },
4407
+ {
4408
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
4409
+ "member": "string",
4410
+ "name": "RequestId",
4411
+ "type": "string"
4412
+ }
4413
+ ],
4414
+ "type": "object"
4415
+ },
3070
4416
  "ScheduleKeyDeletionRequest": {
3071
4417
  "document": "ScheduleKeyDeletion request structure.",
3072
4418
  "members": [
@@ -3258,7 +4604,7 @@
3258
4604
  },
3259
4605
  {
3260
4606
  "disabled": false,
3261
- "document": "Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud services features.",
4607
+ "document": "Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service's features.",
3262
4608
  "example": "resourceId",
3263
4609
  "member": "string",
3264
4610
  "name": "ResourceId",
@@ -3316,6 +4662,78 @@
3316
4662
  ],
3317
4663
  "type": "object"
3318
4664
  },
4665
+ "UpdateDataKeyDescriptionRequest": {
4666
+ "document": "UpdateDataKeyDescription request structure.",
4667
+ "members": [
4668
+ {
4669
+ "disabled": false,
4670
+ "document": "Specifies the unique identifier of the data key.",
4671
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
4672
+ "member": "string",
4673
+ "name": "DataKeyId",
4674
+ "required": true,
4675
+ "type": "string"
4676
+ },
4677
+ {
4678
+ "disabled": false,
4679
+ "document": "Data key description of up to 100 bytes.",
4680
+ "example": "描述信息",
4681
+ "member": "string",
4682
+ "name": "Description",
4683
+ "required": true,
4684
+ "type": "string"
4685
+ }
4686
+ ],
4687
+ "type": "object"
4688
+ },
4689
+ "UpdateDataKeyDescriptionResponse": {
4690
+ "document": "UpdateDataKeyDescription response structure.",
4691
+ "members": [
4692
+ {
4693
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
4694
+ "member": "string",
4695
+ "name": "RequestId",
4696
+ "type": "string"
4697
+ }
4698
+ ],
4699
+ "type": "object"
4700
+ },
4701
+ "UpdateDataKeyNameRequest": {
4702
+ "document": "UpdateDataKeyName request structure.",
4703
+ "members": [
4704
+ {
4705
+ "disabled": false,
4706
+ "document": "Unique identifier of a data key.",
4707
+ "example": "93866e69-9755-11ef-8e65-52540089bc41",
4708
+ "member": "string",
4709
+ "name": "DataKeyId",
4710
+ "required": true,
4711
+ "type": "string"
4712
+ },
4713
+ {
4714
+ "disabled": false,
4715
+ "document": "Name of the data key.",
4716
+ "example": "test",
4717
+ "member": "string",
4718
+ "name": "DataKeyName",
4719
+ "required": true,
4720
+ "type": "string"
4721
+ }
4722
+ ],
4723
+ "type": "object"
4724
+ },
4725
+ "UpdateDataKeyNameResponse": {
4726
+ "document": "UpdateDataKeyName response structure.",
4727
+ "members": [
4728
+ {
4729
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
4730
+ "member": "string",
4731
+ "name": "RequestId",
4732
+ "type": "string"
4733
+ }
4734
+ ],
4735
+ "type": "object"
4736
+ },
3319
4737
  "UpdateKeyDescriptionRequest": {
3320
4738
  "document": "UpdateKeyDescription request structure.",
3321
4739
  "members": [
@@ -3540,7 +4958,7 @@
3540
4958
  },
3541
4959
  {
3542
4960
  "disabled": false,
3543
- "document": "Whether there is a device fingerprint bound to the current key\nNote: this field may return null, indicating that no valid values can be obtained.",
4961
+ "document": "Specifies whether there is a device fingerprint bound to the current key.",
3544
4962
  "example": "false",
3545
4963
  "member": "bool",
3546
4964
  "name": "DeviceFingerprintBind",