tencentcloud-sdk-python 3.0.1409__py2.py3-none-any.whl → 3.0.1411__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 (60) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/ams/v20201229/models.py +16 -189
  3. tencentcloud/apm/v20210622/models.py +15 -0
  4. tencentcloud/bh/v20230418/bh_client.py +138 -0
  5. tencentcloud/bh/v20230418/errorcodes.py +3 -0
  6. tencentcloud/bh/v20230418/models.py +991 -67
  7. tencentcloud/ccc/v20200210/models.py +2 -2
  8. tencentcloud/cdb/v20170320/cdb_client.py +27 -21
  9. tencentcloud/cdb/v20170320/errorcodes.py +0 -3
  10. tencentcloud/cdb/v20170320/models.py +294 -214
  11. tencentcloud/ctem/__init__.py +0 -0
  12. tencentcloud/ctem/v20231128/__init__.py +0 -0
  13. tencentcloud/ctem/v20231128/ctem_client.py +601 -0
  14. tencentcloud/ctem/v20231128/errorcodes.py +75 -0
  15. tencentcloud/ctem/v20231128/models.py +10459 -0
  16. tencentcloud/cwp/v20180228/models.py +165 -0
  17. tencentcloud/cynosdb/v20190107/errorcodes.py +3 -0
  18. tencentcloud/cynosdb/v20190107/models.py +45 -0
  19. tencentcloud/dlc/v20210125/dlc_client.py +3 -1
  20. tencentcloud/dlc/v20210125/models.py +24 -7
  21. tencentcloud/dnspod/v20210323/errorcodes.py +1 -1
  22. tencentcloud/dsgc/v20190723/dsgc_client.py +1 -3
  23. tencentcloud/dsgc/v20190723/models.py +342 -15
  24. tencentcloud/emr/v20190103/models.py +155 -0
  25. tencentcloud/es/v20180416/errorcodes.py +42 -0
  26. tencentcloud/ess/v20201111/models.py +33 -4
  27. tencentcloud/hunyuan/v20230901/models.py +17 -2
  28. tencentcloud/ims/v20201229/models.py +2 -30
  29. tencentcloud/iotexplorer/v20190423/models.py +4 -4
  30. tencentcloud/iotvideo/v20201215/models.py +2 -2
  31. tencentcloud/iotvideo/v20211125/models.py +2 -2
  32. tencentcloud/kms/v20190118/errorcodes.py +36 -0
  33. tencentcloud/kms/v20190118/kms_client.py +345 -0
  34. tencentcloud/kms/v20190118/models.py +3437 -1534
  35. tencentcloud/lighthouse/v20200324/errorcodes.py +9 -0
  36. tencentcloud/lke/v20231130/lke_client.py +92 -0
  37. tencentcloud/lke/v20231130/models.py +2782 -622
  38. tencentcloud/mongodb/v20190725/models.py +15 -0
  39. tencentcloud/mps/v20190612/models.py +217 -18
  40. tencentcloud/mqtt/v20240516/errorcodes.py +3 -0
  41. tencentcloud/mqtt/v20240516/models.py +255 -0
  42. tencentcloud/mqtt/v20240516/mqtt_client.py +23 -0
  43. tencentcloud/redis/v20180412/models.py +6 -6
  44. tencentcloud/ses/v20201002/models.py +0 -8
  45. tencentcloud/tcss/v20201101/models.py +15 -0
  46. tencentcloud/thpc/v20230321/models.py +47 -2
  47. tencentcloud/tione/v20211111/models.py +15 -0
  48. tencentcloud/tke/v20180525/models.py +19 -0
  49. tencentcloud/trocket/v20230308/models.py +624 -354
  50. tencentcloud/trocket/v20230308/trocket_client.py +28 -5
  51. tencentcloud/vm/v20210922/models.py +45 -172
  52. tencentcloud/vpc/v20170312/models.py +15 -0
  53. tencentcloud/waf/v20180125/models.py +110 -18
  54. tencentcloud/wedata/v20210820/models.py +1003 -4
  55. tencentcloud/wedata/v20210820/wedata_client.py +71 -2
  56. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/METADATA +1 -1
  57. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/RECORD +60 -55
  58. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/LICENSE +0 -0
  59. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/WHEEL +0 -0
  60. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/top_level.txt +0 -0
tencentcloud/trocket/v20230308/models.py CHANGED
@@ -431,7 +431,12 @@ class ConsumerClient(AbstractModel):
431
431
  :param _ConsumerLag: 客户端消费堆积
432
432
  注意：此字段可能返回 null，表示取不到有效值。
433
433
  :type ConsumerLag: int
434
- :param _ChannelProtocol: 消费者客户端类型（grpc；remoting；http）
434
+ :param _ChannelProtocol: 消费者客户端类型，枚举值如下：
435
+
436
+ - grpc：GRPC协议
437
+ - remoting：Remoting协议
438
+ - http：HTTP协议
439
+ 注意：此字段可能返回 null，表示取不到有效值。
435
440
  :type ChannelProtocol: str
436
441
  """
437
442
  self._ClientId = None
@@ -499,7 +504,12 @@ class ConsumerClient(AbstractModel):
499
504
 
500
505
  @property
501
506
  def ChannelProtocol(self):
502
- """消费者客户端类型（grpc；remoting；http）
507
+ """消费者客户端类型，枚举值如下：
508
+
509
+ - grpc：GRPC协议
510
+ - remoting：Remoting协议
511
+ - http：HTTP协议
512
+ 注意：此字段可能返回 null，表示取不到有效值。
503
513
  :rtype: str
504
514
  """
505
515
  return self._ChannelProtocol
@@ -533,18 +543,18 @@ class CreateConsumerGroupRequest(AbstractModel):
533
543
 
534
544
  def __init__(self):
535
545
  r"""
536
- :param _InstanceId: 集群ID
546
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
537
547
  :type InstanceId: str
538
- :param _MaxRetryTimes: 最大重试次数
548
+ :param _MaxRetryTimes: 最大重试次数，取值范围0～1000
539
549
  :type MaxRetryTimes: int
540
550
  :param _ConsumeEnable: 是否开启消费
541
551
  :type ConsumeEnable: bool
542
552
  :param _ConsumeMessageOrderly: 顺序投递：true
543
553
  并发投递：false
544
554
  :type ConsumeMessageOrderly: bool
545
- :param _ConsumerGroup: 消费组名称
555
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
546
556
  :type ConsumerGroup: str
547
- :param _Remark: 备注
557
+ :param _Remark: 备注信息，最多 128 个字符
548
558
  :type Remark: str
549
559
  :param _TagList: 标签列表
550
560
  :type TagList: list of Tag
@@ -559,7 +569,7 @@ class CreateConsumerGroupRequest(AbstractModel):
559
569
 
560
570
  @property
561
571
  def InstanceId(self):
562
- """集群ID
572
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
563
573
  :rtype: str
564
574
  """
565
575
  return self._InstanceId
@@ -570,7 +580,7 @@ class CreateConsumerGroupRequest(AbstractModel):
570
580
 
571
581
  @property
572
582
  def MaxRetryTimes(self):
573
- """最大重试次数
583
+ """最大重试次数，取值范围0～1000
574
584
  :rtype: int
575
585
  """
576
586
  return self._MaxRetryTimes
@@ -604,7 +614,7 @@ class CreateConsumerGroupRequest(AbstractModel):
604
614
 
605
615
  @property
606
616
  def ConsumerGroup(self):
607
- """消费组名称
617
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
608
618
  :rtype: str
609
619
  """
610
620
  return self._ConsumerGroup
@@ -615,7 +625,7 @@ class CreateConsumerGroupRequest(AbstractModel):
615
625
 
616
626
  @property
617
627
  def Remark(self):
618
- """备注
628
+ """备注信息，最多 128 个字符
619
629
  :rtype: str
620
630
  """
621
631
  return self._Remark
@@ -724,15 +734,19 @@ class CreateInstanceRequest(AbstractModel):
724
734
 
725
735
  def __init__(self):
726
736
  r"""
727
- :param _InstanceType: 实例类型，
728
- EXPERIMENT 体验版
729
- BASIC 基础版
730
- PRO 专业版
731
- PLATINUM 铂金版
737
+ :param _InstanceType: 实例类型，枚举值如下：
738
+
739
+ - EXPERIMENT：体验版
740
+
741
+ - BASIC：基础版
742
+
743
+ - PRO：专业版
744
+
745
+ - PLATINUM：铂金版
732
746
  :type InstanceType: str
733
- :param _Name: 集群名称
747
+ :param _Name: 集群名称，不能为空， 3-64个字符，只能包含数字、字母、“-”和“_”
734
748
  :type Name: str
735
- :param _SkuCode: 商品规格，可用规格如下：experiment_500, basic_1k, basic_2k, basic_3k, basic_4k, basic_5k, basic_6k, basic_7k, basic_8k, basic_9k, basic_10k, pro_4k, pro_6k, pro_8k, pro_1w, pro_15k, pro_2w, pro_25k, pro_3w, pro_35k, pro_4w, pro_45k, pro_5w, pro_55k, pro_60k, pro_65k, pro_70k, pro_75k, pro_80k, pro_85k, pro_90k, pro_95k, pro_100k, platinum_1w, platinum_2w, platinum_3w, platinum_4w, platinum_5w, platinum_6w, platinum_7w, platinum_8w, platinum_9w, platinum_10w, platinum_12w, platinum_14w, platinum_16w, platinum_18w, platinum_20w, platinum_25w, platinum_30w, platinum_35w, platinum_40w, platinum_45w, platinum_50w, platinum_60w, platinum_70w, platinum_80w, platinum_90w, platinum_100w
749
+ :param _SkuCode: 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
736
750
  :type SkuCode: str
737
751
  :param _Remark: 备注信息
738
752
  :type Remark: str
@@ -746,19 +760,26 @@ PLATINUM 铂金版
746
760
  :type BillingFlow: bool
747
761
  :param _Bandwidth: 公网带宽（单位：兆），默认值为0。如果开启公网，该字段必须为大于0的正整数
748
762
  :type Bandwidth: int
749
- :param _IpRules: 公网访问白名单
763
+ :param _IpRules: 公网访问白名单，不填表示拒绝所有 IP 访问
750
764
  :type IpRules: list of IpRule
751
- :param _MessageRetention: 消息保留时长（单位：小时）
765
+ :param _MessageRetention: 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
766
+
767
+ - 默认值：DefaultRetention 参数
768
+ - 最小值：RetentionLowerLimit 参数
769
+ - 最大值：RetentionUpperLimit 参数
752
770
  :type MessageRetention: int
753
771
  :param _PayMode: 付费模式（0: 后付费；1: 预付费），默认值为0
754
772
  :type PayMode: int
755
- :param _RenewFlag: 是否自动续费（0: 不自动续费；1: 自动续费），默认值为0
773
+ :param _RenewFlag: 预付费集群是否自动续费（0: 不自动续费；1: 自动续费），默认值为0
756
774
  :type RenewFlag: int
757
- :param _TimeSpan: 购买时长（单位：月），默认值为1
775
+ :param _TimeSpan: 预付费集群的购买时长（单位：月），取值范围为1～60，默认值为1
758
776
  :type TimeSpan: int
759
- :param _MaxTopicNum: 最大可创建主题数
777
+ :param _MaxTopicNum: 最大可创建主题数，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
778
+
779
+ - 默认值和最小值：TopicNumLimit 参数
780
+ - 最大值：TopicNumUpperLimit 参数
760
781
  :type MaxTopicNum: int
761
- :param _ZoneIds: 部署可用区列表
782
+ :param _ZoneIds: 部署可用区列表，从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口获得。
762
783
  :type ZoneIds: list of int
763
784
  """
764
785
  self._InstanceType = None
@@ -780,11 +801,15 @@ PLATINUM 铂金版
780
801
 
781
802
  @property
782
803
  def InstanceType(self):
783
- """实例类型，
784
- EXPERIMENT 体验版
785
- BASIC 基础版
786
- PRO 专业版
787
- PLATINUM 铂金版
804
+ """实例类型，枚举值如下：
805
+
806
+ - EXPERIMENT：体验版
807
+
808
+ - BASIC：基础版
809
+
810
+ - PRO：专业版
811
+
812
+ - PLATINUM：铂金版
788
813
  :rtype: str
789
814
  """
790
815
  return self._InstanceType
@@ -795,7 +820,7 @@ PLATINUM 铂金版
795
820
 
796
821
  @property
797
822
  def Name(self):
798
- """集群名称
823
+ """集群名称，不能为空， 3-64个字符，只能包含数字、字母、“-”和“_”
799
824
  :rtype: str
800
825
  """
801
826
  return self._Name
@@ -806,7 +831,7 @@ PLATINUM 铂金版
806
831
 
807
832
  @property
808
833
  def SkuCode(self):
809
- """商品规格，可用规格如下：experiment_500, basic_1k, basic_2k, basic_3k, basic_4k, basic_5k, basic_6k, basic_7k, basic_8k, basic_9k, basic_10k, pro_4k, pro_6k, pro_8k, pro_1w, pro_15k, pro_2w, pro_25k, pro_3w, pro_35k, pro_4w, pro_45k, pro_5w, pro_55k, pro_60k, pro_65k, pro_70k, pro_75k, pro_80k, pro_85k, pro_90k, pro_95k, pro_100k, platinum_1w, platinum_2w, platinum_3w, platinum_4w, platinum_5w, platinum_6w, platinum_7w, platinum_8w, platinum_9w, platinum_10w, platinum_12w, platinum_14w, platinum_16w, platinum_18w, platinum_20w, platinum_25w, platinum_30w, platinum_35w, platinum_40w, platinum_45w, platinum_50w, platinum_60w, platinum_70w, platinum_80w, platinum_90w, platinum_100w
834
+ """商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
810
835
  :rtype: str
811
836
  """
812
837
  return self._SkuCode
@@ -883,7 +908,7 @@ PLATINUM 铂金版
883
908
 
884
909
  @property
885
910
  def IpRules(self):
886
- """公网访问白名单
911
+ """公网访问白名单，不填表示拒绝所有 IP 访问
887
912
  :rtype: list of IpRule
888
913
  """
889
914
  return self._IpRules
@@ -894,7 +919,11 @@ PLATINUM 铂金版
894
919
 
895
920
  @property
896
921
  def MessageRetention(self):
897
- """消息保留时长（单位：小时）
922
+ """消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
923
+
924
+ - 默认值：DefaultRetention 参数
925
+ - 最小值：RetentionLowerLimit 参数
926
+ - 最大值：RetentionUpperLimit 参数
898
927
  :rtype: int
899
928
  """
900
929
  return self._MessageRetention
@@ -916,7 +945,7 @@ PLATINUM 铂金版
916
945
 
917
946
  @property
918
947
  def RenewFlag(self):
919
- """是否自动续费（0: 不自动续费；1: 自动续费），默认值为0
948
+ """预付费集群是否自动续费（0: 不自动续费；1: 自动续费），默认值为0
920
949
  :rtype: int
921
950
  """
922
951
  return self._RenewFlag
@@ -927,7 +956,7 @@ PLATINUM 铂金版
927
956
 
928
957
  @property
929
958
  def TimeSpan(self):
930
- """购买时长（单位：月），默认值为1
959
+ """预付费集群的购买时长（单位：月），取值范围为1～60，默认值为1
931
960
  :rtype: int
932
961
  """
933
962
  return self._TimeSpan
@@ -938,7 +967,10 @@ PLATINUM 铂金版
938
967
 
939
968
  @property
940
969
  def MaxTopicNum(self):
941
- """最大可创建主题数
970
+ """最大可创建主题数，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
971
+
972
+ - 默认值和最小值：TopicNumLimit 参数
973
+ - 最大值：TopicNumUpperLimit 参数
942
974
  :rtype: int
943
975
  """
944
976
  return self._MaxTopicNum
@@ -949,7 +981,7 @@ PLATINUM 铂金版
949
981
 
950
982
  @property
951
983
  def ZoneIds(self):
952
- """部署可用区列表
984
+ """部署可用区列表，从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口获得。
953
985
  :rtype: list of int
954
986
  """
955
987
  return self._ZoneIds
@@ -1667,7 +1699,7 @@ class CreateRoleRequest(AbstractModel):
1667
1699
 
1668
1700
  def __init__(self):
1669
1701
  r"""
1670
- :param _InstanceId: 集群ID
1702
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1671
1703
  :type InstanceId: str
1672
1704
  :param _Role: 角色名称
1673
1705
  :type Role: str
@@ -1679,7 +1711,7 @@ class CreateRoleRequest(AbstractModel):
1679
1711
  :type Remark: str
1680
1712
  :param _PermType: 权限类型，默认按集群授权（Cluster：集群级别；TopicAndGroup：主题&消费组级别）
1681
1713
  :type PermType: str
1682
- :param _DetailedPerms: Topic&Group维度权限配置
1714
+ :param _DetailedPerms: Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
1683
1715
  :type DetailedPerms: list of DetailedRolePerm
1684
1716
  """
1685
1717
  self._InstanceId = None
@@ -1692,7 +1724,7 @@ class CreateRoleRequest(AbstractModel):
1692
1724
 
1693
1725
  @property
1694
1726
  def InstanceId(self):
1695
- """集群ID
1727
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1696
1728
  :rtype: str
1697
1729
  """
1698
1730
  return self._InstanceId
@@ -1758,7 +1790,7 @@ class CreateRoleRequest(AbstractModel):
1758
1790
 
1759
1791
  @property
1760
1792
  def DetailedPerms(self):
1761
- """Topic&Group维度权限配置
1793
+ """Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
1762
1794
  :rtype: list of DetailedRolePerm
1763
1795
  """
1764
1796
  return self._DetailedPerms
@@ -1841,9 +1873,9 @@ class CreateTopicRequest(AbstractModel):
1841
1873
 
1842
1874
  def __init__(self):
1843
1875
  r"""
1844
- :param _InstanceId: 集群ID
1876
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1845
1877
  :type InstanceId: str
1846
- :param _Topic: 主题名称
1878
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
1847
1879
  :type Topic: str
1848
1880
  :param _TopicType: 主题类型
1849
1881
  UNSPECIFIED:未指定,
@@ -1852,11 +1884,11 @@ FIFO:顺序消息,
1852
1884
  DELAY:延时消息,
1853
1885
  TRANSACTION:事务消息
1854
1886
  :type TopicType: str
1855
- :param _QueueNum: 队列数量
1887
+ :param _QueueNum: 队列数量，取值范围3～16
1856
1888
  :type QueueNum: int
1857
- :param _Remark: 备注
1889
+ :param _Remark: 备注，最多 128 字符
1858
1890
  :type Remark: str
1859
- :param _MsgTTL: 消息保留时长
1891
+ :param _MsgTTL: 消息保留时长（单位：小时）
1860
1892
  :type MsgTTL: int
1861
1893
  :param _TagList: 标签列表
1862
1894
  :type TagList: list of Tag
@@ -1871,7 +1903,7 @@ TRANSACTION:事务消息
1871
1903
 
1872
1904
  @property
1873
1905
  def InstanceId(self):
1874
- """集群ID
1906
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1875
1907
  :rtype: str
1876
1908
  """
1877
1909
  return self._InstanceId
@@ -1882,7 +1914,7 @@ TRANSACTION:事务消息
1882
1914
 
1883
1915
  @property
1884
1916
  def Topic(self):
1885
- """主题名称
1917
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
1886
1918
  :rtype: str
1887
1919
  """
1888
1920
  return self._Topic
@@ -1909,7 +1941,7 @@ TRANSACTION:事务消息
1909
1941
 
1910
1942
  @property
1911
1943
  def QueueNum(self):
1912
- """队列数量
1944
+ """队列数量，取值范围3～16
1913
1945
  :rtype: int
1914
1946
  """
1915
1947
  return self._QueueNum
@@ -1920,7 +1952,7 @@ TRANSACTION:事务消息
1920
1952
 
1921
1953
  @property
1922
1954
  def Remark(self):
1923
- """备注
1955
+ """备注，最多 128 字符
1924
1956
  :rtype: str
1925
1957
  """
1926
1958
  return self._Remark
@@ -1931,7 +1963,7 @@ TRANSACTION:事务消息
1931
1963
 
1932
1964
  @property
1933
1965
  def MsgTTL(self):
1934
- """消息保留时长
1966
+ """消息保留时长（单位：小时）
1935
1967
  :rtype: int
1936
1968
  """
1937
1969
  return self._MsgTTL
@@ -2095,9 +2127,9 @@ class DeleteConsumerGroupRequest(AbstractModel):
2095
2127
 
2096
2128
  def __init__(self):
2097
2129
  r"""
2098
- :param _InstanceId: 集群ID
2130
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2099
2131
  :type InstanceId: str
2100
- :param _ConsumerGroup: 消费组名称
2132
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2101
2133
  :type ConsumerGroup: str
2102
2134
  """
2103
2135
  self._InstanceId = None
@@ -2105,7 +2137,7 @@ class DeleteConsumerGroupRequest(AbstractModel):
2105
2137
 
2106
2138
  @property
2107
2139
  def InstanceId(self):
2108
- """集群ID
2140
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2109
2141
  :rtype: str
2110
2142
  """
2111
2143
  return self._InstanceId
@@ -2116,7 +2148,7 @@ class DeleteConsumerGroupRequest(AbstractModel):
2116
2148
 
2117
2149
  @property
2118
2150
  def ConsumerGroup(self):
2119
- """消费组名称
2151
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2120
2152
  :rtype: str
2121
2153
  """
2122
2154
  return self._ConsumerGroup
@@ -2174,14 +2206,14 @@ class DeleteInstanceRequest(AbstractModel):
2174
2206
 
2175
2207
  def __init__(self):
2176
2208
  r"""
2177
- :param _InstanceId: 集群ID
2209
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2178
2210
  :type InstanceId: str
2179
2211
  """
2180
2212
  self._InstanceId = None
2181
2213
 
2182
2214
  @property
2183
2215
  def InstanceId(self):
2184
- """集群ID
2216
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2185
2217
  :rtype: str
2186
2218
  """
2187
2219
  return self._InstanceId
@@ -2524,9 +2556,9 @@ class DeleteRoleRequest(AbstractModel):
2524
2556
 
2525
2557
  def __init__(self):
2526
2558
  r"""
2527
- :param _InstanceId: 集群ID
2559
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2528
2560
  :type InstanceId: str
2529
- :param _Role: 角色名称
2561
+ :param _Role: 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
2530
2562
  :type Role: str
2531
2563
  """
2532
2564
  self._InstanceId = None
@@ -2534,7 +2566,7 @@ class DeleteRoleRequest(AbstractModel):
2534
2566
 
2535
2567
  @property
2536
2568
  def InstanceId(self):
2537
- """集群ID
2569
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2538
2570
  :rtype: str
2539
2571
  """
2540
2572
  return self._InstanceId
@@ -2545,7 +2577,7 @@ class DeleteRoleRequest(AbstractModel):
2545
2577
 
2546
2578
  @property
2547
2579
  def Role(self):
2548
- """角色名称
2580
+ """角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
2549
2581
  :rtype: str
2550
2582
  """
2551
2583
  return self._Role
@@ -2669,9 +2701,9 @@ class DeleteTopicRequest(AbstractModel):
2669
2701
 
2670
2702
  def __init__(self):
2671
2703
  r"""
2672
- :param _InstanceId: 集群ID
2704
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2673
2705
  :type InstanceId: str
2674
- :param _Topic: 主题名称
2706
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2675
2707
  :type Topic: str
2676
2708
  """
2677
2709
  self._InstanceId = None
@@ -2679,7 +2711,7 @@ class DeleteTopicRequest(AbstractModel):
2679
2711
 
2680
2712
  @property
2681
2713
  def InstanceId(self):
2682
- """集群ID
2714
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2683
2715
  :rtype: str
2684
2716
  """
2685
2717
  return self._InstanceId
@@ -2690,7 +2722,7 @@ class DeleteTopicRequest(AbstractModel):
2690
2722
 
2691
2723
  @property
2692
2724
  def Topic(self):
2693
- """主题名称
2725
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2694
2726
  :rtype: str
2695
2727
  """
2696
2728
  return self._Topic
@@ -2741,6 +2773,170 @@ class DeleteTopicResponse(AbstractModel):
2741
2773
  self._RequestId = params.get("RequestId")
2742
2774
 
2743
2775
 
2776
+ class DescribeConsumerClientListRequest(AbstractModel):
2777
+ """DescribeConsumerClientList请求参数结构体
2778
+
2779
+ """
2780
+
2781
+ def __init__(self):
2782
+ r"""
2783
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2784
+ :type InstanceId: str
2785
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2786
+ :type ConsumerGroup: str
2787
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
2788
+ :type Filters: list of Filter
2789
+ :param _Offset: 查询起始位置，默认为0。
2790
+ :type Offset: int
2791
+ :param _Limit: 查询结果限制数量，默认20。
2792
+ :type Limit: int
2793
+ """
2794
+ self._InstanceId = None
2795
+ self._ConsumerGroup = None
2796
+ self._Filters = None
2797
+ self._Offset = None
2798
+ self._Limit = None
2799
+
2800
+ @property
2801
+ def InstanceId(self):
2802
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2803
+ :rtype: str
2804
+ """
2805
+ return self._InstanceId
2806
+
2807
+ @InstanceId.setter
2808
+ def InstanceId(self, InstanceId):
2809
+ self._InstanceId = InstanceId
2810
+
2811
+ @property
2812
+ def ConsumerGroup(self):
2813
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2814
+ :rtype: str
2815
+ """
2816
+ return self._ConsumerGroup
2817
+
2818
+ @ConsumerGroup.setter
2819
+ def ConsumerGroup(self, ConsumerGroup):
2820
+ self._ConsumerGroup = ConsumerGroup
2821
+
2822
+ @property
2823
+ def Filters(self):
2824
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
2825
+ :rtype: list of Filter
2826
+ """
2827
+ return self._Filters
2828
+
2829
+ @Filters.setter
2830
+ def Filters(self, Filters):
2831
+ self._Filters = Filters
2832
+
2833
+ @property
2834
+ def Offset(self):
2835
+ """查询起始位置，默认为0。
2836
+ :rtype: int
2837
+ """
2838
+ return self._Offset
2839
+
2840
+ @Offset.setter
2841
+ def Offset(self, Offset):
2842
+ self._Offset = Offset
2843
+
2844
+ @property
2845
+ def Limit(self):
2846
+ """查询结果限制数量，默认20。
2847
+ :rtype: int
2848
+ """
2849
+ return self._Limit
2850
+
2851
+ @Limit.setter
2852
+ def Limit(self, Limit):
2853
+ self._Limit = Limit
2854
+
2855
+
2856
+ def _deserialize(self, params):
2857
+ self._InstanceId = params.get("InstanceId")
2858
+ self._ConsumerGroup = params.get("ConsumerGroup")
2859
+ if params.get("Filters") is not None:
2860
+ self._Filters = []
2861
+ for item in params.get("Filters"):
2862
+ obj = Filter()
2863
+ obj._deserialize(item)
2864
+ self._Filters.append(obj)
2865
+ self._Offset = params.get("Offset")
2866
+ self._Limit = params.get("Limit")
2867
+ memeber_set = set(params.keys())
2868
+ for name, value in vars(self).items():
2869
+ property_name = name[1:]
2870
+ if property_name in memeber_set:
2871
+ memeber_set.remove(property_name)
2872
+ if len(memeber_set) > 0:
2873
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
2874
+
2875
+
2876
+
2877
+ class DescribeConsumerClientListResponse(AbstractModel):
2878
+ """DescribeConsumerClientList返回参数结构体
2879
+
2880
+ """
2881
+
2882
+ def __init__(self):
2883
+ r"""
2884
+ :param _TotalCount: 查询总数
2885
+ :type TotalCount: int
2886
+ :param _Data: 消费客户端
2887
+ :type Data: list of ConsumerClient
2888
+ :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
2889
+ :type RequestId: str
2890
+ """
2891
+ self._TotalCount = None
2892
+ self._Data = None
2893
+ self._RequestId = None
2894
+
2895
+ @property
2896
+ def TotalCount(self):
2897
+ """查询总数
2898
+ :rtype: int
2899
+ """
2900
+ return self._TotalCount
2901
+
2902
+ @TotalCount.setter
2903
+ def TotalCount(self, TotalCount):
2904
+ self._TotalCount = TotalCount
2905
+
2906
+ @property
2907
+ def Data(self):
2908
+ """消费客户端
2909
+ :rtype: list of ConsumerClient
2910
+ """
2911
+ return self._Data
2912
+
2913
+ @Data.setter
2914
+ def Data(self, Data):
2915
+ self._Data = Data
2916
+
2917
+ @property
2918
+ def RequestId(self):
2919
+ """唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
2920
+ :rtype: str
2921
+ """
2922
+ return self._RequestId
2923
+
2924
+ @RequestId.setter
2925
+ def RequestId(self, RequestId):
2926
+ self._RequestId = RequestId
2927
+
2928
+
2929
+ def _deserialize(self, params):
2930
+ self._TotalCount = params.get("TotalCount")
2931
+ if params.get("Data") is not None:
2932
+ self._Data = []
2933
+ for item in params.get("Data"):
2934
+ obj = ConsumerClient()
2935
+ obj._deserialize(item)
2936
+ self._Data.append(obj)
2937
+ self._RequestId = params.get("RequestId")
2938
+
2939
+
2744
2940
  class DescribeConsumerClientRequest(AbstractModel):
2745
2941
  """DescribeConsumerClient请求参数结构体
2746
2942
 
@@ -2748,17 +2944,17 @@ class DescribeConsumerClientRequest(AbstractModel):
2748
2944
 
2749
2945
  def __init__(self):
2750
2946
  r"""
2751
- :param _InstanceId: 集群ID
2947
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2752
2948
  :type InstanceId: str
2753
- :param _ClientId: 客户端ID
2949
+ :param _ClientId: 客户端ID，从 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140) 接口中的 [ConsumerClient](https://cloud.tencent.com/document/api/1493/96031#ConsumerClient) 出参中获得。
2754
2950
  :type ClientId: str
2755
- :param _Filters: 查询条件列表
2951
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
2756
2952
  :type Filters: list of Filter
2757
- :param _Offset: 查询起始位置
2953
+ :param _Offset: 查询起始位置，默认为0。
2758
2954
  :type Offset: int
2759
- :param _Limit: 查询结果限制数量
2955
+ :param _Limit: 查询结果限制数量，默认20。
2760
2956
  :type Limit: int
2761
- :param _ConsumerGroup: 消费组名称
2957
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2762
2958
  :type ConsumerGroup: str
2763
2959
  """
2764
2960
  self._InstanceId = None
@@ -2770,7 +2966,7 @@ class DescribeConsumerClientRequest(AbstractModel):
2770
2966
 
2771
2967
  @property
2772
2968
  def InstanceId(self):
2773
- """集群ID
2969
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2774
2970
  :rtype: str
2775
2971
  """
2776
2972
  return self._InstanceId
@@ -2781,7 +2977,7 @@ class DescribeConsumerClientRequest(AbstractModel):
2781
2977
 
2782
2978
  @property
2783
2979
  def ClientId(self):
2784
- """客户端ID
2980
+ """客户端ID，从 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140) 接口中的 [ConsumerClient](https://cloud.tencent.com/document/api/1493/96031#ConsumerClient) 出参中获得。
2785
2981
  :rtype: str
2786
2982
  """
2787
2983
  return self._ClientId
@@ -2792,7 +2988,7 @@ class DescribeConsumerClientRequest(AbstractModel):
2792
2988
 
2793
2989
  @property
2794
2990
  def Filters(self):
2795
- """查询条件列表
2991
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
2796
2992
  :rtype: list of Filter
2797
2993
  """
2798
2994
  return self._Filters
@@ -2803,7 +2999,7 @@ class DescribeConsumerClientRequest(AbstractModel):
2803
2999
 
2804
3000
  @property
2805
3001
  def Offset(self):
2806
- """查询起始位置
3002
+ """查询起始位置，默认为0。
2807
3003
  :rtype: int
2808
3004
  """
2809
3005
  return self._Offset
@@ -2814,7 +3010,7 @@ class DescribeConsumerClientRequest(AbstractModel):
2814
3010
 
2815
3011
  @property
2816
3012
  def Limit(self):
2817
- """查询结果限制数量
3013
+ """查询结果限制数量，默认20。
2818
3014
  :rtype: int
2819
3015
  """
2820
3016
  return self._Limit
@@ -2825,7 +3021,7 @@ class DescribeConsumerClientRequest(AbstractModel):
2825
3021
 
2826
3022
  @property
2827
3023
  def ConsumerGroup(self):
2828
- """消费组名称
3024
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2829
3025
  :rtype: str
2830
3026
  """
2831
3027
  return self._ConsumerGroup
@@ -2933,13 +3129,13 @@ class DescribeConsumerGroupListRequest(AbstractModel):
2933
3129
 
2934
3130
  def __init__(self):
2935
3131
  r"""
2936
- :param _InstanceId: 集群ID
3132
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2937
3133
  :type InstanceId: str
2938
- :param _Filters: 查询条件列表
3134
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
2939
3135
  :type Filters: list of Filter
2940
- :param _Offset: 查询起始位置
3136
+ :param _Offset: 查询起始位置，默认为0。
2941
3137
  :type Offset: int
2942
- :param _Limit: 查询结果限制数量
3138
+ :param _Limit: 查询结果限制数量，默认20。
2943
3139
  :type Limit: int
2944
3140
  :param _FromTopic: 查询指定主题下的消费组
2945
3141
  :type FromTopic: str
@@ -2952,7 +3148,7 @@ class DescribeConsumerGroupListRequest(AbstractModel):
2952
3148
 
2953
3149
  @property
2954
3150
  def InstanceId(self):
2955
- """集群ID
3151
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2956
3152
  :rtype: str
2957
3153
  """
2958
3154
  return self._InstanceId
@@ -2963,7 +3159,7 @@ class DescribeConsumerGroupListRequest(AbstractModel):
2963
3159
 
2964
3160
  @property
2965
3161
  def Filters(self):
2966
- """查询条件列表
3162
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
2967
3163
  :rtype: list of Filter
2968
3164
  """
2969
3165
  return self._Filters
@@ -2974,7 +3170,7 @@ class DescribeConsumerGroupListRequest(AbstractModel):
2974
3170
 
2975
3171
  @property
2976
3172
  def Offset(self):
2977
- """查询起始位置
3173
+ """查询起始位置，默认为0。
2978
3174
  :rtype: int
2979
3175
  """
2980
3176
  return self._Offset
@@ -2985,7 +3181,7 @@ class DescribeConsumerGroupListRequest(AbstractModel):
2985
3181
 
2986
3182
  @property
2987
3183
  def Limit(self):
2988
- """查询结果限制数量
3184
+ """查询结果限制数量，默认20。
2989
3185
  :rtype: int
2990
3186
  """
2991
3187
  return self._Limit
@@ -3097,9 +3293,9 @@ class DescribeConsumerGroupRequest(AbstractModel):
3097
3293
 
3098
3294
  def __init__(self):
3099
3295
  r"""
3100
- :param _InstanceId: 集群ID
3296
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3101
3297
  :type InstanceId: str
3102
- :param _ConsumerGroup: 消费组名称
3298
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
3103
3299
  :type ConsumerGroup: str
3104
3300
  """
3105
3301
  self._InstanceId = None
@@ -3107,7 +3303,7 @@ class DescribeConsumerGroupRequest(AbstractModel):
3107
3303
 
3108
3304
  @property
3109
3305
  def InstanceId(self):
3110
- """集群ID
3306
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3111
3307
  :rtype: str
3112
3308
  """
3113
3309
  return self._InstanceId
@@ -3118,7 +3314,7 @@ class DescribeConsumerGroupRequest(AbstractModel):
3118
3314
 
3119
3315
  @property
3120
3316
  def ConsumerGroup(self):
3121
- """消费组名称
3317
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
3122
3318
  :rtype: str
3123
3319
  """
3124
3320
  return self._ConsumerGroup
@@ -3154,9 +3350,13 @@ class DescribeConsumerGroupResponse(AbstractModel):
3154
3350
  :type Tps: int
3155
3351
  :param _ConsumerLag: 消息堆积数量
3156
3352
  :type ConsumerLag: int
3157
- :param _ConsumeType: 消费者类型
3353
+ :param _ConsumeType: 消费类型，枚举值如下：
3354
+
3355
+ - PULL：PULL 消费类型
3356
+ - PUSH：PUSH 消费类型
3357
+ - POP：POP 消费类型
3158
3358
  :type ConsumeType: str
3159
- :param _CreatedTime: 创建时间，秒为单位
3359
+ :param _CreatedTime: 创建时间，**Unix时间戳（毫秒）**
3160
3360
  :type CreatedTime: int
3161
3361
  :param _ConsumeMessageOrderly: 顺序投递：true
3162
3362
  并发投递：false
@@ -3221,7 +3421,11 @@ CLUSTERING 集群模式
3221
3421
 
3222
3422
  @property
3223
3423
  def ConsumeType(self):
3224
- """消费者类型
3424
+ """消费类型，枚举值如下：
3425
+
3426
+ - PULL：PULL 消费类型
3427
+ - PUSH：PUSH 消费类型
3428
+ - POP：POP 消费类型
3225
3429
  :rtype: str
3226
3430
  """
3227
3431
  return self._ConsumeType
@@ -3232,7 +3436,7 @@ CLUSTERING 集群模式
3232
3436
 
3233
3437
  @property
3234
3438
  def CreatedTime(self):
3235
- """创建时间，秒为单位
3439
+ """创建时间，**Unix时间戳（毫秒）**
3236
3440
  :rtype: int
3237
3441
  """
3238
3442
  return self._CreatedTime
@@ -3332,13 +3536,13 @@ class DescribeConsumerLagRequest(AbstractModel):
3332
3536
 
3333
3537
  def __init__(self):
3334
3538
  r"""
3335
- :param _InstanceId: 集群ID
3539
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3336
3540
  :type InstanceId: str
3337
- :param _ConsumerGroup: 消费组名称
3541
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
3338
3542
  :type ConsumerGroup: str
3339
- :param _Namespace: 命名空间，4.x集群必填
3543
+ :param _Namespace: 命名空间，4.x集群必填，从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口或控制台获得。
3340
3544
  :type Namespace: str
3341
- :param _SubscribeTopic: 订阅主题，不为空则查询订阅了该主题的消费组的堆积
3545
+ :param _SubscribeTopic: 订阅主题，不为空则查询订阅了该主题的消费组的堆积，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
3342
3546
  :type SubscribeTopic: str
3343
3547
  """
3344
3548
  self._InstanceId = None
@@ -3348,7 +3552,7 @@ class DescribeConsumerLagRequest(AbstractModel):
3348
3552
 
3349
3553
  @property
3350
3554
  def InstanceId(self):
3351
- """集群ID
3555
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3352
3556
  :rtype: str
3353
3557
  """
3354
3558
  return self._InstanceId
@@ -3359,7 +3563,7 @@ class DescribeConsumerLagRequest(AbstractModel):
3359
3563
 
3360
3564
  @property
3361
3565
  def ConsumerGroup(self):
3362
- """消费组名称
3566
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
3363
3567
  :rtype: str
3364
3568
  """
3365
3569
  return self._ConsumerGroup
@@ -3370,7 +3574,7 @@ class DescribeConsumerLagRequest(AbstractModel):
3370
3574
 
3371
3575
  @property
3372
3576
  def Namespace(self):
3373
- """命名空间，4.x集群必填
3577
+ """命名空间，4.x集群必填，从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口或控制台获得。
3374
3578
  :rtype: str
3375
3579
  """
3376
3580
  return self._Namespace
@@ -3381,7 +3585,7 @@ class DescribeConsumerLagRequest(AbstractModel):
3381
3585
 
3382
3586
  @property
3383
3587
  def SubscribeTopic(self):
3384
- """订阅主题，不为空则查询订阅了该主题的消费组的堆积
3588
+ """订阅主题，不为空则查询订阅了该主题的消费组的堆积，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
3385
3589
  :rtype: str
3386
3590
  """
3387
3591
  return self._SubscribeTopic
@@ -3456,11 +3660,11 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3456
3660
 
3457
3661
  def __init__(self):
3458
3662
  r"""
3459
- :param _Offset: 查询起始位置
3663
+ :param _Offset: 查询起始位置，默认为0。
3460
3664
  :type Offset: int
3461
- :param _Limit: 查询结果限制数量
3665
+ :param _Limit: 查询结果限制数量，默认20。
3462
3666
  :type Limit: int
3463
- :param _Filters: 查询条件列表
3667
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
3464
3668
  :type Filters: list of Filter
3465
3669
  :param _TagFilters: 标签过滤器
3466
3670
  :type TagFilters: list of TagFilter
@@ -3472,7 +3676,7 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3472
3676
 
3473
3677
  @property
3474
3678
  def Offset(self):
3475
- """查询起始位置
3679
+ """查询起始位置，默认为0。
3476
3680
  :rtype: int
3477
3681
  """
3478
3682
  return self._Offset
@@ -3483,7 +3687,7 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3483
3687
 
3484
3688
  @property
3485
3689
  def Limit(self):
3486
- """查询结果限制数量
3690
+ """查询结果限制数量，默认20。
3487
3691
  :rtype: int
3488
3692
  """
3489
3693
  return self._Limit
@@ -3494,7 +3698,7 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3494
3698
 
3495
3699
  @property
3496
3700
  def Filters(self):
3497
- """查询条件列表
3701
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
3498
3702
  :rtype: list of Filter
3499
3703
  """
3500
3704
  return self._Filters
@@ -3610,13 +3814,13 @@ class DescribeInstanceListRequest(AbstractModel):
3610
3814
 
3611
3815
  def __init__(self):
3612
3816
  r"""
3613
- :param _Filters: 查询条件列表
3817
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
3614
3818
  :type Filters: list of Filter
3615
3819
  :param _TagFilters: 标签过滤器
3616
3820
  :type TagFilters: list of TagFilter
3617
- :param _Offset: 查询起始位置
3821
+ :param _Offset: 查询起始位置，默认为0。
3618
3822
  :type Offset: int
3619
- :param _Limit: 查询结果限制数量
3823
+ :param _Limit: 查询结果限制数量，默认20。
3620
3824
  :type Limit: int
3621
3825
  """
3622
3826
  self._Filters = None
@@ -3626,7 +3830,7 @@ class DescribeInstanceListRequest(AbstractModel):
3626
3830
 
3627
3831
  @property
3628
3832
  def Filters(self):
3629
- """查询条件列表
3833
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
3630
3834
  :rtype: list of Filter
3631
3835
  """
3632
3836
  return self._Filters
@@ -3648,7 +3852,7 @@ class DescribeInstanceListRequest(AbstractModel):
3648
3852
 
3649
3853
  @property
3650
3854
  def Offset(self):
3651
- """查询起始位置
3855
+ """查询起始位置，默认为0。
3652
3856
  :rtype: int
3653
3857
  """
3654
3858
  return self._Offset
@@ -3659,7 +3863,7 @@ class DescribeInstanceListRequest(AbstractModel):
3659
3863
 
3660
3864
  @property
3661
3865
  def Limit(self):
3662
- """查询结果限制数量
3866
+ """查询结果限制数量，默认20。
3663
3867
  :rtype: int
3664
3868
  """
3665
3869
  return self._Limit
@@ -3764,14 +3968,14 @@ class DescribeInstanceRequest(AbstractModel):
3764
3968
 
3765
3969
  def __init__(self):
3766
3970
  r"""
3767
- :param _InstanceId: 集群ID
3971
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3768
3972
  :type InstanceId: str
3769
3973
  """
3770
3974
  self._InstanceId = None
3771
3975
 
3772
3976
  @property
3773
3977
  def InstanceId(self):
3774
- """集群ID
3978
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3775
3979
  :rtype: str
3776
3980
  """
3777
3981
  return self._InstanceId
@@ -3830,7 +4034,7 @@ PLATINUM 铂金版
3830
4034
  :type ScaledTpsLimit: int
3831
4035
  :param _MaxMessageDelay: 延迟消息最长时间，小时为单位
3832
4036
  :type MaxMessageDelay: int
3833
- :param _CreatedTime: 创建时间，秒为单位
4037
+ :param _CreatedTime: 创建时间，**Unix时间戳（毫秒）**
3834
4038
  :type CreatedTime: int
3835
4039
  :param _SendReceiveRatio: 消息发送接收比例
3836
4040
  :type SendReceiveRatio: float
@@ -3846,17 +4050,33 @@ PLATINUM 铂金版
3846
4050
  :type TopicQueueNumLowerLimit: int
3847
4051
  :param _Remark: 备注信息
3848
4052
  :type Remark: str
3849
- :param _InstanceStatus: 实例状态
4053
+ :param _InstanceStatus: 实例状态，枚举值如下：
4054
+
4055
+ - RUNNING：运行中
4056
+ - ABNORMAL：异常
4057
+ - OVERDUE：隔离中
4058
+ - DESTROYED：已销毁
4059
+ - CREATING：创建中
4060
+ - MODIFYING：变配中
4061
+ - CREATE_FAILURE：创建失败
4062
+ - MODIFY_FAILURE：变配失败
4063
+ - DELETING：删除中
3850
4064
  :type InstanceStatus: str
3851
4065
  :param _SkuCode: 实例规格
3852
4066
  :type SkuCode: str
3853
- :param _PayMode: 计费模式
4067
+ :param _PayMode: 计费模式，枚举值如下：
4068
+
4069
+ - POSTPAID：后付费按量计费
4070
+ - PREPAID：预付费包年包月
3854
4071
  :type PayMode: str
3855
4072
  :param _ScaledTpsEnabled: 是否开启弹性TPS
3856
4073
  :type ScaledTpsEnabled: bool
3857
- :param _RenewFlag: 是否自动续费
4074
+ :param _RenewFlag: 预付费集群是否自动续费，枚举值如下：
4075
+
4076
+ - 0: 不自动续费
4077
+ - 1: 自动续费
3858
4078
  :type RenewFlag: int
3859
- :param _ExpiryTime: 到期时间
4079
+ :param _ExpiryTime: 到期时间，**Unix时间戳（毫秒）**
3860
4080
  :type ExpiryTime: int
3861
4081
  :param _RoleNumLimit: 角色数量限制
3862
4082
  :type RoleNumLimit: int
@@ -3869,7 +4089,7 @@ PLATINUM 铂金版
3869
4089
  :param _TopicNumUpperLimit: 最大可设置的topic个数
3870
4090
  注意：此字段可能返回 null，表示取不到有效值。
3871
4091
  :type TopicNumUpperLimit: int
3872
- :param _ZoneIds: 可用区列表
4092
+ :param _ZoneIds: 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
3873
4093
  :type ZoneIds: list of int
3874
4094
  :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
3875
4095
  :type RequestId: str
@@ -4056,7 +4276,7 @@ PLATINUM 铂金版
4056
4276
 
4057
4277
  @property
4058
4278
  def CreatedTime(self):
4059
- """创建时间，秒为单位
4279
+ """创建时间，**Unix时间戳（毫秒）**
4060
4280
  :rtype: int
4061
4281
  """
4062
4282
  return self._CreatedTime
@@ -4135,7 +4355,17 @@ PLATINUM 铂金版
4135
4355
 
4136
4356
  @property
4137
4357
  def InstanceStatus(self):
4138
- """实例状态
4358
+ """实例状态，枚举值如下：
4359
+
4360
+ - RUNNING：运行中
4361
+ - ABNORMAL：异常
4362
+ - OVERDUE：隔离中
4363
+ - DESTROYED：已销毁
4364
+ - CREATING：创建中
4365
+ - MODIFYING：变配中
4366
+ - CREATE_FAILURE：创建失败
4367
+ - MODIFY_FAILURE：变配失败
4368
+ - DELETING：删除中
4139
4369
  :rtype: str
4140
4370
  """
4141
4371
  return self._InstanceStatus
@@ -4157,7 +4387,10 @@ PLATINUM 铂金版
4157
4387
 
4158
4388
  @property
4159
4389
  def PayMode(self):
4160
- """计费模式
4390
+ """计费模式，枚举值如下：
4391
+
4392
+ - POSTPAID：后付费按量计费
4393
+ - PREPAID：预付费包年包月
4161
4394
  :rtype: str
4162
4395
  """
4163
4396
  return self._PayMode
@@ -4179,7 +4412,10 @@ PLATINUM 铂金版
4179
4412
 
4180
4413
  @property
4181
4414
  def RenewFlag(self):
4182
- """是否自动续费
4415
+ """预付费集群是否自动续费，枚举值如下：
4416
+
4417
+ - 0: 不自动续费
4418
+ - 1: 自动续费
4183
4419
  :rtype: int
4184
4420
  """
4185
4421
  return self._RenewFlag
@@ -4190,7 +4426,7 @@ PLATINUM 铂金版
4190
4426
 
4191
4427
  @property
4192
4428
  def ExpiryTime(self):
4193
- """到期时间
4429
+ """到期时间，**Unix时间戳（毫秒）**
4194
4430
  :rtype: int
4195
4431
  """
4196
4432
  return self._ExpiryTime
@@ -4248,7 +4484,7 @@ PLATINUM 铂金版
4248
4484
 
4249
4485
  @property
4250
4486
  def ZoneIds(self):
4251
- """可用区列表
4487
+ """所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
4252
4488
  :rtype: list of int
4253
4489
  """
4254
4490
  return self._ZoneIds
@@ -6263,31 +6499,31 @@ class DescribeMessageListRequest(AbstractModel):
6263
6499
 
6264
6500
  def __init__(self):
6265
6501
  r"""
6266
- :param _InstanceId: 集群ID
6502
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6267
6503
  :type InstanceId: str
6268
- :param _Topic: 主题名称
6504
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6269
6505
  :type Topic: str
6270
- :param _StartTime: 开始时间
6506
+ :param _StartTime: 要查询消息的开始时间，**Unix时间戳（毫秒）**
6271
6507
  :type StartTime: int
6272
- :param _EndTime: 结束时间
6508
+ :param _EndTime: 要查询消息的结束时间，**Unix时间戳（毫秒）**
6273
6509
  :type EndTime: int
6274
- :param _TaskRequestId: 一次查询标识
6510
+ :param _TaskRequestId: 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
6275
6511
  :type TaskRequestId: str
6276
- :param _Offset: 查询起始位置
6512
+ :param _Offset: 查询起始位置，默认为0。
6277
6513
  :type Offset: int
6278
- :param _Limit: 查询结果限制数量
6514
+ :param _Limit: 查询结果限制数量，默认20。
6279
6515
  :type Limit: int
6280
- :param _ConsumerGroup: 消费组名称
6516
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
6281
6517
  :type ConsumerGroup: str
6282
- :param _MsgId: 消息 ID
6518
+ :param _MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6283
6519
  :type MsgId: str
6284
- :param _MsgKey: 消息 Key
6520
+ :param _MsgKey: 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6285
6521
  :type MsgKey: str
6286
6522
  :param _RecentMessageNum: 查询最近N条消息 最大不超过1024，默认-1为其他查询条件
6287
6523
  :type RecentMessageNum: int
6288
- :param _QueryDeadLetterMessage: 是否查询死信消息
6524
+ :param _QueryDeadLetterMessage: 是否查询死信消息，默认为false
6289
6525
  :type QueryDeadLetterMessage: bool
6290
- :param _Tag: 消息 Tag
6526
+ :param _Tag: 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6291
6527
  :type Tag: str
6292
6528
  """
6293
6529
  self._InstanceId = None
@@ -6306,7 +6542,7 @@ class DescribeMessageListRequest(AbstractModel):
6306
6542
 
6307
6543
  @property
6308
6544
  def InstanceId(self):
6309
- """集群ID
6545
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6310
6546
  :rtype: str
6311
6547
  """
6312
6548
  return self._InstanceId
@@ -6317,7 +6553,7 @@ class DescribeMessageListRequest(AbstractModel):
6317
6553
 
6318
6554
  @property
6319
6555
  def Topic(self):
6320
- """主题名称
6556
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6321
6557
  :rtype: str
6322
6558
  """
6323
6559
  return self._Topic
@@ -6328,7 +6564,7 @@ class DescribeMessageListRequest(AbstractModel):
6328
6564
 
6329
6565
  @property
6330
6566
  def StartTime(self):
6331
- """开始时间
6567
+ """要查询消息的开始时间，**Unix时间戳（毫秒）**
6332
6568
  :rtype: int
6333
6569
  """
6334
6570
  return self._StartTime
@@ -6339,7 +6575,7 @@ class DescribeMessageListRequest(AbstractModel):
6339
6575
 
6340
6576
  @property
6341
6577
  def EndTime(self):
6342
- """结束时间
6578
+ """要查询消息的结束时间，**Unix时间戳（毫秒）**
6343
6579
  :rtype: int
6344
6580
  """
6345
6581
  return self._EndTime
@@ -6350,7 +6586,7 @@ class DescribeMessageListRequest(AbstractModel):
6350
6586
 
6351
6587
  @property
6352
6588
  def TaskRequestId(self):
6353
- """一次查询标识
6589
+ """一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
6354
6590
  :rtype: str
6355
6591
  """
6356
6592
  return self._TaskRequestId
@@ -6361,7 +6597,7 @@ class DescribeMessageListRequest(AbstractModel):
6361
6597
 
6362
6598
  @property
6363
6599
  def Offset(self):
6364
- """查询起始位置
6600
+ """查询起始位置，默认为0。
6365
6601
  :rtype: int
6366
6602
  """
6367
6603
  return self._Offset
@@ -6372,7 +6608,7 @@ class DescribeMessageListRequest(AbstractModel):
6372
6608
 
6373
6609
  @property
6374
6610
  def Limit(self):
6375
- """查询结果限制数量
6611
+ """查询结果限制数量，默认20。
6376
6612
  :rtype: int
6377
6613
  """
6378
6614
  return self._Limit
@@ -6383,7 +6619,7 @@ class DescribeMessageListRequest(AbstractModel):
6383
6619
 
6384
6620
  @property
6385
6621
  def ConsumerGroup(self):
6386
- """消费组名称
6622
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
6387
6623
  :rtype: str
6388
6624
  """
6389
6625
  return self._ConsumerGroup
@@ -6394,7 +6630,7 @@ class DescribeMessageListRequest(AbstractModel):
6394
6630
 
6395
6631
  @property
6396
6632
  def MsgId(self):
6397
- """消息 ID
6633
+ """消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6398
6634
  :rtype: str
6399
6635
  """
6400
6636
  return self._MsgId
@@ -6405,7 +6641,7 @@ class DescribeMessageListRequest(AbstractModel):
6405
6641
 
6406
6642
  @property
6407
6643
  def MsgKey(self):
6408
- """消息 Key
6644
+ """消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6409
6645
  :rtype: str
6410
6646
  """
6411
6647
  return self._MsgKey
@@ -6427,7 +6663,7 @@ class DescribeMessageListRequest(AbstractModel):
6427
6663
 
6428
6664
  @property
6429
6665
  def QueryDeadLetterMessage(self):
6430
- """是否查询死信消息
6666
+ """是否查询死信消息，默认为false
6431
6667
  :rtype: bool
6432
6668
  """
6433
6669
  return self._QueryDeadLetterMessage
@@ -6438,7 +6674,7 @@ class DescribeMessageListRequest(AbstractModel):
6438
6674
 
6439
6675
  @property
6440
6676
  def Tag(self):
6441
- """消息 Tag
6677
+ """消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6442
6678
  :rtype: str
6443
6679
  """
6444
6680
  return self._Tag
@@ -6561,19 +6797,19 @@ class DescribeMessageRequest(AbstractModel):
6561
6797
 
6562
6798
  def __init__(self):
6563
6799
  r"""
6564
- :param _InstanceId: 集群ID
6800
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6565
6801
  :type InstanceId: str
6566
- :param _Topic: 主题名称
6802
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6567
6803
  :type Topic: str
6568
- :param _MsgId: 消息ID
6804
+ :param _MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6569
6805
  :type MsgId: str
6570
- :param _Offset: 查询起始位置
6806
+ :param _Offset: 查询起始位置，默认为0。
6571
6807
  :type Offset: int
6572
- :param _Limit: 查询结果限制数量
6808
+ :param _Limit: 查询结果限制数量，默认20。
6573
6809
  :type Limit: int
6574
- :param _QueryDeadLetterMessage: 是否是死信消息
6810
+ :param _QueryDeadLetterMessage: 是否是死信消息，默认为false
6575
6811
  :type QueryDeadLetterMessage: bool
6576
- :param _QueryDelayMessage: 是否是延时消息
6812
+ :param _QueryDelayMessage: 是否是延时消息，默认为false
6577
6813
  :type QueryDelayMessage: bool
6578
6814
  """
6579
6815
  self._InstanceId = None
@@ -6586,7 +6822,7 @@ class DescribeMessageRequest(AbstractModel):
6586
6822
 
6587
6823
  @property
6588
6824
  def InstanceId(self):
6589
- """集群ID
6825
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6590
6826
  :rtype: str
6591
6827
  """
6592
6828
  return self._InstanceId
@@ -6597,7 +6833,7 @@ class DescribeMessageRequest(AbstractModel):
6597
6833
 
6598
6834
  @property
6599
6835
  def Topic(self):
6600
- """主题名称
6836
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6601
6837
  :rtype: str
6602
6838
  """
6603
6839
  return self._Topic
@@ -6608,7 +6844,7 @@ class DescribeMessageRequest(AbstractModel):
6608
6844
 
6609
6845
  @property
6610
6846
  def MsgId(self):
6611
- """消息ID
6847
+ """消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6612
6848
  :rtype: str
6613
6849
  """
6614
6850
  return self._MsgId
@@ -6619,7 +6855,7 @@ class DescribeMessageRequest(AbstractModel):
6619
6855
 
6620
6856
  @property
6621
6857
  def Offset(self):
6622
- """查询起始位置
6858
+ """查询起始位置，默认为0。
6623
6859
  :rtype: int
6624
6860
  """
6625
6861
  return self._Offset
@@ -6630,7 +6866,7 @@ class DescribeMessageRequest(AbstractModel):
6630
6866
 
6631
6867
  @property
6632
6868
  def Limit(self):
6633
- """查询结果限制数量
6869
+ """查询结果限制数量，默认20。
6634
6870
  :rtype: int
6635
6871
  """
6636
6872
  return self._Limit
@@ -6641,7 +6877,7 @@ class DescribeMessageRequest(AbstractModel):
6641
6877
 
6642
6878
  @property
6643
6879
  def QueryDeadLetterMessage(self):
6644
- """是否是死信消息
6880
+ """是否是死信消息，默认为false
6645
6881
  :rtype: bool
6646
6882
  """
6647
6883
  return self._QueryDeadLetterMessage
@@ -6652,7 +6888,7 @@ class DescribeMessageRequest(AbstractModel):
6652
6888
 
6653
6889
  @property
6654
6890
  def QueryDelayMessage(self):
6655
- """是否是延时消息
6891
+ """是否是延时消息，默认为false
6656
6892
  :rtype: bool
6657
6893
  """
6658
6894
  return self._QueryDelayMessage
@@ -6701,7 +6937,7 @@ class DescribeMessageResponse(AbstractModel):
6701
6937
  :param _MessageTracks: 消息消费情况列表
6702
6938
  注意：此字段可能返回 null，表示取不到有效值。
6703
6939
  :type MessageTracks: list of MessageTrackItem
6704
- :param _ShowTopicName: Topic
6940
+ :param _ShowTopicName: 主题名称
6705
6941
  :type ShowTopicName: str
6706
6942
  :param _MessageTracksCount: 消息消费情况列表总条数
6707
6943
  注意：此字段可能返回 null，表示取不到有效值。
@@ -6789,7 +7025,7 @@ class DescribeMessageResponse(AbstractModel):
6789
7025
 
6790
7026
  @property
6791
7027
  def ShowTopicName(self):
6792
- """Topic
7028
+ """主题名称
6793
7029
  :rtype: str
6794
7030
  """
6795
7031
  return self._ShowTopicName
@@ -6846,15 +7082,15 @@ class DescribeMessageTraceRequest(AbstractModel):
6846
7082
 
6847
7083
  def __init__(self):
6848
7084
  r"""
6849
- :param _InstanceId: 集群ID
7085
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6850
7086
  :type InstanceId: str
6851
- :param _Topic: 主题名称
7087
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6852
7088
  :type Topic: str
6853
- :param _MsgId: 消息ID
7089
+ :param _MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6854
7090
  :type MsgId: str
6855
- :param _QueryDeadLetterMessage: 是否是死信消息
7091
+ :param _QueryDeadLetterMessage: 是否是死信消息，默认为false
6856
7092
  :type QueryDeadLetterMessage: bool
6857
- :param _QueryDelayMessage: 是否是延时消息
7093
+ :param _QueryDelayMessage: 是否是延时消息，默认为false
6858
7094
  :type QueryDelayMessage: bool
6859
7095
  """
6860
7096
  self._InstanceId = None
@@ -6865,7 +7101,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6865
7101
 
6866
7102
  @property
6867
7103
  def InstanceId(self):
6868
- """集群ID
7104
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6869
7105
  :rtype: str
6870
7106
  """
6871
7107
  return self._InstanceId
@@ -6876,7 +7112,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6876
7112
 
6877
7113
  @property
6878
7114
  def Topic(self):
6879
- """主题名称
7115
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6880
7116
  :rtype: str
6881
7117
  """
6882
7118
  return self._Topic
@@ -6887,7 +7123,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6887
7123
 
6888
7124
  @property
6889
7125
  def MsgId(self):
6890
- """消息ID
7126
+ """消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6891
7127
  :rtype: str
6892
7128
  """
6893
7129
  return self._MsgId
@@ -6898,7 +7134,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6898
7134
 
6899
7135
  @property
6900
7136
  def QueryDeadLetterMessage(self):
6901
- """是否是死信消息
7137
+ """是否是死信消息，默认为false
6902
7138
  :rtype: bool
6903
7139
  """
6904
7140
  return self._QueryDeadLetterMessage
@@ -6909,7 +7145,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6909
7145
 
6910
7146
  @property
6911
7147
  def QueryDelayMessage(self):
6912
- """是否是延时消息
7148
+ """是否是延时消息，默认为false
6913
7149
  :rtype: bool
6914
7150
  """
6915
7151
  return self._QueryDelayMessage
@@ -6942,7 +7178,7 @@ class DescribeMessageTraceResponse(AbstractModel):
6942
7178
 
6943
7179
  def __init__(self):
6944
7180
  r"""
6945
- :param _ShowTopicName: 展示Topic名
7181
+ :param _ShowTopicName: 主题名称
6946
7182
  :type ShowTopicName: str
6947
7183
  :param _Data: 轨迹详情
6948
7184
  注意：此字段可能返回 null，表示取不到有效值。
@@ -6956,7 +7192,7 @@ class DescribeMessageTraceResponse(AbstractModel):
6956
7192
 
6957
7193
  @property
6958
7194
  def ShowTopicName(self):
6959
- """展示Topic名
7195
+ """主题名称
6960
7196
  :rtype: str
6961
7197
  """
6962
7198
  return self._ShowTopicName
@@ -7674,13 +7910,13 @@ class DescribeRoleListRequest(AbstractModel):
7674
7910
 
7675
7911
  def __init__(self):
7676
7912
  r"""
7677
- :param _InstanceId: 集群ID
7913
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
7678
7914
  :type InstanceId: str
7679
- :param _Offset: 查询起始位置
7915
+ :param _Offset: 查询起始位置，默认为0。
7680
7916
  :type Offset: int
7681
- :param _Limit: 查询结果限制数量
7917
+ :param _Limit: 查询结果限制数量，默认20。
7682
7918
  :type Limit: int
7683
- :param _Filters: 查询条件列表
7919
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
7684
7920
  :type Filters: list of Filter
7685
7921
  """
7686
7922
  self._InstanceId = None
@@ -7690,7 +7926,7 @@ class DescribeRoleListRequest(AbstractModel):
7690
7926
 
7691
7927
  @property
7692
7928
  def InstanceId(self):
7693
- """集群ID
7929
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
7694
7930
  :rtype: str
7695
7931
  """
7696
7932
  return self._InstanceId
@@ -7701,7 +7937,7 @@ class DescribeRoleListRequest(AbstractModel):
7701
7937
 
7702
7938
  @property
7703
7939
  def Offset(self):
7704
- """查询起始位置
7940
+ """查询起始位置，默认为0。
7705
7941
  :rtype: int
7706
7942
  """
7707
7943
  return self._Offset
@@ -7712,7 +7948,7 @@ class DescribeRoleListRequest(AbstractModel):
7712
7948
 
7713
7949
  @property
7714
7950
  def Limit(self):
7715
- """查询结果限制数量
7951
+ """查询结果限制数量，默认20。
7716
7952
  :rtype: int
7717
7953
  """
7718
7954
  return self._Limit
@@ -7723,7 +7959,7 @@ class DescribeRoleListRequest(AbstractModel):
7723
7959
 
7724
7960
  @property
7725
7961
  def Filters(self):
7726
- """查询条件列表
7962
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
7727
7963
  :rtype: list of Filter
7728
7964
  """
7729
7965
  return self._Filters
@@ -8110,15 +8346,15 @@ class DescribeTopicListByGroupRequest(AbstractModel):
8110
8346
 
8111
8347
  def __init__(self):
8112
8348
  r"""
8113
- :param _InstanceId: 集群ID
8349
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8114
8350
  :type InstanceId: str
8115
- :param _Offset: 查询起始位置
8351
+ :param _Offset: 查询起始位置，默认为0。
8116
8352
  :type Offset: int
8117
- :param _Limit: 查询结果限制数量
8353
+ :param _Limit: 查询结果限制数量，默认20。
8118
8354
  :type Limit: int
8119
- :param _ConsumerGroup: 消费组名称
8355
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
8120
8356
  :type ConsumerGroup: str
8121
- :param _Filters: 查询条件列表
8357
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
8122
8358
  :type Filters: list of Filter
8123
8359
  """
8124
8360
  self._InstanceId = None
@@ -8129,7 +8365,7 @@ class DescribeTopicListByGroupRequest(AbstractModel):
8129
8365
 
8130
8366
  @property
8131
8367
  def InstanceId(self):
8132
- """集群ID
8368
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8133
8369
  :rtype: str
8134
8370
  """
8135
8371
  return self._InstanceId
@@ -8140,7 +8376,7 @@ class DescribeTopicListByGroupRequest(AbstractModel):
8140
8376
 
8141
8377
  @property
8142
8378
  def Offset(self):
8143
- """查询起始位置
8379
+ """查询起始位置，默认为0。
8144
8380
  :rtype: int
8145
8381
  """
8146
8382
  return self._Offset
@@ -8151,7 +8387,7 @@ class DescribeTopicListByGroupRequest(AbstractModel):
8151
8387
 
8152
8388
  @property
8153
8389
  def Limit(self):
8154
- """查询结果限制数量
8390
+ """查询结果限制数量，默认20。
8155
8391
  :rtype: int
8156
8392
  """
8157
8393
  return self._Limit
@@ -8162,7 +8398,7 @@ class DescribeTopicListByGroupRequest(AbstractModel):
8162
8398
 
8163
8399
  @property
8164
8400
  def ConsumerGroup(self):
8165
- """消费组名称
8401
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
8166
8402
  :rtype: str
8167
8403
  """
8168
8404
  return self._ConsumerGroup
@@ -8173,7 +8409,7 @@ class DescribeTopicListByGroupRequest(AbstractModel):
8173
8409
 
8174
8410
  @property
8175
8411
  def Filters(self):
8176
- """查询条件列表
8412
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
8177
8413
  :rtype: list of Filter
8178
8414
  """
8179
8415
  return self._Filters
@@ -8274,13 +8510,13 @@ class DescribeTopicListRequest(AbstractModel):
8274
8510
 
8275
8511
  def __init__(self):
8276
8512
  r"""
8277
- :param _InstanceId: 集群ID
8513
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8278
8514
  :type InstanceId: str
8279
- :param _Filters: 查询条件列表
8515
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
8280
8516
  :type Filters: list of Filter
8281
- :param _Offset: 查询起始位置
8517
+ :param _Offset: 查询起始位置，默认为0。
8282
8518
  :type Offset: int
8283
- :param _Limit: 查询结果限制数量
8519
+ :param _Limit: 查询结果限制数量，默认20。
8284
8520
  :type Limit: int
8285
8521
  """
8286
8522
  self._InstanceId = None
@@ -8290,7 +8526,7 @@ class DescribeTopicListRequest(AbstractModel):
8290
8526
 
8291
8527
  @property
8292
8528
  def InstanceId(self):
8293
- """集群ID
8529
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8294
8530
  :rtype: str
8295
8531
  """
8296
8532
  return self._InstanceId
@@ -8301,7 +8537,7 @@ class DescribeTopicListRequest(AbstractModel):
8301
8537
 
8302
8538
  @property
8303
8539
  def Filters(self):
8304
- """查询条件列表
8540
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
8305
8541
  :rtype: list of Filter
8306
8542
  """
8307
8543
  return self._Filters
@@ -8312,7 +8548,7 @@ class DescribeTopicListRequest(AbstractModel):
8312
8548
 
8313
8549
  @property
8314
8550
  def Offset(self):
8315
- """查询起始位置
8551
+ """查询起始位置，默认为0。
8316
8552
  :rtype: int
8317
8553
  """
8318
8554
  return self._Offset
@@ -8323,7 +8559,7 @@ class DescribeTopicListRequest(AbstractModel):
8323
8559
 
8324
8560
  @property
8325
8561
  def Limit(self):
8326
- """查询结果限制数量
8562
+ """查询结果限制数量，默认20。
8327
8563
  :rtype: int
8328
8564
  """
8329
8565
  return self._Limit
@@ -8423,15 +8659,15 @@ class DescribeTopicRequest(AbstractModel):
8423
8659
 
8424
8660
  def __init__(self):
8425
8661
  r"""
8426
- :param _InstanceId: 集群ID
8662
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8427
8663
  :type InstanceId: str
8428
- :param _Topic: 主题名称
8664
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
8429
8665
  :type Topic: str
8430
- :param _Filters: 查询条件列表
8666
+ :param _Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
8431
8667
  :type Filters: list of Filter
8432
- :param _Offset: 查询起始位置
8668
+ :param _Offset: 查询起始位置，默认为0。
8433
8669
  :type Offset: int
8434
- :param _Limit: 查询结果限制数量
8670
+ :param _Limit: 查询结果限制数量，默认20。
8435
8671
  :type Limit: int
8436
8672
  """
8437
8673
  self._InstanceId = None
@@ -8442,7 +8678,7 @@ class DescribeTopicRequest(AbstractModel):
8442
8678
 
8443
8679
  @property
8444
8680
  def InstanceId(self):
8445
- """集群ID
8681
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8446
8682
  :rtype: str
8447
8683
  """
8448
8684
  return self._InstanceId
@@ -8453,7 +8689,7 @@ class DescribeTopicRequest(AbstractModel):
8453
8689
 
8454
8690
  @property
8455
8691
  def Topic(self):
8456
- """主题名称
8692
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
8457
8693
  :rtype: str
8458
8694
  """
8459
8695
  return self._Topic
@@ -8464,7 +8700,7 @@ class DescribeTopicRequest(AbstractModel):
8464
8700
 
8465
8701
  @property
8466
8702
  def Filters(self):
8467
- """查询条件列表
8703
+ """过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
8468
8704
  :rtype: list of Filter
8469
8705
  """
8470
8706
  return self._Filters
@@ -8475,7 +8711,7 @@ class DescribeTopicRequest(AbstractModel):
8475
8711
 
8476
8712
  @property
8477
8713
  def Offset(self):
8478
- """查询起始位置
8714
+ """查询起始位置，默认为0。
8479
8715
  :rtype: int
8480
8716
  """
8481
8717
  return self._Offset
@@ -8486,7 +8722,7 @@ class DescribeTopicRequest(AbstractModel):
8486
8722
 
8487
8723
  @property
8488
8724
  def Limit(self):
8489
- """查询结果限制数量
8725
+ """查询结果限制数量，默认20。
8490
8726
  :rtype: int
8491
8727
  """
8492
8728
  return self._Limit
@@ -8703,6 +8939,8 @@ class DetailedRolePerm(AbstractModel):
8703
8939
  def __init__(self):
8704
8940
  r"""
8705
8941
  :param _Resource: 权限对应的资源
8942
+ 可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
8943
+ 可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
8706
8944
  :type Resource: str
8707
8945
  :param _PermWrite: 是否开启生产权限
8708
8946
  :type PermWrite: bool
@@ -8722,6 +8960,8 @@ class DetailedRolePerm(AbstractModel):
8722
8960
  @property
8723
8961
  def Resource(self):
8724
8962
  """权限对应的资源
8963
+ 可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
8964
+ 可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
8725
8965
  :rtype: str
8726
8966
  """
8727
8967
  return self._Resource
@@ -8984,10 +9224,13 @@ class Endpoint(AbstractModel):
8984
9224
 
8985
9225
  def __init__(self):
8986
9226
  r"""
8987
- :param _Type: 接入点类型，枚举值如下
8988
- VPC: VPC;
8989
- PUBLIC: 公网;
8990
- INTERNAL: 支撑网;
9227
+ :param _Type: 接入点类型，枚举值如下：
9228
+
9229
+ - VPC：VPC 网络
9230
+
9231
+ - PUBLIC：公网
9232
+
9233
+ - INTERNAL：支撑网
8991
9234
  :type Type: str
8992
9235
  :param _Status: 状态，
8993
9236
  OPEN 开启，
@@ -9030,10 +9273,13 @@ POSTPAID 按量付费
9030
9273
 
9031
9274
  @property
9032
9275
  def Type(self):
9033
- """接入点类型，枚举值如下
9034
- VPC: VPC;
9035
- PUBLIC: 公网;
9036
- INTERNAL: 支撑网;
9276
+ """接入点类型，枚举值如下：
9277
+
9278
+ - VPC：VPC 网络
9279
+
9280
+ - PUBLIC：公网
9281
+
9282
+ - INTERNAL：支撑网
9037
9283
  :rtype: str
9038
9284
  """
9039
9285
  return self._Type
@@ -9254,11 +9500,13 @@ DELETING，删除中
9254
9500
  :type TopicNumLimit: int
9255
9501
  :param _GroupNumLimit: 实例消费组数量上限
9256
9502
  :type GroupNumLimit: int
9257
- :param _PayMode: 计费模式，
9258
- POSTPAID，按量计费
9259
- PREPAID，包年包月
9503
+ :param _PayMode: 计费模式，枚举值如下：
9504
+
9505
+ - POSTPAID：按量计费
9506
+
9507
+ - PREPAID：包年包月
9260
9508
  :type PayMode: str
9261
- :param _ExpiryTime: 到期时间，秒为单位
9509
+ :param _ExpiryTime: 到期时间，**Unix时间戳（毫秒）**
9262
9510
  注意：此字段可能返回 null，表示取不到有效值。
9263
9511
  :type ExpiryTime: int
9264
9512
  :param _Remark: 备注信息
@@ -9277,24 +9525,23 @@ PREPAID，包年包月
9277
9525
  注意：此字段可能返回 null，表示取不到有效值。
9278
9526
  :type TpsLimit: int
9279
9527
  :param _ScaledTpsLimit: 弹性TPS限流值
9280
- 注意：此字段可能返回 null，表示取不到有效值。
9281
9528
  :type ScaledTpsLimit: int
9282
9529
  :param _MessageRetention: 消息保留时间，小时为单位
9283
- 注意：此字段可能返回 null，表示取不到有效值。
9284
9530
  :type MessageRetention: int
9285
9531
  :param _MaxMessageDelay: 延迟消息最大时长，小时为单位
9286
- 注意：此字段可能返回 null，表示取不到有效值。
9287
9532
  :type MaxMessageDelay: int
9288
- :param _RenewFlag: 是否自动续费
9289
- 注意：此字段可能返回 null，表示取不到有效值。
9533
+ :param _RenewFlag: 预付费集群是否自动续费，枚举值如下：
9534
+
9535
+ - 0: 不自动续费
9536
+ - 1: 自动续费
9290
9537
  :type RenewFlag: int
9291
9538
  :param _InstanceItemExtraInfo: 4.x独有数据
9292
9539
  注意：此字段可能返回 null，表示取不到有效值。
9293
9540
  :type InstanceItemExtraInfo: :class:`tencentcloud.trocket.v20230308.models.InstanceItemExtraInfo`
9294
- :param _DestroyTime: 预销毁时间
9541
+ :param _DestroyTime: 预销毁时间，**Unix时间戳（毫秒）**
9295
9542
  注意：此字段可能返回 null，表示取不到有效值。
9296
9543
  :type DestroyTime: int
9297
- :param _ZoneIds: 所属可用区列表
9544
+ :param _ZoneIds: 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
9298
9545
  注意：此字段可能返回 null，表示取不到有效值。
9299
9546
  :type ZoneIds: list of int
9300
9547
  :param _EnableDeletionProtection: 是否开启删除保护
@@ -9417,9 +9664,11 @@ DELETING，删除中
9417
9664
 
9418
9665
  @property
9419
9666
  def PayMode(self):
9420
- """计费模式，
9421
- POSTPAID，按量计费
9422
- PREPAID，包年包月
9667
+ """计费模式，枚举值如下：
9668
+
9669
+ - POSTPAID：按量计费
9670
+
9671
+ - PREPAID：包年包月
9423
9672
  :rtype: str
9424
9673
  """
9425
9674
  return self._PayMode
@@ -9430,7 +9679,7 @@ PREPAID，包年包月
9430
9679
 
9431
9680
  @property
9432
9681
  def ExpiryTime(self):
9433
- """到期时间，秒为单位
9682
+ """到期时间，**Unix时间戳（毫秒）**
9434
9683
  注意：此字段可能返回 null，表示取不到有效值。
9435
9684
  :rtype: int
9436
9685
  """
@@ -9512,7 +9761,6 @@ PREPAID，包年包月
9512
9761
  @property
9513
9762
  def ScaledTpsLimit(self):
9514
9763
  """弹性TPS限流值
9515
- 注意：此字段可能返回 null，表示取不到有效值。
9516
9764
  :rtype: int
9517
9765
  """
9518
9766
  return self._ScaledTpsLimit
@@ -9524,7 +9772,6 @@ PREPAID，包年包月
9524
9772
  @property
9525
9773
  def MessageRetention(self):
9526
9774
  """消息保留时间，小时为单位
9527
- 注意：此字段可能返回 null，表示取不到有效值。
9528
9775
  :rtype: int
9529
9776
  """
9530
9777
  return self._MessageRetention
@@ -9536,7 +9783,6 @@ PREPAID，包年包月
9536
9783
  @property
9537
9784
  def MaxMessageDelay(self):
9538
9785
  """延迟消息最大时长，小时为单位
9539
- 注意：此字段可能返回 null，表示取不到有效值。
9540
9786
  :rtype: int
9541
9787
  """
9542
9788
  return self._MaxMessageDelay
@@ -9547,8 +9793,10 @@ PREPAID，包年包月
9547
9793
 
9548
9794
  @property
9549
9795
  def RenewFlag(self):
9550
- """是否自动续费
9551
- 注意：此字段可能返回 null，表示取不到有效值。
9796
+ """预付费集群是否自动续费，枚举值如下：
9797
+
9798
+ - 0: 不自动续费
9799
+ - 1: 自动续费
9552
9800
  :rtype: int
9553
9801
  """
9554
9802
  return self._RenewFlag
@@ -9571,7 +9819,7 @@ PREPAID，包年包月
9571
9819
 
9572
9820
  @property
9573
9821
  def DestroyTime(self):
9574
- """预销毁时间
9822
+ """预销毁时间，**Unix时间戳（毫秒）**
9575
9823
  注意：此字段可能返回 null，表示取不到有效值。
9576
9824
  :rtype: int
9577
9825
  """
@@ -9583,7 +9831,7 @@ PREPAID，包年包月
9583
9831
 
9584
9832
  @property
9585
9833
  def ZoneIds(self):
9586
- """所属可用区列表
9834
+ """所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
9587
9835
  注意：此字段可能返回 null，表示取不到有效值。
9588
9836
  :rtype: list of int
9589
9837
  """
@@ -9853,11 +10101,13 @@ DELETING，删除中
9853
10101
  :type TopicNumLimit: int
9854
10102
  :param _GroupNumLimit: 实例消费组数量上限
9855
10103
  :type GroupNumLimit: int
9856
- :param _PayMode: 计费模式，
9857
- POSTPAID，按量计费
9858
- PREPAID，包年包月
10104
+ :param _PayMode: 计费模式，枚举值如下：
10105
+
10106
+ - POSTPAID：按量计费
10107
+
10108
+ - PREPAID：包年包月
9859
10109
  :type PayMode: str
9860
- :param _ExpiryTime: 到期时间，秒为单位
10110
+ :param _ExpiryTime: 到期时间戳，**Unix时间戳（毫秒）**
9861
10111
  注意：此字段可能返回 null，表示取不到有效值。
9862
10112
  :type ExpiryTime: int
9863
10113
  :param _Remark: 备注信息
@@ -9873,19 +10123,14 @@ PREPAID，包年包月
9873
10123
  :param _SkuCode: 商品规格
9874
10124
  :type SkuCode: str
9875
10125
  :param _TpsLimit: TPS限流值
9876
- 注意：此字段可能返回 null，表示取不到有效值。
9877
10126
  :type TpsLimit: int
9878
10127
  :param _ScaledTpsLimit: 弹性TPS限流值
9879
- 注意：此字段可能返回 null，表示取不到有效值。
9880
10128
  :type ScaledTpsLimit: int
9881
10129
  :param _MessageRetention: 消息保留时间，小时为单位
9882
- 注意：此字段可能返回 null，表示取不到有效值。
9883
10130
  :type MessageRetention: int
9884
10131
  :param _MaxMessageDelay: 延迟消息最大时长，小时为单位
9885
- 注意：此字段可能返回 null，表示取不到有效值。
9886
10132
  :type MaxMessageDelay: int
9887
- :param _RenewFlag: 是否自动续费
9888
- 注意：此字段可能返回 null，表示取不到有效值。
10133
+ :param _RenewFlag: 是否自动续费，仅针对预付费集群（0: 不自动续费；1:自动续费）
9889
10134
  :type RenewFlag: int
9890
10135
  """
9891
10136
  self._InstanceId = None
@@ -10001,9 +10246,11 @@ DELETING，删除中
10001
10246
 
10002
10247
  @property
10003
10248
  def PayMode(self):
10004
- """计费模式，
10005
- POSTPAID，按量计费
10006
- PREPAID，包年包月
10249
+ """计费模式，枚举值如下：
10250
+
10251
+ - POSTPAID：按量计费
10252
+
10253
+ - PREPAID：包年包月
10007
10254
  :rtype: str
10008
10255
  """
10009
10256
  return self._PayMode
@@ -10014,7 +10261,7 @@ PREPAID，包年包月
10014
10261
 
10015
10262
  @property
10016
10263
  def ExpiryTime(self):
10017
- """到期时间，秒为单位
10264
+ """到期时间戳，**Unix时间戳（毫秒）**
10018
10265
  注意：此字段可能返回 null，表示取不到有效值。
10019
10266
  :rtype: int
10020
10267
  """
@@ -10084,7 +10331,6 @@ PREPAID，包年包月
10084
10331
  @property
10085
10332
  def TpsLimit(self):
10086
10333
  """TPS限流值
10087
- 注意：此字段可能返回 null，表示取不到有效值。
10088
10334
  :rtype: int
10089
10335
  """
10090
10336
  return self._TpsLimit
@@ -10096,7 +10342,6 @@ PREPAID，包年包月
10096
10342
  @property
10097
10343
  def ScaledTpsLimit(self):
10098
10344
  """弹性TPS限流值
10099
- 注意：此字段可能返回 null，表示取不到有效值。
10100
10345
  :rtype: int
10101
10346
  """
10102
10347
  return self._ScaledTpsLimit
@@ -10108,7 +10353,6 @@ PREPAID，包年包月
10108
10353
  @property
10109
10354
  def MessageRetention(self):
10110
10355
  """消息保留时间，小时为单位
10111
- 注意：此字段可能返回 null，表示取不到有效值。
10112
10356
  :rtype: int
10113
10357
  """
10114
10358
  return self._MessageRetention
@@ -10120,7 +10364,6 @@ PREPAID，包年包月
10120
10364
  @property
10121
10365
  def MaxMessageDelay(self):
10122
10366
  """延迟消息最大时长，小时为单位
10123
- 注意：此字段可能返回 null，表示取不到有效值。
10124
10367
  :rtype: int
10125
10368
  """
10126
10369
  return self._MaxMessageDelay
@@ -10131,8 +10374,7 @@ PREPAID，包年包月
10131
10374
 
10132
10375
  @property
10133
10376
  def RenewFlag(self):
10134
- """是否自动续费
10135
- 注意：此字段可能返回 null，表示取不到有效值。
10377
+ """是否自动续费，仅针对预付费集群（0: 不自动续费；1:自动续费）
10136
10378
  :rtype: int
10137
10379
  """
10138
10380
  return self._RenewFlag
@@ -10375,10 +10617,9 @@ class IpRule(AbstractModel):
10375
10617
  r"""
10376
10618
  :param _Ip: IP地址
10377
10619
  :type Ip: str
10378
- :param _Allow: 是否允许放行
10620
+ :param _Allow: 是否允许放行，默认为false表示拒绝
10379
10621
  :type Allow: bool
10380
10622
  :param _Remark: 备注信息
10381
- 注意：此字段可能返回 null，表示取不到有效值。
10382
10623
  :type Remark: str
10383
10624
  """
10384
10625
  self._Ip = None
@@ -10398,7 +10639,7 @@ class IpRule(AbstractModel):
10398
10639
 
10399
10640
  @property
10400
10641
  def Allow(self):
10401
- """是否允许放行
10642
+ """是否允许放行，默认为false表示拒绝
10402
10643
  :rtype: bool
10403
10644
  """
10404
10645
  return self._Allow
@@ -10410,7 +10651,6 @@ class IpRule(AbstractModel):
10410
10651
  @property
10411
10652
  def Remark(self):
10412
10653
  """备注信息
10413
- 注意：此字段可能返回 null，表示取不到有效值。
10414
10654
  :rtype: str
10415
10655
  """
10416
10656
  return self._Remark
@@ -11581,7 +11821,13 @@ class MessageTraceItem(AbstractModel):
11581
11821
 
11582
11822
  def __init__(self):
11583
11823
  r"""
11584
- :param _Stage: 步骤
11824
+ :param _Stage: 消息处理阶段，枚举值如下：
11825
+
11826
+ - produce：消息生产
11827
+
11828
+ - persist：消息存储
11829
+
11830
+ - consume：消息消费
11585
11831
  注意：此字段可能返回 null，表示取不到有效值。
11586
11832
  :type Stage: str
11587
11833
  :param _Data: 轨迹详情
@@ -11593,7 +11839,13 @@ class MessageTraceItem(AbstractModel):
11593
11839
 
11594
11840
  @property
11595
11841
  def Stage(self):
11596
- """步骤
11842
+ """消息处理阶段，枚举值如下：
11843
+
11844
+ - produce：消息生产
11845
+
11846
+ - persist：消息存储
11847
+
11848
+ - consume：消息消费
11597
11849
  注意：此字段可能返回 null，表示取不到有效值。
11598
11850
  :rtype: str
11599
11851
  """
@@ -12019,18 +12271,18 @@ class ModifyConsumerGroupRequest(AbstractModel):
12019
12271
 
12020
12272
  def __init__(self):
12021
12273
  r"""
12022
- :param _InstanceId: 集群ID
12274
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12023
12275
  :type InstanceId: str
12024
- :param _ConsumerGroup: 消费组名称
12276
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
12025
12277
  :type ConsumerGroup: str
12026
12278
  :param _ConsumeEnable: 是否开启消费
12027
12279
  :type ConsumeEnable: bool
12028
12280
  :param _ConsumeMessageOrderly: 顺序投递：true
12029
12281
  并发投递：false
12030
12282
  :type ConsumeMessageOrderly: bool
12031
- :param _MaxRetryTimes: 最大重试次数
12283
+ :param _MaxRetryTimes: 最大重试次数，取值范围0～1000
12032
12284
  :type MaxRetryTimes: int
12033
- :param _Remark: 备注
12285
+ :param _Remark: 备注信息，最多 128 个字符
12034
12286
  :type Remark: str
12035
12287
  """
12036
12288
  self._InstanceId = None
@@ -12042,7 +12294,7 @@ class ModifyConsumerGroupRequest(AbstractModel):
12042
12294
 
12043
12295
  @property
12044
12296
  def InstanceId(self):
12045
- """集群ID
12297
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12046
12298
  :rtype: str
12047
12299
  """
12048
12300
  return self._InstanceId
@@ -12053,7 +12305,7 @@ class ModifyConsumerGroupRequest(AbstractModel):
12053
12305
 
12054
12306
  @property
12055
12307
  def ConsumerGroup(self):
12056
- """消费组名称
12308
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
12057
12309
  :rtype: str
12058
12310
  """
12059
12311
  return self._ConsumerGroup
@@ -12087,7 +12339,7 @@ class ModifyConsumerGroupRequest(AbstractModel):
12087
12339
 
12088
12340
  @property
12089
12341
  def MaxRetryTimes(self):
12090
- """最大重试次数
12342
+ """最大重试次数，取值范围0～1000
12091
12343
  :rtype: int
12092
12344
  """
12093
12345
  return self._MaxRetryTimes
@@ -12098,7 +12350,7 @@ class ModifyConsumerGroupRequest(AbstractModel):
12098
12350
 
12099
12351
  @property
12100
12352
  def Remark(self):
12101
- """备注
12353
+ """备注信息，最多 128 个字符
12102
12354
  :rtype: str
12103
12355
  """
12104
12356
  return self._Remark
@@ -12160,7 +12412,7 @@ class ModifyInstanceEndpointRequest(AbstractModel):
12160
12412
 
12161
12413
  def __init__(self):
12162
12414
  r"""
12163
- :param _InstanceId: 集群ID
12415
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12164
12416
  :type InstanceId: str
12165
12417
  :param _Type: 接入点类型，
12166
12418
  PUBLIC 公网
@@ -12180,7 +12432,7 @@ PUBLIC 公网
12180
12432
 
12181
12433
  @property
12182
12434
  def InstanceId(self):
12183
- """集群ID
12435
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12184
12436
  :rtype: str
12185
12437
  """
12186
12438
  return self._InstanceId
@@ -12291,25 +12543,32 @@ class ModifyInstanceRequest(AbstractModel):
12291
12543
 
12292
12544
  def __init__(self):
12293
12545
  r"""
12294
- :param _InstanceId: 集群ID
12546
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12295
12547
  :type InstanceId: str
12296
- :param _Name: 实例名称
12548
+ :param _Name: 实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”
12297
12549
  :type Name: str
12298
- :param _Remark: 备注信息
12550
+ :param _Remark: 备注信息，最多 128 个字符
12299
12551
  :type Remark: str
12300
12552
  :param _SendReceiveRatio: 消息发送和接收的比例
12301
12553
  :type SendReceiveRatio: float
12302
- :param _SkuCode: 调整实例规格的商品代号
12554
+ :param _SkuCode: 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
12303
12555
  :type SkuCode: str
12304
- :param _MessageRetention: 消息保留时长，小时为单位
12556
+ :param _MessageRetention: 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
12557
+
12558
+ - 默认值：DefaultRetention 参数
12559
+ - 最小值：RetentionLowerLimit 参数
12560
+ - 最大值：RetentionUpperLimit 参数
12305
12561
  :type MessageRetention: int
12306
12562
  :param _ScaledTpsEnabled: 是否开启弹性TPS
12307
12563
  :type ScaledTpsEnabled: bool
12308
12564
  :param _AclEnabled: 是否开启ACL
12309
12565
  :type AclEnabled: bool
12310
- :param _MaxTopicNum: 最大可创建主题数
12566
+ :param _MaxTopicNum: 最大可创建主题数，取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
12567
+
12568
+ - 最小值和默认值：TopicNumLimit 参数
12569
+ - 最大值：TopicNumUpperLimit 参数
12311
12570
  :type MaxTopicNum: int
12312
- :param _ExtraTopicNum: 免费额度之外的主题个数
12571
+ :param _ExtraTopicNum: 免费额度之外的主题个数，免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
12313
12572
  :type ExtraTopicNum: str
12314
12573
  :param _EnableDeletionProtection: 是否开启删除保护
12315
12574
  :type EnableDeletionProtection: bool
@@ -12328,7 +12587,7 @@ class ModifyInstanceRequest(AbstractModel):
12328
12587
 
12329
12588
  @property
12330
12589
  def InstanceId(self):
12331
- """集群ID
12590
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12332
12591
  :rtype: str
12333
12592
  """
12334
12593
  return self._InstanceId
@@ -12339,7 +12598,7 @@ class ModifyInstanceRequest(AbstractModel):
12339
12598
 
12340
12599
  @property
12341
12600
  def Name(self):
12342
- """实例名称
12601
+ """实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”
12343
12602
  :rtype: str
12344
12603
  """
12345
12604
  return self._Name
@@ -12350,7 +12609,7 @@ class ModifyInstanceRequest(AbstractModel):
12350
12609
 
12351
12610
  @property
12352
12611
  def Remark(self):
12353
- """备注信息
12612
+ """备注信息，最多 128 个字符
12354
12613
  :rtype: str
12355
12614
  """
12356
12615
  return self._Remark
@@ -12372,7 +12631,7 @@ class ModifyInstanceRequest(AbstractModel):
12372
12631
 
12373
12632
  @property
12374
12633
  def SkuCode(self):
12375
- """调整实例规格的商品代号
12634
+ """商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
12376
12635
  :rtype: str
12377
12636
  """
12378
12637
  return self._SkuCode
@@ -12383,7 +12642,11 @@ class ModifyInstanceRequest(AbstractModel):
12383
12642
 
12384
12643
  @property
12385
12644
  def MessageRetention(self):
12386
- """消息保留时长，小时为单位
12645
+ """消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
12646
+
12647
+ - 默认值：DefaultRetention 参数
12648
+ - 最小值：RetentionLowerLimit 参数
12649
+ - 最大值：RetentionUpperLimit 参数
12387
12650
  :rtype: int
12388
12651
  """
12389
12652
  return self._MessageRetention
@@ -12416,7 +12679,10 @@ class ModifyInstanceRequest(AbstractModel):
12416
12679
 
12417
12680
  @property
12418
12681
  def MaxTopicNum(self):
12419
- """最大可创建主题数
12682
+ """最大可创建主题数，取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
12683
+
12684
+ - 最小值和默认值：TopicNumLimit 参数
12685
+ - 最大值：TopicNumUpperLimit 参数
12420
12686
  :rtype: int
12421
12687
  """
12422
12688
  return self._MaxTopicNum
@@ -12427,7 +12693,7 @@ class ModifyInstanceRequest(AbstractModel):
12427
12693
 
12428
12694
  @property
12429
12695
  def ExtraTopicNum(self):
12430
- """免费额度之外的主题个数
12696
+ """免费额度之外的主题个数，免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
12431
12697
  :rtype: str
12432
12698
  """
12433
12699
  return self._ExtraTopicNum
@@ -13010,9 +13276,9 @@ class ModifyRoleRequest(AbstractModel):
13010
13276
 
13011
13277
  def __init__(self):
13012
13278
  r"""
13013
- :param _InstanceId: 集群ID
13279
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13014
13280
  :type InstanceId: str
13015
- :param _Role: 角色名称
13281
+ :param _Role: 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
13016
13282
  :type Role: str
13017
13283
  :param _PermRead: 是否开启消费
13018
13284
  :type PermRead: bool
@@ -13022,7 +13288,7 @@ class ModifyRoleRequest(AbstractModel):
13022
13288
  :type PermType: str
13023
13289
  :param _Remark: 备注
13024
13290
  :type Remark: str
13025
- :param _DetailedPerms: Topic&Group维度权限配置
13291
+ :param _DetailedPerms: Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
13026
13292
  :type DetailedPerms: list of DetailedRolePerm
13027
13293
  """
13028
13294
  self._InstanceId = None
@@ -13035,7 +13301,7 @@ class ModifyRoleRequest(AbstractModel):
13035
13301
 
13036
13302
  @property
13037
13303
  def InstanceId(self):
13038
- """集群ID
13304
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13039
13305
  :rtype: str
13040
13306
  """
13041
13307
  return self._InstanceId
@@ -13046,7 +13312,7 @@ class ModifyRoleRequest(AbstractModel):
13046
13312
 
13047
13313
  @property
13048
13314
  def Role(self):
13049
- """角色名称
13315
+ """角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
13050
13316
  :rtype: str
13051
13317
  """
13052
13318
  return self._Role
@@ -13101,7 +13367,7 @@ class ModifyRoleRequest(AbstractModel):
13101
13367
 
13102
13368
  @property
13103
13369
  def DetailedPerms(self):
13104
- """Topic&Group维度权限配置
13370
+ """Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
13105
13371
  :rtype: list of DetailedRolePerm
13106
13372
  """
13107
13373
  return self._DetailedPerms
@@ -13169,15 +13435,15 @@ class ModifyTopicRequest(AbstractModel):
13169
13435
 
13170
13436
  def __init__(self):
13171
13437
  r"""
13172
- :param _InstanceId: 集群ID
13438
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13173
13439
  :type InstanceId: str
13174
- :param _Topic: 主题名称
13440
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
13175
13441
  :type Topic: str
13176
- :param _QueueNum: 队列数量
13442
+ :param _QueueNum: 队列数量，取值范围3～16
13177
13443
  :type QueueNum: int
13178
- :param _Remark: 备注信息
13444
+ :param _Remark: 备注信息，最多 128 个字符
13179
13445
  :type Remark: str
13180
- :param _MsgTTL: 消息保留时长
13446
+ :param _MsgTTL: 消息保留时长（单位：小时）
13181
13447
  :type MsgTTL: int
13182
13448
  """
13183
13449
  self._InstanceId = None
@@ -13188,7 +13454,7 @@ class ModifyTopicRequest(AbstractModel):
13188
13454
 
13189
13455
  @property
13190
13456
  def InstanceId(self):
13191
- """集群ID
13457
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13192
13458
  :rtype: str
13193
13459
  """
13194
13460
  return self._InstanceId
@@ -13199,7 +13465,7 @@ class ModifyTopicRequest(AbstractModel):
13199
13465
 
13200
13466
  @property
13201
13467
  def Topic(self):
13202
- """主题名称
13468
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
13203
13469
  :rtype: str
13204
13470
  """
13205
13471
  return self._Topic
@@ -13210,7 +13476,7 @@ class ModifyTopicRequest(AbstractModel):
13210
13476
 
13211
13477
  @property
13212
13478
  def QueueNum(self):
13213
- """队列数量
13479
+ """队列数量，取值范围3～16
13214
13480
  :rtype: int
13215
13481
  """
13216
13482
  return self._QueueNum
@@ -13221,7 +13487,7 @@ class ModifyTopicRequest(AbstractModel):
13221
13487
 
13222
13488
  @property
13223
13489
  def Remark(self):
13224
- """备注信息
13490
+ """备注信息，最多 128 个字符
13225
13491
  :rtype: str
13226
13492
  """
13227
13493
  return self._Remark
@@ -13232,7 +13498,7 @@ class ModifyTopicRequest(AbstractModel):
13232
13498
 
13233
13499
  @property
13234
13500
  def MsgTTL(self):
13235
- """消息保留时长
13501
+ """消息保留时长（单位：小时）
13236
13502
  :rtype: int
13237
13503
  """
13238
13504
  return self._MsgTTL
@@ -13427,35 +13693,26 @@ PLATINUM，铂金版
13427
13693
  :param _SkuCode: 规格代码
13428
13694
  :type SkuCode: str
13429
13695
  :param _TpsLimit: TPS上限
13430
- 注意：此字段可能返回 null，表示取不到有效值。
13431
13696
  :type TpsLimit: int
13432
13697
  :param _ScaledTpsLimit: 弹性TPS上限
13433
- 注意：此字段可能返回 null，表示取不到有效值。
13434
13698
  :type ScaledTpsLimit: int
13435
13699
  :param _TopicNumLimit: 主题数量上限默认值
13436
- 注意：此字段可能返回 null，表示取不到有效值。
13437
13700
  :type TopicNumLimit: int
13438
13701
  :param _GroupNumLimit: 消费组数量上限
13439
- 注意：此字段可能返回 null，表示取不到有效值。
13440
13702
  :type GroupNumLimit: int
13441
13703
  :param _DefaultRetention: 默认消息保留时间，小时为单位
13442
- 注意：此字段可能返回 null，表示取不到有效值。
13443
13704
  :type DefaultRetention: int
13444
13705
  :param _RetentionUpperLimit: 可调整消息保留时间上限，小时为单位
13445
- 注意：此字段可能返回 null，表示取不到有效值。
13446
13706
  :type RetentionUpperLimit: int
13447
13707
  :param _RetentionLowerLimit: 可调整消息保留时间下限，小时为单位
13448
- 注意：此字段可能返回 null，表示取不到有效值。
13449
13708
  :type RetentionLowerLimit: int
13450
13709
  :param _MaxMessageDelay: 延时消息最大时长，小时为单位
13451
- 注意：此字段可能返回 null，表示取不到有效值。
13452
13710
  :type MaxMessageDelay: int
13453
13711
  :param _OnSale: 是否可购买
13454
13712
  :type OnSale: bool
13455
13713
  :param _PriceTags: 计费项信息
13456
13714
  :type PriceTags: list of PriceTag
13457
13715
  :param _TopicNumUpperLimit: 主题数量上限默认最大值
13458
- 注意：此字段可能返回 null，表示取不到有效值。
13459
13716
  :type TopicNumUpperLimit: int
13460
13717
  """
13461
13718
  self._InstanceType = None
@@ -13501,7 +13758,6 @@ PLATINUM，铂金版
13501
13758
  @property
13502
13759
  def TpsLimit(self):
13503
13760
  """TPS上限
13504
- 注意：此字段可能返回 null，表示取不到有效值。
13505
13761
  :rtype: int
13506
13762
  """
13507
13763
  return self._TpsLimit
@@ -13513,7 +13769,6 @@ PLATINUM，铂金版
13513
13769
  @property
13514
13770
  def ScaledTpsLimit(self):
13515
13771
  """弹性TPS上限
13516
- 注意：此字段可能返回 null，表示取不到有效值。
13517
13772
  :rtype: int
13518
13773
  """
13519
13774
  return self._ScaledTpsLimit
@@ -13525,7 +13780,6 @@ PLATINUM，铂金版
13525
13780
  @property
13526
13781
  def TopicNumLimit(self):
13527
13782
  """主题数量上限默认值
13528
- 注意：此字段可能返回 null，表示取不到有效值。
13529
13783
  :rtype: int
13530
13784
  """
13531
13785
  return self._TopicNumLimit
@@ -13537,7 +13791,6 @@ PLATINUM，铂金版
13537
13791
  @property
13538
13792
  def GroupNumLimit(self):
13539
13793
  """消费组数量上限
13540
- 注意：此字段可能返回 null，表示取不到有效值。
13541
13794
  :rtype: int
13542
13795
  """
13543
13796
  return self._GroupNumLimit
@@ -13549,7 +13802,6 @@ PLATINUM，铂金版
13549
13802
  @property
13550
13803
  def DefaultRetention(self):
13551
13804
  """默认消息保留时间，小时为单位
13552
- 注意：此字段可能返回 null，表示取不到有效值。
13553
13805
  :rtype: int
13554
13806
  """
13555
13807
  return self._DefaultRetention
@@ -13561,7 +13813,6 @@ PLATINUM，铂金版
13561
13813
  @property
13562
13814
  def RetentionUpperLimit(self):
13563
13815
  """可调整消息保留时间上限，小时为单位
13564
- 注意：此字段可能返回 null，表示取不到有效值。
13565
13816
  :rtype: int
13566
13817
  """
13567
13818
  return self._RetentionUpperLimit
@@ -13573,7 +13824,6 @@ PLATINUM，铂金版
13573
13824
  @property
13574
13825
  def RetentionLowerLimit(self):
13575
13826
  """可调整消息保留时间下限，小时为单位
13576
- 注意：此字段可能返回 null，表示取不到有效值。
13577
13827
  :rtype: int
13578
13828
  """
13579
13829
  return self._RetentionLowerLimit
@@ -13585,7 +13835,6 @@ PLATINUM，铂金版
13585
13835
  @property
13586
13836
  def MaxMessageDelay(self):
13587
13837
  """延时消息最大时长，小时为单位
13588
- 注意：此字段可能返回 null，表示取不到有效值。
13589
13838
  :rtype: int
13590
13839
  """
13591
13840
  return self._MaxMessageDelay
@@ -13619,7 +13868,6 @@ PLATINUM，铂金版
13619
13868
  @property
13620
13869
  def TopicNumUpperLimit(self):
13621
13870
  """主题数量上限默认最大值
13622
- 注意：此字段可能返回 null，表示取不到有效值。
13623
13871
  :rtype: int
13624
13872
  """
13625
13873
  return self._TopicNumUpperLimit
@@ -13944,13 +14192,13 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13944
14192
 
13945
14193
  def __init__(self):
13946
14194
  r"""
13947
- :param _InstanceId: 集群ID
14195
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13948
14196
  :type InstanceId: str
13949
- :param _Topic: 主题名称
14197
+ :param _Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
13950
14198
  :type Topic: str
13951
- :param _ResetTimestamp: 重置位点时间（单位：毫秒）-1表示重置到最新位点
14199
+ :param _ResetTimestamp: 重置位点的时间戳（单位：毫秒），指定为 -1 时表示重置到最新位点
13952
14200
  :type ResetTimestamp: int
13953
- :param _ConsumerGroup: 消费组名称
14201
+ :param _ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
13954
14202
  :type ConsumerGroup: str
13955
14203
  """
13956
14204
  self._InstanceId = None
@@ -13960,7 +14208,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13960
14208
 
13961
14209
  @property
13962
14210
  def InstanceId(self):
13963
- """集群ID
14211
+ """腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13964
14212
  :rtype: str
13965
14213
  """
13966
14214
  return self._InstanceId
@@ -13971,7 +14219,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13971
14219
 
13972
14220
  @property
13973
14221
  def Topic(self):
13974
- """主题名称
14222
+ """主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
13975
14223
  :rtype: str
13976
14224
  """
13977
14225
  return self._Topic
@@ -13982,7 +14230,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13982
14230
 
13983
14231
  @property
13984
14232
  def ResetTimestamp(self):
13985
- """重置位点时间（单位：毫秒）-1表示重置到最新位点
14233
+ """重置位点的时间戳（单位：毫秒），指定为 -1 时表示重置到最新位点
13986
14234
  :rtype: int
13987
14235
  """
13988
14236
  return self._ResetTimestamp
@@ -13993,7 +14241,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13993
14241
 
13994
14242
  @property
13995
14243
  def ConsumerGroup(self):
13996
- """消费组名称
14244
+ """消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
13997
14245
  :rtype: str
13998
14246
  """
13999
14247
  return self._ConsumerGroup
@@ -14065,9 +14313,9 @@ class RoleItem(AbstractModel):
14065
14313
  :type SecretKey: str
14066
14314
  :param _Remark: 备注信息
14067
14315
  :type Remark: str
14068
- :param _CreatedTime: 创建时间，秒为单位
14316
+ :param _CreatedTime: 角色的创建时间，**Unix时间戳（毫秒）**
14069
14317
  :type CreatedTime: int
14070
- :param _ModifiedTime: 修改时间，秒为单位
14318
+ :param _ModifiedTime: 角色的更新时间，**Unix时间戳（毫秒）**
14071
14319
  :type ModifiedTime: int
14072
14320
  :param _PermType: 权限类型，默认按集群授权（Cluster：集群级别；TopicAndGroup：主题&消费组级别）
14073
14321
  :type PermType: str
@@ -14154,7 +14402,7 @@ class RoleItem(AbstractModel):
14154
14402
 
14155
14403
  @property
14156
14404
  def CreatedTime(self):
14157
- """创建时间，秒为单位
14405
+ """角色的创建时间，**Unix时间戳（毫秒）**
14158
14406
  :rtype: int
14159
14407
  """
14160
14408
  return self._CreatedTime
@@ -14165,7 +14413,7 @@ class RoleItem(AbstractModel):
14165
14413
 
14166
14414
  @property
14167
14415
  def ModifiedTime(self):
14168
- """修改时间，秒为单位
14416
+ """角色的更新时间，**Unix时间戳（毫秒）**
14169
14417
  :rtype: int
14170
14418
  """
14171
14419
  return self._ModifiedTime
@@ -14983,7 +15231,11 @@ class SubscriptionData(AbstractModel):
14983
15231
  :param _IsOnline: 是否在线
14984
15232
  注意：此字段可能返回 null，表示取不到有效值。
14985
15233
  :type IsOnline: bool
14986
- :param _ConsumeType: 消费类型
15234
+ :param _ConsumeType: 消费类型，枚举值如下：
15235
+
15236
+ - PULL：PULL 消费类型
15237
+ - PUSH：PUSH 消费类型
15238
+ - POP：POP 消费类型
14987
15239
  注意：此字段可能返回 null，表示取不到有效值。
14988
15240
  :type ConsumeType: str
14989
15241
  :param _SubString: 订阅规则
@@ -14992,7 +15244,10 @@ class SubscriptionData(AbstractModel):
14992
15244
  :param _ExpressionType: 过滤类型
14993
15245
  注意：此字段可能返回 null，表示取不到有效值。
14994
15246
  :type ExpressionType: str
14995
- :param _Consistency: 订阅一致性
15247
+ :param _Consistency: 订阅一致性，枚举如下：
15248
+
15249
+ - 0: 订阅一致
15250
+ - 1: 订阅不一致
14996
15251
  注意：此字段可能返回 null，表示取不到有效值。
14997
15252
  :type Consistency: int
14998
15253
  :param _ConsumerLag: 消费堆积
@@ -15107,7 +15362,11 @@ CLUSTERING 集群模式;
15107
15362
 
15108
15363
  @property
15109
15364
  def ConsumeType(self):
15110
- """消费类型
15365
+ """消费类型，枚举值如下：
15366
+
15367
+ - PULL：PULL 消费类型
15368
+ - PUSH：PUSH 消费类型
15369
+ - POP：POP 消费类型
15111
15370
  注意：此字段可能返回 null，表示取不到有效值。
15112
15371
  :rtype: str
15113
15372
  """
@@ -15143,7 +15402,10 @@ CLUSTERING 集群模式;
15143
15402
 
15144
15403
  @property
15145
15404
  def Consistency(self):
15146
- """订阅一致性
15405
+ """订阅一致性，枚举如下：
15406
+
15407
+ - 0: 订阅一致
15408
+ - 1: 订阅不一致
15147
15409
  注意：此字段可能返回 null，表示取不到有效值。
15148
15410
  :rtype: int
15149
15411
  """
@@ -15375,15 +15637,20 @@ class TopicConsumeStats(AbstractModel):
15375
15637
  r"""
15376
15638
  :param _Topic: 主题名称
15377
15639
  :type Topic: str
15378
- :param _TopicType: 主题类型
15640
+ :param _TopicType: 主题类型，枚举值如下：
15641
+
15642
+ - NORMAL：普通消息主题
15643
+ - FIFO：顺序消息主题
15644
+ - DELAY：延迟消息主题
15645
+ - TRANSACTION：事务消息主题
15379
15646
  :type TopicType: str
15380
15647
  :param _QueueNum: 单节点主题队列数量
15381
15648
  :type QueueNum: int
15382
15649
  :param _ConsumerLag: 消费堆积
15383
15650
  :type ConsumerLag: int
15384
- :param _SubString: 订阅规则
15651
+ :param _SubString: 订阅规则，`*`表示订阅全部TAG
15385
15652
  :type SubString: str
15386
- :param _LastUpdateTime: 最后消费进度更新时间
15653
+ :param _LastUpdateTime: 最后消费进度更新时间，**Unix时间戳（毫秒）**
15387
15654
  :type LastUpdateTime: int
15388
15655
  """
15389
15656
  self._Topic = None
@@ -15406,7 +15673,12 @@ class TopicConsumeStats(AbstractModel):
15406
15673
 
15407
15674
  @property
15408
15675
  def TopicType(self):
15409
- """主题类型
15676
+ """主题类型，枚举值如下：
15677
+
15678
+ - NORMAL：普通消息主题
15679
+ - FIFO：顺序消息主题
15680
+ - DELAY：延迟消息主题
15681
+ - TRANSACTION：事务消息主题
15410
15682
  :rtype: str
15411
15683
  """
15412
15684
  return self._TopicType
@@ -15439,7 +15711,7 @@ class TopicConsumeStats(AbstractModel):
15439
15711
 
15440
15712
  @property
15441
15713
  def SubString(self):
15442
- """订阅规则
15714
+ """订阅规则，`*`表示订阅全部TAG
15443
15715
  :rtype: str
15444
15716
  """
15445
15717
  return self._SubString
@@ -15450,7 +15722,7 @@ class TopicConsumeStats(AbstractModel):
15450
15722
 
15451
15723
  @property
15452
15724
  def LastUpdateTime(self):
15453
- """最后消费进度更新时间
15725
+ """最后消费进度更新时间，**Unix时间戳（毫秒）**
15454
15726
  :rtype: int
15455
15727
  """
15456
15728
  return self._LastUpdateTime
@@ -15496,7 +15768,7 @@ TRANSACTION:事务消息
15496
15768
  :type TopicType: str
15497
15769
  :param _QueueNum: 队列数量
15498
15770
  :type QueueNum: int
15499
- :param _Remark: 描述
15771
+ :param _Remark: 备注信息
15500
15772
  :type Remark: str
15501
15773
  :param _ClusterIdV4: 4.x的集群id
15502
15774
  注意：此字段可能返回 null，表示取不到有效值。
@@ -15511,7 +15783,6 @@ TRANSACTION:事务消息
15511
15783
  注意：此字段可能返回 null，表示取不到有效值。
15512
15784
  :type FullNamespaceV4: str
15513
15785
  :param _MsgTTL: 消息保留时长
15514
- 注意：此字段可能返回 null，表示取不到有效值。
15515
15786
  :type MsgTTL: int
15516
15787
  """
15517
15788
  self._InstanceId = None
@@ -15575,7 +15846,7 @@ TRANSACTION:事务消息
15575
15846
 
15576
15847
  @property
15577
15848
  def Remark(self):
15578
- """描述
15849
+ """备注信息
15579
15850
  :rtype: str
15580
15851
  """
15581
15852
  return self._Remark
@@ -15635,7 +15906,6 @@ TRANSACTION:事务消息
15635
15906
  @property
15636
15907
  def MsgTTL(self):
15637
15908
  """消息保留时长
15638
- 注意：此字段可能返回 null，表示取不到有效值。
15639
15909
  :rtype: int
15640
15910
  """
15641
15911
  return self._MsgTTL