tencentcloud-sdk-python 3.0.1338__py2.py3-none-any.whl → 3.0.1372__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 (284) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/advisor/v20200721/models.py +0 -26
  3. tencentcloud/ams/v20201229/ams_client.py +17 -6
  4. tencentcloud/ams/v20201229/models.py +8 -6
  5. tencentcloud/antiddos/v20200309/antiddos_client.py +0 -50
  6. tencentcloud/antiddos/v20200309/models.py +44 -837
  7. tencentcloud/apm/v20210622/models.py +60 -60
  8. tencentcloud/autoscaling/v20180419/autoscaling_client.py +28 -1
  9. tencentcloud/autoscaling/v20180419/models.py +352 -210
  10. tencentcloud/batch/v20170312/batch_client.py +0 -46
  11. tencentcloud/batch/v20170312/errorcodes.py +0 -9
  12. tencentcloud/batch/v20170312/models.py +44 -1179
  13. tencentcloud/bh/v20230418/bh_client.py +253 -0
  14. tencentcloud/bh/v20230418/errorcodes.py +15 -0
  15. tencentcloud/bh/v20230418/models.py +3489 -1335
  16. tencentcloud/bi/v20220105/models.py +242 -2
  17. tencentcloud/billing/v20180709/billing_client.py +0 -23
  18. tencentcloud/billing/v20180709/models.py +34 -926
  19. tencentcloud/bpaas/v20181217/models.py +0 -54
  20. tencentcloud/cam/v20190116/errorcodes.py +3 -0
  21. tencentcloud/cam/v20190116/models.py +2 -86
  22. tencentcloud/captcha/v20190722/models.py +21 -54
  23. tencentcloud/cat/v20180409/cat_client.py +23 -0
  24. tencentcloud/cat/v20180409/models.py +509 -0
  25. tencentcloud/cbs/v20170312/cbs_client.py +1 -1
  26. tencentcloud/cbs/v20170312/models.py +75 -96
  27. tencentcloud/ccc/v20200210/ccc_client.py +184 -0
  28. tencentcloud/ccc/v20200210/errorcodes.py +12 -0
  29. tencentcloud/ccc/v20200210/models.py +2552 -1026
  30. tencentcloud/cdb/v20170320/cdb_client.py +27 -4
  31. tencentcloud/cdb/v20170320/models.py +180 -20
  32. tencentcloud/cdc/v20201214/cdc_client.py +46 -0
  33. tencentcloud/cdc/v20201214/errorcodes.py +18 -0
  34. tencentcloud/cdc/v20201214/models.py +202 -86
  35. tencentcloud/cdn/v20180606/cdn_client.py +70 -24
  36. tencentcloud/cdn/v20180606/models.py +19 -50
  37. tencentcloud/cdwch/v20200915/errorcodes.py +15 -0
  38. tencentcloud/cdwch/v20200915/models.py +242 -260
  39. tencentcloud/cdwdoris/v20211228/models.py +330 -0
  40. tencentcloud/cdwpg/v20201230/models.py +196 -516
  41. tencentcloud/cdz/v20221123/models.py +0 -12
  42. tencentcloud/cfg/v20210820/models.py +30 -198
  43. tencentcloud/cfs/v20190719/errorcodes.py +3 -0
  44. tencentcloud/cfs/v20190719/models.py +15 -0
  45. tencentcloud/cfw/v20190904/cfw_client.py +23 -0
  46. tencentcloud/cfw/v20190904/models.py +331 -4
  47. tencentcloud/chc/__init__.py +0 -0
  48. tencentcloud/chc/v20230418/__init__.py +0 -0
  49. tencentcloud/chc/v20230418/chc_client.py +877 -0
  50. tencentcloud/chc/v20230418/errorcodes.py +15 -0
  51. tencentcloud/chc/v20230418/models.py +10146 -0
  52. tencentcloud/chdfs/v20201112/models.py +2 -2
  53. tencentcloud/ckafka/v20190819/ckafka_client.py +46 -0
  54. tencentcloud/ckafka/v20190819/models.py +371 -1230
  55. tencentcloud/clb/v20180317/clb_client.py +3 -3
  56. tencentcloud/clb/v20180317/models.py +395 -406
  57. tencentcloud/cls/v20201016/cls_client.py +41 -18
  58. tencentcloud/cls/v20201016/models.py +256 -606
  59. tencentcloud/cme/v20191029/cme_client.py +0 -1
  60. tencentcloud/cme/v20191029/errorcodes.py +3 -0
  61. tencentcloud/cme/v20191029/models.py +10 -14
  62. tencentcloud/cmq/v20190304/models.py +0 -90
  63. tencentcloud/common/abstract_client.py +29 -24
  64. tencentcloud/common/abstract_model.py +5 -1
  65. tencentcloud/common/common_client.py +14 -15
  66. tencentcloud/common/credential.py +68 -65
  67. tencentcloud/common/exception/tencent_cloud_sdk_exception.py +1 -1
  68. tencentcloud/common/profile/client_profile.py +32 -30
  69. tencentcloud/common/profile/http_profile.py +20 -12
  70. tencentcloud/common/retry.py +18 -0
  71. tencentcloud/controlcenter/v20230110/models.py +0 -58
  72. tencentcloud/cvm/v20170312/cvm_client.py +42 -10
  73. tencentcloud/cvm/v20170312/errorcodes.py +25 -1
  74. tencentcloud/cvm/v20170312/models.py +835 -290
  75. tencentcloud/cwp/v20180228/cwp_client.py +1 -1
  76. tencentcloud/cwp/v20180228/models.py +362 -58
  77. tencentcloud/cynosdb/v20190107/cynosdb_client.py +69 -0
  78. tencentcloud/cynosdb/v20190107/models.py +451 -824
  79. tencentcloud/dbbrain/v20191016/dbbrain_client.py +23 -0
  80. tencentcloud/dbbrain/v20191016/models.py +605 -52
  81. tencentcloud/dbbrain/v20210527/dbbrain_client.py +322 -0
  82. tencentcloud/dbbrain/v20210527/models.py +6071 -2974
  83. tencentcloud/dbdc/v20201029/models.py +0 -16
  84. tencentcloud/dc/v20180410/models.py +25 -12
  85. tencentcloud/dcdb/v20180411/errorcodes.py +3 -0
  86. tencentcloud/dcdb/v20180411/models.py +175 -114
  87. tencentcloud/dlc/v20210125/dlc_client.py +69 -0
  88. tencentcloud/dlc/v20210125/errorcodes.py +3 -0
  89. tencentcloud/dlc/v20210125/models.py +1217 -592
  90. tencentcloud/dnspod/v20210323/dnspod_client.py +69 -0
  91. tencentcloud/dnspod/v20210323/errorcodes.py +9 -0
  92. tencentcloud/dnspod/v20210323/models.py +718 -110
  93. tencentcloud/domain/v20180808/domain_client.py +4 -2
  94. tencentcloud/domain/v20180808/errorcodes.py +3 -0
  95. tencentcloud/domain/v20180808/models.py +628 -324
  96. tencentcloud/dsgc/v20190723/dsgc_client.py +0 -23
  97. tencentcloud/dsgc/v20190723/models.py +53 -34
  98. tencentcloud/dts/v20180330/models.py +0 -10
  99. tencentcloud/dts/v20211206/models.py +118 -585
  100. tencentcloud/ecdn/v20191012/ecdn_client.py +24 -225
  101. tencentcloud/ecdn/v20191012/errorcodes.py +0 -63
  102. tencentcloud/ecdn/v20191012/models.py +4 -1047
  103. tencentcloud/emr/v20190103/emr_client.py +47 -1
  104. tencentcloud/emr/v20190103/models.py +1174 -146
  105. tencentcloud/es/v20180416/errorcodes.py +3 -0
  106. tencentcloud/es/v20180416/models.py +74 -6
  107. tencentcloud/es/v20250101/__init__.py +0 -0
  108. tencentcloud/es/v20250101/errorcodes.py +45 -0
  109. tencentcloud/es/v20250101/es_client.py +251 -0
  110. tencentcloud/es/v20250101/models.py +2519 -0
  111. tencentcloud/ess/v20201111/ess_client.py +43 -5
  112. tencentcloud/ess/v20201111/models.py +854 -60
  113. tencentcloud/essbasic/v20210526/essbasic_client.py +35 -2
  114. tencentcloud/essbasic/v20210526/models.py +726 -43
  115. tencentcloud/facefusion/v20220927/models.py +4 -2
  116. tencentcloud/fmu/v20191213/errorcodes.py +3 -21
  117. tencentcloud/fmu/v20191213/fmu_client.py +0 -75
  118. tencentcloud/fmu/v20191213/models.py +4 -531
  119. tencentcloud/gaap/v20180529/gaap_client.py +1 -1
  120. tencentcloud/gaap/v20180529/models.py +2 -276
  121. tencentcloud/goosefs/v20220519/models.py +0 -2
  122. tencentcloud/gs/v20191118/errorcodes.py +36 -0
  123. tencentcloud/gs/v20191118/gs_client.py +1074 -12
  124. tencentcloud/gs/v20191118/models.py +6976 -492
  125. tencentcloud/gwlb/v20240906/errorcodes.py +3 -0
  126. tencentcloud/gwlb/v20240906/gwlb_client.py +5 -8
  127. tencentcloud/gwlb/v20240906/models.py +94 -84
  128. tencentcloud/hai/v20230812/errorcodes.py +7 -1
  129. tencentcloud/hai/v20230812/hai_client.py +23 -0
  130. tencentcloud/hai/v20230812/models.py +111 -136
  131. tencentcloud/hunyuan/v20230901/errorcodes.py +27 -0
  132. tencentcloud/hunyuan/v20230901/hunyuan_client.py +71 -0
  133. tencentcloud/hunyuan/v20230901/models.py +1089 -119
  134. tencentcloud/ims/v20201229/models.py +25 -4
  135. tencentcloud/ioa/v20220601/ioa_client.py +92 -0
  136. tencentcloud/ioa/v20220601/models.py +1136 -225
  137. tencentcloud/iotcloud/v20210408/models.py +2 -4
  138. tencentcloud/iotexplorer/v20190423/errorcodes.py +12 -0
  139. tencentcloud/iotexplorer/v20190423/iotexplorer_client.py +234 -52
  140. tencentcloud/iotexplorer/v20190423/models.py +2906 -1063
  141. tencentcloud/iotvideo/v20191126/models.py +0 -4
  142. tencentcloud/iotvideo/v20201215/models.py +17 -0
  143. tencentcloud/iotvideo/v20211125/iotvideo_client.py +69 -0
  144. tencentcloud/iotvideo/v20211125/models.py +476 -0
  145. tencentcloud/iotvideoindustry/v20201201/iotvideoindustry_client.py +2 -2
  146. tencentcloud/iotvideoindustry/v20201201/models.py +30 -486
  147. tencentcloud/iss/v20230517/errorcodes.py +9 -0
  148. tencentcloud/iss/v20230517/iss_client.py +161 -0
  149. tencentcloud/iss/v20230517/models.py +1716 -743
  150. tencentcloud/kms/v20190118/models.py +101 -0
  151. tencentcloud/lcic/v20220817/errorcodes.py +2 -2
  152. tencentcloud/lcic/v20220817/lcic_client.py +47 -1
  153. tencentcloud/lcic/v20220817/models.py +357 -72
  154. tencentcloud/lighthouse/v20200324/errorcodes.py +12 -15
  155. tencentcloud/lighthouse/v20200324/lighthouse_client.py +39 -76
  156. tencentcloud/lighthouse/v20200324/models.py +237 -259
  157. tencentcloud/live/v20180801/models.py +61 -46
  158. tencentcloud/lke/v20231130/errorcodes.py +3 -0
  159. tencentcloud/lke/v20231130/lke_client.py +8 -29
  160. tencentcloud/lke/v20231130/models.py +561 -115
  161. tencentcloud/lkeap/v20240522/lkeap_client.py +33 -4
  162. tencentcloud/lkeap/v20240522/models.py +290 -18
  163. tencentcloud/lowcode/v20210108/errorcodes.py +3 -0
  164. tencentcloud/lowcode/v20210108/models.py +0 -2
  165. tencentcloud/mariadb/v20170312/models.py +155 -140
  166. tencentcloud/memcached/v20190318/models.py +2 -2
  167. tencentcloud/mmps/v20200710/models.py +0 -66
  168. tencentcloud/mna/v20210119/errorcodes.py +0 -36
  169. tencentcloud/mna/v20210119/mna_client.py +0 -75
  170. tencentcloud/mna/v20210119/models.py +0 -1002
  171. tencentcloud/mongodb/v20190725/models.py +115 -6
  172. tencentcloud/mongodb/v20190725/mongodb_client.py +23 -0
  173. tencentcloud/monitor/v20180724/errorcodes.py +3 -0
  174. tencentcloud/monitor/v20180724/models.py +1055 -74
  175. tencentcloud/monitor/v20180724/monitor_client.py +94 -2
  176. tencentcloud/mps/v20190612/errorcodes.py +36 -0
  177. tencentcloud/mps/v20190612/models.py +4866 -448
  178. tencentcloud/mps/v20190612/mps_client.py +208 -0
  179. tencentcloud/mqtt/v20240516/errorcodes.py +15 -0
  180. tencentcloud/mqtt/v20240516/models.py +705 -372
  181. tencentcloud/mqtt/v20240516/mqtt_client.py +4 -4
  182. tencentcloud/oceanus/v20190422/models.py +14 -2
  183. tencentcloud/ocr/v20181119/errorcodes.py +0 -12
  184. tencentcloud/ocr/v20181119/models.py +311 -1042
  185. tencentcloud/ocr/v20181119/ocr_client.py +5 -102
  186. tencentcloud/organization/v20210331/errorcodes.py +3 -0
  187. tencentcloud/organization/v20210331/models.py +45 -82
  188. tencentcloud/partners/v20180321/models.py +169 -0
  189. tencentcloud/partners/v20180321/partners_client.py +23 -0
  190. tencentcloud/postgres/v20170312/models.py +36 -328
  191. tencentcloud/postgres/v20170312/postgres_client.py +15 -5
  192. tencentcloud/privatedns/v20201028/models.py +36 -28
  193. tencentcloud/rce/v20201103/models.py +0 -15
  194. tencentcloud/redis/v20180412/models.py +233 -18
  195. tencentcloud/redis/v20180412/redis_client.py +23 -0
  196. tencentcloud/rum/v20210622/models.py +0 -2
  197. tencentcloud/ses/v20201002/models.py +32 -4
  198. tencentcloud/smop/v20201203/smop_client.py +3 -1
  199. tencentcloud/soe/v20180724/models.py +4 -2
  200. tencentcloud/sqlserver/v20180328/models.py +75 -0
  201. tencentcloud/ssl/v20191205/models.py +7 -319
  202. tencentcloud/ssm/v20190923/models.py +45 -0
  203. tencentcloud/sts/v20180813/errorcodes.py +9 -0
  204. tencentcloud/sts/v20180813/models.py +171 -0
  205. tencentcloud/sts/v20180813/sts_client.py +23 -0
  206. tencentcloud/svp/v20240125/errorcodes.py +3 -0
  207. tencentcloud/svp/v20240125/models.py +506 -44
  208. tencentcloud/svp/v20240125/svp_client.py +23 -0
  209. tencentcloud/tan/v20220420/tan_client.py +3 -1
  210. tencentcloud/tat/v20201028/errorcodes.py +12 -0
  211. tencentcloud/tat/v20201028/models.py +138 -42
  212. tencentcloud/tbaas/v20180416/models.py +0 -58
  213. tencentcloud/tcb/v20180608/errorcodes.py +3 -0
  214. tencentcloud/tcb/v20180608/models.py +189 -582
  215. tencentcloud/tcb/v20180608/tcb_client.py +23 -23
  216. tencentcloud/tcbr/v20220217/models.py +45 -0
  217. tencentcloud/tchd/v20230306/models.py +166 -0
  218. tencentcloud/tchd/v20230306/tchd_client.py +24 -0
  219. tencentcloud/tcr/v20190924/models.py +44 -174
  220. tencentcloud/tcss/v20201101/models.py +1458 -2066
  221. tencentcloud/tcss/v20201101/tcss_client.py +92 -125
  222. tencentcloud/tdid/v20210519/models.py +0 -10
  223. tencentcloud/tdmq/v20200217/models.py +405 -575
  224. tencentcloud/tdmq/v20200217/tdmq_client.py +12 -54
  225. tencentcloud/tds/v20220801/models.py +441 -0
  226. tencentcloud/tds/v20220801/tds_client.py +23 -0
  227. tencentcloud/tem/v20210701/models.py +0 -498
  228. tencentcloud/teo/v20220106/teo_client.py +6 -2
  229. tencentcloud/teo/v20220901/errorcodes.py +9 -0
  230. tencentcloud/teo/v20220901/models.py +1828 -472
  231. tencentcloud/teo/v20220901/teo_client.py +54 -4
  232. tencentcloud/thpc/v20211109/models.py +0 -6
  233. tencentcloud/thpc/v20220401/models.py +0 -14
  234. tencentcloud/thpc/v20230321/models.py +64 -52
  235. tencentcloud/tione/v20211111/errorcodes.py +114 -0
  236. tencentcloud/tione/v20211111/models.py +2288 -160
  237. tencentcloud/tione/v20211111/tione_client.py +138 -0
  238. tencentcloud/tiw/v20190919/errorcodes.py +3 -24
  239. tencentcloud/tiw/v20190919/models.py +3657 -8172
  240. tencentcloud/tiw/v20190919/tiw_client.py +1 -580
  241. tencentcloud/tke/v20180525/models.py +705 -721
  242. tencentcloud/tke/v20180525/tke_client.py +23 -0
  243. tencentcloud/tke/v20220501/models.py +0 -34
  244. tencentcloud/trocket/v20230308/models.py +1630 -160
  245. tencentcloud/trocket/v20230308/trocket_client.py +238 -0
  246. tencentcloud/trro/v20220325/models.py +1132 -44
  247. tencentcloud/trro/v20220325/trro_client.py +142 -0
  248. tencentcloud/trtc/v20190722/models.py +94 -90
  249. tencentcloud/trtc/v20190722/trtc_client.py +4 -0
  250. tencentcloud/tse/v20201207/models.py +90 -1010
  251. tencentcloud/tsf/v20180326/errorcodes.py +6 -0
  252. tencentcloud/tsf/v20180326/models.py +350 -582
  253. tencentcloud/tsf/v20180326/tsf_client.py +26 -1
  254. tencentcloud/tts/v20190823/models.py +15 -15
  255. tencentcloud/tts/v20190823/tts_client.py +6 -5
  256. tencentcloud/vclm/v20240523/models.py +2 -2
  257. tencentcloud/vcube/v20220410/models.py +66 -158
  258. tencentcloud/vcube/v20220410/vcube_client.py +2 -2
  259. tencentcloud/vdb/v20230616/models.py +1487 -29
  260. tencentcloud/vdb/v20230616/vdb_client.py +185 -1
  261. tencentcloud/vm/v20210922/models.py +2 -2
  262. tencentcloud/vm/v20210922/vm_client.py +16 -8
  263. tencentcloud/vod/v20180717/errorcodes.py +3 -0
  264. tencentcloud/vod/v20180717/models.py +106 -417
  265. tencentcloud/vod/v20180717/vod_client.py +2 -1
  266. tencentcloud/vod/v20240718/errorcodes.py +33 -0
  267. tencentcloud/vod/v20240718/models.py +1839 -0
  268. tencentcloud/vod/v20240718/vod_client.py +146 -0
  269. tencentcloud/vpc/v20170312/errorcodes.py +12 -0
  270. tencentcloud/vpc/v20170312/models.py +2052 -519
  271. tencentcloud/vpc/v20170312/vpc_client.py +229 -11
  272. tencentcloud/vrs/v20200824/models.py +49 -0
  273. tencentcloud/waf/v20180125/errorcodes.py +9 -0
  274. tencentcloud/waf/v20180125/models.py +4191 -0
  275. tencentcloud/waf/v20180125/waf_client.py +276 -0
  276. tencentcloud/wedata/v20210820/models.py +5404 -394
  277. tencentcloud/wedata/v20210820/wedata_client.py +161 -0
  278. tencentcloud/weilingwith/v20230427/models.py +0 -964
  279. tencentcloud/weilingwith/v20230427/weilingwith_client.py +3 -1
  280. {tencentcloud_sdk_python-3.0.1338.dist-info → tencentcloud_sdk_python-3.0.1372.dist-info}/METADATA +1 -1
  281. {tencentcloud_sdk_python-3.0.1338.dist-info → tencentcloud_sdk_python-3.0.1372.dist-info}/RECORD +284 -275
  282. {tencentcloud_sdk_python-3.0.1338.dist-info → tencentcloud_sdk_python-3.0.1372.dist-info}/LICENSE +0 -0
  283. {tencentcloud_sdk_python-3.0.1338.dist-info → tencentcloud_sdk_python-3.0.1372.dist-info}/WHEEL +0 -0
  284. {tencentcloud_sdk_python-3.0.1338.dist-info → tencentcloud_sdk_python-3.0.1372.dist-info}/top_level.txt +0 -0
@@ -25,9 +25,9 @@ class ActivateCaCertificateRequest(AbstractModel):
25
25
 
26
26
  def __init__(self):
27
27
  r"""
28
- :param _InstanceId: 集群id
28
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
29
29
  :type InstanceId: str
30
- :param _CaSn: 证书序列号
30
+ :param _CaSn: CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
31
31
  :type CaSn: str
32
32
  """
33
33
  self._InstanceId = None
@@ -35,7 +35,7 @@ class ActivateCaCertificateRequest(AbstractModel):
35
35
 
36
36
  @property
37
37
  def InstanceId(self):
38
- """集群id
38
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
39
39
  :rtype: str
40
40
  """
41
41
  return self._InstanceId
@@ -46,7 +46,7 @@ class ActivateCaCertificateRequest(AbstractModel):
46
46
 
47
47
  @property
48
48
  def CaSn(self):
49
- """证书序列号
49
+ """CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
50
50
  :rtype: str
51
51
  """
52
52
  return self._CaSn
@@ -104,9 +104,9 @@ class ActivateDeviceCertificateRequest(AbstractModel):
104
104
 
105
105
  def __init__(self):
106
106
  r"""
107
- :param _InstanceId: 集群id
107
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
108
108
  :type InstanceId: str
109
- :param _DeviceCertificateSn: 设备证书序列号
109
+ :param _DeviceCertificateSn: 设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
110
110
  :type DeviceCertificateSn: str
111
111
  """
112
112
  self._InstanceId = None
@@ -114,7 +114,7 @@ class ActivateDeviceCertificateRequest(AbstractModel):
114
114
 
115
115
  @property
116
116
  def InstanceId(self):
117
- """集群id
117
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
118
118
  :rtype: str
119
119
  """
120
120
  return self._InstanceId
@@ -125,7 +125,7 @@ class ActivateDeviceCertificateRequest(AbstractModel):
125
125
 
126
126
  @property
127
127
  def DeviceCertificateSn(self):
128
- """设备证书序列号
128
+ """设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
129
129
  :rtype: str
130
130
  """
131
131
  return self._DeviceCertificateSn
@@ -183,14 +183,14 @@ class ApplyRegistrationCodeRequest(AbstractModel):
183
183
 
184
184
  def __init__(self):
185
185
  r"""
186
- :param _InstanceId: 集群id
186
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
187
187
  :type InstanceId: str
188
188
  """
189
189
  self._InstanceId = None
190
190
 
191
191
  @property
192
192
  def InstanceId(self):
193
- """集群id
193
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
194
194
  :rtype: str
195
195
  """
196
196
  return self._InstanceId
@@ -277,39 +277,47 @@ class AuthorizationPolicyItem(AbstractModel):
277
277
 
278
278
  def __init__(self):
279
279
  r"""
280
- :param _Id: 规则ID
280
+ :param _Id: 策略规则ID
281
281
  :type Id: int
282
- :param _InstanceId: 集群ID
282
+ :param _InstanceId: MQTT集群ID
283
283
  :type InstanceId: str
284
- :param _PolicyName: 规则名
284
+ :param _PolicyName: 策略规则名
285
285
  :type PolicyName: str
286
- :param _Version: 规则语法版本
286
+ :param _Version: 规则语法版本,当前仅支持1,默认为1
287
287
  :type Version: int
288
- :param _Priority: 越小越优先
288
+ :param _Priority: 策略优先级,优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
289
289
  :type Priority: int
290
- :param _Effect: allow/deny
290
+ :param _Effect: 决策
291
+ allow:允许符合该策略的设备的访问请求。
292
+ deny:拒绝覆盖该策略的设备的访问请求。
293
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
291
294
  :type Effect: str
292
- :param _Actions: connect、pub、sub
295
+ :param _Actions: 操作
296
+ connect:连接
297
+ pub:发布mqtt消息
298
+ sub:订阅mqtt消息
299
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
293
300
  :type Actions: str
294
- :param _Resources: 资源
301
+ :param _Resources: 资源,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
295
302
  :type Resources: str
296
- :param _ClientId: client
303
+ :param _ClientId: 条件-连接设备ID,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
297
304
  :type ClientId: str
298
- :param _Username: 用户
305
+ :param _Username: 条件-用户名,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
299
306
  :type Username: str
300
- :param _Ip: IP地址
307
+ :param _Ip: 条件-客户端IP地址,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
301
308
  :type Ip: str
302
- :param _Qos: 0,1,2
309
+ :param _Qos: 条件-服务质量,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
303
310
  :type Qos: str
304
- :param _Retain: 1:表示匹配retain消息
311
+ :param _Retain: 条件-保留消息,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
312
+ 1:表示匹配retain消息
305
313
  2:表示匹配非retain消息
306
314
  3:表示匹配retain和非retain消息
307
315
  :type Retain: int
308
- :param _Remark: 描述
316
+ :param _Remark: 备注,长度不超过128个字符。
309
317
  :type Remark: str
310
- :param _CreatedTime: 1713164969433
318
+ :param _CreatedTime: 创建时间。毫秒级时间戳 。
311
319
  :type CreatedTime: int
312
- :param _UpdateTime: 1713164969433
320
+ :param _UpdateTime: 更新时间。毫秒级时间戳 。
313
321
  :type UpdateTime: int
314
322
  """
315
323
  self._Id = None
@@ -331,7 +339,7 @@ class AuthorizationPolicyItem(AbstractModel):
331
339
 
332
340
  @property
333
341
  def Id(self):
334
- """规则ID
342
+ """策略规则ID
335
343
  :rtype: int
336
344
  """
337
345
  return self._Id
@@ -342,7 +350,7 @@ class AuthorizationPolicyItem(AbstractModel):
342
350
 
343
351
  @property
344
352
  def InstanceId(self):
345
- """集群ID
353
+ """MQTT集群ID
346
354
  :rtype: str
347
355
  """
348
356
  return self._InstanceId
@@ -353,7 +361,7 @@ class AuthorizationPolicyItem(AbstractModel):
353
361
 
354
362
  @property
355
363
  def PolicyName(self):
356
- """规则名
364
+ """策略规则名
357
365
  :rtype: str
358
366
  """
359
367
  return self._PolicyName
@@ -364,7 +372,7 @@ class AuthorizationPolicyItem(AbstractModel):
364
372
 
365
373
  @property
366
374
  def Version(self):
367
- """规则语法版本
375
+ """规则语法版本,当前仅支持1,默认为1
368
376
  :rtype: int
369
377
  """
370
378
  return self._Version
@@ -375,7 +383,7 @@ class AuthorizationPolicyItem(AbstractModel):
375
383
 
376
384
  @property
377
385
  def Priority(self):
378
- """越小越优先
386
+ """策略优先级,优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
379
387
  :rtype: int
380
388
  """
381
389
  return self._Priority
@@ -386,7 +394,10 @@ class AuthorizationPolicyItem(AbstractModel):
386
394
 
387
395
  @property
388
396
  def Effect(self):
389
- """allow/deny
397
+ """决策
398
+ allow:允许符合该策略的设备的访问请求。
399
+ deny:拒绝覆盖该策略的设备的访问请求。
400
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
390
401
  :rtype: str
391
402
  """
392
403
  return self._Effect
@@ -397,7 +408,11 @@ class AuthorizationPolicyItem(AbstractModel):
397
408
 
398
409
  @property
399
410
  def Actions(self):
400
- """connect、pub、sub
411
+ """操作
412
+ connect:连接
413
+ pub:发布mqtt消息
414
+ sub:订阅mqtt消息
415
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
401
416
  :rtype: str
402
417
  """
403
418
  return self._Actions
@@ -408,7 +423,7 @@ class AuthorizationPolicyItem(AbstractModel):
408
423
 
409
424
  @property
410
425
  def Resources(self):
411
- """资源
426
+ """资源,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
412
427
  :rtype: str
413
428
  """
414
429
  return self._Resources
@@ -419,7 +434,7 @@ class AuthorizationPolicyItem(AbstractModel):
419
434
 
420
435
  @property
421
436
  def ClientId(self):
422
- """client
437
+ """条件-连接设备ID,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
423
438
  :rtype: str
424
439
  """
425
440
  return self._ClientId
@@ -430,7 +445,7 @@ class AuthorizationPolicyItem(AbstractModel):
430
445
 
431
446
  @property
432
447
  def Username(self):
433
- """用户
448
+ """条件-用户名,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
434
449
  :rtype: str
435
450
  """
436
451
  return self._Username
@@ -441,7 +456,7 @@ class AuthorizationPolicyItem(AbstractModel):
441
456
 
442
457
  @property
443
458
  def Ip(self):
444
- """IP地址
459
+ """条件-客户端IP地址,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
445
460
  :rtype: str
446
461
  """
447
462
  return self._Ip
@@ -452,7 +467,7 @@ class AuthorizationPolicyItem(AbstractModel):
452
467
 
453
468
  @property
454
469
  def Qos(self):
455
- """0,1,2
470
+ """条件-服务质量,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
456
471
  :rtype: str
457
472
  """
458
473
  return self._Qos
@@ -463,7 +478,8 @@ class AuthorizationPolicyItem(AbstractModel):
463
478
 
464
479
  @property
465
480
  def Retain(self):
466
- """1:表示匹配retain消息
481
+ """条件-保留消息,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
482
+ 1:表示匹配retain消息
467
483
  2:表示匹配非retain消息
468
484
  3:表示匹配retain和非retain消息
469
485
  :rtype: int
@@ -476,7 +492,7 @@ class AuthorizationPolicyItem(AbstractModel):
476
492
 
477
493
  @property
478
494
  def Remark(self):
479
- """描述
495
+ """备注,长度不超过128个字符。
480
496
  :rtype: str
481
497
  """
482
498
  return self._Remark
@@ -487,7 +503,7 @@ class AuthorizationPolicyItem(AbstractModel):
487
503
 
488
504
  @property
489
505
  def CreatedTime(self):
490
- """1713164969433
506
+ """创建时间。毫秒级时间戳 。
491
507
  :rtype: int
492
508
  """
493
509
  return self._CreatedTime
@@ -498,7 +514,7 @@ class AuthorizationPolicyItem(AbstractModel):
498
514
 
499
515
  @property
500
516
  def UpdateTime(self):
501
- """1713164969433
517
+ """更新时间。毫秒级时间戳 。
502
518
  :rtype: int
503
519
  """
504
520
  return self._UpdateTime
@@ -542,7 +558,7 @@ class AuthorizationPolicyPriority(AbstractModel):
542
558
 
543
559
  def __init__(self):
544
560
  r"""
545
- :param _Id: 策略id
561
+ :param _Id: 授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
546
562
  :type Id: int
547
563
  :param _Priority: 优先级
548
564
  :type Priority: int
@@ -552,7 +568,7 @@ class AuthorizationPolicyPriority(AbstractModel):
552
568
 
553
569
  @property
554
570
  def Id(self):
555
- """策略id
571
+ """授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
556
572
  :rtype: int
557
573
  """
558
574
  return self._Id
@@ -644,31 +660,35 @@ class CaCertificateItem(AbstractModel):
644
660
 
645
661
  def __init__(self):
646
662
  r"""
647
- :param _CaCn: common name
663
+ :param _CaCn: 证书的公用名(Common Name)
648
664
  :type CaCn: str
649
665
  :param _CaCertificate: 证书内容
650
666
  :type CaCertificate: str
651
667
  :param _CaSn: 证书序列号
652
668
  :type CaSn: str
653
- :param _Format: 证书格式
669
+ :param _Format: 证书格式,当前仅支持 PEM 格式
654
670
  :type Format: str
655
671
  :param _VerificationCertificate: 验证证书内容
656
672
  :type VerificationCertificate: str
657
- :param _Status: ca状态
673
+ :param _Status: CA证书的状态
674
+ ACTIVE:激活
675
+ INACTIVE:未激活
676
+ REVOKED:吊销
677
+ PENDING_ACTIVATION:注册待激活
658
678
  :type Status: str
659
- :param _LastActivationTime: 上次激活时间
679
+ :param _LastActivationTime: 上次激活时间,毫秒级时间戳 。
660
680
  :type LastActivationTime: int
661
- :param _CreatedTime: 创建时间
681
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
662
682
  :type CreatedTime: int
663
- :param _UpdateTime: 预销毁时间
683
+ :param _UpdateTime: 更新时间,毫秒级时间戳 。
664
684
  :type UpdateTime: int
665
- :param _LastInactivationTime: 上次去激活时间
685
+ :param _LastInactivationTime: 上次去激活时间,毫秒级时间戳 。
666
686
  :type LastInactivationTime: int
667
687
  :param _CaIssuerCn: Ca证书颁发者CN
668
688
  :type CaIssuerCn: str
669
- :param _NotBeforeTime: 生效时间
689
+ :param _NotBeforeTime: 生效时间,毫秒级时间戳 。
670
690
  :type NotBeforeTime: int
671
- :param _NotAfterTime: 失效时间
691
+ :param _NotAfterTime: 失效时间,毫秒级时间戳 。
672
692
  :type NotAfterTime: int
673
693
  """
674
694
  self._CaCn = None
@@ -687,7 +707,7 @@ class CaCertificateItem(AbstractModel):
687
707
 
688
708
  @property
689
709
  def CaCn(self):
690
- """common name
710
+ """证书的公用名(Common Name)
691
711
  :rtype: str
692
712
  """
693
713
  return self._CaCn
@@ -720,7 +740,7 @@ class CaCertificateItem(AbstractModel):
720
740
 
721
741
  @property
722
742
  def Format(self):
723
- """证书格式
743
+ """证书格式,当前仅支持 PEM 格式
724
744
  :rtype: str
725
745
  """
726
746
  return self._Format
@@ -742,7 +762,11 @@ class CaCertificateItem(AbstractModel):
742
762
 
743
763
  @property
744
764
  def Status(self):
745
- """ca状态
765
+ """CA证书的状态
766
+ ACTIVE:激活
767
+ INACTIVE:未激活
768
+ REVOKED:吊销
769
+ PENDING_ACTIVATION:注册待激活
746
770
  :rtype: str
747
771
  """
748
772
  return self._Status
@@ -753,7 +777,7 @@ class CaCertificateItem(AbstractModel):
753
777
 
754
778
  @property
755
779
  def LastActivationTime(self):
756
- """上次激活时间
780
+ """上次激活时间,毫秒级时间戳 。
757
781
  :rtype: int
758
782
  """
759
783
  return self._LastActivationTime
@@ -764,7 +788,7 @@ class CaCertificateItem(AbstractModel):
764
788
 
765
789
  @property
766
790
  def CreatedTime(self):
767
- """创建时间
791
+ """创建时间,毫秒级时间戳 。
768
792
  :rtype: int
769
793
  """
770
794
  return self._CreatedTime
@@ -775,7 +799,7 @@ class CaCertificateItem(AbstractModel):
775
799
 
776
800
  @property
777
801
  def UpdateTime(self):
778
- """预销毁时间
802
+ """更新时间,毫秒级时间戳 。
779
803
  :rtype: int
780
804
  """
781
805
  return self._UpdateTime
@@ -786,7 +810,7 @@ class CaCertificateItem(AbstractModel):
786
810
 
787
811
  @property
788
812
  def LastInactivationTime(self):
789
- """上次去激活时间
813
+ """上次去激活时间,毫秒级时间戳 。
790
814
  :rtype: int
791
815
  """
792
816
  return self._LastInactivationTime
@@ -808,7 +832,7 @@ class CaCertificateItem(AbstractModel):
808
832
 
809
833
  @property
810
834
  def NotBeforeTime(self):
811
- """生效时间
835
+ """生效时间,毫秒级时间戳 。
812
836
  :rtype: int
813
837
  """
814
838
  return self._NotBeforeTime
@@ -819,7 +843,7 @@ class CaCertificateItem(AbstractModel):
819
843
 
820
844
  @property
821
845
  def NotAfterTime(self):
822
- """失效时间
846
+ """失效时间,毫秒级时间戳 。
823
847
  :rtype: int
824
848
  """
825
849
  return self._NotAfterTime
@@ -860,31 +884,42 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
860
884
 
861
885
  def __init__(self):
862
886
  r"""
863
- :param _InstanceId: 实例ID
887
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
864
888
  :type InstanceId: str
865
- :param _PolicyName: 策略名称
889
+ :param _PolicyName: 策略名称,不能为空,3-64个字符,支持中文、字母、数字、“-”及“_”。
866
890
  :type PolicyName: str
867
- :param _PolicyVersion: 策略版本
891
+ :param _PolicyVersion: 策略版本,默认为1,当前仅支持1
868
892
  :type PolicyVersion: int
869
- :param _Priority: 策略优先级,越小越优先
893
+ :param _Priority: 策略优先级,越小越优先,不能重复
870
894
  :type Priority: int
871
- :param _Effect: allow、deny
895
+ :param _Effect: 决策:
896
+ allow 允许
897
+ deny 拒绝
872
898
  :type Effect: str
873
- :param _Actions: connect、pub、sub
899
+ :param _Actions: 操作
900
+ connect:连接
901
+ pub:发布
902
+ sub:订阅
874
903
  :type Actions: str
875
- :param _Retain: 1,匹配保留消息;2,匹配非保留消息,3.匹配所有消息
904
+ :param _Retain: 条件-保留消息
905
+ 1,匹配保留消息;
906
+ 2,匹配非保留消息,
907
+ 3.匹配保留和非保留消息
876
908
  :type Retain: int
877
- :param _Qos: 0、1、2
909
+ :param _Qos: 条件:服务质量
910
+ 0:最多一次
911
+ 1:最少一次
912
+ 2:精确一次
878
913
  :type Qos: str
879
- :param _Resources: 资源
914
+ :param _Resources: 资源,需要匹配的订阅
880
915
  :type Resources: str
881
- :param _Username: 用户名
916
+ :param _Username: 条件-用户名
882
917
  :type Username: str
883
- :param _ClientId: 客户端
918
+ :param _ClientId: 条件:客户端ID,支持正则
884
919
  :type ClientId: str
885
- :param _Ip: IP地址
920
+ :param _Ip: 条件:客户端IP地址,支持IP或者CIDR
886
921
  :type Ip: str
887
- :param _Remark: 备注信息
922
+ :param _Remark: 备注信息,最长 128 字符
888
923
  :type Remark: str
889
924
  """
890
925
  self._InstanceId = None
@@ -903,7 +938,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
903
938
 
904
939
  @property
905
940
  def InstanceId(self):
906
- """实例ID
941
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
907
942
  :rtype: str
908
943
  """
909
944
  return self._InstanceId
@@ -914,7 +949,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
914
949
 
915
950
  @property
916
951
  def PolicyName(self):
917
- """策略名称
952
+ """策略名称,不能为空,3-64个字符,支持中文、字母、数字、“-”及“_”。
918
953
  :rtype: str
919
954
  """
920
955
  return self._PolicyName
@@ -925,7 +960,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
925
960
 
926
961
  @property
927
962
  def PolicyVersion(self):
928
- """策略版本
963
+ """策略版本,默认为1,当前仅支持1
929
964
  :rtype: int
930
965
  """
931
966
  return self._PolicyVersion
@@ -936,7 +971,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
936
971
 
937
972
  @property
938
973
  def Priority(self):
939
- """策略优先级,越小越优先
974
+ """策略优先级,越小越优先,不能重复
940
975
  :rtype: int
941
976
  """
942
977
  return self._Priority
@@ -947,7 +982,9 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
947
982
 
948
983
  @property
949
984
  def Effect(self):
950
- """allow、deny
985
+ """决策:
986
+ allow 允许
987
+ deny 拒绝
951
988
  :rtype: str
952
989
  """
953
990
  return self._Effect
@@ -958,7 +995,10 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
958
995
 
959
996
  @property
960
997
  def Actions(self):
961
- """connect、pub、sub
998
+ """操作
999
+ connect:连接
1000
+ pub:发布
1001
+ sub:订阅
962
1002
  :rtype: str
963
1003
  """
964
1004
  return self._Actions
@@ -969,7 +1009,10 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
969
1009
 
970
1010
  @property
971
1011
  def Retain(self):
972
- """1,匹配保留消息;2,匹配非保留消息,3.匹配所有消息
1012
+ """条件-保留消息
1013
+ 1,匹配保留消息;
1014
+ 2,匹配非保留消息,
1015
+ 3.匹配保留和非保留消息
973
1016
  :rtype: int
974
1017
  """
975
1018
  return self._Retain
@@ -980,7 +1023,10 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
980
1023
 
981
1024
  @property
982
1025
  def Qos(self):
983
- """0、1、2
1026
+ """条件:服务质量
1027
+ 0:最多一次
1028
+ 1:最少一次
1029
+ 2:精确一次
984
1030
  :rtype: str
985
1031
  """
986
1032
  return self._Qos
@@ -991,7 +1037,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
991
1037
 
992
1038
  @property
993
1039
  def Resources(self):
994
- """资源
1040
+ """资源,需要匹配的订阅
995
1041
  :rtype: str
996
1042
  """
997
1043
  return self._Resources
@@ -1002,7 +1048,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
1002
1048
 
1003
1049
  @property
1004
1050
  def Username(self):
1005
- """用户名
1051
+ """条件-用户名
1006
1052
  :rtype: str
1007
1053
  """
1008
1054
  return self._Username
@@ -1013,7 +1059,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
1013
1059
 
1014
1060
  @property
1015
1061
  def ClientId(self):
1016
- """客户端
1062
+ """条件:客户端ID,支持正则
1017
1063
  :rtype: str
1018
1064
  """
1019
1065
  return self._ClientId
@@ -1024,7 +1070,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
1024
1070
 
1025
1071
  @property
1026
1072
  def Ip(self):
1027
- """IP地址
1073
+ """条件:客户端IP地址,支持IP或者CIDR
1028
1074
  :rtype: str
1029
1075
  """
1030
1076
  return self._Ip
@@ -1035,7 +1081,7 @@ class CreateAuthorizationPolicyRequest(AbstractModel):
1035
1081
 
1036
1082
  @property
1037
1083
  def Remark(self):
1038
- """备注信息
1084
+ """备注信息,最长 128 字符
1039
1085
  :rtype: str
1040
1086
  """
1041
1087
  return self._Remark
@@ -1076,11 +1122,39 @@ class CreateAuthorizationPolicyResponse(AbstractModel):
1076
1122
 
1077
1123
  def __init__(self):
1078
1124
  r"""
1125
+ :param _InstanceId: 集群Id
1126
+ :type InstanceId: str
1127
+ :param _Id: 策略id
1128
+ :type Id: int
1079
1129
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1080
1130
  :type RequestId: str
1081
1131
  """
1132
+ self._InstanceId = None
1133
+ self._Id = None
1082
1134
  self._RequestId = None
1083
1135
 
1136
+ @property
1137
+ def InstanceId(self):
1138
+ """集群Id
1139
+ :rtype: str
1140
+ """
1141
+ return self._InstanceId
1142
+
1143
+ @InstanceId.setter
1144
+ def InstanceId(self, InstanceId):
1145
+ self._InstanceId = InstanceId
1146
+
1147
+ @property
1148
+ def Id(self):
1149
+ """策略id
1150
+ :rtype: int
1151
+ """
1152
+ return self._Id
1153
+
1154
+ @Id.setter
1155
+ def Id(self, Id):
1156
+ self._Id = Id
1157
+
1084
1158
  @property
1085
1159
  def RequestId(self):
1086
1160
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -1094,6 +1168,8 @@ class CreateAuthorizationPolicyResponse(AbstractModel):
1094
1168
 
1095
1169
 
1096
1170
  def _deserialize(self, params):
1171
+ self._InstanceId = params.get("InstanceId")
1172
+ self._Id = params.get("Id")
1097
1173
  self._RequestId = params.get("RequestId")
1098
1174
 
1099
1175
 
@@ -1987,11 +2063,11 @@ class CreateTopicRequest(AbstractModel):
1987
2063
 
1988
2064
  def __init__(self):
1989
2065
  r"""
1990
- :param _InstanceId: 实例ID
2066
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1991
2067
  :type InstanceId: str
1992
- :param _Topic: 主题
2068
+ :param _Topic: 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
1993
2069
  :type Topic: str
1994
- :param _Remark: 备注
2070
+ :param _Remark: 备注,最长 128 字符
1995
2071
  :type Remark: str
1996
2072
  """
1997
2073
  self._InstanceId = None
@@ -2000,7 +2076,7 @@ class CreateTopicRequest(AbstractModel):
2000
2076
 
2001
2077
  @property
2002
2078
  def InstanceId(self):
2003
- """实例ID
2079
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2004
2080
  :rtype: str
2005
2081
  """
2006
2082
  return self._InstanceId
@@ -2011,7 +2087,7 @@ class CreateTopicRequest(AbstractModel):
2011
2087
 
2012
2088
  @property
2013
2089
  def Topic(self):
2014
- """主题
2090
+ """主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
2015
2091
  :rtype: str
2016
2092
  """
2017
2093
  return self._Topic
@@ -2022,7 +2098,7 @@ class CreateTopicRequest(AbstractModel):
2022
2098
 
2023
2099
  @property
2024
2100
  def Remark(self):
2025
- """备注
2101
+ """备注,最长 128 字符
2026
2102
  :rtype: str
2027
2103
  """
2028
2104
  return self._Remark
@@ -2111,13 +2187,13 @@ class CreateUserRequest(AbstractModel):
2111
2187
 
2112
2188
  def __init__(self):
2113
2189
  r"""
2114
- :param _InstanceId: 实例ID
2190
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2115
2191
  :type InstanceId: str
2116
- :param _Username: 用户名
2192
+ :param _Username: 用户名,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 32 个字符
2117
2193
  :type Username: str
2118
- :param _Password: 密码,该字段为空时候则后端会默认生成
2194
+ :param _Password: 密码,该字段为空时候则后端会默认生成。用户自定义密码时,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 64 个字符。
2119
2195
  :type Password: str
2120
- :param _Remark: 备注
2196
+ :param _Remark: 备注,长度不超过128个字符。
2121
2197
  :type Remark: str
2122
2198
  """
2123
2199
  self._InstanceId = None
@@ -2127,7 +2203,7 @@ class CreateUserRequest(AbstractModel):
2127
2203
 
2128
2204
  @property
2129
2205
  def InstanceId(self):
2130
- """实例ID
2206
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2131
2207
  :rtype: str
2132
2208
  """
2133
2209
  return self._InstanceId
@@ -2138,7 +2214,7 @@ class CreateUserRequest(AbstractModel):
2138
2214
 
2139
2215
  @property
2140
2216
  def Username(self):
2141
- """用户名
2217
+ """用户名,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 32 个字符
2142
2218
  :rtype: str
2143
2219
  """
2144
2220
  return self._Username
@@ -2149,7 +2225,7 @@ class CreateUserRequest(AbstractModel):
2149
2225
 
2150
2226
  @property
2151
2227
  def Password(self):
2152
- """密码,该字段为空时候则后端会默认生成
2228
+ """密码,该字段为空时候则后端会默认生成。用户自定义密码时,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 64 个字符。
2153
2229
  :rtype: str
2154
2230
  """
2155
2231
  return self._Password
@@ -2160,7 +2236,7 @@ class CreateUserRequest(AbstractModel):
2160
2236
 
2161
2237
  @property
2162
2238
  def Remark(self):
2163
- """备注
2239
+ """备注,长度不超过128个字符。
2164
2240
  :rtype: str
2165
2241
  """
2166
2242
  return self._Remark
@@ -2220,9 +2296,9 @@ class DeactivateCaCertificateRequest(AbstractModel):
2220
2296
 
2221
2297
  def __init__(self):
2222
2298
  r"""
2223
- :param _InstanceId: 集群id
2299
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2224
2300
  :type InstanceId: str
2225
- :param _CaSn: 证书序列号
2301
+ :param _CaSn: 证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2226
2302
  :type CaSn: str
2227
2303
  """
2228
2304
  self._InstanceId = None
@@ -2230,7 +2306,7 @@ class DeactivateCaCertificateRequest(AbstractModel):
2230
2306
 
2231
2307
  @property
2232
2308
  def InstanceId(self):
2233
- """集群id
2309
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2234
2310
  :rtype: str
2235
2311
  """
2236
2312
  return self._InstanceId
@@ -2241,7 +2317,7 @@ class DeactivateCaCertificateRequest(AbstractModel):
2241
2317
 
2242
2318
  @property
2243
2319
  def CaSn(self):
2244
- """证书序列号
2320
+ """证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2245
2321
  :rtype: str
2246
2322
  """
2247
2323
  return self._CaSn
@@ -2299,9 +2375,9 @@ class DeactivateDeviceCertificateRequest(AbstractModel):
2299
2375
 
2300
2376
  def __init__(self):
2301
2377
  r"""
2302
- :param _InstanceId: 集群id
2378
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2303
2379
  :type InstanceId: str
2304
- :param _DeviceCertificateSn: 设备证书序列号
2380
+ :param _DeviceCertificateSn: 设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。
2305
2381
  :type DeviceCertificateSn: str
2306
2382
  """
2307
2383
  self._InstanceId = None
@@ -2309,7 +2385,7 @@ class DeactivateDeviceCertificateRequest(AbstractModel):
2309
2385
 
2310
2386
  @property
2311
2387
  def InstanceId(self):
2312
- """集群id
2388
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2313
2389
  :rtype: str
2314
2390
  """
2315
2391
  return self._InstanceId
@@ -2320,7 +2396,7 @@ class DeactivateDeviceCertificateRequest(AbstractModel):
2320
2396
 
2321
2397
  @property
2322
2398
  def DeviceCertificateSn(self):
2323
- """设备证书序列号
2399
+ """设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。
2324
2400
  :rtype: str
2325
2401
  """
2326
2402
  return self._DeviceCertificateSn
@@ -2378,12 +2454,12 @@ class DeleteAuthenticatorRequest(AbstractModel):
2378
2454
 
2379
2455
  def __init__(self):
2380
2456
  r"""
2381
- :param _InstanceId: 实例ID
2457
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2382
2458
  :type InstanceId: str
2383
2459
  :param _Type: 认证器类型:
2384
2460
  JWT:JWT认证器
2385
2461
  JWKS:JWKS认证器
2386
- BYOC:一端一证认证器
2462
+ HTTP:HTTP认证器
2387
2463
  :type Type: str
2388
2464
  """
2389
2465
  self._InstanceId = None
@@ -2391,7 +2467,7 @@ BYOC:一端一证认证器
2391
2467
 
2392
2468
  @property
2393
2469
  def InstanceId(self):
2394
- """实例ID
2470
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2395
2471
  :rtype: str
2396
2472
  """
2397
2473
  return self._InstanceId
@@ -2405,7 +2481,7 @@ BYOC:一端一证认证器
2405
2481
  """认证器类型:
2406
2482
  JWT:JWT认证器
2407
2483
  JWKS:JWKS认证器
2408
- BYOC:一端一证认证器
2484
+ HTTP:HTTP认证器
2409
2485
  :rtype: str
2410
2486
  """
2411
2487
  return self._Type
@@ -2463,9 +2539,9 @@ class DeleteAuthorizationPolicyRequest(AbstractModel):
2463
2539
 
2464
2540
  def __init__(self):
2465
2541
  r"""
2466
- :param _InstanceId: 实例ID
2542
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2467
2543
  :type InstanceId: str
2468
- :param _Id: 策略规则id
2544
+ :param _Id: 授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
2469
2545
  :type Id: int
2470
2546
  """
2471
2547
  self._InstanceId = None
@@ -2473,7 +2549,7 @@ class DeleteAuthorizationPolicyRequest(AbstractModel):
2473
2549
 
2474
2550
  @property
2475
2551
  def InstanceId(self):
2476
- """实例ID
2552
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2477
2553
  :rtype: str
2478
2554
  """
2479
2555
  return self._InstanceId
@@ -2484,7 +2560,7 @@ class DeleteAuthorizationPolicyRequest(AbstractModel):
2484
2560
 
2485
2561
  @property
2486
2562
  def Id(self):
2487
- """策略规则id
2563
+ """授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
2488
2564
  :rtype: int
2489
2565
  """
2490
2566
  return self._Id
@@ -2542,9 +2618,9 @@ class DeleteCaCertificateRequest(AbstractModel):
2542
2618
 
2543
2619
  def __init__(self):
2544
2620
  r"""
2545
- :param _InstanceId: 集群id
2621
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2546
2622
  :type InstanceId: str
2547
- :param _CaSn: 证书序列号
2623
+ :param _CaSn: CA证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2548
2624
  :type CaSn: str
2549
2625
  """
2550
2626
  self._InstanceId = None
@@ -2552,7 +2628,7 @@ class DeleteCaCertificateRequest(AbstractModel):
2552
2628
 
2553
2629
  @property
2554
2630
  def InstanceId(self):
2555
- """集群id
2631
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2556
2632
  :rtype: str
2557
2633
  """
2558
2634
  return self._InstanceId
@@ -2563,7 +2639,7 @@ class DeleteCaCertificateRequest(AbstractModel):
2563
2639
 
2564
2640
  @property
2565
2641
  def CaSn(self):
2566
- """证书序列号
2642
+ """CA证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2567
2643
  :rtype: str
2568
2644
  """
2569
2645
  return self._CaSn
@@ -2700,14 +2776,14 @@ class DeleteInsPublicEndpointRequest(AbstractModel):
2700
2776
 
2701
2777
  def __init__(self):
2702
2778
  r"""
2703
- :param _InstanceId: 实例ID
2779
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2704
2780
  :type InstanceId: str
2705
2781
  """
2706
2782
  self._InstanceId = None
2707
2783
 
2708
2784
  @property
2709
2785
  def InstanceId(self):
2710
- """实例ID
2786
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2711
2787
  :rtype: str
2712
2788
  """
2713
2789
  return self._InstanceId
@@ -2764,14 +2840,14 @@ class DeleteInstanceRequest(AbstractModel):
2764
2840
 
2765
2841
  def __init__(self):
2766
2842
  r"""
2767
- :param _InstanceId: 实例ID
2843
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2768
2844
  :type InstanceId: str
2769
2845
  """
2770
2846
  self._InstanceId = None
2771
2847
 
2772
2848
  @property
2773
2849
  def InstanceId(self):
2774
- """实例ID
2850
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2775
2851
  :rtype: str
2776
2852
  """
2777
2853
  return self._InstanceId
@@ -2986,9 +3062,12 @@ class DescribeAuthenticatorRequest(AbstractModel):
2986
3062
 
2987
3063
  def __init__(self):
2988
3064
  r"""
2989
- :param _InstanceId: 实例ID
3065
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2990
3066
  :type InstanceId: str
2991
- :param _Type: 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
3067
+ :param _Type: 认证器类型:
3068
+ JWT:JWT认证器
3069
+ JWKS:JWKS认证器
3070
+ HTTP:HTTP认证器
2992
3071
  :type Type: str
2993
3072
  """
2994
3073
  self._InstanceId = None
@@ -2996,7 +3075,7 @@ class DescribeAuthenticatorRequest(AbstractModel):
2996
3075
 
2997
3076
  @property
2998
3077
  def InstanceId(self):
2999
- """实例ID
3078
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3000
3079
  :rtype: str
3001
3080
  """
3002
3081
  return self._InstanceId
@@ -3007,7 +3086,10 @@ class DescribeAuthenticatorRequest(AbstractModel):
3007
3086
 
3008
3087
  @property
3009
3088
  def Type(self):
3010
- """认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
3089
+ """认证器类型:
3090
+ JWT:JWT认证器
3091
+ JWKS:JWKS认证器
3092
+ HTTP:HTTP认证器
3011
3093
  :rtype: str
3012
3094
  """
3013
3095
  return self._Type
@@ -3085,14 +3167,14 @@ class DescribeAuthorizationPoliciesRequest(AbstractModel):
3085
3167
 
3086
3168
  def __init__(self):
3087
3169
  r"""
3088
- :param _InstanceId: 集群ID
3170
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3089
3171
  :type InstanceId: str
3090
3172
  """
3091
3173
  self._InstanceId = None
3092
3174
 
3093
3175
  @property
3094
3176
  def InstanceId(self):
3095
- """集群ID
3177
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3096
3178
  :rtype: str
3097
3179
  """
3098
3180
  return self._InstanceId
@@ -3169,9 +3251,9 @@ class DescribeCaCertificateRequest(AbstractModel):
3169
3251
 
3170
3252
  def __init__(self):
3171
3253
  r"""
3172
- :param _CaSn: ca证书sn
3254
+ :param _CaSn: CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
3173
3255
  :type CaSn: str
3174
- :param _InstanceId: 集群id
3256
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3175
3257
  :type InstanceId: str
3176
3258
  """
3177
3259
  self._CaSn = None
@@ -3179,7 +3261,7 @@ class DescribeCaCertificateRequest(AbstractModel):
3179
3261
 
3180
3262
  @property
3181
3263
  def CaSn(self):
3182
- """ca证书sn
3264
+ """CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
3183
3265
  :rtype: str
3184
3266
  """
3185
3267
  return self._CaSn
@@ -3190,7 +3272,7 @@ class DescribeCaCertificateRequest(AbstractModel):
3190
3272
 
3191
3273
  @property
3192
3274
  def InstanceId(self):
3193
- """集群id
3275
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3194
3276
  :rtype: str
3195
3277
  """
3196
3278
  return self._InstanceId
@@ -3220,29 +3302,32 @@ class DescribeCaCertificateResponse(AbstractModel):
3220
3302
 
3221
3303
  def __init__(self):
3222
3304
  r"""
3223
- :param _CreatedTime: 创建时间
3305
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
3224
3306
  :type CreatedTime: int
3225
- :param _UpdateTime: 上次更新时间
3307
+ :param _UpdateTime: 上次更新时间,毫秒级时间戳 。
3226
3308
  :type UpdateTime: int
3227
- :param _NotAfterTime: 失效日期
3309
+ :param _NotAfterTime: 失效日期,毫秒级时间戳 。
3228
3310
  :type NotAfterTime: int
3229
- :param _LastActivationTime: 上次激活时间
3311
+ :param _LastActivationTime: 上次激活时间,毫秒级时间戳 。
3230
3312
  :type LastActivationTime: int
3231
- :param _LastInactivationTime: 上次吊销时间
3313
+ :param _LastInactivationTime: 上次吊销时间,毫秒级时间戳 。
3232
3314
  :type LastInactivationTime: int
3233
- :param _Status: 证书状态
3315
+ :param _Status: CA证书状态
3316
+ ACTIVE:激活
3317
+ INACTIVE:未激活
3318
+
3234
3319
  :type Status: str
3235
3320
  :param _CaSn: 证书序列号
3236
3321
  :type CaSn: str
3237
- :param _CaCn: common name
3322
+ :param _CaCn: 证书的CN(Common Name),证书中用于标识主体的名称,通常是域名或组织名称
3238
3323
  :type CaCn: str
3239
3324
  :param _CaCertificate: 证书内容
3240
3325
  :type CaCertificate: str
3241
- :param _Format: 证书格式
3326
+ :param _Format: 证书格式,当仅支持PEM格式
3242
3327
  :type Format: str
3243
3328
  :param _CaIssuerCn: Ca证书颁发者CN
3244
3329
  :type CaIssuerCn: str
3245
- :param _NotBeforeTime: 生效开始时间
3330
+ :param _NotBeforeTime: 生效开始时间,毫秒级时间戳 。
3246
3331
  :type NotBeforeTime: int
3247
3332
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3248
3333
  :type RequestId: str
@@ -3263,7 +3348,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3263
3348
 
3264
3349
  @property
3265
3350
  def CreatedTime(self):
3266
- """创建时间
3351
+ """创建时间,毫秒级时间戳 。
3267
3352
  :rtype: int
3268
3353
  """
3269
3354
  return self._CreatedTime
@@ -3274,7 +3359,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3274
3359
 
3275
3360
  @property
3276
3361
  def UpdateTime(self):
3277
- """上次更新时间
3362
+ """上次更新时间,毫秒级时间戳 。
3278
3363
  :rtype: int
3279
3364
  """
3280
3365
  return self._UpdateTime
@@ -3285,7 +3370,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3285
3370
 
3286
3371
  @property
3287
3372
  def NotAfterTime(self):
3288
- """失效日期
3373
+ """失效日期,毫秒级时间戳 。
3289
3374
  :rtype: int
3290
3375
  """
3291
3376
  return self._NotAfterTime
@@ -3296,7 +3381,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3296
3381
 
3297
3382
  @property
3298
3383
  def LastActivationTime(self):
3299
- """上次激活时间
3384
+ """上次激活时间,毫秒级时间戳 。
3300
3385
  :rtype: int
3301
3386
  """
3302
3387
  return self._LastActivationTime
@@ -3307,7 +3392,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3307
3392
 
3308
3393
  @property
3309
3394
  def LastInactivationTime(self):
3310
- """上次吊销时间
3395
+ """上次吊销时间,毫秒级时间戳 。
3311
3396
  :rtype: int
3312
3397
  """
3313
3398
  return self._LastInactivationTime
@@ -3318,7 +3403,10 @@ class DescribeCaCertificateResponse(AbstractModel):
3318
3403
 
3319
3404
  @property
3320
3405
  def Status(self):
3321
- """证书状态
3406
+ """CA证书状态
3407
+ ACTIVE:激活
3408
+ INACTIVE:未激活
3409
+
3322
3410
  :rtype: str
3323
3411
  """
3324
3412
  return self._Status
@@ -3340,7 +3428,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3340
3428
 
3341
3429
  @property
3342
3430
  def CaCn(self):
3343
- """common name
3431
+ """证书的CN(Common Name),证书中用于标识主体的名称,通常是域名或组织名称
3344
3432
  :rtype: str
3345
3433
  """
3346
3434
  return self._CaCn
@@ -3362,7 +3450,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3362
3450
 
3363
3451
  @property
3364
3452
  def Format(self):
3365
- """证书格式
3453
+ """证书格式,当仅支持PEM格式
3366
3454
  :rtype: str
3367
3455
  """
3368
3456
  return self._Format
@@ -3384,7 +3472,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3384
3472
 
3385
3473
  @property
3386
3474
  def NotBeforeTime(self):
3387
- """生效开始时间
3475
+ """生效开始时间,毫秒级时间戳 。
3388
3476
  :rtype: int
3389
3477
  """
3390
3478
  return self._NotBeforeTime
@@ -3428,14 +3516,14 @@ class DescribeCaCertificatesRequest(AbstractModel):
3428
3516
 
3429
3517
  def __init__(self):
3430
3518
  r"""
3431
- :param _InstanceId: 集群ID
3519
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3432
3520
  :type InstanceId: str
3433
3521
  """
3434
3522
  self._InstanceId = None
3435
3523
 
3436
3524
  @property
3437
3525
  def InstanceId(self):
3438
- """集群ID
3526
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3439
3527
  :rtype: str
3440
3528
  """
3441
3529
  return self._InstanceId
@@ -3512,9 +3600,9 @@ class DescribeClientListRequest(AbstractModel):
3512
3600
 
3513
3601
  def __init__(self):
3514
3602
  r"""
3515
- :param _InstanceId: 实例ID
3603
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3516
3604
  :type InstanceId: str
3517
- :param _ClientId: 客户端名
3605
+ :param _ClientId: 客户端ID
3518
3606
  :type ClientId: str
3519
3607
  :param _Number: 客户端数量限制,最大1024,默认1024
3520
3608
  :type Number: str
@@ -3525,7 +3613,7 @@ class DescribeClientListRequest(AbstractModel):
3525
3613
 
3526
3614
  @property
3527
3615
  def InstanceId(self):
3528
- """实例ID
3616
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3529
3617
  :rtype: str
3530
3618
  """
3531
3619
  return self._InstanceId
@@ -3536,7 +3624,7 @@ class DescribeClientListRequest(AbstractModel):
3536
3624
 
3537
3625
  @property
3538
3626
  def ClientId(self):
3539
- """客户端名
3627
+ """客户端ID
3540
3628
  :rtype: str
3541
3629
  """
3542
3630
  return self._ClientId
@@ -3626,9 +3714,9 @@ class DescribeDeviceCertificateRequest(AbstractModel):
3626
3714
 
3627
3715
  def __init__(self):
3628
3716
  r"""
3629
- :param _DeviceCertificateSn: 设备证书sn
3717
+ :param _DeviceCertificateSn: 设备证书的SN序列号,用于唯一标识一个设备证书。
3630
3718
  :type DeviceCertificateSn: str
3631
- :param _InstanceId: 集群id
3719
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3632
3720
  :type InstanceId: str
3633
3721
  """
3634
3722
  self._DeviceCertificateSn = None
@@ -3636,7 +3724,7 @@ class DescribeDeviceCertificateRequest(AbstractModel):
3636
3724
 
3637
3725
  @property
3638
3726
  def DeviceCertificateSn(self):
3639
- """设备证书sn
3727
+ """设备证书的SN序列号,用于唯一标识一个设备证书。
3640
3728
  :rtype: str
3641
3729
  """
3642
3730
  return self._DeviceCertificateSn
@@ -3647,7 +3735,7 @@ class DescribeDeviceCertificateRequest(AbstractModel):
3647
3735
 
3648
3736
  @property
3649
3737
  def InstanceId(self):
3650
- """集群id
3738
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3651
3739
  :rtype: str
3652
3740
  """
3653
3741
  return self._InstanceId
@@ -3677,17 +3765,21 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3677
3765
 
3678
3766
  def __init__(self):
3679
3767
  r"""
3680
- :param _CreatedTime: 创建时间
3768
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
3681
3769
  :type CreatedTime: int
3682
- :param _UpdateTime: 上次更新时间
3770
+ :param _UpdateTime: 上次更新时间,毫秒级时间戳 。
3683
3771
  :type UpdateTime: int
3684
- :param _NotAfterTime: 证书失效日期
3772
+ :param _NotAfterTime: 证书失效日期,毫秒级时间戳 。
3685
3773
  :type NotAfterTime: int
3686
- :param _LastActivationTime: 上次激活时间
3774
+ :param _LastActivationTime: 上次激活时间,毫秒级时间戳 。
3687
3775
  :type LastActivationTime: int
3688
- :param _LastInactivationTime: 上次取消激活时间
3776
+ :param _LastInactivationTime: 上次取消激活时间,毫秒级时间戳 。
3689
3777
  :type LastInactivationTime: int
3690
- :param _Status: 证书状态
3778
+ :param _Status: 设备证书的状态
3779
+ ACTIVE:激活
3780
+ INACTIVE:未激活
3781
+ REVOKED:吊销
3782
+ PENDING_ACTIVATION:注册待激活
3691
3783
  :type Status: str
3692
3784
  :param _CaSn: Ca证书序列号
3693
3785
  :type CaSn: str
@@ -3697,14 +3789,15 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3697
3789
  :type DeviceCertificate: str
3698
3790
  :param _DeviceCertificateCn: 设备证书common name
3699
3791
  :type DeviceCertificateCn: str
3700
- :param _Format: 证书格式
3792
+ :param _Format: 证书格式,当前仅支持PEM格式
3701
3793
  :type Format: str
3702
3794
  :param _ClientId: 客户端id
3703
3795
  :type ClientId: str
3704
- :param _CertificateSource: API, 手动注册
3705
- JITP 自动注册
3796
+ :param _CertificateSource: 证书来源
3797
+ API:手动注册
3798
+ JITP:自动注册
3706
3799
  :type CertificateSource: str
3707
- :param _NotBeforeTime: 证书生效开始时间
3800
+ :param _NotBeforeTime: 证书生效开始时间,毫秒级时间戳 。
3708
3801
  :type NotBeforeTime: int
3709
3802
  :param _OrganizationalUnit: 组织单位
3710
3803
  :type OrganizationalUnit: str
@@ -3730,7 +3823,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3730
3823
 
3731
3824
  @property
3732
3825
  def CreatedTime(self):
3733
- """创建时间
3826
+ """创建时间,毫秒级时间戳 。
3734
3827
  :rtype: int
3735
3828
  """
3736
3829
  return self._CreatedTime
@@ -3741,7 +3834,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3741
3834
 
3742
3835
  @property
3743
3836
  def UpdateTime(self):
3744
- """上次更新时间
3837
+ """上次更新时间,毫秒级时间戳 。
3745
3838
  :rtype: int
3746
3839
  """
3747
3840
  return self._UpdateTime
@@ -3752,7 +3845,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3752
3845
 
3753
3846
  @property
3754
3847
  def NotAfterTime(self):
3755
- """证书失效日期
3848
+ """证书失效日期,毫秒级时间戳 。
3756
3849
  :rtype: int
3757
3850
  """
3758
3851
  return self._NotAfterTime
@@ -3763,7 +3856,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3763
3856
 
3764
3857
  @property
3765
3858
  def LastActivationTime(self):
3766
- """上次激活时间
3859
+ """上次激活时间,毫秒级时间戳 。
3767
3860
  :rtype: int
3768
3861
  """
3769
3862
  return self._LastActivationTime
@@ -3774,7 +3867,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3774
3867
 
3775
3868
  @property
3776
3869
  def LastInactivationTime(self):
3777
- """上次取消激活时间
3870
+ """上次取消激活时间,毫秒级时间戳 。
3778
3871
  :rtype: int
3779
3872
  """
3780
3873
  return self._LastInactivationTime
@@ -3785,7 +3878,11 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3785
3878
 
3786
3879
  @property
3787
3880
  def Status(self):
3788
- """证书状态
3881
+ """设备证书的状态
3882
+ ACTIVE:激活
3883
+ INACTIVE:未激活
3884
+ REVOKED:吊销
3885
+ PENDING_ACTIVATION:注册待激活
3789
3886
  :rtype: str
3790
3887
  """
3791
3888
  return self._Status
@@ -3840,7 +3937,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3840
3937
 
3841
3938
  @property
3842
3939
  def Format(self):
3843
- """证书格式
3940
+ """证书格式,当前仅支持PEM格式
3844
3941
  :rtype: str
3845
3942
  """
3846
3943
  return self._Format
@@ -3862,8 +3959,9 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3862
3959
 
3863
3960
  @property
3864
3961
  def CertificateSource(self):
3865
- """ API, 手动注册
3866
- JITP 自动注册
3962
+ """证书来源
3963
+ API:手动注册
3964
+ JITP:自动注册
3867
3965
  :rtype: str
3868
3966
  """
3869
3967
  return self._CertificateSource
@@ -3874,7 +3972,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3874
3972
 
3875
3973
  @property
3876
3974
  def NotBeforeTime(self):
3877
- """证书生效开始时间
3975
+ """证书生效开始时间,毫秒级时间戳 。
3878
3976
  :rtype: int
3879
3977
  """
3880
3978
  return self._NotBeforeTime
@@ -3932,15 +4030,25 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3932
4030
 
3933
4031
  def __init__(self):
3934
4032
  r"""
3935
- :param _InstanceId: 集群ID
4033
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3936
4034
  :type InstanceId: str
3937
- :param _Filters: 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
4035
+ :param _Filters: 支持搜索参数
4036
+ ClientId:客户端id,根据实际业务使用获取
4037
+ CaSn:所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
4038
+ DeviceCertificateSn:设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
4039
+ DeviceCertificateCn:设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
4040
+ OrganizationalUnit:证书OU
4041
+ NotAfterEnd:过期时间小于等于指定时间的证书
4042
+ NotAfterStart:过期时间大于等于指定时间的证书
4043
+ Status:设备证书状态 ACTIVE(激活); INACTIVE(未激活)REVOKED(吊销);PENDING_ACTIVATION(注册待激活)
4044
+
3938
4045
  :type Filters: list of Filter
3939
- :param _Limit: 分页limit
4046
+ :param _Limit: 分页limit,默认20,最大100
3940
4047
  :type Limit: int
3941
- :param _Offset: 分页偏移量
4048
+ :param _Offset: 分页偏移量,默认0
3942
4049
  :type Offset: int
3943
- :param _OrderBy: CREATE_TIME_DESC, 创建时间降序
4050
+ :param _OrderBy: 排序规则
4051
+ CREATE_TIME_DESC, 创建时间降序
3944
4052
  CREATE_TIME_ASC,创建时间升序
3945
4053
  UPDATE_TIME_DESC,更新时间降序
3946
4054
  UPDATE_TIME_ASC,更新时间升序
@@ -3954,7 +4062,7 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3954
4062
 
3955
4063
  @property
3956
4064
  def InstanceId(self):
3957
- """集群ID
4065
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3958
4066
  :rtype: str
3959
4067
  """
3960
4068
  return self._InstanceId
@@ -3965,7 +4073,16 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3965
4073
 
3966
4074
  @property
3967
4075
  def Filters(self):
3968
- """过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
4076
+ """支持搜索参数
4077
+ ClientId:客户端id,根据实际业务使用获取
4078
+ CaSn:所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
4079
+ DeviceCertificateSn:设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
4080
+ DeviceCertificateCn:设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
4081
+ OrganizationalUnit:证书OU
4082
+ NotAfterEnd:过期时间小于等于指定时间的证书
4083
+ NotAfterStart:过期时间大于等于指定时间的证书
4084
+ Status:设备证书状态 ACTIVE(激活); INACTIVE(未激活)REVOKED(吊销);PENDING_ACTIVATION(注册待激活)
4085
+
3969
4086
  :rtype: list of Filter
3970
4087
  """
3971
4088
  return self._Filters
@@ -3976,7 +4093,7 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3976
4093
 
3977
4094
  @property
3978
4095
  def Limit(self):
3979
- """分页limit
4096
+ """分页limit,默认20,最大100
3980
4097
  :rtype: int
3981
4098
  """
3982
4099
  return self._Limit
@@ -3987,7 +4104,7 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3987
4104
 
3988
4105
  @property
3989
4106
  def Offset(self):
3990
- """分页偏移量
4107
+ """分页偏移量,默认0
3991
4108
  :rtype: int
3992
4109
  """
3993
4110
  return self._Offset
@@ -3998,7 +4115,8 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3998
4115
 
3999
4116
  @property
4000
4117
  def OrderBy(self):
4001
- """CREATE_TIME_DESC, 创建时间降序
4118
+ """排序规则
4119
+ CREATE_TIME_DESC, 创建时间降序
4002
4120
  CREATE_TIME_ASC,创建时间升序
4003
4121
  UPDATE_TIME_DESC,更新时间降序
4004
4122
  UPDATE_TIME_ASC,更新时间升序
@@ -4041,7 +4159,7 @@ class DescribeDeviceCertificatesResponse(AbstractModel):
4041
4159
  r"""
4042
4160
  :param _TotalCount: 总数
4043
4161
  :type TotalCount: int
4044
- :param _Data: 设备证书
4162
+ :param _Data: 设备证书列表
4045
4163
  :type Data: list of DeviceCertificateItem
4046
4164
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4047
4165
  :type RequestId: str
@@ -4063,7 +4181,7 @@ class DescribeDeviceCertificatesResponse(AbstractModel):
4063
4181
 
4064
4182
  @property
4065
4183
  def Data(self):
4066
- """设备证书
4184
+ """设备证书列表
4067
4185
  :rtype: list of DeviceCertificateItem
4068
4186
  """
4069
4187
  return self._Data
@@ -4102,14 +4220,14 @@ class DescribeInsPublicEndpointsRequest(AbstractModel):
4102
4220
 
4103
4221
  def __init__(self):
4104
4222
  r"""
4105
- :param _InstanceId: 实例ID
4223
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4106
4224
  :type InstanceId: str
4107
4225
  """
4108
4226
  self._InstanceId = None
4109
4227
 
4110
4228
  @property
4111
4229
  def InstanceId(self):
4112
- """实例ID
4230
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4113
4231
  :rtype: str
4114
4232
  """
4115
4233
  return self._InstanceId
@@ -4142,7 +4260,7 @@ class DescribeInsPublicEndpointsResponse(AbstractModel):
4142
4260
  :type Endpoints: list of MQTTEndpointItem
4143
4261
  :param _InstanceId: 实例id
4144
4262
  :type InstanceId: str
4145
- :param _Bandwidth: 带宽
4263
+ :param _Bandwidth: 带宽,单位Mbps
4146
4264
  :type Bandwidth: int
4147
4265
  :param _Rules: 公网访问规则
4148
4266
  :type Rules: list of PublicAccessRule
@@ -4187,7 +4305,7 @@ class DescribeInsPublicEndpointsResponse(AbstractModel):
4187
4305
 
4188
4306
  @property
4189
4307
  def Bandwidth(self):
4190
- """带宽
4308
+ """带宽,单位Mbps
4191
4309
  :rtype: int
4192
4310
  """
4193
4311
  return self._Bandwidth
@@ -4261,14 +4379,14 @@ class DescribeInsVPCEndpointsRequest(AbstractModel):
4261
4379
 
4262
4380
  def __init__(self):
4263
4381
  r"""
4264
- :param _InstanceId: 实例ID
4382
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4265
4383
  :type InstanceId: str
4266
4384
  """
4267
4385
  self._InstanceId = None
4268
4386
 
4269
4387
  @property
4270
4388
  def InstanceId(self):
4271
- """实例ID
4389
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4272
4390
  :rtype: str
4273
4391
  """
4274
4392
  return self._InstanceId
@@ -4345,14 +4463,14 @@ class DescribeInstanceListRequest(AbstractModel):
4345
4463
 
4346
4464
  def __init__(self):
4347
4465
  r"""
4348
- :param _Filters: 查询条件列表,支持以下子弹
4466
+ :param _Filters: 查询条件列表,支持以下字段
4349
4467
  InstanceName:集群名模糊搜索
4350
4468
  InstanceId:集群id精确搜索
4351
- InstanceStatus:集群状态搜索
4469
+ InstanceStatus:集群状态搜索(RUNNING-运行中,CREATING-创建中,MODIFYING-变配中,DELETING-删除中)
4352
4470
  :type Filters: list of Filter
4353
- :param _Offset: 查询起始位置
4471
+ :param _Offset: 查询起始位置,默认0
4354
4472
  :type Offset: int
4355
- :param _Limit: 查询结果限制数量
4473
+ :param _Limit: 查询结果限制数量,默认20,最大100
4356
4474
  :type Limit: int
4357
4475
  :param _TagFilters: 标签过滤器
4358
4476
  :type TagFilters: list of TagFilter
@@ -4364,10 +4482,10 @@ InstanceStatus:集群状态搜索
4364
4482
 
4365
4483
  @property
4366
4484
  def Filters(self):
4367
- """查询条件列表,支持以下子弹
4485
+ """查询条件列表,支持以下字段
4368
4486
  InstanceName:集群名模糊搜索
4369
4487
  InstanceId:集群id精确搜索
4370
- InstanceStatus:集群状态搜索
4488
+ InstanceStatus:集群状态搜索(RUNNING-运行中,CREATING-创建中,MODIFYING-变配中,DELETING-删除中)
4371
4489
  :rtype: list of Filter
4372
4490
  """
4373
4491
  return self._Filters
@@ -4378,7 +4496,7 @@ InstanceStatus:集群状态搜索
4378
4496
 
4379
4497
  @property
4380
4498
  def Offset(self):
4381
- """查询起始位置
4499
+ """查询起始位置,默认0
4382
4500
  :rtype: int
4383
4501
  """
4384
4502
  return self._Offset
@@ -4389,7 +4507,7 @@ InstanceStatus:集群状态搜索
4389
4507
 
4390
4508
  @property
4391
4509
  def Limit(self):
4392
- """查询结果限制数量
4510
+ """查询结果限制数量,默认20,最大100
4393
4511
  :rtype: int
4394
4512
  """
4395
4513
  return self._Limit
@@ -4505,14 +4623,14 @@ class DescribeInstanceRequest(AbstractModel):
4505
4623
 
4506
4624
  def __init__(self):
4507
4625
  r"""
4508
- :param _InstanceId: 实例ID
4626
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4509
4627
  :type InstanceId: str
4510
4628
  """
4511
4629
  self._InstanceId = None
4512
4630
 
4513
4631
  @property
4514
4632
  def InstanceId(self):
4515
- """实例ID
4633
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4516
4634
  :rtype: str
4517
4635
  """
4518
4636
  return self._InstanceId
@@ -4544,6 +4662,7 @@ class DescribeInstanceResponse(AbstractModel):
4544
4662
  :param _InstanceType: 实例类型
4545
4663
  BASIC 基础版
4546
4664
  PRO 专业版
4665
+ PLATINUM 铂金版
4547
4666
  :type InstanceType: str
4548
4667
  :param _InstanceId: 实例ID
4549
4668
  :type InstanceId: str
@@ -4559,7 +4678,7 @@ PRO 专业版
4559
4678
  :type CreatedTime: int
4560
4679
  :param _Remark: 备注信息
4561
4680
  :type Remark: str
4562
- :param _InstanceStatus: 实例状态
4681
+ :param _InstanceStatus: 实例状态, RUNNING, 运行中 MAINTAINING,维护中 ABNORMAL,异常 OVERDUE,欠费 DESTROYED,已删除 CREATING,创建中 MODIFYING,变配中 CREATE_FAILURE,创建失败 MODIFY_FAILURE,变配失败 DELETING,删除中
4563
4682
  :type InstanceStatus: str
4564
4683
  :param _SkuCode: 实例规格
4565
4684
  :type SkuCode: str
@@ -4575,13 +4694,13 @@ API:通过API手动注册
4575
4694
  :type DeviceCertificateProvisionType: str
4576
4695
  :param _AutomaticActivation: 自动注册设备证书时是否自动激活
4577
4696
  :type AutomaticActivation: bool
4578
- :param _RenewFlag: 是否自动续费
4697
+ :param _RenewFlag: 是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费
4579
4698
  :type RenewFlag: int
4580
4699
  :param _PayMode: 计费模式, POSTPAID,按量计费 PREPAID,包年包月
4581
4700
  :type PayMode: str
4582
- :param _ExpiryTime: 到期时间,秒为单位
4701
+ :param _ExpiryTime: 到期时间,毫秒级时间戳
4583
4702
  :type ExpiryTime: int
4584
- :param _DestroyTime: 预销毁时间
4703
+ :param _DestroyTime: 预销毁时间,毫秒级时间戳
4585
4704
  :type DestroyTime: int
4586
4705
  :param _X509Mode: TLS,单向认证 mTLS,双向认证 BYOC;一机一证
4587
4706
  :type X509Mode: str
@@ -4591,6 +4710,8 @@ API:通过API手动注册
4591
4710
  :type RegistrationCode: str
4592
4711
  :param _MaxSubscription: 集群最大订阅数
4593
4712
  :type MaxSubscription: int
4713
+ :param _AuthorizationPolicy: 授权策略开关
4714
+ :type AuthorizationPolicy: bool
4594
4715
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4595
4716
  :type RequestId: str
4596
4717
  """
@@ -4617,6 +4738,7 @@ API:通过API手动注册
4617
4738
  self._MaxCaNum = None
4618
4739
  self._RegistrationCode = None
4619
4740
  self._MaxSubscription = None
4741
+ self._AuthorizationPolicy = None
4620
4742
  self._RequestId = None
4621
4743
 
4622
4744
  @property
@@ -4624,6 +4746,7 @@ API:通过API手动注册
4624
4746
  """实例类型
4625
4747
  BASIC 基础版
4626
4748
  PRO 专业版
4749
+ PLATINUM 铂金版
4627
4750
  :rtype: str
4628
4751
  """
4629
4752
  return self._InstanceType
@@ -4711,7 +4834,7 @@ PRO 专业版
4711
4834
 
4712
4835
  @property
4713
4836
  def InstanceStatus(self):
4714
- """实例状态
4837
+ """实例状态, RUNNING, 运行中 MAINTAINING,维护中 ABNORMAL,异常 OVERDUE,欠费 DESTROYED,已删除 CREATING,创建中 MODIFYING,变配中 CREATE_FAILURE,创建失败 MODIFY_FAILURE,变配失败 DELETING,删除中
4715
4838
  :rtype: str
4716
4839
  """
4717
4840
  return self._InstanceStatus
@@ -4790,7 +4913,7 @@ API:通过API手动注册
4790
4913
 
4791
4914
  @property
4792
4915
  def RenewFlag(self):
4793
- """是否自动续费
4916
+ """是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费
4794
4917
  :rtype: int
4795
4918
  """
4796
4919
  return self._RenewFlag
@@ -4812,7 +4935,7 @@ API:通过API手动注册
4812
4935
 
4813
4936
  @property
4814
4937
  def ExpiryTime(self):
4815
- """到期时间,秒为单位
4938
+ """到期时间,毫秒级时间戳
4816
4939
  :rtype: int
4817
4940
  """
4818
4941
  return self._ExpiryTime
@@ -4823,7 +4946,7 @@ API:通过API手动注册
4823
4946
 
4824
4947
  @property
4825
4948
  def DestroyTime(self):
4826
- """预销毁时间
4949
+ """预销毁时间,毫秒级时间戳
4827
4950
  :rtype: int
4828
4951
  """
4829
4952
  return self._DestroyTime
@@ -4876,6 +4999,17 @@ API:通过API手动注册
4876
4999
  def MaxSubscription(self, MaxSubscription):
4877
5000
  self._MaxSubscription = MaxSubscription
4878
5001
 
5002
+ @property
5003
+ def AuthorizationPolicy(self):
5004
+ """授权策略开关
5005
+ :rtype: bool
5006
+ """
5007
+ return self._AuthorizationPolicy
5008
+
5009
+ @AuthorizationPolicy.setter
5010
+ def AuthorizationPolicy(self, AuthorizationPolicy):
5011
+ self._AuthorizationPolicy = AuthorizationPolicy
5012
+
4879
5013
  @property
4880
5014
  def RequestId(self):
4881
5015
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -4912,6 +5046,7 @@ API:通过API手动注册
4912
5046
  self._MaxCaNum = params.get("MaxCaNum")
4913
5047
  self._RegistrationCode = params.get("RegistrationCode")
4914
5048
  self._MaxSubscription = params.get("MaxSubscription")
5049
+ self._AuthorizationPolicy = params.get("AuthorizationPolicy")
4915
5050
  self._RequestId = params.get("RequestId")
4916
5051
 
4917
5052
 
@@ -4922,19 +5057,19 @@ class DescribeMessageListRequest(AbstractModel):
4922
5057
 
4923
5058
  def __init__(self):
4924
5059
  r"""
4925
- :param _InstanceId: 实例ID
5060
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4926
5061
  :type InstanceId: str
4927
- :param _Topic: 主题
5062
+ :param _Topic: 要查询的一级Topic,可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。
4928
5063
  :type Topic: str
4929
- :param _StartTime: 开始时间
5064
+ :param _StartTime: 开始时间,毫秒级时间戳 。
4930
5065
  :type StartTime: int
4931
- :param _EndTime: 结束时间
5066
+ :param _EndTime: 结束时间,毫秒级时间戳 。
4932
5067
  :type EndTime: int
4933
- :param _TaskRequestId: 请求任务id
5068
+ :param _TaskRequestId: 请求任务id,用于相同查询参数下查询加速,第一次查询时无需传递,第一次查询会根据本次查询参数生成查询任务ID,保留查询条件,查询下一页消息时可传递第一次查询返回的任务ID。
4934
5069
  :type TaskRequestId: str
4935
- :param _Offset: 查询起始位置
5070
+ :param _Offset: 查询起始位置,默认0
4936
5071
  :type Offset: int
4937
- :param _Limit: 查询结果限制数量
5072
+ :param _Limit: 查询结果限制数量,默认20,最大50
4938
5073
  :type Limit: int
4939
5074
  """
4940
5075
  self._InstanceId = None
@@ -4947,7 +5082,7 @@ class DescribeMessageListRequest(AbstractModel):
4947
5082
 
4948
5083
  @property
4949
5084
  def InstanceId(self):
4950
- """实例ID
5085
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4951
5086
  :rtype: str
4952
5087
  """
4953
5088
  return self._InstanceId
@@ -4958,7 +5093,7 @@ class DescribeMessageListRequest(AbstractModel):
4958
5093
 
4959
5094
  @property
4960
5095
  def Topic(self):
4961
- """主题
5096
+ """要查询的一级Topic,可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。
4962
5097
  :rtype: str
4963
5098
  """
4964
5099
  return self._Topic
@@ -4969,7 +5104,7 @@ class DescribeMessageListRequest(AbstractModel):
4969
5104
 
4970
5105
  @property
4971
5106
  def StartTime(self):
4972
- """开始时间
5107
+ """开始时间,毫秒级时间戳 。
4973
5108
  :rtype: int
4974
5109
  """
4975
5110
  return self._StartTime
@@ -4980,7 +5115,7 @@ class DescribeMessageListRequest(AbstractModel):
4980
5115
 
4981
5116
  @property
4982
5117
  def EndTime(self):
4983
- """结束时间
5118
+ """结束时间,毫秒级时间戳 。
4984
5119
  :rtype: int
4985
5120
  """
4986
5121
  return self._EndTime
@@ -4991,7 +5126,7 @@ class DescribeMessageListRequest(AbstractModel):
4991
5126
 
4992
5127
  @property
4993
5128
  def TaskRequestId(self):
4994
- """请求任务id
5129
+ """请求任务id,用于相同查询参数下查询加速,第一次查询时无需传递,第一次查询会根据本次查询参数生成查询任务ID,保留查询条件,查询下一页消息时可传递第一次查询返回的任务ID。
4995
5130
  :rtype: str
4996
5131
  """
4997
5132
  return self._TaskRequestId
@@ -5002,7 +5137,7 @@ class DescribeMessageListRequest(AbstractModel):
5002
5137
 
5003
5138
  @property
5004
5139
  def Offset(self):
5005
- """查询起始位置
5140
+ """查询起始位置,默认0
5006
5141
  :rtype: int
5007
5142
  """
5008
5143
  return self._Offset
@@ -5013,7 +5148,7 @@ class DescribeMessageListRequest(AbstractModel):
5013
5148
 
5014
5149
  @property
5015
5150
  def Limit(self):
5016
- """查询结果限制数量
5151
+ """查询结果限制数量,默认20,最大50
5017
5152
  :rtype: int
5018
5153
  """
5019
5154
  return self._Limit
@@ -5289,14 +5424,14 @@ class DescribeTopicListRequest(AbstractModel):
5289
5424
 
5290
5425
  def __init__(self):
5291
5426
  r"""
5292
- :param _InstanceId: 实例ID
5427
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5293
5428
  :type InstanceId: str
5294
5429
  :param _Filters: 查询条件列表:
5295
5430
  支持TopicName模糊查询
5296
5431
  :type Filters: list of Filter
5297
- :param _Offset: 查询起始位置
5432
+ :param _Offset: 查询起始位置,默认0。
5298
5433
  :type Offset: int
5299
- :param _Limit: 查询结果限制数量
5434
+ :param _Limit: 查询结果限制数量,默认20,最大20
5300
5435
  :type Limit: int
5301
5436
  """
5302
5437
  self._InstanceId = None
@@ -5306,7 +5441,7 @@ class DescribeTopicListRequest(AbstractModel):
5306
5441
 
5307
5442
  @property
5308
5443
  def InstanceId(self):
5309
- """实例ID
5444
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5310
5445
  :rtype: str
5311
5446
  """
5312
5447
  return self._InstanceId
@@ -5329,7 +5464,7 @@ class DescribeTopicListRequest(AbstractModel):
5329
5464
 
5330
5465
  @property
5331
5466
  def Offset(self):
5332
- """查询起始位置
5467
+ """查询起始位置,默认0。
5333
5468
  :rtype: int
5334
5469
  """
5335
5470
  return self._Offset
@@ -5340,7 +5475,7 @@ class DescribeTopicListRequest(AbstractModel):
5340
5475
 
5341
5476
  @property
5342
5477
  def Limit(self):
5343
- """查询结果限制数量
5478
+ """查询结果限制数量,默认20,最大20
5344
5479
  :rtype: int
5345
5480
  """
5346
5481
  return self._Limit
@@ -5579,14 +5714,14 @@ class DescribeUserListRequest(AbstractModel):
5579
5714
 
5580
5715
  def __init__(self):
5581
5716
  r"""
5582
- :param _InstanceId: 实例ID
5717
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5583
5718
  :type InstanceId: str
5584
5719
  :param _Filters: 查询条件列表支持字段
5585
- Username:Username模糊查询
5720
+ Username:按照【用户名】进行过滤,支持模糊过滤,类型:String
5586
5721
  :type Filters: list of Filter
5587
- :param _Offset: 查询起始位置
5722
+ :param _Offset: 查询起始位置,默认值0
5588
5723
  :type Offset: int
5589
- :param _Limit: 查询结果限制数量
5724
+ :param _Limit: 查询结果限制数量,默认值20,最大值100
5590
5725
  :type Limit: int
5591
5726
  """
5592
5727
  self._InstanceId = None
@@ -5596,7 +5731,7 @@ Username:Username模糊查询
5596
5731
 
5597
5732
  @property
5598
5733
  def InstanceId(self):
5599
- """实例ID
5734
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5600
5735
  :rtype: str
5601
5736
  """
5602
5737
  return self._InstanceId
@@ -5608,7 +5743,7 @@ Username:Username模糊查询
5608
5743
  @property
5609
5744
  def Filters(self):
5610
5745
  """查询条件列表支持字段
5611
- Username:Username模糊查询
5746
+ Username:按照【用户名】进行过滤,支持模糊过滤,类型:String
5612
5747
  :rtype: list of Filter
5613
5748
  """
5614
5749
  return self._Filters
@@ -5619,7 +5754,7 @@ Username:Username模糊查询
5619
5754
 
5620
5755
  @property
5621
5756
  def Offset(self):
5622
- """查询起始位置
5757
+ """查询起始位置,默认值0
5623
5758
  :rtype: int
5624
5759
  """
5625
5760
  return self._Offset
@@ -5630,7 +5765,7 @@ Username:Username模糊查询
5630
5765
 
5631
5766
  @property
5632
5767
  def Limit(self):
5633
- """查询结果限制数量
5768
+ """查询结果限制数量,默认值20,最大值100
5634
5769
  :rtype: int
5635
5770
  """
5636
5771
  return self._Limit
@@ -5734,37 +5869,37 @@ class DeviceCertificateItem(AbstractModel):
5734
5869
  :type ClientId: str
5735
5870
  :param _DeviceCertificate: 设备证书
5736
5871
  :type DeviceCertificate: str
5737
- :param _DeviceCertificateSn: 设备证书Sn
5872
+ :param _DeviceCertificateSn: 设备证书SN序列号,用于唯一标识一个设备证书
5738
5873
  :type DeviceCertificateSn: str
5739
5874
  :param _DeviceCertificateCn: 设备证书Cn
5740
5875
  :type DeviceCertificateCn: str
5741
- :param _CaSn: 签发ca的序列号
5876
+ :param _CaSn: 签发该证书的CA证书的序列号
5742
5877
  :type CaSn: str
5743
- :param _Format: 证书格式
5878
+ :param _Format: 证书格式,当前仅支持PEM
5744
5879
  :type Format: str
5745
- :param _Status: 证书状态
5746
- ACTIVE,//激活
5747
- INACTIVE,//未激活
5748
- REVOKED,//吊销
5749
- PENDING_ACTIVATION,//注册待激活
5880
+ :param _Status: 设备证书状态
5881
+ ACTIVE:激活
5882
+ INACTIVE:未激活
5883
+ REVOKED:吊销
5884
+ PENDING_ACTIVATION:注册待激活
5750
5885
  :type Status: str
5751
5886
  :param _OrganizationalUnit: 组织单位
5752
5887
  :type OrganizationalUnit: str
5753
- :param _LastActivationTime: 上次激活时间
5888
+ :param _LastActivationTime: 上次激活时间,毫秒级时间戳 。
5754
5889
  :type LastActivationTime: int
5755
- :param _LastInactivationTime: 上次取消激活时间
5890
+ :param _LastInactivationTime: 上次取消激活时间,毫秒级时间戳 。
5756
5891
  :type LastInactivationTime: int
5757
- :param _CreatedTime: 创建时间
5892
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
5758
5893
  :type CreatedTime: int
5759
- :param _UpdateTime: 预销毁时间
5894
+ :param _UpdateTime: 更新时间,毫秒级时间戳 。
5760
5895
  :type UpdateTime: int
5761
5896
  :param _CertificateSource: 证书来源:
5762
5897
  API, 手动注册
5763
5898
  JITP 自动注册
5764
5899
  :type CertificateSource: str
5765
- :param _NotAfterTime: 证书失效日期
5900
+ :param _NotAfterTime: 证书失效日期,毫秒级时间戳 。
5766
5901
  :type NotAfterTime: int
5767
- :param _NotBeforeTime: 证书生效开始日期
5902
+ :param _NotBeforeTime: 证书生效开始日期,毫秒级时间戳 。
5768
5903
  :type NotBeforeTime: int
5769
5904
  """
5770
5905
  self._ClientId = None
@@ -5807,7 +5942,7 @@ JITP 自动注册
5807
5942
 
5808
5943
  @property
5809
5944
  def DeviceCertificateSn(self):
5810
- """设备证书Sn
5945
+ """设备证书SN序列号,用于唯一标识一个设备证书
5811
5946
  :rtype: str
5812
5947
  """
5813
5948
  return self._DeviceCertificateSn
@@ -5829,7 +5964,7 @@ JITP 自动注册
5829
5964
 
5830
5965
  @property
5831
5966
  def CaSn(self):
5832
- """签发ca的序列号
5967
+ """签发该证书的CA证书的序列号
5833
5968
  :rtype: str
5834
5969
  """
5835
5970
  return self._CaSn
@@ -5840,7 +5975,7 @@ JITP 自动注册
5840
5975
 
5841
5976
  @property
5842
5977
  def Format(self):
5843
- """证书格式
5978
+ """证书格式,当前仅支持PEM
5844
5979
  :rtype: str
5845
5980
  """
5846
5981
  return self._Format
@@ -5851,11 +5986,11 @@ JITP 自动注册
5851
5986
 
5852
5987
  @property
5853
5988
  def Status(self):
5854
- """证书状态
5855
- ACTIVE,//激活
5856
- INACTIVE,//未激活
5857
- REVOKED,//吊销
5858
- PENDING_ACTIVATION,//注册待激活
5989
+ """设备证书状态
5990
+ ACTIVE:激活
5991
+ INACTIVE:未激活
5992
+ REVOKED:吊销
5993
+ PENDING_ACTIVATION:注册待激活
5859
5994
  :rtype: str
5860
5995
  """
5861
5996
  return self._Status
@@ -5877,7 +6012,7 @@ JITP 自动注册
5877
6012
 
5878
6013
  @property
5879
6014
  def LastActivationTime(self):
5880
- """上次激活时间
6015
+ """上次激活时间,毫秒级时间戳 。
5881
6016
  :rtype: int
5882
6017
  """
5883
6018
  return self._LastActivationTime
@@ -5888,7 +6023,7 @@ JITP 自动注册
5888
6023
 
5889
6024
  @property
5890
6025
  def LastInactivationTime(self):
5891
- """上次取消激活时间
6026
+ """上次取消激活时间,毫秒级时间戳 。
5892
6027
  :rtype: int
5893
6028
  """
5894
6029
  return self._LastInactivationTime
@@ -5899,7 +6034,7 @@ JITP 自动注册
5899
6034
 
5900
6035
  @property
5901
6036
  def CreatedTime(self):
5902
- """创建时间
6037
+ """创建时间,毫秒级时间戳 。
5903
6038
  :rtype: int
5904
6039
  """
5905
6040
  return self._CreatedTime
@@ -5910,7 +6045,7 @@ JITP 自动注册
5910
6045
 
5911
6046
  @property
5912
6047
  def UpdateTime(self):
5913
- """预销毁时间
6048
+ """更新时间,毫秒级时间戳 。
5914
6049
  :rtype: int
5915
6050
  """
5916
6051
  return self._UpdateTime
@@ -5934,7 +6069,7 @@ JITP 自动注册
5934
6069
 
5935
6070
  @property
5936
6071
  def NotAfterTime(self):
5937
- """证书失效日期
6072
+ """证书失效日期,毫秒级时间戳 。
5938
6073
  :rtype: int
5939
6074
  """
5940
6075
  return self._NotAfterTime
@@ -5945,7 +6080,7 @@ JITP 自动注册
5945
6080
 
5946
6081
  @property
5947
6082
  def NotBeforeTime(self):
5948
- """证书生效开始日期
6083
+ """证书生效开始日期,毫秒级时间戳 。
5949
6084
  :rtype: int
5950
6085
  """
5951
6086
  return self._NotBeforeTime
@@ -6156,15 +6291,49 @@ class MQTTAuthenticatorItem(AbstractModel):
6156
6291
 
6157
6292
  def __init__(self):
6158
6293
  r"""
6159
- :param _Type: 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
6294
+ :param _Type: 认证器类型
6295
+ JWT:JWT认证器
6296
+ JWKS:JWKS认证器
6297
+ HTTP:HTTP认证器
6160
6298
  :type Type: str
6161
- :param _Config: 认证器配置
6299
+ :param _Config: JWT认证器字段说明
6300
+ from(认证字段)
6301
+ password:从password字段获取认证字段
6302
+ username:从username字段获取认证字段
6303
+ secret(签名方式)
6304
+ hmac-based:hmac-based签名方式
6305
+ public-key:public-key签名方式
6306
+ secret(密钥),hmac-based需要配置密钥
6307
+ public-key(公钥),public-key签名方式需要配置
6308
+ 样例:{"from":"password","secret":"secret282698","algorithm":"hmac-based"}
6309
+
6310
+ JWKS认证器字段说明
6311
+ endpoint(接入点):公钥获取服务器接入地址
6312
+ refreshInterval(认证内容):公钥集合刷新周期
6313
+ from(认证字段)
6314
+ password:从password字段获取认证字段
6315
+ username:从username字段获取认证字段
6316
+ text:公钥集合
6317
+ 样例:{"endpoint":"127.0.0.1","refreshInterval":60,"from":"password"}
6318
+
6319
+ HTTP认证器
6320
+ headers(请求头):标准请求头和自定义请求头
6321
+ endpoint(接入点):认证服务器接入点
6322
+ method(http请求方法):POST/GET
6323
+ readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
6324
+ connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
6325
+ body(请求体):http请求体
6326
+ concurrency(并发数):最大并发请求数量
6327
+ 样例:{"headers":[{"key":"Content-type","value":"application/json"},{"key":"username","value":"${Username}"}],"endpoint":"https://127.0.0.1:443","method":"POST","readTimeout":10,"connectTimeout":10,"body":[{"key":"client-id","value":"${ClientId}"}],"concurrency":8}
6328
+ 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
6162
6329
  :type Config: str
6163
6330
  :param _Status: 认证器状态
6331
+ open:认证器打开
6332
+ close:认证器关闭
6164
6333
  :type Status: str
6165
- :param _CreateTime: 创建时间
6334
+ :param _CreateTime: 创建时间,毫秒级时间戳 。
6166
6335
  :type CreateTime: int
6167
- :param _Remark: 说明
6336
+ :param _Remark: 说明,最长 128 字符。
6168
6337
  :type Remark: str
6169
6338
  """
6170
6339
  self._Type = None
@@ -6175,7 +6344,10 @@ class MQTTAuthenticatorItem(AbstractModel):
6175
6344
 
6176
6345
  @property
6177
6346
  def Type(self):
6178
- """认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
6347
+ """认证器类型
6348
+ JWT:JWT认证器
6349
+ JWKS:JWKS认证器
6350
+ HTTP:HTTP认证器
6179
6351
  :rtype: str
6180
6352
  """
6181
6353
  return self._Type
@@ -6186,7 +6358,36 @@ class MQTTAuthenticatorItem(AbstractModel):
6186
6358
 
6187
6359
  @property
6188
6360
  def Config(self):
6189
- """认证器配置
6361
+ """JWT认证器字段说明
6362
+ from(认证字段)
6363
+ password:从password字段获取认证字段
6364
+ username:从username字段获取认证字段
6365
+ secret(签名方式)
6366
+ hmac-based:hmac-based签名方式
6367
+ public-key:public-key签名方式
6368
+ secret(密钥),hmac-based需要配置密钥
6369
+ public-key(公钥),public-key签名方式需要配置
6370
+ 样例:{"from":"password","secret":"secret282698","algorithm":"hmac-based"}
6371
+
6372
+ JWKS认证器字段说明
6373
+ endpoint(接入点):公钥获取服务器接入地址
6374
+ refreshInterval(认证内容):公钥集合刷新周期
6375
+ from(认证字段)
6376
+ password:从password字段获取认证字段
6377
+ username:从username字段获取认证字段
6378
+ text:公钥集合
6379
+ 样例:{"endpoint":"127.0.0.1","refreshInterval":60,"from":"password"}
6380
+
6381
+ HTTP认证器
6382
+ headers(请求头):标准请求头和自定义请求头
6383
+ endpoint(接入点):认证服务器接入点
6384
+ method(http请求方法):POST/GET
6385
+ readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
6386
+ connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
6387
+ body(请求体):http请求体
6388
+ concurrency(并发数):最大并发请求数量
6389
+ 样例:{"headers":[{"key":"Content-type","value":"application/json"},{"key":"username","value":"${Username}"}],"endpoint":"https://127.0.0.1:443","method":"POST","readTimeout":10,"connectTimeout":10,"body":[{"key":"client-id","value":"${ClientId}"}],"concurrency":8}
6390
+ 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
6190
6391
  :rtype: str
6191
6392
  """
6192
6393
  return self._Config
@@ -6198,6 +6399,8 @@ class MQTTAuthenticatorItem(AbstractModel):
6198
6399
  @property
6199
6400
  def Status(self):
6200
6401
  """认证器状态
6402
+ open:认证器打开
6403
+ close:认证器关闭
6201
6404
  :rtype: str
6202
6405
  """
6203
6406
  return self._Status
@@ -6208,7 +6411,7 @@ class MQTTAuthenticatorItem(AbstractModel):
6208
6411
 
6209
6412
  @property
6210
6413
  def CreateTime(self):
6211
- """创建时间
6414
+ """创建时间,毫秒级时间戳 。
6212
6415
  :rtype: int
6213
6416
  """
6214
6417
  return self._CreateTime
@@ -6219,7 +6422,7 @@ class MQTTAuthenticatorItem(AbstractModel):
6219
6422
 
6220
6423
  @property
6221
6424
  def Remark(self):
6222
- """说明
6425
+ """说明,最长 128 字符。
6223
6426
  :rtype: str
6224
6427
  """
6225
6428
  return self._Remark
@@ -6252,21 +6455,24 @@ class MQTTClientInfo(AbstractModel):
6252
6455
 
6253
6456
  def __init__(self):
6254
6457
  r"""
6255
- :param _ClientId: 客户端唯一标识
6458
+ :param _ClientId: 客户端ID
6256
6459
  :type ClientId: str
6257
6460
  :param _ClientAddress: 客户端网络地址
6258
6461
  :type ClientAddress: str
6259
- :param _ProtocolVersion: MQTT 协议版本,4 表示 MQTT 3.1.1
6462
+ :param _ProtocolVersion: MQTT 协议版本
6463
+ 3:表示MQTT 3.1版本
6464
+ 4:表示 MQTT 3.1.1
6465
+ 5:表示MQTT 5.0协议
6260
6466
  :type ProtocolVersion: int
6261
6467
  :param _Keepalive: 保持连接时间,单位:秒
6262
6468
  :type Keepalive: int
6263
6469
  :param _ConnectionStatus: 连接状态,CONNECTED 已连接,DISCONNECTED 未连接
6264
6470
  :type ConnectionStatus: str
6265
- :param _CreateTime: 客户端创建时间
6471
+ :param _CreateTime: 客户端创建时间,毫秒级时间戳 。
6266
6472
  :type CreateTime: int
6267
- :param _ConnectTime: 上次建立连接时间
6473
+ :param _ConnectTime: 上次建立连接时间,毫秒级时间戳 。
6268
6474
  :type ConnectTime: int
6269
- :param _DisconnectTime: 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
6475
+ :param _DisconnectTime: 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义,毫秒级时间戳 。
6270
6476
  :type DisconnectTime: int
6271
6477
  :param _MQTTClientSubscriptions: 客户端的订阅列表
6272
6478
  :type MQTTClientSubscriptions: list of MQTTClientSubscription
@@ -6283,7 +6489,7 @@ class MQTTClientInfo(AbstractModel):
6283
6489
 
6284
6490
  @property
6285
6491
  def ClientId(self):
6286
- """客户端唯一标识
6492
+ """客户端ID
6287
6493
  :rtype: str
6288
6494
  """
6289
6495
  return self._ClientId
@@ -6305,7 +6511,10 @@ class MQTTClientInfo(AbstractModel):
6305
6511
 
6306
6512
  @property
6307
6513
  def ProtocolVersion(self):
6308
- """MQTT 协议版本,4 表示 MQTT 3.1.1
6514
+ """MQTT 协议版本
6515
+ 3:表示MQTT 3.1版本
6516
+ 4:表示 MQTT 3.1.1
6517
+ 5:表示MQTT 5.0协议
6309
6518
  :rtype: int
6310
6519
  """
6311
6520
  return self._ProtocolVersion
@@ -6338,7 +6547,7 @@ class MQTTClientInfo(AbstractModel):
6338
6547
 
6339
6548
  @property
6340
6549
  def CreateTime(self):
6341
- """客户端创建时间
6550
+ """客户端创建时间,毫秒级时间戳 。
6342
6551
  :rtype: int
6343
6552
  """
6344
6553
  return self._CreateTime
@@ -6349,7 +6558,7 @@ class MQTTClientInfo(AbstractModel):
6349
6558
 
6350
6559
  @property
6351
6560
  def ConnectTime(self):
6352
- """上次建立连接时间
6561
+ """上次建立连接时间,毫秒级时间戳 。
6353
6562
  :rtype: int
6354
6563
  """
6355
6564
  return self._ConnectTime
@@ -6360,7 +6569,7 @@ class MQTTClientInfo(AbstractModel):
6360
6569
 
6361
6570
  @property
6362
6571
  def DisconnectTime(self):
6363
- """上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
6572
+ """上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义,毫秒级时间戳 。
6364
6573
  :rtype: int
6365
6574
  """
6366
6575
  return self._DisconnectTime
@@ -6416,6 +6625,9 @@ class MQTTClientSubscription(AbstractModel):
6416
6625
  :param _TopicFilter: topic 订阅
6417
6626
  :type TopicFilter: str
6418
6627
  :param _Qos: 服务质量等级
6628
+ 0: 至多一次
6629
+ 1: 至少一次
6630
+ 2: 恰好一次
6419
6631
  :type Qos: int
6420
6632
  :param _Lag: 堆积数量
6421
6633
  :type Lag: int
@@ -6441,6 +6653,9 @@ class MQTTClientSubscription(AbstractModel):
6441
6653
  @property
6442
6654
  def Qos(self):
6443
6655
  """服务质量等级
6656
+ 0: 至多一次
6657
+ 1: 至少一次
6658
+ 2: 恰好一次
6444
6659
  :rtype: int
6445
6660
  """
6446
6661
  return self._Qos
@@ -6626,8 +6841,7 @@ class MQTTInstanceItem(AbstractModel):
6626
6841
  :type InstanceName: str
6627
6842
  :param _Version: 实例版本
6628
6843
  :type Version: str
6629
- :param _InstanceType: 实例类型,
6630
- EXPERIMENT,体验版
6844
+ :param _InstanceType: 实例类型
6631
6845
  BASIC,基础版
6632
6846
  PRO,专业版
6633
6847
  PLATINUM,铂金版
@@ -6654,19 +6868,21 @@ DELETING,删除中
6654
6868
  :type SkuCode: str
6655
6869
  :param _TpsLimit: 弹性TPS限流值
6656
6870
  :type TpsLimit: int
6657
- :param _CreateTime: 创建时间
6871
+ :param _CreateTime: 创建时间,毫秒级时间戳
6658
6872
  :type CreateTime: int
6659
6873
  :param _MaxSubscriptionPerClient: 单客户端最大订阅数量
6660
6874
  :type MaxSubscriptionPerClient: int
6661
6875
  :param _ClientNumLimit: 客户端连接数上线
6662
6876
  :type ClientNumLimit: int
6663
- :param _RenewFlag: 是否自动续费
6877
+ :param _RenewFlag: 是否自动续费。仅包年包月集群生效。
6878
+ 1:自动续费
6879
+ 0:非自动续费
6664
6880
  :type RenewFlag: int
6665
6881
  :param _PayMode: 计费模式, POSTPAID,按量计费 PREPAID,包年包月
6666
6882
  :type PayMode: str
6667
- :param _ExpiryTime: 到期时间,秒为单位
6883
+ :param _ExpiryTime: 到期时间,毫秒级时间戳
6668
6884
  :type ExpiryTime: int
6669
- :param _DestroyTime: 预销毁时间
6885
+ :param _DestroyTime: 预销毁时间,毫秒级时间戳
6670
6886
  :type DestroyTime: int
6671
6887
  :param _AuthorizationPolicyLimit: 授权规则条数限制
6672
6888
  :type AuthorizationPolicyLimit: int
@@ -6731,8 +6947,7 @@ DELETING,删除中
6731
6947
 
6732
6948
  @property
6733
6949
  def InstanceType(self):
6734
- """实例类型,
6735
- EXPERIMENT,体验版
6950
+ """实例类型
6736
6951
  BASIC,基础版
6737
6952
  PRO,专业版
6738
6953
  PLATINUM,铂金版
@@ -6822,7 +7037,7 @@ DELETING,删除中
6822
7037
 
6823
7038
  @property
6824
7039
  def CreateTime(self):
6825
- """创建时间
7040
+ """创建时间,毫秒级时间戳
6826
7041
  :rtype: int
6827
7042
  """
6828
7043
  return self._CreateTime
@@ -6855,7 +7070,9 @@ DELETING,删除中
6855
7070
 
6856
7071
  @property
6857
7072
  def RenewFlag(self):
6858
- """是否自动续费
7073
+ """是否自动续费。仅包年包月集群生效。
7074
+ 1:自动续费
7075
+ 0:非自动续费
6859
7076
  :rtype: int
6860
7077
  """
6861
7078
  return self._RenewFlag
@@ -6877,7 +7094,7 @@ DELETING,删除中
6877
7094
 
6878
7095
  @property
6879
7096
  def ExpiryTime(self):
6880
- """到期时间,秒为单位
7097
+ """到期时间,毫秒级时间戳
6881
7098
  :rtype: int
6882
7099
  """
6883
7100
  return self._ExpiryTime
@@ -6888,7 +7105,7 @@ DELETING,删除中
6888
7105
 
6889
7106
  @property
6890
7107
  def DestroyTime(self):
6891
- """预销毁时间
7108
+ """预销毁时间,毫秒级时间戳
6892
7109
  :rtype: int
6893
7110
  """
6894
7111
  return self._DestroyTime
@@ -6977,7 +7194,7 @@ class MQTTMessageItem(AbstractModel):
6977
7194
  :type Keys: str
6978
7195
  :param _ProducerAddr: 客户端地址
6979
7196
  :type ProducerAddr: str
6980
- :param _ProduceTime: 消息发送时间
7197
+ :param _ProduceTime: 消息发送时间,格式 日期时间:YYYY-MM-DD hh:mm:ss
6981
7198
  :type ProduceTime: str
6982
7199
  :param _DeadLetterResendTimes: 死信重发次数
6983
7200
  :type DeadLetterResendTimes: int
@@ -6986,6 +7203,9 @@ class MQTTMessageItem(AbstractModel):
6986
7203
  :param _SubTopic: 子topic
6987
7204
  :type SubTopic: str
6988
7205
  :param _Qos: 消息质量等级
7206
+ 0:至多一次
7207
+ 1:至少一次
7208
+ 2:精确一次
6989
7209
  :type Qos: str
6990
7210
  """
6991
7211
  self._MsgId = None
@@ -7044,7 +7264,7 @@ class MQTTMessageItem(AbstractModel):
7044
7264
 
7045
7265
  @property
7046
7266
  def ProduceTime(self):
7047
- """消息发送时间
7267
+ """消息发送时间,格式 日期时间:YYYY-MM-DD hh:mm:ss
7048
7268
  :rtype: str
7049
7269
  """
7050
7270
  return self._ProduceTime
@@ -7089,6 +7309,9 @@ class MQTTMessageItem(AbstractModel):
7089
7309
  @property
7090
7310
  def Qos(self):
7091
7311
  """消息质量等级
7312
+ 0:至多一次
7313
+ 1:至少一次
7314
+ 2:精确一次
7092
7315
  :rtype: str
7093
7316
  """
7094
7317
  return self._Qos
@@ -7197,9 +7420,9 @@ class MQTTUserItem(AbstractModel):
7197
7420
  :type Password: str
7198
7421
  :param _Remark: 备注信息
7199
7422
  :type Remark: str
7200
- :param _CreatedTime: 创建时间,秒为单位
7423
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
7201
7424
  :type CreatedTime: int
7202
- :param _ModifiedTime: 修改时间,秒为单位
7425
+ :param _ModifiedTime: 修改时间,毫秒级时间戳 。
7203
7426
  :type ModifiedTime: int
7204
7427
  """
7205
7428
  self._Username = None
@@ -7243,7 +7466,7 @@ class MQTTUserItem(AbstractModel):
7243
7466
 
7244
7467
  @property
7245
7468
  def CreatedTime(self):
7246
- """创建时间,秒为单位
7469
+ """创建时间,毫秒级时间戳 。
7247
7470
  :rtype: int
7248
7471
  """
7249
7472
  return self._CreatedTime
@@ -7254,7 +7477,7 @@ class MQTTUserItem(AbstractModel):
7254
7477
 
7255
7478
  @property
7256
7479
  def ModifiedTime(self):
7257
- """修改时间,秒为单位
7480
+ """修改时间,毫秒级时间戳 。
7258
7481
  :rtype: int
7259
7482
  """
7260
7483
  return self._ModifiedTime
@@ -8003,13 +8226,14 @@ class ModifyInstanceRequest(AbstractModel):
8003
8226
 
8004
8227
  def __init__(self):
8005
8228
  r"""
8006
- :param _InstanceId: 实例ID
8229
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8007
8230
  :type InstanceId: str
8008
- :param _Name: 要修改实例名称
8231
+ :param _Name: 要修改实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”。
8009
8232
  :type Name: str
8010
- :param _Remark: 要修改的备注信息
8233
+ :param _Remark: 要修改的备注信息,最多64个字符。
8011
8234
  :type Remark: str
8012
- :param _SkuCode: 要变更的配置规格
8235
+ :param _SkuCode: 需要变更的配置规格
8236
+ 基础版和专业版集群不能升配到铂金版规格,铂金版集群不能降配至基础版和增强版规格。
8013
8237
  :type SkuCode: str
8014
8238
  :param _DeviceCertificateProvisionType: 客户端证书注册方式:
8015
8239
  JITP:自动注册
@@ -8017,6 +8241,8 @@ API:手动通过API注册
8017
8241
  :type DeviceCertificateProvisionType: str
8018
8242
  :param _AutomaticActivation: 自动注册证书是否自动激活
8019
8243
  :type AutomaticActivation: bool
8244
+ :param _AuthorizationPolicy: 授权策略开关
8245
+ :type AuthorizationPolicy: bool
8020
8246
  """
8021
8247
  self._InstanceId = None
8022
8248
  self._Name = None
@@ -8024,10 +8250,11 @@ API:手动通过API注册
8024
8250
  self._SkuCode = None
8025
8251
  self._DeviceCertificateProvisionType = None
8026
8252
  self._AutomaticActivation = None
8253
+ self._AuthorizationPolicy = None
8027
8254
 
8028
8255
  @property
8029
8256
  def InstanceId(self):
8030
- """实例ID
8257
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8031
8258
  :rtype: str
8032
8259
  """
8033
8260
  return self._InstanceId
@@ -8038,7 +8265,7 @@ API:手动通过API注册
8038
8265
 
8039
8266
  @property
8040
8267
  def Name(self):
8041
- """要修改实例名称
8268
+ """要修改实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”。
8042
8269
  :rtype: str
8043
8270
  """
8044
8271
  return self._Name
@@ -8049,7 +8276,7 @@ API:手动通过API注册
8049
8276
 
8050
8277
  @property
8051
8278
  def Remark(self):
8052
- """要修改的备注信息
8279
+ """要修改的备注信息,最多64个字符。
8053
8280
  :rtype: str
8054
8281
  """
8055
8282
  return self._Remark
@@ -8060,7 +8287,8 @@ API:手动通过API注册
8060
8287
 
8061
8288
  @property
8062
8289
  def SkuCode(self):
8063
- """要变更的配置规格
8290
+ """需要变更的配置规格
8291
+ 基础版和专业版集群不能升配到铂金版规格,铂金版集群不能降配至基础版和增强版规格。
8064
8292
  :rtype: str
8065
8293
  """
8066
8294
  return self._SkuCode
@@ -8093,6 +8321,17 @@ API:手动通过API注册
8093
8321
  def AutomaticActivation(self, AutomaticActivation):
8094
8322
  self._AutomaticActivation = AutomaticActivation
8095
8323
 
8324
+ @property
8325
+ def AuthorizationPolicy(self):
8326
+ """授权策略开关
8327
+ :rtype: bool
8328
+ """
8329
+ return self._AuthorizationPolicy
8330
+
8331
+ @AuthorizationPolicy.setter
8332
+ def AuthorizationPolicy(self, AuthorizationPolicy):
8333
+ self._AuthorizationPolicy = AuthorizationPolicy
8334
+
8096
8335
 
8097
8336
  def _deserialize(self, params):
8098
8337
  self._InstanceId = params.get("InstanceId")
@@ -8101,6 +8340,7 @@ API:手动通过API注册
8101
8340
  self._SkuCode = params.get("SkuCode")
8102
8341
  self._DeviceCertificateProvisionType = params.get("DeviceCertificateProvisionType")
8103
8342
  self._AutomaticActivation = params.get("AutomaticActivation")
8343
+ self._AuthorizationPolicy = params.get("AuthorizationPolicy")
8104
8344
  memeber_set = set(params.keys())
8105
8345
  for name, value in vars(self).items():
8106
8346
  property_name = name[1:]
@@ -8458,11 +8698,11 @@ class ModifyTopicRequest(AbstractModel):
8458
8698
 
8459
8699
  def __init__(self):
8460
8700
  r"""
8461
- :param _InstanceId: 实例ID
8701
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8462
8702
  :type InstanceId: str
8463
- :param _Topic: 主题
8703
+ :param _Topic: 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
8464
8704
  :type Topic: str
8465
- :param _Remark: 备注信息
8705
+ :param _Remark: 备注信息,最长 128 字符
8466
8706
  :type Remark: str
8467
8707
  """
8468
8708
  self._InstanceId = None
@@ -8471,7 +8711,7 @@ class ModifyTopicRequest(AbstractModel):
8471
8711
 
8472
8712
  @property
8473
8713
  def InstanceId(self):
8474
- """实例ID
8714
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8475
8715
  :rtype: str
8476
8716
  """
8477
8717
  return self._InstanceId
@@ -8482,7 +8722,7 @@ class ModifyTopicRequest(AbstractModel):
8482
8722
 
8483
8723
  @property
8484
8724
  def Topic(self):
8485
- """主题
8725
+ """主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
8486
8726
  :rtype: str
8487
8727
  """
8488
8728
  return self._Topic
@@ -8493,7 +8733,7 @@ class ModifyTopicRequest(AbstractModel):
8493
8733
 
8494
8734
  @property
8495
8735
  def Remark(self):
8496
- """备注信息
8736
+ """备注信息,最长 128 字符
8497
8737
  :rtype: str
8498
8738
  """
8499
8739
  return self._Remark
@@ -8552,11 +8792,11 @@ class ModifyUserRequest(AbstractModel):
8552
8792
 
8553
8793
  def __init__(self):
8554
8794
  r"""
8555
- :param _InstanceId: 实例ID
8795
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8556
8796
  :type InstanceId: str
8557
8797
  :param _Username: 用户名
8558
8798
  :type Username: str
8559
- :param _Remark: 备注
8799
+ :param _Remark: 备注,长度不超过128个字符。
8560
8800
  :type Remark: str
8561
8801
  """
8562
8802
  self._InstanceId = None
@@ -8565,7 +8805,7 @@ class ModifyUserRequest(AbstractModel):
8565
8805
 
8566
8806
  @property
8567
8807
  def InstanceId(self):
8568
- """实例ID
8808
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8569
8809
  :rtype: str
8570
8810
  """
8571
8811
  return self._InstanceId
@@ -8587,7 +8827,7 @@ class ModifyUserRequest(AbstractModel):
8587
8827
 
8588
8828
  @property
8589
8829
  def Remark(self):
8590
- """备注
8830
+ """备注,长度不超过128个字符。
8591
8831
  :rtype: str
8592
8832
  """
8593
8833
  return self._Remark
@@ -8646,13 +8886,14 @@ class PriceTag(AbstractModel):
8646
8886
 
8647
8887
  def __init__(self):
8648
8888
  r"""
8649
- :param _Name: 计价名称
8889
+ :param _Name: 计价名称,表示规格的计费项项目分类,具体规格的计价名称可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232) 接口的返回结果。
8650
8890
  :type Name: str
8651
- :param _Category: 计价类别
8891
+ :param _Category: 计价类别,计价名称子类,具体规格的计价类别可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232) 的返回结果。
8652
8892
  :type Category: str
8653
- :param _Code: 计费项标签
8893
+ :param _Code: 计费项标签,为计价名称(Name)下计价类别(Category)的子项目,表示一个具体的收费项。规格的计费项标签可参考
8894
+ [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232) 接口的返回结果。
8654
8895
  :type Code: str
8655
- :param _Step: 步长
8896
+ :param _Step: 计费步长,表示该规格在 计价名称(Name)下的计价类别(Category)的计费项标签(Code)计费数量。具体规格该字段取值参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232)
8656
8897
  :type Step: int
8657
8898
  """
8658
8899
  self._Name = None
@@ -8662,7 +8903,7 @@ class PriceTag(AbstractModel):
8662
8903
 
8663
8904
  @property
8664
8905
  def Name(self):
8665
- """计价名称
8906
+ """计价名称,表示规格的计费项项目分类,具体规格的计价名称可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232) 接口的返回结果。
8666
8907
  :rtype: str
8667
8908
  """
8668
8909
  return self._Name
@@ -8673,7 +8914,7 @@ class PriceTag(AbstractModel):
8673
8914
 
8674
8915
  @property
8675
8916
  def Category(self):
8676
- """计价类别
8917
+ """计价类别,计价名称子类,具体规格的计价类别可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232) 的返回结果。
8677
8918
  :rtype: str
8678
8919
  """
8679
8920
  return self._Category
@@ -8684,7 +8925,8 @@ class PriceTag(AbstractModel):
8684
8925
 
8685
8926
  @property
8686
8927
  def Code(self):
8687
- """计费项标签
8928
+ """计费项标签,为计价名称(Name)下计价类别(Category)的子项目,表示一个具体的收费项。规格的计费项标签可参考
8929
+ [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232) 接口的返回结果。
8688
8930
  :rtype: str
8689
8931
  """
8690
8932
  return self._Code
@@ -8695,7 +8937,7 @@ class PriceTag(AbstractModel):
8695
8937
 
8696
8938
  @property
8697
8939
  def Step(self):
8698
- """步长
8940
+ """计费步长,表示该规格在 计价名称(Name)下的计价类别(Category)的计费项标签(Code)计费数量。具体规格该字段取值参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/product/1778/116232)
8699
8941
  :rtype: int
8700
8942
  """
8701
8943
  return self._Step
@@ -8730,14 +8972,17 @@ class ProductSkuItem(AbstractModel):
8730
8972
  :param _InstanceType: 规格类型
8731
8973
  BASIC:基础版
8732
8974
  PRO :专业版
8975
+ PLATINUM: 铂金版
8733
8976
  :type InstanceType: str
8734
8977
  :param _SkuCode: 规格代码
8735
8978
  :type SkuCode: str
8736
8979
  :param _OnSale: 是否售卖
8980
+ 1: 可售卖
8981
+ 0: 不可售卖
8737
8982
  :type OnSale: bool
8738
8983
  :param _TopicNumLimit: topic num限制
8739
8984
  :type TopicNumLimit: int
8740
- :param _TpsLimit: tps
8985
+ :param _TpsLimit: MQTT 集群下每秒钟生产消息量和消费消息量之和。详细计算方式参考 [计费概述](https://cloud.tencent.com/document/product/1778/109698)
8741
8986
  :type TpsLimit: int
8742
8987
  :param _ClientNumLimit: 客户端连接数
8743
8988
  :type ClientNumLimit: int
@@ -8763,6 +9008,7 @@ PRO :专业版
8763
9008
  """规格类型
8764
9009
  BASIC:基础版
8765
9010
  PRO :专业版
9011
+ PLATINUM: 铂金版
8766
9012
  :rtype: str
8767
9013
  """
8768
9014
  return self._InstanceType
@@ -8785,6 +9031,8 @@ PRO :专业版
8785
9031
  @property
8786
9032
  def OnSale(self):
8787
9033
  """是否售卖
9034
+ 1: 可售卖
9035
+ 0: 不可售卖
8788
9036
  :rtype: bool
8789
9037
  """
8790
9038
  return self._OnSale
@@ -8806,7 +9054,7 @@ PRO :专业版
8806
9054
 
8807
9055
  @property
8808
9056
  def TpsLimit(self):
8809
- """tps
9057
+ """MQTT 集群下每秒钟生产消息量和消费消息量之和。详细计算方式参考 [计费概述](https://cloud.tencent.com/document/product/1778/109698)
8810
9058
  :rtype: int
8811
9059
  """
8812
9060
  return self._TpsLimit
@@ -8958,9 +9206,9 @@ class PublishMessageRequest(AbstractModel):
8958
9206
 
8959
9207
  def __init__(self):
8960
9208
  r"""
8961
- :param _InstanceId: 实例ID
9209
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8962
9210
  :type InstanceId: str
8963
- :param _Payload: 消息 payload,需要按 encoding 指定的编码方式进行编码
9211
+ :param _Payload: 消息负载 Payload,是消息的实际内容,需要按 encoding 指定的编码方式进行编码
8964
9212
  :type Payload: str
8965
9213
  :param _TargetTopic: 消息目的主题,该参数与 TargetClientId 二选一
8966
9214
  :type TargetTopic: str
@@ -8969,6 +9217,9 @@ class PublishMessageRequest(AbstractModel):
8969
9217
  :param _Encoding: 消息 payload 编码,可选 plain 或 base64,默认为 plain(即不编码)
8970
9218
  :type Encoding: str
8971
9219
  :param _Qos: 消息的服务质量等级,默认为 1
9220
+ QoS 0(至多一次)消息发送后,不保证接收方一定收到,也不要求接收方确认。
9221
+ QoS 1(至少一次)消息至少被接收方成功接收一次,但可能重复。
9222
+ QoS 2(恰好一次)消息确保被接收方接收且仅接收一次,无重复。
8972
9223
  :type Qos: int
8973
9224
  :param _Retain: 是否为保留消息,默认为 false,且仅支持发布到主题的消息设置为 true
8974
9225
  :type Retain: bool
@@ -8983,7 +9234,7 @@ class PublishMessageRequest(AbstractModel):
8983
9234
 
8984
9235
  @property
8985
9236
  def InstanceId(self):
8986
- """实例ID
9237
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8987
9238
  :rtype: str
8988
9239
  """
8989
9240
  return self._InstanceId
@@ -8994,7 +9245,7 @@ class PublishMessageRequest(AbstractModel):
8994
9245
 
8995
9246
  @property
8996
9247
  def Payload(self):
8997
- """消息 payload,需要按 encoding 指定的编码方式进行编码
9248
+ """消息负载 Payload,是消息的实际内容,需要按 encoding 指定的编码方式进行编码
8998
9249
  :rtype: str
8999
9250
  """
9000
9251
  return self._Payload
@@ -9039,6 +9290,9 @@ class PublishMessageRequest(AbstractModel):
9039
9290
  @property
9040
9291
  def Qos(self):
9041
9292
  """消息的服务质量等级,默认为 1
9293
+ QoS 0(至多一次)消息发送后,不保证接收方一定收到,也不要求接收方确认。
9294
+ QoS 1(至少一次)消息至少被接收方成功接收一次,但可能重复。
9295
+ QoS 2(恰好一次)消息确保被接收方接收且仅接收一次,无重复。
9042
9296
  :rtype: int
9043
9297
  """
9044
9298
  return self._Qos
@@ -9112,19 +9366,17 @@ class RegisterCaCertificateRequest(AbstractModel):
9112
9366
 
9113
9367
  def __init__(self):
9114
9368
  r"""
9115
- :param _InstanceId: 集群id
9369
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9116
9370
  :type InstanceId: str
9117
- :param _CaCertificate: CA证书
9371
+ :param _CaCertificate: CA证书内容,自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA
9118
9372
  :type CaCertificate: str
9119
- :param _VerificationCertificate: 验证证书
9373
+ :param _VerificationCertificate: 验证证书内容,可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节
9120
9374
  :type VerificationCertificate: str
9121
- :param _Format: 证书格式,不传默认PEM格式
9375
+ :param _Format: 证书格式,不传默认PEM格式,当前仅支持PEM格式
9122
9376
  :type Format: str
9123
9377
  :param _Status: 证书状态,不传默认ACTIVE状态
9124
- ACTIVE,//激活
9125
- INACTIVE,//未激活
9126
- REVOKED,//吊销
9127
- PENDING_ACTIVATION,//注册待激活
9378
+ ACTIVE:激活
9379
+ INACTIVE:未激活
9128
9380
  :type Status: str
9129
9381
  """
9130
9382
  self._InstanceId = None
@@ -9135,7 +9387,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9135
9387
 
9136
9388
  @property
9137
9389
  def InstanceId(self):
9138
- """集群id
9390
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9139
9391
  :rtype: str
9140
9392
  """
9141
9393
  return self._InstanceId
@@ -9146,7 +9398,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9146
9398
 
9147
9399
  @property
9148
9400
  def CaCertificate(self):
9149
- """CA证书
9401
+ """CA证书内容,自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA
9150
9402
  :rtype: str
9151
9403
  """
9152
9404
  return self._CaCertificate
@@ -9157,7 +9409,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9157
9409
 
9158
9410
  @property
9159
9411
  def VerificationCertificate(self):
9160
- """验证证书
9412
+ """验证证书内容,可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节
9161
9413
  :rtype: str
9162
9414
  """
9163
9415
  return self._VerificationCertificate
@@ -9168,7 +9420,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9168
9420
 
9169
9421
  @property
9170
9422
  def Format(self):
9171
- """证书格式,不传默认PEM格式
9423
+ """证书格式,不传默认PEM格式,当前仅支持PEM格式
9172
9424
  :rtype: str
9173
9425
  """
9174
9426
  return self._Format
@@ -9180,10 +9432,8 @@ class RegisterCaCertificateRequest(AbstractModel):
9180
9432
  @property
9181
9433
  def Status(self):
9182
9434
  """证书状态,不传默认ACTIVE状态
9183
- ACTIVE,//激活
9184
- INACTIVE,//未激活
9185
- REVOKED,//吊销
9186
- PENDING_ACTIVATION,//注册待激活
9435
+ ACTIVE:激活
9436
+ INACTIVE:未激活
9187
9437
  :rtype: str
9188
9438
  """
9189
9439
  return self._Status
@@ -9216,11 +9466,39 @@ class RegisterCaCertificateResponse(AbstractModel):
9216
9466
 
9217
9467
  def __init__(self):
9218
9468
  r"""
9469
+ :param _InstanceId: mqtt实例ID
9470
+ :type InstanceId: str
9471
+ :param _CaSn: ca 证书的序列号
9472
+ :type CaSn: str
9219
9473
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9220
9474
  :type RequestId: str
9221
9475
  """
9476
+ self._InstanceId = None
9477
+ self._CaSn = None
9222
9478
  self._RequestId = None
9223
9479
 
9480
+ @property
9481
+ def InstanceId(self):
9482
+ """mqtt实例ID
9483
+ :rtype: str
9484
+ """
9485
+ return self._InstanceId
9486
+
9487
+ @InstanceId.setter
9488
+ def InstanceId(self, InstanceId):
9489
+ self._InstanceId = InstanceId
9490
+
9491
+ @property
9492
+ def CaSn(self):
9493
+ """ca 证书的序列号
9494
+ :rtype: str
9495
+ """
9496
+ return self._CaSn
9497
+
9498
+ @CaSn.setter
9499
+ def CaSn(self, CaSn):
9500
+ self._CaSn = CaSn
9501
+
9224
9502
  @property
9225
9503
  def RequestId(self):
9226
9504
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -9234,6 +9512,8 @@ class RegisterCaCertificateResponse(AbstractModel):
9234
9512
 
9235
9513
 
9236
9514
  def _deserialize(self, params):
9515
+ self._InstanceId = params.get("InstanceId")
9516
+ self._CaSn = params.get("CaSn")
9237
9517
  self._RequestId = params.get("RequestId")
9238
9518
 
9239
9519
 
@@ -9244,17 +9524,21 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9244
9524
 
9245
9525
  def __init__(self):
9246
9526
  r"""
9247
- :param _InstanceId: 集群id
9527
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9248
9528
  :type InstanceId: str
9249
- :param _DeviceCertificate: 设备证书
9529
+ :param _DeviceCertificate: 设备证书内容,可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成
9250
9530
  :type DeviceCertificate: str
9251
9531
  :param _CaSn: 关联的CA证书SN
9252
9532
  :type CaSn: str
9253
- :param _ClientId: 客户端ID
9533
+ :param _ClientId: 客户端ID,需要关联该证书的客户端ID。根据实际业务使用填写
9254
9534
  :type ClientId: str
9255
- :param _Format: 证书格式
9535
+ :param _Format: 证书格式,默认为PEM,当前仅支持PEM格式
9256
9536
  :type Format: str
9257
- :param _Status: ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
9537
+ :param _Status: 客户端证书状态,默认激活状态(ACTIVE
9538
+ ACTIVE:激活
9539
+ INACTIVE:未激活
9540
+ REVOKED:吊销
9541
+ PENDING_ACTIVATION:注册待激活
9258
9542
  :type Status: str
9259
9543
  """
9260
9544
  self._InstanceId = None
@@ -9266,7 +9550,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9266
9550
 
9267
9551
  @property
9268
9552
  def InstanceId(self):
9269
- """集群id
9553
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9270
9554
  :rtype: str
9271
9555
  """
9272
9556
  return self._InstanceId
@@ -9277,7 +9561,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9277
9561
 
9278
9562
  @property
9279
9563
  def DeviceCertificate(self):
9280
- """设备证书
9564
+ """设备证书内容,可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成
9281
9565
  :rtype: str
9282
9566
  """
9283
9567
  return self._DeviceCertificate
@@ -9299,7 +9583,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9299
9583
 
9300
9584
  @property
9301
9585
  def ClientId(self):
9302
- """客户端ID
9586
+ """客户端ID,需要关联该证书的客户端ID。根据实际业务使用填写
9303
9587
  :rtype: str
9304
9588
  """
9305
9589
  return self._ClientId
@@ -9310,7 +9594,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9310
9594
 
9311
9595
  @property
9312
9596
  def Format(self):
9313
- """证书格式
9597
+ """证书格式,默认为PEM,当前仅支持PEM格式
9314
9598
  :rtype: str
9315
9599
  """
9316
9600
  return self._Format
@@ -9321,7 +9605,11 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9321
9605
 
9322
9606
  @property
9323
9607
  def Status(self):
9324
- """ ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
9608
+ """ 客户端证书状态,默认激活状态(ACTIVE
9609
+ ACTIVE:激活
9610
+ INACTIVE:未激活
9611
+ REVOKED:吊销
9612
+ PENDING_ACTIVATION:注册待激活
9325
9613
  :rtype: str
9326
9614
  """
9327
9615
  return self._Status
@@ -9355,11 +9643,53 @@ class RegisterDeviceCertificateResponse(AbstractModel):
9355
9643
 
9356
9644
  def __init__(self):
9357
9645
  r"""
9646
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9647
+ :type InstanceId: str
9648
+ :param _CaSn: 关联的CA证书SN
9649
+ :type CaSn: str
9650
+ :param _DeviceCertificateSn: 设备证书的SN
9651
+ :type DeviceCertificateSn: str
9358
9652
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9359
9653
  :type RequestId: str
9360
9654
  """
9655
+ self._InstanceId = None
9656
+ self._CaSn = None
9657
+ self._DeviceCertificateSn = None
9361
9658
  self._RequestId = None
9362
9659
 
9660
+ @property
9661
+ def InstanceId(self):
9662
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9663
+ :rtype: str
9664
+ """
9665
+ return self._InstanceId
9666
+
9667
+ @InstanceId.setter
9668
+ def InstanceId(self, InstanceId):
9669
+ self._InstanceId = InstanceId
9670
+
9671
+ @property
9672
+ def CaSn(self):
9673
+ """关联的CA证书SN
9674
+ :rtype: str
9675
+ """
9676
+ return self._CaSn
9677
+
9678
+ @CaSn.setter
9679
+ def CaSn(self, CaSn):
9680
+ self._CaSn = CaSn
9681
+
9682
+ @property
9683
+ def DeviceCertificateSn(self):
9684
+ """设备证书的SN
9685
+ :rtype: str
9686
+ """
9687
+ return self._DeviceCertificateSn
9688
+
9689
+ @DeviceCertificateSn.setter
9690
+ def DeviceCertificateSn(self, DeviceCertificateSn):
9691
+ self._DeviceCertificateSn = DeviceCertificateSn
9692
+
9363
9693
  @property
9364
9694
  def RequestId(self):
9365
9695
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -9373,6 +9703,9 @@ class RegisterDeviceCertificateResponse(AbstractModel):
9373
9703
 
9374
9704
 
9375
9705
  def _deserialize(self, params):
9706
+ self._InstanceId = params.get("InstanceId")
9707
+ self._CaSn = params.get("CaSn")
9708
+ self._DeviceCertificateSn = params.get("DeviceCertificateSn")
9376
9709
  self._RequestId = params.get("RequestId")
9377
9710
 
9378
9711
 
@@ -9564,7 +9897,7 @@ class UpdateAuthorizationPolicyPriorityRequest(AbstractModel):
9564
9897
 
9565
9898
  def __init__(self):
9566
9899
  r"""
9567
- :param _InstanceId: 实例ID
9900
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9568
9901
  :type InstanceId: str
9569
9902
  :param _Priorities: 策略ID和优先级
9570
9903
  :type Priorities: list of AuthorizationPolicyPriority
@@ -9574,7 +9907,7 @@ class UpdateAuthorizationPolicyPriorityRequest(AbstractModel):
9574
9907
 
9575
9908
  @property
9576
9909
  def InstanceId(self):
9577
- """实例ID
9910
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9578
9911
  :rtype: str
9579
9912
  """
9580
9913
  return self._InstanceId