tencentcloud-sdk-python 3.0.1347__py2.py3-none-any.whl → 3.0.1349__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 (62) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/bh/v20230418/models.py +61 -23
  3. tencentcloud/cam/v20190116/models.py +2 -2
  4. tencentcloud/captcha/v20190722/models.py +15 -30
  5. tencentcloud/cbs/v20170312/models.py +0 -4
  6. tencentcloud/ccc/v20200210/errorcodes.py +3 -0
  7. tencentcloud/ccc/v20200210/models.py +159 -2
  8. tencentcloud/cdwdoris/v20211228/models.py +300 -0
  9. tencentcloud/cdwpg/v20201230/models.py +98 -86
  10. tencentcloud/chc/v20230418/models.py +0 -30
  11. tencentcloud/clb/v20180317/models.py +48 -18
  12. tencentcloud/dbbrain/v20210527/models.py +0 -8
  13. tencentcloud/dbdc/v20201029/models.py +0 -16
  14. tencentcloud/dcdb/v20180411/errorcodes.py +3 -0
  15. tencentcloud/dcdb/v20180411/models.py +0 -64
  16. tencentcloud/dlc/v20210125/models.py +256 -16
  17. tencentcloud/emr/v20190103/models.py +15 -54
  18. tencentcloud/es/v20180416/errorcodes.py +3 -0
  19. tencentcloud/ess/v20201111/models.py +12 -12
  20. tencentcloud/essbasic/v20210526/essbasic_client.py +2 -2
  21. tencentcloud/essbasic/v20210526/models.py +10 -10
  22. tencentcloud/gs/v20191118/models.py +4 -58
  23. tencentcloud/hai/v20230812/models.py +0 -96
  24. tencentcloud/hunyuan/v20230901/models.py +6 -4
  25. tencentcloud/iotexplorer/v20190423/iotexplorer_client.py +1 -1
  26. tencentcloud/iotvideo/v20191126/models.py +0 -4
  27. tencentcloud/iotvideo/v20201215/models.py +17 -0
  28. tencentcloud/iotvideo/v20211125/iotvideo_client.py +1 -1
  29. tencentcloud/iotvideoindustry/v20201201/models.py +0 -30
  30. tencentcloud/lcic/v20220817/lcic_client.py +1 -1
  31. tencentcloud/lcic/v20220817/models.py +56 -68
  32. tencentcloud/live/v20180801/models.py +8 -24
  33. tencentcloud/lkeap/v20240522/lkeap_client.py +6 -0
  34. tencentcloud/mariadb/v20170312/models.py +4 -76
  35. tencentcloud/monitor/v20180724/models.py +95 -14
  36. tencentcloud/mps/v20190612/models.py +260 -0
  37. tencentcloud/mqtt/v20240516/models.py +402 -284
  38. tencentcloud/mqtt/v20240516/mqtt_client.py +2 -2
  39. tencentcloud/organization/v20210331/models.py +30 -0
  40. tencentcloud/privatedns/v20201028/models.py +0 -22
  41. tencentcloud/taf/v20200210/models.py +270 -0
  42. tencentcloud/taf/v20200210/taf_client.py +23 -0
  43. tencentcloud/tbaas/v20180416/models.py +0 -58
  44. tencentcloud/tcb/v20180608/errorcodes.py +3 -0
  45. tencentcloud/tcr/v20190924/models.py +30 -154
  46. tencentcloud/tdmq/v20200217/models.py +0 -16
  47. tencentcloud/thpc/v20230321/models.py +34 -0
  48. tencentcloud/tke/v20180525/models.py +692 -622
  49. tencentcloud/tke/v20180525/tke_client.py +23 -0
  50. tencentcloud/trocket/v20230308/models.py +0 -24
  51. tencentcloud/tsf/v20180326/models.py +252 -196
  52. tencentcloud/vcube/v20220410/models.py +51 -158
  53. tencentcloud/vcube/v20220410/vcube_client.py +2 -2
  54. tencentcloud/vod/v20180717/errorcodes.py +3 -0
  55. tencentcloud/vod/v20180717/models.py +28 -260
  56. tencentcloud/vpc/v20170312/models.py +135 -0
  57. tencentcloud/wedata/v20210820/models.py +17 -0
  58. {tencentcloud_sdk_python-3.0.1347.dist-info → tencentcloud_sdk_python-3.0.1349.dist-info}/METADATA +1 -1
  59. {tencentcloud_sdk_python-3.0.1347.dist-info → tencentcloud_sdk_python-3.0.1349.dist-info}/RECORD +62 -62
  60. {tencentcloud_sdk_python-3.0.1347.dist-info → tencentcloud_sdk_python-3.0.1349.dist-info}/LICENSE +0 -0
  61. {tencentcloud_sdk_python-3.0.1347.dist-info → tencentcloud_sdk_python-3.0.1349.dist-info}/WHEEL +0 -0
  62. {tencentcloud_sdk_python-3.0.1347.dist-info → tencentcloud_sdk_python-3.0.1349.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
@@ -1987,11 +2011,11 @@ class CreateTopicRequest(AbstractModel):
1987
2011
 
1988
2012
  def __init__(self):
1989
2013
  r"""
1990
- :param _InstanceId: 实例ID
2014
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1991
2015
  :type InstanceId: str
1992
- :param _Topic: 主题
2016
+ :param _Topic: 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
1993
2017
  :type Topic: str
1994
- :param _Remark: 备注
2018
+ :param _Remark: 备注,最长 128 字符
1995
2019
  :type Remark: str
1996
2020
  """
1997
2021
  self._InstanceId = None
@@ -2000,7 +2024,7 @@ class CreateTopicRequest(AbstractModel):
2000
2024
 
2001
2025
  @property
2002
2026
  def InstanceId(self):
2003
- """实例ID
2027
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2004
2028
  :rtype: str
2005
2029
  """
2006
2030
  return self._InstanceId
@@ -2011,7 +2035,7 @@ class CreateTopicRequest(AbstractModel):
2011
2035
 
2012
2036
  @property
2013
2037
  def Topic(self):
2014
- """主题
2038
+ """主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
2015
2039
  :rtype: str
2016
2040
  """
2017
2041
  return self._Topic
@@ -2022,7 +2046,7 @@ class CreateTopicRequest(AbstractModel):
2022
2046
 
2023
2047
  @property
2024
2048
  def Remark(self):
2025
- """备注
2049
+ """备注,最长 128 字符
2026
2050
  :rtype: str
2027
2051
  """
2028
2052
  return self._Remark
@@ -2111,13 +2135,13 @@ class CreateUserRequest(AbstractModel):
2111
2135
 
2112
2136
  def __init__(self):
2113
2137
  r"""
2114
- :param _InstanceId: 实例ID
2138
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2115
2139
  :type InstanceId: str
2116
- :param _Username: 用户名
2140
+ :param _Username: 用户名,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 32 个字符
2117
2141
  :type Username: str
2118
- :param _Password: 密码,该字段为空时候则后端会默认生成
2142
+ :param _Password: 密码,该字段为空时候则后端会默认生成。用户自定义密码时,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 64 个字符。
2119
2143
  :type Password: str
2120
- :param _Remark: 备注
2144
+ :param _Remark: 备注,长度不超过128个字符。
2121
2145
  :type Remark: str
2122
2146
  """
2123
2147
  self._InstanceId = None
@@ -2127,7 +2151,7 @@ class CreateUserRequest(AbstractModel):
2127
2151
 
2128
2152
  @property
2129
2153
  def InstanceId(self):
2130
- """实例ID
2154
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2131
2155
  :rtype: str
2132
2156
  """
2133
2157
  return self._InstanceId
@@ -2138,7 +2162,7 @@ class CreateUserRequest(AbstractModel):
2138
2162
 
2139
2163
  @property
2140
2164
  def Username(self):
2141
- """用户名
2165
+ """用户名,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 32 个字符
2142
2166
  :rtype: str
2143
2167
  """
2144
2168
  return self._Username
@@ -2149,7 +2173,7 @@ class CreateUserRequest(AbstractModel):
2149
2173
 
2150
2174
  @property
2151
2175
  def Password(self):
2152
- """密码,该字段为空时候则后端会默认生成
2176
+ """密码,该字段为空时候则后端会默认生成。用户自定义密码时,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 64 个字符。
2153
2177
  :rtype: str
2154
2178
  """
2155
2179
  return self._Password
@@ -2160,7 +2184,7 @@ class CreateUserRequest(AbstractModel):
2160
2184
 
2161
2185
  @property
2162
2186
  def Remark(self):
2163
- """备注
2187
+ """备注,长度不超过128个字符。
2164
2188
  :rtype: str
2165
2189
  """
2166
2190
  return self._Remark
@@ -2220,9 +2244,9 @@ class DeactivateCaCertificateRequest(AbstractModel):
2220
2244
 
2221
2245
  def __init__(self):
2222
2246
  r"""
2223
- :param _InstanceId: 集群id
2247
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2224
2248
  :type InstanceId: str
2225
- :param _CaSn: 证书序列号
2249
+ :param _CaSn: 证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2226
2250
  :type CaSn: str
2227
2251
  """
2228
2252
  self._InstanceId = None
@@ -2230,7 +2254,7 @@ class DeactivateCaCertificateRequest(AbstractModel):
2230
2254
 
2231
2255
  @property
2232
2256
  def InstanceId(self):
2233
- """集群id
2257
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2234
2258
  :rtype: str
2235
2259
  """
2236
2260
  return self._InstanceId
@@ -2241,7 +2265,7 @@ class DeactivateCaCertificateRequest(AbstractModel):
2241
2265
 
2242
2266
  @property
2243
2267
  def CaSn(self):
2244
- """证书序列号
2268
+ """证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2245
2269
  :rtype: str
2246
2270
  """
2247
2271
  return self._CaSn
@@ -2299,9 +2323,9 @@ class DeactivateDeviceCertificateRequest(AbstractModel):
2299
2323
 
2300
2324
  def __init__(self):
2301
2325
  r"""
2302
- :param _InstanceId: 集群id
2326
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2303
2327
  :type InstanceId: str
2304
- :param _DeviceCertificateSn: 设备证书序列号
2328
+ :param _DeviceCertificateSn: 设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。
2305
2329
  :type DeviceCertificateSn: str
2306
2330
  """
2307
2331
  self._InstanceId = None
@@ -2309,7 +2333,7 @@ class DeactivateDeviceCertificateRequest(AbstractModel):
2309
2333
 
2310
2334
  @property
2311
2335
  def InstanceId(self):
2312
- """集群id
2336
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2313
2337
  :rtype: str
2314
2338
  """
2315
2339
  return self._InstanceId
@@ -2320,7 +2344,7 @@ class DeactivateDeviceCertificateRequest(AbstractModel):
2320
2344
 
2321
2345
  @property
2322
2346
  def DeviceCertificateSn(self):
2323
- """设备证书序列号
2347
+ """设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。
2324
2348
  :rtype: str
2325
2349
  """
2326
2350
  return self._DeviceCertificateSn
@@ -2378,12 +2402,12 @@ class DeleteAuthenticatorRequest(AbstractModel):
2378
2402
 
2379
2403
  def __init__(self):
2380
2404
  r"""
2381
- :param _InstanceId: 实例ID
2405
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2382
2406
  :type InstanceId: str
2383
2407
  :param _Type: 认证器类型:
2384
2408
  JWT:JWT认证器
2385
2409
  JWKS:JWKS认证器
2386
- BYOC:一端一证认证器
2410
+ HTTP:HTTP认证器
2387
2411
  :type Type: str
2388
2412
  """
2389
2413
  self._InstanceId = None
@@ -2391,7 +2415,7 @@ BYOC:一端一证认证器
2391
2415
 
2392
2416
  @property
2393
2417
  def InstanceId(self):
2394
- """实例ID
2418
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2395
2419
  :rtype: str
2396
2420
  """
2397
2421
  return self._InstanceId
@@ -2405,7 +2429,7 @@ BYOC:一端一证认证器
2405
2429
  """认证器类型:
2406
2430
  JWT:JWT认证器
2407
2431
  JWKS:JWKS认证器
2408
- BYOC:一端一证认证器
2432
+ HTTP:HTTP认证器
2409
2433
  :rtype: str
2410
2434
  """
2411
2435
  return self._Type
@@ -2463,9 +2487,9 @@ class DeleteAuthorizationPolicyRequest(AbstractModel):
2463
2487
 
2464
2488
  def __init__(self):
2465
2489
  r"""
2466
- :param _InstanceId: 实例ID
2490
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2467
2491
  :type InstanceId: str
2468
- :param _Id: 策略规则id
2492
+ :param _Id: 授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
2469
2493
  :type Id: int
2470
2494
  """
2471
2495
  self._InstanceId = None
@@ -2473,7 +2497,7 @@ class DeleteAuthorizationPolicyRequest(AbstractModel):
2473
2497
 
2474
2498
  @property
2475
2499
  def InstanceId(self):
2476
- """实例ID
2500
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2477
2501
  :rtype: str
2478
2502
  """
2479
2503
  return self._InstanceId
@@ -2484,7 +2508,7 @@ class DeleteAuthorizationPolicyRequest(AbstractModel):
2484
2508
 
2485
2509
  @property
2486
2510
  def Id(self):
2487
- """策略规则id
2511
+ """授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
2488
2512
  :rtype: int
2489
2513
  """
2490
2514
  return self._Id
@@ -2542,9 +2566,9 @@ class DeleteCaCertificateRequest(AbstractModel):
2542
2566
 
2543
2567
  def __init__(self):
2544
2568
  r"""
2545
- :param _InstanceId: 集群id
2569
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2546
2570
  :type InstanceId: str
2547
- :param _CaSn: 证书序列号
2571
+ :param _CaSn: CA证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2548
2572
  :type CaSn: str
2549
2573
  """
2550
2574
  self._InstanceId = None
@@ -2552,7 +2576,7 @@ class DeleteCaCertificateRequest(AbstractModel):
2552
2576
 
2553
2577
  @property
2554
2578
  def InstanceId(self):
2555
- """集群id
2579
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2556
2580
  :rtype: str
2557
2581
  """
2558
2582
  return self._InstanceId
@@ -2563,7 +2587,7 @@ class DeleteCaCertificateRequest(AbstractModel):
2563
2587
 
2564
2588
  @property
2565
2589
  def CaSn(self):
2566
- """证书序列号
2590
+ """CA证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
2567
2591
  :rtype: str
2568
2592
  """
2569
2593
  return self._CaSn
@@ -2700,14 +2724,14 @@ class DeleteInsPublicEndpointRequest(AbstractModel):
2700
2724
 
2701
2725
  def __init__(self):
2702
2726
  r"""
2703
- :param _InstanceId: 实例ID
2727
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2704
2728
  :type InstanceId: str
2705
2729
  """
2706
2730
  self._InstanceId = None
2707
2731
 
2708
2732
  @property
2709
2733
  def InstanceId(self):
2710
- """实例ID
2734
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2711
2735
  :rtype: str
2712
2736
  """
2713
2737
  return self._InstanceId
@@ -2764,14 +2788,14 @@ class DeleteInstanceRequest(AbstractModel):
2764
2788
 
2765
2789
  def __init__(self):
2766
2790
  r"""
2767
- :param _InstanceId: 实例ID
2791
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2768
2792
  :type InstanceId: str
2769
2793
  """
2770
2794
  self._InstanceId = None
2771
2795
 
2772
2796
  @property
2773
2797
  def InstanceId(self):
2774
- """实例ID
2798
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2775
2799
  :rtype: str
2776
2800
  """
2777
2801
  return self._InstanceId
@@ -2986,9 +3010,12 @@ class DescribeAuthenticatorRequest(AbstractModel):
2986
3010
 
2987
3011
  def __init__(self):
2988
3012
  r"""
2989
- :param _InstanceId: 实例ID
3013
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2990
3014
  :type InstanceId: str
2991
- :param _Type: 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
3015
+ :param _Type: 认证器类型:
3016
+ JWT:JWT认证器
3017
+ JWKS:JWKS认证器
3018
+ HTTP:HTTP认证器
2992
3019
  :type Type: str
2993
3020
  """
2994
3021
  self._InstanceId = None
@@ -2996,7 +3023,7 @@ class DescribeAuthenticatorRequest(AbstractModel):
2996
3023
 
2997
3024
  @property
2998
3025
  def InstanceId(self):
2999
- """实例ID
3026
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3000
3027
  :rtype: str
3001
3028
  """
3002
3029
  return self._InstanceId
@@ -3007,7 +3034,10 @@ class DescribeAuthenticatorRequest(AbstractModel):
3007
3034
 
3008
3035
  @property
3009
3036
  def Type(self):
3010
- """认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
3037
+ """认证器类型:
3038
+ JWT:JWT认证器
3039
+ JWKS:JWKS认证器
3040
+ HTTP:HTTP认证器
3011
3041
  :rtype: str
3012
3042
  """
3013
3043
  return self._Type
@@ -3085,14 +3115,14 @@ class DescribeAuthorizationPoliciesRequest(AbstractModel):
3085
3115
 
3086
3116
  def __init__(self):
3087
3117
  r"""
3088
- :param _InstanceId: 集群ID
3118
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3089
3119
  :type InstanceId: str
3090
3120
  """
3091
3121
  self._InstanceId = None
3092
3122
 
3093
3123
  @property
3094
3124
  def InstanceId(self):
3095
- """集群ID
3125
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3096
3126
  :rtype: str
3097
3127
  """
3098
3128
  return self._InstanceId
@@ -3169,9 +3199,9 @@ class DescribeCaCertificateRequest(AbstractModel):
3169
3199
 
3170
3200
  def __init__(self):
3171
3201
  r"""
3172
- :param _CaSn: ca证书sn
3202
+ :param _CaSn: CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
3173
3203
  :type CaSn: str
3174
- :param _InstanceId: 集群id
3204
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3175
3205
  :type InstanceId: str
3176
3206
  """
3177
3207
  self._CaSn = None
@@ -3179,7 +3209,7 @@ class DescribeCaCertificateRequest(AbstractModel):
3179
3209
 
3180
3210
  @property
3181
3211
  def CaSn(self):
3182
- """ca证书sn
3212
+ """CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
3183
3213
  :rtype: str
3184
3214
  """
3185
3215
  return self._CaSn
@@ -3190,7 +3220,7 @@ class DescribeCaCertificateRequest(AbstractModel):
3190
3220
 
3191
3221
  @property
3192
3222
  def InstanceId(self):
3193
- """集群id
3223
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3194
3224
  :rtype: str
3195
3225
  """
3196
3226
  return self._InstanceId
@@ -3220,29 +3250,32 @@ class DescribeCaCertificateResponse(AbstractModel):
3220
3250
 
3221
3251
  def __init__(self):
3222
3252
  r"""
3223
- :param _CreatedTime: 创建时间
3253
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
3224
3254
  :type CreatedTime: int
3225
- :param _UpdateTime: 上次更新时间
3255
+ :param _UpdateTime: 上次更新时间,毫秒级时间戳 。
3226
3256
  :type UpdateTime: int
3227
- :param _NotAfterTime: 失效日期
3257
+ :param _NotAfterTime: 失效日期,毫秒级时间戳 。
3228
3258
  :type NotAfterTime: int
3229
- :param _LastActivationTime: 上次激活时间
3259
+ :param _LastActivationTime: 上次激活时间,毫秒级时间戳 。
3230
3260
  :type LastActivationTime: int
3231
- :param _LastInactivationTime: 上次吊销时间
3261
+ :param _LastInactivationTime: 上次吊销时间,毫秒级时间戳 。
3232
3262
  :type LastInactivationTime: int
3233
- :param _Status: 证书状态
3263
+ :param _Status: CA证书状态
3264
+ ACTIVE:激活
3265
+ INACTIVE:未激活
3266
+
3234
3267
  :type Status: str
3235
3268
  :param _CaSn: 证书序列号
3236
3269
  :type CaSn: str
3237
- :param _CaCn: common name
3270
+ :param _CaCn: 证书的CN(Common Name),证书中用于标识主体的名称,通常是域名或组织名称
3238
3271
  :type CaCn: str
3239
3272
  :param _CaCertificate: 证书内容
3240
3273
  :type CaCertificate: str
3241
- :param _Format: 证书格式
3274
+ :param _Format: 证书格式,当仅支持PEM格式
3242
3275
  :type Format: str
3243
3276
  :param _CaIssuerCn: Ca证书颁发者CN
3244
3277
  :type CaIssuerCn: str
3245
- :param _NotBeforeTime: 生效开始时间
3278
+ :param _NotBeforeTime: 生效开始时间,毫秒级时间戳 。
3246
3279
  :type NotBeforeTime: int
3247
3280
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3248
3281
  :type RequestId: str
@@ -3263,7 +3296,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3263
3296
 
3264
3297
  @property
3265
3298
  def CreatedTime(self):
3266
- """创建时间
3299
+ """创建时间,毫秒级时间戳 。
3267
3300
  :rtype: int
3268
3301
  """
3269
3302
  return self._CreatedTime
@@ -3274,7 +3307,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3274
3307
 
3275
3308
  @property
3276
3309
  def UpdateTime(self):
3277
- """上次更新时间
3310
+ """上次更新时间,毫秒级时间戳 。
3278
3311
  :rtype: int
3279
3312
  """
3280
3313
  return self._UpdateTime
@@ -3285,7 +3318,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3285
3318
 
3286
3319
  @property
3287
3320
  def NotAfterTime(self):
3288
- """失效日期
3321
+ """失效日期,毫秒级时间戳 。
3289
3322
  :rtype: int
3290
3323
  """
3291
3324
  return self._NotAfterTime
@@ -3296,7 +3329,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3296
3329
 
3297
3330
  @property
3298
3331
  def LastActivationTime(self):
3299
- """上次激活时间
3332
+ """上次激活时间,毫秒级时间戳 。
3300
3333
  :rtype: int
3301
3334
  """
3302
3335
  return self._LastActivationTime
@@ -3307,7 +3340,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3307
3340
 
3308
3341
  @property
3309
3342
  def LastInactivationTime(self):
3310
- """上次吊销时间
3343
+ """上次吊销时间,毫秒级时间戳 。
3311
3344
  :rtype: int
3312
3345
  """
3313
3346
  return self._LastInactivationTime
@@ -3318,7 +3351,10 @@ class DescribeCaCertificateResponse(AbstractModel):
3318
3351
 
3319
3352
  @property
3320
3353
  def Status(self):
3321
- """证书状态
3354
+ """CA证书状态
3355
+ ACTIVE:激活
3356
+ INACTIVE:未激活
3357
+
3322
3358
  :rtype: str
3323
3359
  """
3324
3360
  return self._Status
@@ -3340,7 +3376,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3340
3376
 
3341
3377
  @property
3342
3378
  def CaCn(self):
3343
- """common name
3379
+ """证书的CN(Common Name),证书中用于标识主体的名称,通常是域名或组织名称
3344
3380
  :rtype: str
3345
3381
  """
3346
3382
  return self._CaCn
@@ -3362,7 +3398,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3362
3398
 
3363
3399
  @property
3364
3400
  def Format(self):
3365
- """证书格式
3401
+ """证书格式,当仅支持PEM格式
3366
3402
  :rtype: str
3367
3403
  """
3368
3404
  return self._Format
@@ -3384,7 +3420,7 @@ class DescribeCaCertificateResponse(AbstractModel):
3384
3420
 
3385
3421
  @property
3386
3422
  def NotBeforeTime(self):
3387
- """生效开始时间
3423
+ """生效开始时间,毫秒级时间戳 。
3388
3424
  :rtype: int
3389
3425
  """
3390
3426
  return self._NotBeforeTime
@@ -3428,14 +3464,14 @@ class DescribeCaCertificatesRequest(AbstractModel):
3428
3464
 
3429
3465
  def __init__(self):
3430
3466
  r"""
3431
- :param _InstanceId: 集群ID
3467
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3432
3468
  :type InstanceId: str
3433
3469
  """
3434
3470
  self._InstanceId = None
3435
3471
 
3436
3472
  @property
3437
3473
  def InstanceId(self):
3438
- """集群ID
3474
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3439
3475
  :rtype: str
3440
3476
  """
3441
3477
  return self._InstanceId
@@ -3512,9 +3548,9 @@ class DescribeClientListRequest(AbstractModel):
3512
3548
 
3513
3549
  def __init__(self):
3514
3550
  r"""
3515
- :param _InstanceId: 实例ID
3551
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3516
3552
  :type InstanceId: str
3517
- :param _ClientId: 客户端名
3553
+ :param _ClientId: 客户端ID
3518
3554
  :type ClientId: str
3519
3555
  :param _Number: 客户端数量限制,最大1024,默认1024
3520
3556
  :type Number: str
@@ -3525,7 +3561,7 @@ class DescribeClientListRequest(AbstractModel):
3525
3561
 
3526
3562
  @property
3527
3563
  def InstanceId(self):
3528
- """实例ID
3564
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3529
3565
  :rtype: str
3530
3566
  """
3531
3567
  return self._InstanceId
@@ -3536,7 +3572,7 @@ class DescribeClientListRequest(AbstractModel):
3536
3572
 
3537
3573
  @property
3538
3574
  def ClientId(self):
3539
- """客户端名
3575
+ """客户端ID
3540
3576
  :rtype: str
3541
3577
  """
3542
3578
  return self._ClientId
@@ -3626,9 +3662,9 @@ class DescribeDeviceCertificateRequest(AbstractModel):
3626
3662
 
3627
3663
  def __init__(self):
3628
3664
  r"""
3629
- :param _DeviceCertificateSn: 设备证书sn
3665
+ :param _DeviceCertificateSn: 设备证书的SN序列号,用于唯一标识一个设备证书。
3630
3666
  :type DeviceCertificateSn: str
3631
- :param _InstanceId: 集群id
3667
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3632
3668
  :type InstanceId: str
3633
3669
  """
3634
3670
  self._DeviceCertificateSn = None
@@ -3636,7 +3672,7 @@ class DescribeDeviceCertificateRequest(AbstractModel):
3636
3672
 
3637
3673
  @property
3638
3674
  def DeviceCertificateSn(self):
3639
- """设备证书sn
3675
+ """设备证书的SN序列号,用于唯一标识一个设备证书。
3640
3676
  :rtype: str
3641
3677
  """
3642
3678
  return self._DeviceCertificateSn
@@ -3647,7 +3683,7 @@ class DescribeDeviceCertificateRequest(AbstractModel):
3647
3683
 
3648
3684
  @property
3649
3685
  def InstanceId(self):
3650
- """集群id
3686
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3651
3687
  :rtype: str
3652
3688
  """
3653
3689
  return self._InstanceId
@@ -3677,17 +3713,21 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3677
3713
 
3678
3714
  def __init__(self):
3679
3715
  r"""
3680
- :param _CreatedTime: 创建时间
3716
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
3681
3717
  :type CreatedTime: int
3682
- :param _UpdateTime: 上次更新时间
3718
+ :param _UpdateTime: 上次更新时间,毫秒级时间戳 。
3683
3719
  :type UpdateTime: int
3684
- :param _NotAfterTime: 证书失效日期
3720
+ :param _NotAfterTime: 证书失效日期,毫秒级时间戳 。
3685
3721
  :type NotAfterTime: int
3686
- :param _LastActivationTime: 上次激活时间
3722
+ :param _LastActivationTime: 上次激活时间,毫秒级时间戳 。
3687
3723
  :type LastActivationTime: int
3688
- :param _LastInactivationTime: 上次取消激活时间
3724
+ :param _LastInactivationTime: 上次取消激活时间,毫秒级时间戳 。
3689
3725
  :type LastInactivationTime: int
3690
- :param _Status: 证书状态
3726
+ :param _Status: 设备证书的状态
3727
+ ACTIVE:激活
3728
+ INACTIVE:未激活
3729
+ REVOKED:吊销
3730
+ PENDING_ACTIVATION:注册待激活
3691
3731
  :type Status: str
3692
3732
  :param _CaSn: Ca证书序列号
3693
3733
  :type CaSn: str
@@ -3697,14 +3737,15 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3697
3737
  :type DeviceCertificate: str
3698
3738
  :param _DeviceCertificateCn: 设备证书common name
3699
3739
  :type DeviceCertificateCn: str
3700
- :param _Format: 证书格式
3740
+ :param _Format: 证书格式,当前仅支持PEM格式
3701
3741
  :type Format: str
3702
3742
  :param _ClientId: 客户端id
3703
3743
  :type ClientId: str
3704
- :param _CertificateSource: API, 手动注册
3705
- JITP 自动注册
3744
+ :param _CertificateSource: 证书来源
3745
+ API:手动注册
3746
+ JITP:自动注册
3706
3747
  :type CertificateSource: str
3707
- :param _NotBeforeTime: 证书生效开始时间
3748
+ :param _NotBeforeTime: 证书生效开始时间,毫秒级时间戳 。
3708
3749
  :type NotBeforeTime: int
3709
3750
  :param _OrganizationalUnit: 组织单位
3710
3751
  :type OrganizationalUnit: str
@@ -3730,7 +3771,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3730
3771
 
3731
3772
  @property
3732
3773
  def CreatedTime(self):
3733
- """创建时间
3774
+ """创建时间,毫秒级时间戳 。
3734
3775
  :rtype: int
3735
3776
  """
3736
3777
  return self._CreatedTime
@@ -3741,7 +3782,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3741
3782
 
3742
3783
  @property
3743
3784
  def UpdateTime(self):
3744
- """上次更新时间
3785
+ """上次更新时间,毫秒级时间戳 。
3745
3786
  :rtype: int
3746
3787
  """
3747
3788
  return self._UpdateTime
@@ -3752,7 +3793,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3752
3793
 
3753
3794
  @property
3754
3795
  def NotAfterTime(self):
3755
- """证书失效日期
3796
+ """证书失效日期,毫秒级时间戳 。
3756
3797
  :rtype: int
3757
3798
  """
3758
3799
  return self._NotAfterTime
@@ -3763,7 +3804,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3763
3804
 
3764
3805
  @property
3765
3806
  def LastActivationTime(self):
3766
- """上次激活时间
3807
+ """上次激活时间,毫秒级时间戳 。
3767
3808
  :rtype: int
3768
3809
  """
3769
3810
  return self._LastActivationTime
@@ -3774,7 +3815,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3774
3815
 
3775
3816
  @property
3776
3817
  def LastInactivationTime(self):
3777
- """上次取消激活时间
3818
+ """上次取消激活时间,毫秒级时间戳 。
3778
3819
  :rtype: int
3779
3820
  """
3780
3821
  return self._LastInactivationTime
@@ -3785,7 +3826,11 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3785
3826
 
3786
3827
  @property
3787
3828
  def Status(self):
3788
- """证书状态
3829
+ """设备证书的状态
3830
+ ACTIVE:激活
3831
+ INACTIVE:未激活
3832
+ REVOKED:吊销
3833
+ PENDING_ACTIVATION:注册待激活
3789
3834
  :rtype: str
3790
3835
  """
3791
3836
  return self._Status
@@ -3840,7 +3885,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3840
3885
 
3841
3886
  @property
3842
3887
  def Format(self):
3843
- """证书格式
3888
+ """证书格式,当前仅支持PEM格式
3844
3889
  :rtype: str
3845
3890
  """
3846
3891
  return self._Format
@@ -3862,8 +3907,9 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3862
3907
 
3863
3908
  @property
3864
3909
  def CertificateSource(self):
3865
- """ API, 手动注册
3866
- JITP 自动注册
3910
+ """证书来源
3911
+ API:手动注册
3912
+ JITP:自动注册
3867
3913
  :rtype: str
3868
3914
  """
3869
3915
  return self._CertificateSource
@@ -3874,7 +3920,7 @@ class DescribeDeviceCertificateResponse(AbstractModel):
3874
3920
 
3875
3921
  @property
3876
3922
  def NotBeforeTime(self):
3877
- """证书生效开始时间
3923
+ """证书生效开始时间,毫秒级时间戳 。
3878
3924
  :rtype: int
3879
3925
  """
3880
3926
  return self._NotBeforeTime
@@ -3932,15 +3978,25 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3932
3978
 
3933
3979
  def __init__(self):
3934
3980
  r"""
3935
- :param _InstanceId: 集群ID
3981
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3936
3982
  :type InstanceId: str
3937
- :param _Filters: 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
3983
+ :param _Filters: 支持搜索参数
3984
+ ClientId:客户端id,根据实际业务使用获取
3985
+ CaSn:所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
3986
+ DeviceCertificateSn:设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
3987
+ DeviceCertificateCn:设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
3988
+ OrganizationalUnit:证书OU
3989
+ NotAfterEnd:过期时间小于等于指定时间的证书
3990
+ NotAfterStart:过期时间大于等于指定时间的证书
3991
+ Status:设备证书状态 ACTIVE(激活); INACTIVE(未激活)REVOKED(吊销);PENDING_ACTIVATION(注册待激活)
3992
+
3938
3993
  :type Filters: list of Filter
3939
- :param _Limit: 分页limit
3994
+ :param _Limit: 分页limit,默认20,最大100
3940
3995
  :type Limit: int
3941
- :param _Offset: 分页偏移量
3996
+ :param _Offset: 分页偏移量,默认0
3942
3997
  :type Offset: int
3943
- :param _OrderBy: CREATE_TIME_DESC, 创建时间降序
3998
+ :param _OrderBy: 排序规则
3999
+ CREATE_TIME_DESC, 创建时间降序
3944
4000
  CREATE_TIME_ASC,创建时间升序
3945
4001
  UPDATE_TIME_DESC,更新时间降序
3946
4002
  UPDATE_TIME_ASC,更新时间升序
@@ -3954,7 +4010,7 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3954
4010
 
3955
4011
  @property
3956
4012
  def InstanceId(self):
3957
- """集群ID
4013
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3958
4014
  :rtype: str
3959
4015
  """
3960
4016
  return self._InstanceId
@@ -3965,7 +4021,16 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3965
4021
 
3966
4022
  @property
3967
4023
  def Filters(self):
3968
- """过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
4024
+ """支持搜索参数
4025
+ ClientId:客户端id,根据实际业务使用获取
4026
+ CaSn:所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
4027
+ DeviceCertificateSn:设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
4028
+ DeviceCertificateCn:设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
4029
+ OrganizationalUnit:证书OU
4030
+ NotAfterEnd:过期时间小于等于指定时间的证书
4031
+ NotAfterStart:过期时间大于等于指定时间的证书
4032
+ Status:设备证书状态 ACTIVE(激活); INACTIVE(未激活)REVOKED(吊销);PENDING_ACTIVATION(注册待激活)
4033
+
3969
4034
  :rtype: list of Filter
3970
4035
  """
3971
4036
  return self._Filters
@@ -3976,7 +4041,7 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3976
4041
 
3977
4042
  @property
3978
4043
  def Limit(self):
3979
- """分页limit
4044
+ """分页limit,默认20,最大100
3980
4045
  :rtype: int
3981
4046
  """
3982
4047
  return self._Limit
@@ -3987,7 +4052,7 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3987
4052
 
3988
4053
  @property
3989
4054
  def Offset(self):
3990
- """分页偏移量
4055
+ """分页偏移量,默认0
3991
4056
  :rtype: int
3992
4057
  """
3993
4058
  return self._Offset
@@ -3998,7 +4063,8 @@ class DescribeDeviceCertificatesRequest(AbstractModel):
3998
4063
 
3999
4064
  @property
4000
4065
  def OrderBy(self):
4001
- """CREATE_TIME_DESC, 创建时间降序
4066
+ """排序规则
4067
+ CREATE_TIME_DESC, 创建时间降序
4002
4068
  CREATE_TIME_ASC,创建时间升序
4003
4069
  UPDATE_TIME_DESC,更新时间降序
4004
4070
  UPDATE_TIME_ASC,更新时间升序
@@ -4041,7 +4107,7 @@ class DescribeDeviceCertificatesResponse(AbstractModel):
4041
4107
  r"""
4042
4108
  :param _TotalCount: 总数
4043
4109
  :type TotalCount: int
4044
- :param _Data: 设备证书
4110
+ :param _Data: 设备证书列表
4045
4111
  :type Data: list of DeviceCertificateItem
4046
4112
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4047
4113
  :type RequestId: str
@@ -4063,7 +4129,7 @@ class DescribeDeviceCertificatesResponse(AbstractModel):
4063
4129
 
4064
4130
  @property
4065
4131
  def Data(self):
4066
- """设备证书
4132
+ """设备证书列表
4067
4133
  :rtype: list of DeviceCertificateItem
4068
4134
  """
4069
4135
  return self._Data
@@ -4102,14 +4168,14 @@ class DescribeInsPublicEndpointsRequest(AbstractModel):
4102
4168
 
4103
4169
  def __init__(self):
4104
4170
  r"""
4105
- :param _InstanceId: 实例ID
4171
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4106
4172
  :type InstanceId: str
4107
4173
  """
4108
4174
  self._InstanceId = None
4109
4175
 
4110
4176
  @property
4111
4177
  def InstanceId(self):
4112
- """实例ID
4178
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4113
4179
  :rtype: str
4114
4180
  """
4115
4181
  return self._InstanceId
@@ -4142,7 +4208,7 @@ class DescribeInsPublicEndpointsResponse(AbstractModel):
4142
4208
  :type Endpoints: list of MQTTEndpointItem
4143
4209
  :param _InstanceId: 实例id
4144
4210
  :type InstanceId: str
4145
- :param _Bandwidth: 带宽
4211
+ :param _Bandwidth: 带宽,单位Mbps
4146
4212
  :type Bandwidth: int
4147
4213
  :param _Rules: 公网访问规则
4148
4214
  :type Rules: list of PublicAccessRule
@@ -4187,7 +4253,7 @@ class DescribeInsPublicEndpointsResponse(AbstractModel):
4187
4253
 
4188
4254
  @property
4189
4255
  def Bandwidth(self):
4190
- """带宽
4256
+ """带宽,单位Mbps
4191
4257
  :rtype: int
4192
4258
  """
4193
4259
  return self._Bandwidth
@@ -4261,14 +4327,14 @@ class DescribeInsVPCEndpointsRequest(AbstractModel):
4261
4327
 
4262
4328
  def __init__(self):
4263
4329
  r"""
4264
- :param _InstanceId: 实例ID
4330
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4265
4331
  :type InstanceId: str
4266
4332
  """
4267
4333
  self._InstanceId = None
4268
4334
 
4269
4335
  @property
4270
4336
  def InstanceId(self):
4271
- """实例ID
4337
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
4272
4338
  :rtype: str
4273
4339
  """
4274
4340
  return self._InstanceId
@@ -5289,14 +5355,14 @@ class DescribeTopicListRequest(AbstractModel):
5289
5355
 
5290
5356
  def __init__(self):
5291
5357
  r"""
5292
- :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5358
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5293
5359
  :type InstanceId: str
5294
5360
  :param _Filters: 查询条件列表:
5295
5361
  支持TopicName模糊查询
5296
5362
  :type Filters: list of Filter
5297
- :param _Offset: 查询起始位置
5363
+ :param _Offset: 查询起始位置,默认0。
5298
5364
  :type Offset: int
5299
- :param _Limit: 查询结果限制数量
5365
+ :param _Limit: 查询结果限制数量,默认20,最大20
5300
5366
  :type Limit: int
5301
5367
  """
5302
5368
  self._InstanceId = None
@@ -5306,7 +5372,7 @@ class DescribeTopicListRequest(AbstractModel):
5306
5372
 
5307
5373
  @property
5308
5374
  def InstanceId(self):
5309
- """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5375
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5310
5376
  :rtype: str
5311
5377
  """
5312
5378
  return self._InstanceId
@@ -5329,7 +5395,7 @@ class DescribeTopicListRequest(AbstractModel):
5329
5395
 
5330
5396
  @property
5331
5397
  def Offset(self):
5332
- """查询起始位置
5398
+ """查询起始位置,默认0。
5333
5399
  :rtype: int
5334
5400
  """
5335
5401
  return self._Offset
@@ -5340,7 +5406,7 @@ class DescribeTopicListRequest(AbstractModel):
5340
5406
 
5341
5407
  @property
5342
5408
  def Limit(self):
5343
- """查询结果限制数量
5409
+ """查询结果限制数量,默认20,最大20
5344
5410
  :rtype: int
5345
5411
  """
5346
5412
  return self._Limit
@@ -5579,14 +5645,14 @@ class DescribeUserListRequest(AbstractModel):
5579
5645
 
5580
5646
  def __init__(self):
5581
5647
  r"""
5582
- :param _InstanceId: 实例ID
5648
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5583
5649
  :type InstanceId: str
5584
5650
  :param _Filters: 查询条件列表支持字段
5585
- Username:Username模糊查询
5651
+ Username:按照【用户名】进行过滤,支持模糊过滤,类型:String
5586
5652
  :type Filters: list of Filter
5587
- :param _Offset: 查询起始位置
5653
+ :param _Offset: 查询起始位置,默认值0
5588
5654
  :type Offset: int
5589
- :param _Limit: 查询结果限制数量
5655
+ :param _Limit: 查询结果限制数量,默认值20,最大值100
5590
5656
  :type Limit: int
5591
5657
  """
5592
5658
  self._InstanceId = None
@@ -5596,7 +5662,7 @@ Username:Username模糊查询
5596
5662
 
5597
5663
  @property
5598
5664
  def InstanceId(self):
5599
- """实例ID
5665
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
5600
5666
  :rtype: str
5601
5667
  """
5602
5668
  return self._InstanceId
@@ -5608,7 +5674,7 @@ Username:Username模糊查询
5608
5674
  @property
5609
5675
  def Filters(self):
5610
5676
  """查询条件列表支持字段
5611
- Username:Username模糊查询
5677
+ Username:按照【用户名】进行过滤,支持模糊过滤,类型:String
5612
5678
  :rtype: list of Filter
5613
5679
  """
5614
5680
  return self._Filters
@@ -5619,7 +5685,7 @@ Username:Username模糊查询
5619
5685
 
5620
5686
  @property
5621
5687
  def Offset(self):
5622
- """查询起始位置
5688
+ """查询起始位置,默认值0
5623
5689
  :rtype: int
5624
5690
  """
5625
5691
  return self._Offset
@@ -5630,7 +5696,7 @@ Username:Username模糊查询
5630
5696
 
5631
5697
  @property
5632
5698
  def Limit(self):
5633
- """查询结果限制数量
5699
+ """查询结果限制数量,默认值20,最大值100
5634
5700
  :rtype: int
5635
5701
  """
5636
5702
  return self._Limit
@@ -5734,37 +5800,37 @@ class DeviceCertificateItem(AbstractModel):
5734
5800
  :type ClientId: str
5735
5801
  :param _DeviceCertificate: 设备证书
5736
5802
  :type DeviceCertificate: str
5737
- :param _DeviceCertificateSn: 设备证书Sn
5803
+ :param _DeviceCertificateSn: 设备证书SN序列号,用于唯一标识一个设备证书
5738
5804
  :type DeviceCertificateSn: str
5739
5805
  :param _DeviceCertificateCn: 设备证书Cn
5740
5806
  :type DeviceCertificateCn: str
5741
- :param _CaSn: 签发ca的序列号
5807
+ :param _CaSn: 签发该证书的CA证书的序列号
5742
5808
  :type CaSn: str
5743
- :param _Format: 证书格式
5809
+ :param _Format: 证书格式,当前仅支持PEM
5744
5810
  :type Format: str
5745
- :param _Status: 证书状态
5746
- ACTIVE,//激活
5747
- INACTIVE,//未激活
5748
- REVOKED,//吊销
5749
- PENDING_ACTIVATION,//注册待激活
5811
+ :param _Status: 设备证书状态
5812
+ ACTIVE:激活
5813
+ INACTIVE:未激活
5814
+ REVOKED:吊销
5815
+ PENDING_ACTIVATION:注册待激活
5750
5816
  :type Status: str
5751
5817
  :param _OrganizationalUnit: 组织单位
5752
5818
  :type OrganizationalUnit: str
5753
- :param _LastActivationTime: 上次激活时间
5819
+ :param _LastActivationTime: 上次激活时间,毫秒级时间戳 。
5754
5820
  :type LastActivationTime: int
5755
- :param _LastInactivationTime: 上次取消激活时间
5821
+ :param _LastInactivationTime: 上次取消激活时间,毫秒级时间戳 。
5756
5822
  :type LastInactivationTime: int
5757
- :param _CreatedTime: 创建时间
5823
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
5758
5824
  :type CreatedTime: int
5759
- :param _UpdateTime: 预销毁时间
5825
+ :param _UpdateTime: 更新时间,毫秒级时间戳 。
5760
5826
  :type UpdateTime: int
5761
5827
  :param _CertificateSource: 证书来源:
5762
5828
  API, 手动注册
5763
5829
  JITP 自动注册
5764
5830
  :type CertificateSource: str
5765
- :param _NotAfterTime: 证书失效日期
5831
+ :param _NotAfterTime: 证书失效日期,毫秒级时间戳 。
5766
5832
  :type NotAfterTime: int
5767
- :param _NotBeforeTime: 证书生效开始日期
5833
+ :param _NotBeforeTime: 证书生效开始日期,毫秒级时间戳 。
5768
5834
  :type NotBeforeTime: int
5769
5835
  """
5770
5836
  self._ClientId = None
@@ -5807,7 +5873,7 @@ JITP 自动注册
5807
5873
 
5808
5874
  @property
5809
5875
  def DeviceCertificateSn(self):
5810
- """设备证书Sn
5876
+ """设备证书SN序列号,用于唯一标识一个设备证书
5811
5877
  :rtype: str
5812
5878
  """
5813
5879
  return self._DeviceCertificateSn
@@ -5829,7 +5895,7 @@ JITP 自动注册
5829
5895
 
5830
5896
  @property
5831
5897
  def CaSn(self):
5832
- """签发ca的序列号
5898
+ """签发该证书的CA证书的序列号
5833
5899
  :rtype: str
5834
5900
  """
5835
5901
  return self._CaSn
@@ -5840,7 +5906,7 @@ JITP 自动注册
5840
5906
 
5841
5907
  @property
5842
5908
  def Format(self):
5843
- """证书格式
5909
+ """证书格式,当前仅支持PEM
5844
5910
  :rtype: str
5845
5911
  """
5846
5912
  return self._Format
@@ -5851,11 +5917,11 @@ JITP 自动注册
5851
5917
 
5852
5918
  @property
5853
5919
  def Status(self):
5854
- """证书状态
5855
- ACTIVE,//激活
5856
- INACTIVE,//未激活
5857
- REVOKED,//吊销
5858
- PENDING_ACTIVATION,//注册待激活
5920
+ """设备证书状态
5921
+ ACTIVE:激活
5922
+ INACTIVE:未激活
5923
+ REVOKED:吊销
5924
+ PENDING_ACTIVATION:注册待激活
5859
5925
  :rtype: str
5860
5926
  """
5861
5927
  return self._Status
@@ -5877,7 +5943,7 @@ JITP 自动注册
5877
5943
 
5878
5944
  @property
5879
5945
  def LastActivationTime(self):
5880
- """上次激活时间
5946
+ """上次激活时间,毫秒级时间戳 。
5881
5947
  :rtype: int
5882
5948
  """
5883
5949
  return self._LastActivationTime
@@ -5888,7 +5954,7 @@ JITP 自动注册
5888
5954
 
5889
5955
  @property
5890
5956
  def LastInactivationTime(self):
5891
- """上次取消激活时间
5957
+ """上次取消激活时间,毫秒级时间戳 。
5892
5958
  :rtype: int
5893
5959
  """
5894
5960
  return self._LastInactivationTime
@@ -5899,7 +5965,7 @@ JITP 自动注册
5899
5965
 
5900
5966
  @property
5901
5967
  def CreatedTime(self):
5902
- """创建时间
5968
+ """创建时间,毫秒级时间戳 。
5903
5969
  :rtype: int
5904
5970
  """
5905
5971
  return self._CreatedTime
@@ -5910,7 +5976,7 @@ JITP 自动注册
5910
5976
 
5911
5977
  @property
5912
5978
  def UpdateTime(self):
5913
- """预销毁时间
5979
+ """更新时间,毫秒级时间戳 。
5914
5980
  :rtype: int
5915
5981
  """
5916
5982
  return self._UpdateTime
@@ -5934,7 +6000,7 @@ JITP 自动注册
5934
6000
 
5935
6001
  @property
5936
6002
  def NotAfterTime(self):
5937
- """证书失效日期
6003
+ """证书失效日期,毫秒级时间戳 。
5938
6004
  :rtype: int
5939
6005
  """
5940
6006
  return self._NotAfterTime
@@ -5945,7 +6011,7 @@ JITP 自动注册
5945
6011
 
5946
6012
  @property
5947
6013
  def NotBeforeTime(self):
5948
- """证书生效开始日期
6014
+ """证书生效开始日期,毫秒级时间戳 。
5949
6015
  :rtype: int
5950
6016
  """
5951
6017
  return self._NotBeforeTime
@@ -6156,15 +6222,30 @@ class MQTTAuthenticatorItem(AbstractModel):
6156
6222
 
6157
6223
  def __init__(self):
6158
6224
  r"""
6159
- :param _Type: 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
6225
+ :param _Type: 认证器类型
6226
+ JWT:JWT认证器
6227
+ JWKS:JWKS认证器
6228
+ HTTP:HTTP认证器
6160
6229
  :type Type: str
6161
- :param _Config: 认证器配置
6230
+ :param _Config: HTTP认证器
6231
+ headers(请求头):标准请求头和自定义请求头
6232
+ endpoint(接入点):认证服务器接入点
6233
+ method(http请求方法):POST/GET
6234
+ readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
6235
+ connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
6236
+ body(请求体):http请求体
6237
+ concurrency(并发数):最大并发请求数
6238
+ 样例:{"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}
6239
+
6240
+ 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
6162
6241
  :type Config: str
6163
6242
  :param _Status: 认证器状态
6243
+ open:认证器打开
6244
+ close:认证器关闭
6164
6245
  :type Status: str
6165
- :param _CreateTime: 创建时间
6246
+ :param _CreateTime: 创建时间,毫秒级时间戳 。
6166
6247
  :type CreateTime: int
6167
- :param _Remark: 说明
6248
+ :param _Remark: 说明,最长 128 字符。
6168
6249
  :type Remark: str
6169
6250
  """
6170
6251
  self._Type = None
@@ -6175,7 +6256,10 @@ class MQTTAuthenticatorItem(AbstractModel):
6175
6256
 
6176
6257
  @property
6177
6258
  def Type(self):
6178
- """认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
6259
+ """认证器类型
6260
+ JWT:JWT认证器
6261
+ JWKS:JWKS认证器
6262
+ HTTP:HTTP认证器
6179
6263
  :rtype: str
6180
6264
  """
6181
6265
  return self._Type
@@ -6186,7 +6270,17 @@ class MQTTAuthenticatorItem(AbstractModel):
6186
6270
 
6187
6271
  @property
6188
6272
  def Config(self):
6189
- """认证器配置
6273
+ """HTTP认证器
6274
+ headers(请求头):标准请求头和自定义请求头
6275
+ endpoint(接入点):认证服务器接入点
6276
+ method(http请求方法):POST/GET
6277
+ readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
6278
+ connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
6279
+ body(请求体):http请求体
6280
+ concurrency(并发数):最大并发请求数
6281
+ 样例:{"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}
6282
+
6283
+ 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
6190
6284
  :rtype: str
6191
6285
  """
6192
6286
  return self._Config
@@ -6198,6 +6292,8 @@ class MQTTAuthenticatorItem(AbstractModel):
6198
6292
  @property
6199
6293
  def Status(self):
6200
6294
  """认证器状态
6295
+ open:认证器打开
6296
+ close:认证器关闭
6201
6297
  :rtype: str
6202
6298
  """
6203
6299
  return self._Status
@@ -6208,7 +6304,7 @@ class MQTTAuthenticatorItem(AbstractModel):
6208
6304
 
6209
6305
  @property
6210
6306
  def CreateTime(self):
6211
- """创建时间
6307
+ """创建时间,毫秒级时间戳 。
6212
6308
  :rtype: int
6213
6309
  """
6214
6310
  return self._CreateTime
@@ -6219,7 +6315,7 @@ class MQTTAuthenticatorItem(AbstractModel):
6219
6315
 
6220
6316
  @property
6221
6317
  def Remark(self):
6222
- """说明
6318
+ """说明,最长 128 字符。
6223
6319
  :rtype: str
6224
6320
  """
6225
6321
  return self._Remark
@@ -6252,21 +6348,24 @@ class MQTTClientInfo(AbstractModel):
6252
6348
 
6253
6349
  def __init__(self):
6254
6350
  r"""
6255
- :param _ClientId: 客户端唯一标识
6351
+ :param _ClientId: 客户端ID
6256
6352
  :type ClientId: str
6257
6353
  :param _ClientAddress: 客户端网络地址
6258
6354
  :type ClientAddress: str
6259
- :param _ProtocolVersion: MQTT 协议版本,4 表示 MQTT 3.1.1
6355
+ :param _ProtocolVersion: MQTT 协议版本
6356
+ 3:表示MQTT 3.1版本
6357
+ 4:表示 MQTT 3.1.1
6358
+ 5: 标识MQTT 5.0协议
6260
6359
  :type ProtocolVersion: int
6261
6360
  :param _Keepalive: 保持连接时间,单位:秒
6262
6361
  :type Keepalive: int
6263
6362
  :param _ConnectionStatus: 连接状态,CONNECTED 已连接,DISCONNECTED 未连接
6264
6363
  :type ConnectionStatus: str
6265
- :param _CreateTime: 客户端创建时间
6364
+ :param _CreateTime: 客户端创建时间,毫秒级时间戳 。
6266
6365
  :type CreateTime: int
6267
- :param _ConnectTime: 上次建立连接时间
6366
+ :param _ConnectTime: 上次建立连接时间,毫秒级时间戳 。
6268
6367
  :type ConnectTime: int
6269
- :param _DisconnectTime: 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
6368
+ :param _DisconnectTime: 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义,毫秒级时间戳 。
6270
6369
  :type DisconnectTime: int
6271
6370
  :param _MQTTClientSubscriptions: 客户端的订阅列表
6272
6371
  :type MQTTClientSubscriptions: list of MQTTClientSubscription
@@ -6283,7 +6382,7 @@ class MQTTClientInfo(AbstractModel):
6283
6382
 
6284
6383
  @property
6285
6384
  def ClientId(self):
6286
- """客户端唯一标识
6385
+ """客户端ID
6287
6386
  :rtype: str
6288
6387
  """
6289
6388
  return self._ClientId
@@ -6305,7 +6404,10 @@ class MQTTClientInfo(AbstractModel):
6305
6404
 
6306
6405
  @property
6307
6406
  def ProtocolVersion(self):
6308
- """MQTT 协议版本,4 表示 MQTT 3.1.1
6407
+ """MQTT 协议版本
6408
+ 3:表示MQTT 3.1版本
6409
+ 4:表示 MQTT 3.1.1
6410
+ 5: 标识MQTT 5.0协议
6309
6411
  :rtype: int
6310
6412
  """
6311
6413
  return self._ProtocolVersion
@@ -6338,7 +6440,7 @@ class MQTTClientInfo(AbstractModel):
6338
6440
 
6339
6441
  @property
6340
6442
  def CreateTime(self):
6341
- """客户端创建时间
6443
+ """客户端创建时间,毫秒级时间戳 。
6342
6444
  :rtype: int
6343
6445
  """
6344
6446
  return self._CreateTime
@@ -6349,7 +6451,7 @@ class MQTTClientInfo(AbstractModel):
6349
6451
 
6350
6452
  @property
6351
6453
  def ConnectTime(self):
6352
- """上次建立连接时间
6454
+ """上次建立连接时间,毫秒级时间戳 。
6353
6455
  :rtype: int
6354
6456
  """
6355
6457
  return self._ConnectTime
@@ -6360,7 +6462,7 @@ class MQTTClientInfo(AbstractModel):
6360
6462
 
6361
6463
  @property
6362
6464
  def DisconnectTime(self):
6363
- """上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
6465
+ """上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义,毫秒级时间戳 。
6364
6466
  :rtype: int
6365
6467
  """
6366
6468
  return self._DisconnectTime
@@ -6416,6 +6518,9 @@ class MQTTClientSubscription(AbstractModel):
6416
6518
  :param _TopicFilter: topic 订阅
6417
6519
  :type TopicFilter: str
6418
6520
  :param _Qos: 服务质量等级
6521
+ 0: 至多一次
6522
+ 1: 至少一次
6523
+ 2: 恰好一次
6419
6524
  :type Qos: int
6420
6525
  :param _Lag: 堆积数量
6421
6526
  :type Lag: int
@@ -6441,6 +6546,9 @@ class MQTTClientSubscription(AbstractModel):
6441
6546
  @property
6442
6547
  def Qos(self):
6443
6548
  """服务质量等级
6549
+ 0: 至多一次
6550
+ 1: 至少一次
6551
+ 2: 恰好一次
6444
6552
  :rtype: int
6445
6553
  """
6446
6554
  return self._Qos
@@ -6659,7 +6767,7 @@ DELETING,删除中
6659
6767
  :type MaxSubscriptionPerClient: int
6660
6768
  :param _ClientNumLimit: 客户端连接数上线
6661
6769
  :type ClientNumLimit: int
6662
- :param _RenewFlag: 是否自动续费。仅包年包月就去那生效。
6770
+ :param _RenewFlag: 是否自动续费。仅包年包月集群生效。
6663
6771
  1:自动续费
6664
6772
  0:非自动续费
6665
6773
  :type RenewFlag: int
@@ -6855,7 +6963,7 @@ DELETING,删除中
6855
6963
 
6856
6964
  @property
6857
6965
  def RenewFlag(self):
6858
- """是否自动续费。仅包年包月就去那生效。
6966
+ """是否自动续费。仅包年包月集群生效。
6859
6967
  1:自动续费
6860
6968
  0:非自动续费
6861
6969
  :rtype: int
@@ -7199,9 +7307,9 @@ class MQTTUserItem(AbstractModel):
7199
7307
  :type Password: str
7200
7308
  :param _Remark: 备注信息
7201
7309
  :type Remark: str
7202
- :param _CreatedTime: 创建时间,秒为单位
7310
+ :param _CreatedTime: 创建时间,毫秒级时间戳 。
7203
7311
  :type CreatedTime: int
7204
- :param _ModifiedTime: 修改时间,秒为单位
7312
+ :param _ModifiedTime: 修改时间,毫秒级时间戳 。
7205
7313
  :type ModifiedTime: int
7206
7314
  """
7207
7315
  self._Username = None
@@ -7245,7 +7353,7 @@ class MQTTUserItem(AbstractModel):
7245
7353
 
7246
7354
  @property
7247
7355
  def CreatedTime(self):
7248
- """创建时间,秒为单位
7356
+ """创建时间,毫秒级时间戳 。
7249
7357
  :rtype: int
7250
7358
  """
7251
7359
  return self._CreatedTime
@@ -7256,7 +7364,7 @@ class MQTTUserItem(AbstractModel):
7256
7364
 
7257
7365
  @property
7258
7366
  def ModifiedTime(self):
7259
- """修改时间,秒为单位
7367
+ """修改时间,毫秒级时间戳 。
7260
7368
  :rtype: int
7261
7369
  """
7262
7370
  return self._ModifiedTime
@@ -8460,11 +8568,11 @@ class ModifyTopicRequest(AbstractModel):
8460
8568
 
8461
8569
  def __init__(self):
8462
8570
  r"""
8463
- :param _InstanceId: 实例ID
8571
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8464
8572
  :type InstanceId: str
8465
- :param _Topic: 主题
8573
+ :param _Topic: 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
8466
8574
  :type Topic: str
8467
- :param _Remark: 备注信息
8575
+ :param _Remark: 备注信息,最长 128 字符
8468
8576
  :type Remark: str
8469
8577
  """
8470
8578
  self._InstanceId = None
@@ -8473,7 +8581,7 @@ class ModifyTopicRequest(AbstractModel):
8473
8581
 
8474
8582
  @property
8475
8583
  def InstanceId(self):
8476
- """实例ID
8584
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8477
8585
  :rtype: str
8478
8586
  """
8479
8587
  return self._InstanceId
@@ -8484,7 +8592,7 @@ class ModifyTopicRequest(AbstractModel):
8484
8592
 
8485
8593
  @property
8486
8594
  def Topic(self):
8487
- """主题
8595
+ """主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
8488
8596
  :rtype: str
8489
8597
  """
8490
8598
  return self._Topic
@@ -8495,7 +8603,7 @@ class ModifyTopicRequest(AbstractModel):
8495
8603
 
8496
8604
  @property
8497
8605
  def Remark(self):
8498
- """备注信息
8606
+ """备注信息,最长 128 字符
8499
8607
  :rtype: str
8500
8608
  """
8501
8609
  return self._Remark
@@ -8554,11 +8662,11 @@ class ModifyUserRequest(AbstractModel):
8554
8662
 
8555
8663
  def __init__(self):
8556
8664
  r"""
8557
- :param _InstanceId: 实例ID
8665
+ :param _InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8558
8666
  :type InstanceId: str
8559
8667
  :param _Username: 用户名
8560
8668
  :type Username: str
8561
- :param _Remark: 备注
8669
+ :param _Remark: 备注,长度不超过128个字符。
8562
8670
  :type Remark: str
8563
8671
  """
8564
8672
  self._InstanceId = None
@@ -8567,7 +8675,7 @@ class ModifyUserRequest(AbstractModel):
8567
8675
 
8568
8676
  @property
8569
8677
  def InstanceId(self):
8570
- """实例ID
8678
+ """实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8571
8679
  :rtype: str
8572
8680
  """
8573
8681
  return self._InstanceId
@@ -8589,7 +8697,7 @@ class ModifyUserRequest(AbstractModel):
8589
8697
 
8590
8698
  @property
8591
8699
  def Remark(self):
8592
- """备注
8700
+ """备注,长度不超过128个字符。
8593
8701
  :rtype: str
8594
8702
  """
8595
8703
  return self._Remark
@@ -8960,9 +9068,9 @@ class PublishMessageRequest(AbstractModel):
8960
9068
 
8961
9069
  def __init__(self):
8962
9070
  r"""
8963
- :param _InstanceId: 实例ID
9071
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8964
9072
  :type InstanceId: str
8965
- :param _Payload: 消息 payload,需要按 encoding 指定的编码方式进行编码
9073
+ :param _Payload: 消息负载 Payload,是消息的实际内容,需要按 encoding 指定的编码方式进行编码
8966
9074
  :type Payload: str
8967
9075
  :param _TargetTopic: 消息目的主题,该参数与 TargetClientId 二选一
8968
9076
  :type TargetTopic: str
@@ -8971,6 +9079,9 @@ class PublishMessageRequest(AbstractModel):
8971
9079
  :param _Encoding: 消息 payload 编码,可选 plain 或 base64,默认为 plain(即不编码)
8972
9080
  :type Encoding: str
8973
9081
  :param _Qos: 消息的服务质量等级,默认为 1
9082
+ QoS 0(至多一次)消息发送后,不保证接收方一定收到,也不要求接收方确认。
9083
+ QoS 1(至少一次)消息至少被接收方成功接收一次,但可能重复。
9084
+ QoS 2(恰好一次)消息确保被接收方接收且仅接收一次,无重复。
8974
9085
  :type Qos: int
8975
9086
  :param _Retain: 是否为保留消息,默认为 false,且仅支持发布到主题的消息设置为 true
8976
9087
  :type Retain: bool
@@ -8985,7 +9096,7 @@ class PublishMessageRequest(AbstractModel):
8985
9096
 
8986
9097
  @property
8987
9098
  def InstanceId(self):
8988
- """实例ID
9099
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
8989
9100
  :rtype: str
8990
9101
  """
8991
9102
  return self._InstanceId
@@ -8996,7 +9107,7 @@ class PublishMessageRequest(AbstractModel):
8996
9107
 
8997
9108
  @property
8998
9109
  def Payload(self):
8999
- """消息 payload,需要按 encoding 指定的编码方式进行编码
9110
+ """消息负载 Payload,是消息的实际内容,需要按 encoding 指定的编码方式进行编码
9000
9111
  :rtype: str
9001
9112
  """
9002
9113
  return self._Payload
@@ -9041,6 +9152,9 @@ class PublishMessageRequest(AbstractModel):
9041
9152
  @property
9042
9153
  def Qos(self):
9043
9154
  """消息的服务质量等级,默认为 1
9155
+ QoS 0(至多一次)消息发送后,不保证接收方一定收到,也不要求接收方确认。
9156
+ QoS 1(至少一次)消息至少被接收方成功接收一次,但可能重复。
9157
+ QoS 2(恰好一次)消息确保被接收方接收且仅接收一次,无重复。
9044
9158
  :rtype: int
9045
9159
  """
9046
9160
  return self._Qos
@@ -9114,19 +9228,17 @@ class RegisterCaCertificateRequest(AbstractModel):
9114
9228
 
9115
9229
  def __init__(self):
9116
9230
  r"""
9117
- :param _InstanceId: 集群id
9231
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9118
9232
  :type InstanceId: str
9119
- :param _CaCertificate: CA证书
9233
+ :param _CaCertificate: CA证书内容,自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA
9120
9234
  :type CaCertificate: str
9121
- :param _VerificationCertificate: 验证证书
9235
+ :param _VerificationCertificate: 验证证书内容,可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节
9122
9236
  :type VerificationCertificate: str
9123
- :param _Format: 证书格式,不传默认PEM格式
9237
+ :param _Format: 证书格式,不传默认PEM格式,当前仅支持PEM格式
9124
9238
  :type Format: str
9125
9239
  :param _Status: 证书状态,不传默认ACTIVE状态
9126
- ACTIVE,//激活
9127
- INACTIVE,//未激活
9128
- REVOKED,//吊销
9129
- PENDING_ACTIVATION,//注册待激活
9240
+ ACTIVE:激活
9241
+ INACTIVE:未激活
9130
9242
  :type Status: str
9131
9243
  """
9132
9244
  self._InstanceId = None
@@ -9137,7 +9249,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9137
9249
 
9138
9250
  @property
9139
9251
  def InstanceId(self):
9140
- """集群id
9252
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9141
9253
  :rtype: str
9142
9254
  """
9143
9255
  return self._InstanceId
@@ -9148,7 +9260,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9148
9260
 
9149
9261
  @property
9150
9262
  def CaCertificate(self):
9151
- """CA证书
9263
+ """CA证书内容,自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA
9152
9264
  :rtype: str
9153
9265
  """
9154
9266
  return self._CaCertificate
@@ -9159,7 +9271,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9159
9271
 
9160
9272
  @property
9161
9273
  def VerificationCertificate(self):
9162
- """验证证书
9274
+ """验证证书内容,可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节
9163
9275
  :rtype: str
9164
9276
  """
9165
9277
  return self._VerificationCertificate
@@ -9170,7 +9282,7 @@ class RegisterCaCertificateRequest(AbstractModel):
9170
9282
 
9171
9283
  @property
9172
9284
  def Format(self):
9173
- """证书格式,不传默认PEM格式
9285
+ """证书格式,不传默认PEM格式,当前仅支持PEM格式
9174
9286
  :rtype: str
9175
9287
  """
9176
9288
  return self._Format
@@ -9182,10 +9294,8 @@ class RegisterCaCertificateRequest(AbstractModel):
9182
9294
  @property
9183
9295
  def Status(self):
9184
9296
  """证书状态,不传默认ACTIVE状态
9185
- ACTIVE,//激活
9186
- INACTIVE,//未激活
9187
- REVOKED,//吊销
9188
- PENDING_ACTIVATION,//注册待激活
9297
+ ACTIVE:激活
9298
+ INACTIVE:未激活
9189
9299
  :rtype: str
9190
9300
  """
9191
9301
  return self._Status
@@ -9246,17 +9356,21 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9246
9356
 
9247
9357
  def __init__(self):
9248
9358
  r"""
9249
- :param _InstanceId: 集群id
9359
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9250
9360
  :type InstanceId: str
9251
- :param _DeviceCertificate: 设备证书
9361
+ :param _DeviceCertificate: 设备证书内容,可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成
9252
9362
  :type DeviceCertificate: str
9253
9363
  :param _CaSn: 关联的CA证书SN
9254
9364
  :type CaSn: str
9255
- :param _ClientId: 客户端ID
9365
+ :param _ClientId: 客户端ID,需要关联该证书的客户端ID。根据实际业务使用填写
9256
9366
  :type ClientId: str
9257
- :param _Format: 证书格式
9367
+ :param _Format: 证书格式,默认为PEM,当前仅支持PEM格式
9258
9368
  :type Format: str
9259
- :param _Status: ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
9369
+ :param _Status: 客户端证书状态,默认激活状态(ACTIVE
9370
+ ACTIVE:激活
9371
+ INACTIVE:未激活
9372
+ REVOKED:吊销
9373
+ PENDING_ACTIVATION:注册待激活
9260
9374
  :type Status: str
9261
9375
  """
9262
9376
  self._InstanceId = None
@@ -9268,7 +9382,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9268
9382
 
9269
9383
  @property
9270
9384
  def InstanceId(self):
9271
- """集群id
9385
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9272
9386
  :rtype: str
9273
9387
  """
9274
9388
  return self._InstanceId
@@ -9279,7 +9393,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9279
9393
 
9280
9394
  @property
9281
9395
  def DeviceCertificate(self):
9282
- """设备证书
9396
+ """设备证书内容,可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成
9283
9397
  :rtype: str
9284
9398
  """
9285
9399
  return self._DeviceCertificate
@@ -9301,7 +9415,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9301
9415
 
9302
9416
  @property
9303
9417
  def ClientId(self):
9304
- """客户端ID
9418
+ """客户端ID,需要关联该证书的客户端ID。根据实际业务使用填写
9305
9419
  :rtype: str
9306
9420
  """
9307
9421
  return self._ClientId
@@ -9312,7 +9426,7 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9312
9426
 
9313
9427
  @property
9314
9428
  def Format(self):
9315
- """证书格式
9429
+ """证书格式,默认为PEM,当前仅支持PEM格式
9316
9430
  :rtype: str
9317
9431
  """
9318
9432
  return self._Format
@@ -9323,7 +9437,11 @@ class RegisterDeviceCertificateRequest(AbstractModel):
9323
9437
 
9324
9438
  @property
9325
9439
  def Status(self):
9326
- """ ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
9440
+ """ 客户端证书状态,默认激活状态(ACTIVE
9441
+ ACTIVE:激活
9442
+ INACTIVE:未激活
9443
+ REVOKED:吊销
9444
+ PENDING_ACTIVATION:注册待激活
9327
9445
  :rtype: str
9328
9446
  """
9329
9447
  return self._Status
@@ -9566,7 +9684,7 @@ class UpdateAuthorizationPolicyPriorityRequest(AbstractModel):
9566
9684
 
9567
9685
  def __init__(self):
9568
9686
  r"""
9569
- :param _InstanceId: 实例ID
9687
+ :param _InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9570
9688
  :type InstanceId: str
9571
9689
  :param _Priorities: 策略ID和优先级
9572
9690
  :type Priorities: list of AuthorizationPolicyPriority
@@ -9576,7 +9694,7 @@ class UpdateAuthorizationPolicyPriorityRequest(AbstractModel):
9576
9694
 
9577
9695
  @property
9578
9696
  def InstanceId(self):
9579
- """实例ID
9697
+ """腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
9580
9698
  :rtype: str
9581
9699
  """
9582
9700
  return self._InstanceId