tencentcloud-sdk-python 3.0.1408__py2.py3-none-any.whl → 3.0.1410__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 (50) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/bh/v20230418/bh_client.py +138 -0
  3. tencentcloud/bh/v20230418/errorcodes.py +3 -0
  4. tencentcloud/bh/v20230418/models.py +1006 -67
  5. tencentcloud/ccc/v20200210/models.py +2 -2
  6. tencentcloud/cdb/v20170320/cdb_client.py +25 -19
  7. tencentcloud/cdb/v20170320/errorcodes.py +0 -3
  8. tencentcloud/cdb/v20170320/models.py +274 -202
  9. tencentcloud/common/credential.py +2 -3
  10. tencentcloud/csip/v20221121/models.py +45 -4
  11. tencentcloud/cvm/v20170312/models.py +15 -0
  12. tencentcloud/cwp/v20180228/models.py +165 -0
  13. tencentcloud/cynosdb/v20190107/models.py +45 -0
  14. tencentcloud/dsgc/v20190723/dsgc_client.py +1 -3
  15. tencentcloud/dsgc/v20190723/models.py +342 -15
  16. tencentcloud/emr/v20190103/emr_client.py +23 -0
  17. tencentcloud/emr/v20190103/models.py +500 -0
  18. tencentcloud/es/v20180416/errorcodes.py +42 -0
  19. tencentcloud/ess/v20201111/errorcodes.py +24 -0
  20. tencentcloud/ess/v20201111/ess_client.py +1 -0
  21. tencentcloud/ess/v20201111/models.py +33 -4
  22. tencentcloud/essbasic/v20210526/errorcodes.py +24 -0
  23. tencentcloud/essbasic/v20210526/essbasic_client.py +1 -0
  24. tencentcloud/gs/v20191118/models.py +15 -0
  25. tencentcloud/kms/v20190118/errorcodes.py +36 -0
  26. tencentcloud/kms/v20190118/kms_client.py +345 -0
  27. tencentcloud/kms/v20190118/models.py +3437 -1534
  28. tencentcloud/lighthouse/v20200324/errorcodes.py +21 -0
  29. tencentcloud/live/v20180801/models.py +15 -0
  30. tencentcloud/lke/v20231130/lke_client.py +92 -0
  31. tencentcloud/lke/v20231130/models.py +2702 -572
  32. tencentcloud/mqtt/v20240516/models.py +120 -0
  33. tencentcloud/organization/v20210331/models.py +15 -0
  34. tencentcloud/partners/v20180321/models.py +4 -4
  35. tencentcloud/postgres/v20170312/models.py +4 -0
  36. tencentcloud/ses/v20201002/models.py +0 -8
  37. tencentcloud/tcss/v20201101/models.py +15 -0
  38. tencentcloud/thpc/v20230321/models.py +47 -2
  39. tencentcloud/tione/v20211111/models.py +15 -0
  40. tencentcloud/trocket/v20230308/models.py +476 -238
  41. tencentcloud/trocket/v20230308/trocket_client.py +58 -17
  42. tencentcloud/vpc/v20170312/models.py +15 -0
  43. tencentcloud/waf/v20180125/models.py +110 -18
  44. tencentcloud/wedata/v20210820/models.py +764 -4
  45. tencentcloud/wedata/v20210820/wedata_client.py +48 -2
  46. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/METADATA +1 -1
  47. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/RECORD +50 -50
  48. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/LICENSE +0 -0
  49. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/WHEEL +0 -0
  50. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/top_level.txt +0 -0
@@ -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
@@ -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
@@ -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
@@ -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: 集群ID
2784
+ :type InstanceId: str
2785
+ :param _ConsumerGroup: 消费组名称
2786
+ :type ConsumerGroup: str
2787
+ :param _Filters: 查询条件列表
2788
+ :type Filters: list of Filter
2789
+ :param _Offset: 查询起始位置
2790
+ :type Offset: int
2791
+ :param _Limit: 查询结果限制数量
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
+ """集群ID
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
+ """消费组名称
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
+ """查询条件列表
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
+ """查询起始位置
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
+ """查询结果限制数量
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
 
@@ -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
@@ -3456,11 +3652,11 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3456
3652
 
3457
3653
  def __init__(self):
3458
3654
  r"""
3459
- :param _Offset: 查询起始位置
3655
+ :param _Offset: 查询起始位置,默认为0。
3460
3656
  :type Offset: int
3461
- :param _Limit: 查询结果限制数量
3657
+ :param _Limit: 查询结果限制数量,默认20。
3462
3658
  :type Limit: int
3463
- :param _Filters: 查询条件列表
3659
+ :param _Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3464
3660
  :type Filters: list of Filter
3465
3661
  :param _TagFilters: 标签过滤器
3466
3662
  :type TagFilters: list of TagFilter
@@ -3472,7 +3668,7 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3472
3668
 
3473
3669
  @property
3474
3670
  def Offset(self):
3475
- """查询起始位置
3671
+ """查询起始位置,默认为0。
3476
3672
  :rtype: int
3477
3673
  """
3478
3674
  return self._Offset
@@ -3483,7 +3679,7 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3483
3679
 
3484
3680
  @property
3485
3681
  def Limit(self):
3486
- """查询结果限制数量
3682
+ """查询结果限制数量,默认20。
3487
3683
  :rtype: int
3488
3684
  """
3489
3685
  return self._Limit
@@ -3494,7 +3690,7 @@ class DescribeFusionInstanceListRequest(AbstractModel):
3494
3690
 
3495
3691
  @property
3496
3692
  def Filters(self):
3497
- """查询条件列表
3693
+ """过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3498
3694
  :rtype: list of Filter
3499
3695
  """
3500
3696
  return self._Filters
@@ -3610,13 +3806,13 @@ class DescribeInstanceListRequest(AbstractModel):
3610
3806
 
3611
3807
  def __init__(self):
3612
3808
  r"""
3613
- :param _Filters: 查询条件列表
3809
+ :param _Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3614
3810
  :type Filters: list of Filter
3615
3811
  :param _TagFilters: 标签过滤器
3616
3812
  :type TagFilters: list of TagFilter
3617
- :param _Offset: 查询起始位置
3813
+ :param _Offset: 查询起始位置,默认为0。
3618
3814
  :type Offset: int
3619
- :param _Limit: 查询结果限制数量
3815
+ :param _Limit: 查询结果限制数量,默认20。
3620
3816
  :type Limit: int
3621
3817
  """
3622
3818
  self._Filters = None
@@ -3626,7 +3822,7 @@ class DescribeInstanceListRequest(AbstractModel):
3626
3822
 
3627
3823
  @property
3628
3824
  def Filters(self):
3629
- """查询条件列表
3825
+ """过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3630
3826
  :rtype: list of Filter
3631
3827
  """
3632
3828
  return self._Filters
@@ -3648,7 +3844,7 @@ class DescribeInstanceListRequest(AbstractModel):
3648
3844
 
3649
3845
  @property
3650
3846
  def Offset(self):
3651
- """查询起始位置
3847
+ """查询起始位置,默认为0。
3652
3848
  :rtype: int
3653
3849
  """
3654
3850
  return self._Offset
@@ -3659,7 +3855,7 @@ class DescribeInstanceListRequest(AbstractModel):
3659
3855
 
3660
3856
  @property
3661
3857
  def Limit(self):
3662
- """查询结果限制数量
3858
+ """查询结果限制数量,默认20。
3663
3859
  :rtype: int
3664
3860
  """
3665
3861
  return self._Limit
@@ -3764,14 +3960,14 @@ class DescribeInstanceRequest(AbstractModel):
3764
3960
 
3765
3961
  def __init__(self):
3766
3962
  r"""
3767
- :param _InstanceId: 集群ID
3963
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3768
3964
  :type InstanceId: str
3769
3965
  """
3770
3966
  self._InstanceId = None
3771
3967
 
3772
3968
  @property
3773
3969
  def InstanceId(self):
3774
- """集群ID
3970
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3775
3971
  :rtype: str
3776
3972
  """
3777
3973
  return self._InstanceId
@@ -3830,7 +4026,7 @@ PLATINUM 铂金版
3830
4026
  :type ScaledTpsLimit: int
3831
4027
  :param _MaxMessageDelay: 延迟消息最长时间,小时为单位
3832
4028
  :type MaxMessageDelay: int
3833
- :param _CreatedTime: 创建时间,秒为单位
4029
+ :param _CreatedTime: 创建时间,**Unix时间戳(毫秒)**
3834
4030
  :type CreatedTime: int
3835
4031
  :param _SendReceiveRatio: 消息发送接收比例
3836
4032
  :type SendReceiveRatio: float
@@ -3846,17 +4042,33 @@ PLATINUM 铂金版
3846
4042
  :type TopicQueueNumLowerLimit: int
3847
4043
  :param _Remark: 备注信息
3848
4044
  :type Remark: str
3849
- :param _InstanceStatus: 实例状态
4045
+ :param _InstanceStatus: 实例状态,枚举值如下:
4046
+
4047
+ - RUNNING:运行中
4048
+ - ABNORMAL:异常
4049
+ - OVERDUE:隔离中
4050
+ - DESTROYED:已销毁
4051
+ - CREATING:创建中
4052
+ - MODIFYING:变配中
4053
+ - CREATE_FAILURE:创建失败
4054
+ - MODIFY_FAILURE:变配失败
4055
+ - DELETING:删除中
3850
4056
  :type InstanceStatus: str
3851
4057
  :param _SkuCode: 实例规格
3852
4058
  :type SkuCode: str
3853
- :param _PayMode: 计费模式
4059
+ :param _PayMode: 计费模式,枚举值如下:
4060
+
4061
+ - POSTPAID:后付费按量计费
4062
+ - PREPAID:预付费包年包月
3854
4063
  :type PayMode: str
3855
4064
  :param _ScaledTpsEnabled: 是否开启弹性TPS
3856
4065
  :type ScaledTpsEnabled: bool
3857
- :param _RenewFlag: 是否自动续费
4066
+ :param _RenewFlag: 预付费集群是否自动续费,枚举值如下:
4067
+
4068
+ - 0: 不自动续费
4069
+ - 1: 自动续费
3858
4070
  :type RenewFlag: int
3859
- :param _ExpiryTime: 到期时间
4071
+ :param _ExpiryTime: 到期时间,**Unix时间戳(毫秒)**
3860
4072
  :type ExpiryTime: int
3861
4073
  :param _RoleNumLimit: 角色数量限制
3862
4074
  :type RoleNumLimit: int
@@ -3869,7 +4081,7 @@ PLATINUM 铂金版
3869
4081
  :param _TopicNumUpperLimit: 最大可设置的topic个数
3870
4082
  注意:此字段可能返回 null,表示取不到有效值。
3871
4083
  :type TopicNumUpperLimit: int
3872
- :param _ZoneIds: 可用区列表
4084
+ :param _ZoneIds: 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
3873
4085
  :type ZoneIds: list of int
3874
4086
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3875
4087
  :type RequestId: str
@@ -4056,7 +4268,7 @@ PLATINUM 铂金版
4056
4268
 
4057
4269
  @property
4058
4270
  def CreatedTime(self):
4059
- """创建时间,秒为单位
4271
+ """创建时间,**Unix时间戳(毫秒)**
4060
4272
  :rtype: int
4061
4273
  """
4062
4274
  return self._CreatedTime
@@ -4135,7 +4347,17 @@ PLATINUM 铂金版
4135
4347
 
4136
4348
  @property
4137
4349
  def InstanceStatus(self):
4138
- """实例状态
4350
+ """实例状态,枚举值如下:
4351
+
4352
+ - RUNNING:运行中
4353
+ - ABNORMAL:异常
4354
+ - OVERDUE:隔离中
4355
+ - DESTROYED:已销毁
4356
+ - CREATING:创建中
4357
+ - MODIFYING:变配中
4358
+ - CREATE_FAILURE:创建失败
4359
+ - MODIFY_FAILURE:变配失败
4360
+ - DELETING:删除中
4139
4361
  :rtype: str
4140
4362
  """
4141
4363
  return self._InstanceStatus
@@ -4157,7 +4379,10 @@ PLATINUM 铂金版
4157
4379
 
4158
4380
  @property
4159
4381
  def PayMode(self):
4160
- """计费模式
4382
+ """计费模式,枚举值如下:
4383
+
4384
+ - POSTPAID:后付费按量计费
4385
+ - PREPAID:预付费包年包月
4161
4386
  :rtype: str
4162
4387
  """
4163
4388
  return self._PayMode
@@ -4179,7 +4404,10 @@ PLATINUM 铂金版
4179
4404
 
4180
4405
  @property
4181
4406
  def RenewFlag(self):
4182
- """是否自动续费
4407
+ """预付费集群是否自动续费,枚举值如下:
4408
+
4409
+ - 0: 不自动续费
4410
+ - 1: 自动续费
4183
4411
  :rtype: int
4184
4412
  """
4185
4413
  return self._RenewFlag
@@ -4190,7 +4418,7 @@ PLATINUM 铂金版
4190
4418
 
4191
4419
  @property
4192
4420
  def ExpiryTime(self):
4193
- """到期时间
4421
+ """到期时间,**Unix时间戳(毫秒)**
4194
4422
  :rtype: int
4195
4423
  """
4196
4424
  return self._ExpiryTime
@@ -4248,7 +4476,7 @@ PLATINUM 铂金版
4248
4476
 
4249
4477
  @property
4250
4478
  def ZoneIds(self):
4251
- """可用区列表
4479
+ """所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
4252
4480
  :rtype: list of int
4253
4481
  """
4254
4482
  return self._ZoneIds
@@ -6263,31 +6491,31 @@ class DescribeMessageListRequest(AbstractModel):
6263
6491
 
6264
6492
  def __init__(self):
6265
6493
  r"""
6266
- :param _InstanceId: 集群ID
6494
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6267
6495
  :type InstanceId: str
6268
- :param _Topic: 主题名称
6496
+ :param _Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6269
6497
  :type Topic: str
6270
- :param _StartTime: 开始时间
6498
+ :param _StartTime: 要查询消息的开始时间,**Unix时间戳(毫秒)**
6271
6499
  :type StartTime: int
6272
- :param _EndTime: 结束时间
6500
+ :param _EndTime: 要查询消息的结束时间,**Unix时间戳(毫秒)**
6273
6501
  :type EndTime: int
6274
- :param _TaskRequestId: 一次查询标识
6502
+ :param _TaskRequestId: 一次查询标识。第一次查询可传空字符串,当查询结果涉及分页,请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
6275
6503
  :type TaskRequestId: str
6276
- :param _Offset: 查询起始位置
6504
+ :param _Offset: 查询起始位置,默认为0。
6277
6505
  :type Offset: int
6278
- :param _Limit: 查询结果限制数量
6506
+ :param _Limit: 查询结果限制数量,默认20。
6279
6507
  :type Limit: int
6280
- :param _ConsumerGroup: 消费组名称
6508
+ :param _ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
6281
6509
  :type ConsumerGroup: str
6282
- :param _MsgId: 消息 ID
6510
+ :param _MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6283
6511
  :type MsgId: str
6284
- :param _MsgKey: 消息 Key
6512
+ :param _MsgKey: 消息 Key,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6285
6513
  :type MsgKey: str
6286
6514
  :param _RecentMessageNum: 查询最近N条消息 最大不超过1024,默认-1为其他查询条件
6287
6515
  :type RecentMessageNum: int
6288
- :param _QueryDeadLetterMessage: 是否查询死信消息
6516
+ :param _QueryDeadLetterMessage: 是否查询死信消息,默认为false
6289
6517
  :type QueryDeadLetterMessage: bool
6290
- :param _Tag: 消息 Tag
6518
+ :param _Tag: 消息 Tag,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6291
6519
  :type Tag: str
6292
6520
  """
6293
6521
  self._InstanceId = None
@@ -6306,7 +6534,7 @@ class DescribeMessageListRequest(AbstractModel):
6306
6534
 
6307
6535
  @property
6308
6536
  def InstanceId(self):
6309
- """集群ID
6537
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6310
6538
  :rtype: str
6311
6539
  """
6312
6540
  return self._InstanceId
@@ -6317,7 +6545,7 @@ class DescribeMessageListRequest(AbstractModel):
6317
6545
 
6318
6546
  @property
6319
6547
  def Topic(self):
6320
- """主题名称
6548
+ """主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6321
6549
  :rtype: str
6322
6550
  """
6323
6551
  return self._Topic
@@ -6328,7 +6556,7 @@ class DescribeMessageListRequest(AbstractModel):
6328
6556
 
6329
6557
  @property
6330
6558
  def StartTime(self):
6331
- """开始时间
6559
+ """要查询消息的开始时间,**Unix时间戳(毫秒)**
6332
6560
  :rtype: int
6333
6561
  """
6334
6562
  return self._StartTime
@@ -6339,7 +6567,7 @@ class DescribeMessageListRequest(AbstractModel):
6339
6567
 
6340
6568
  @property
6341
6569
  def EndTime(self):
6342
- """结束时间
6570
+ """要查询消息的结束时间,**Unix时间戳(毫秒)**
6343
6571
  :rtype: int
6344
6572
  """
6345
6573
  return self._EndTime
@@ -6350,7 +6578,7 @@ class DescribeMessageListRequest(AbstractModel):
6350
6578
 
6351
6579
  @property
6352
6580
  def TaskRequestId(self):
6353
- """一次查询标识
6581
+ """一次查询标识。第一次查询可传空字符串,当查询结果涉及分页,请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
6354
6582
  :rtype: str
6355
6583
  """
6356
6584
  return self._TaskRequestId
@@ -6361,7 +6589,7 @@ class DescribeMessageListRequest(AbstractModel):
6361
6589
 
6362
6590
  @property
6363
6591
  def Offset(self):
6364
- """查询起始位置
6592
+ """查询起始位置,默认为0。
6365
6593
  :rtype: int
6366
6594
  """
6367
6595
  return self._Offset
@@ -6372,7 +6600,7 @@ class DescribeMessageListRequest(AbstractModel):
6372
6600
 
6373
6601
  @property
6374
6602
  def Limit(self):
6375
- """查询结果限制数量
6603
+ """查询结果限制数量,默认20。
6376
6604
  :rtype: int
6377
6605
  """
6378
6606
  return self._Limit
@@ -6383,7 +6611,7 @@ class DescribeMessageListRequest(AbstractModel):
6383
6611
 
6384
6612
  @property
6385
6613
  def ConsumerGroup(self):
6386
- """消费组名称
6614
+ """消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
6387
6615
  :rtype: str
6388
6616
  """
6389
6617
  return self._ConsumerGroup
@@ -6394,7 +6622,7 @@ class DescribeMessageListRequest(AbstractModel):
6394
6622
 
6395
6623
  @property
6396
6624
  def MsgId(self):
6397
- """消息 ID
6625
+ """消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6398
6626
  :rtype: str
6399
6627
  """
6400
6628
  return self._MsgId
@@ -6405,7 +6633,7 @@ class DescribeMessageListRequest(AbstractModel):
6405
6633
 
6406
6634
  @property
6407
6635
  def MsgKey(self):
6408
- """消息 Key
6636
+ """消息 Key,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6409
6637
  :rtype: str
6410
6638
  """
6411
6639
  return self._MsgKey
@@ -6427,7 +6655,7 @@ class DescribeMessageListRequest(AbstractModel):
6427
6655
 
6428
6656
  @property
6429
6657
  def QueryDeadLetterMessage(self):
6430
- """是否查询死信消息
6658
+ """是否查询死信消息,默认为false
6431
6659
  :rtype: bool
6432
6660
  """
6433
6661
  return self._QueryDeadLetterMessage
@@ -6438,7 +6666,7 @@ class DescribeMessageListRequest(AbstractModel):
6438
6666
 
6439
6667
  @property
6440
6668
  def Tag(self):
6441
- """消息 Tag
6669
+ """消息 Tag,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6442
6670
  :rtype: str
6443
6671
  """
6444
6672
  return self._Tag
@@ -6561,19 +6789,19 @@ class DescribeMessageRequest(AbstractModel):
6561
6789
 
6562
6790
  def __init__(self):
6563
6791
  r"""
6564
- :param _InstanceId: 集群ID
6792
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6565
6793
  :type InstanceId: str
6566
- :param _Topic: 主题名称
6794
+ :param _Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6567
6795
  :type Topic: str
6568
- :param _MsgId: 消息ID
6796
+ :param _MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6569
6797
  :type MsgId: str
6570
- :param _Offset: 查询起始位置
6798
+ :param _Offset: 查询起始位置,默认为0。
6571
6799
  :type Offset: int
6572
- :param _Limit: 查询结果限制数量
6800
+ :param _Limit: 查询结果限制数量,默认20。
6573
6801
  :type Limit: int
6574
- :param _QueryDeadLetterMessage: 是否是死信消息
6802
+ :param _QueryDeadLetterMessage: 是否是死信消息,默认为false
6575
6803
  :type QueryDeadLetterMessage: bool
6576
- :param _QueryDelayMessage: 是否是延时消息
6804
+ :param _QueryDelayMessage: 是否是延时消息,默认为false
6577
6805
  :type QueryDelayMessage: bool
6578
6806
  """
6579
6807
  self._InstanceId = None
@@ -6586,7 +6814,7 @@ class DescribeMessageRequest(AbstractModel):
6586
6814
 
6587
6815
  @property
6588
6816
  def InstanceId(self):
6589
- """集群ID
6817
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6590
6818
  :rtype: str
6591
6819
  """
6592
6820
  return self._InstanceId
@@ -6597,7 +6825,7 @@ class DescribeMessageRequest(AbstractModel):
6597
6825
 
6598
6826
  @property
6599
6827
  def Topic(self):
6600
- """主题名称
6828
+ """主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6601
6829
  :rtype: str
6602
6830
  """
6603
6831
  return self._Topic
@@ -6608,7 +6836,7 @@ class DescribeMessageRequest(AbstractModel):
6608
6836
 
6609
6837
  @property
6610
6838
  def MsgId(self):
6611
- """消息ID
6839
+ """消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6612
6840
  :rtype: str
6613
6841
  """
6614
6842
  return self._MsgId
@@ -6619,7 +6847,7 @@ class DescribeMessageRequest(AbstractModel):
6619
6847
 
6620
6848
  @property
6621
6849
  def Offset(self):
6622
- """查询起始位置
6850
+ """查询起始位置,默认为0。
6623
6851
  :rtype: int
6624
6852
  """
6625
6853
  return self._Offset
@@ -6630,7 +6858,7 @@ class DescribeMessageRequest(AbstractModel):
6630
6858
 
6631
6859
  @property
6632
6860
  def Limit(self):
6633
- """查询结果限制数量
6861
+ """查询结果限制数量,默认20。
6634
6862
  :rtype: int
6635
6863
  """
6636
6864
  return self._Limit
@@ -6641,7 +6869,7 @@ class DescribeMessageRequest(AbstractModel):
6641
6869
 
6642
6870
  @property
6643
6871
  def QueryDeadLetterMessage(self):
6644
- """是否是死信消息
6872
+ """是否是死信消息,默认为false
6645
6873
  :rtype: bool
6646
6874
  """
6647
6875
  return self._QueryDeadLetterMessage
@@ -6652,7 +6880,7 @@ class DescribeMessageRequest(AbstractModel):
6652
6880
 
6653
6881
  @property
6654
6882
  def QueryDelayMessage(self):
6655
- """是否是延时消息
6883
+ """是否是延时消息,默认为false
6656
6884
  :rtype: bool
6657
6885
  """
6658
6886
  return self._QueryDelayMessage
@@ -6701,7 +6929,7 @@ class DescribeMessageResponse(AbstractModel):
6701
6929
  :param _MessageTracks: 消息消费情况列表
6702
6930
  注意:此字段可能返回 null,表示取不到有效值。
6703
6931
  :type MessageTracks: list of MessageTrackItem
6704
- :param _ShowTopicName: Topic
6932
+ :param _ShowTopicName: 主题名称
6705
6933
  :type ShowTopicName: str
6706
6934
  :param _MessageTracksCount: 消息消费情况列表总条数
6707
6935
  注意:此字段可能返回 null,表示取不到有效值。
@@ -6789,7 +7017,7 @@ class DescribeMessageResponse(AbstractModel):
6789
7017
 
6790
7018
  @property
6791
7019
  def ShowTopicName(self):
6792
- """Topic
7020
+ """主题名称
6793
7021
  :rtype: str
6794
7022
  """
6795
7023
  return self._ShowTopicName
@@ -6846,15 +7074,15 @@ class DescribeMessageTraceRequest(AbstractModel):
6846
7074
 
6847
7075
  def __init__(self):
6848
7076
  r"""
6849
- :param _InstanceId: 集群ID
7077
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6850
7078
  :type InstanceId: str
6851
- :param _Topic: 主题名称
7079
+ :param _Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6852
7080
  :type Topic: str
6853
- :param _MsgId: 消息ID
7081
+ :param _MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6854
7082
  :type MsgId: str
6855
- :param _QueryDeadLetterMessage: 是否是死信消息
7083
+ :param _QueryDeadLetterMessage: 是否是死信消息,默认为false
6856
7084
  :type QueryDeadLetterMessage: bool
6857
- :param _QueryDelayMessage: 是否是延时消息
7085
+ :param _QueryDelayMessage: 是否是延时消息,默认为false
6858
7086
  :type QueryDelayMessage: bool
6859
7087
  """
6860
7088
  self._InstanceId = None
@@ -6865,7 +7093,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6865
7093
 
6866
7094
  @property
6867
7095
  def InstanceId(self):
6868
- """集群ID
7096
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
6869
7097
  :rtype: str
6870
7098
  """
6871
7099
  return self._InstanceId
@@ -6876,7 +7104,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6876
7104
 
6877
7105
  @property
6878
7106
  def Topic(self):
6879
- """主题名称
7107
+ """主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
6880
7108
  :rtype: str
6881
7109
  """
6882
7110
  return self._Topic
@@ -6887,7 +7115,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6887
7115
 
6888
7116
  @property
6889
7117
  def MsgId(self):
6890
- """消息ID
7118
+ """消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
6891
7119
  :rtype: str
6892
7120
  """
6893
7121
  return self._MsgId
@@ -6898,7 +7126,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6898
7126
 
6899
7127
  @property
6900
7128
  def QueryDeadLetterMessage(self):
6901
- """是否是死信消息
7129
+ """是否是死信消息,默认为false
6902
7130
  :rtype: bool
6903
7131
  """
6904
7132
  return self._QueryDeadLetterMessage
@@ -6909,7 +7137,7 @@ class DescribeMessageTraceRequest(AbstractModel):
6909
7137
 
6910
7138
  @property
6911
7139
  def QueryDelayMessage(self):
6912
- """是否是延时消息
7140
+ """是否是延时消息,默认为false
6913
7141
  :rtype: bool
6914
7142
  """
6915
7143
  return self._QueryDelayMessage
@@ -6942,7 +7170,7 @@ class DescribeMessageTraceResponse(AbstractModel):
6942
7170
 
6943
7171
  def __init__(self):
6944
7172
  r"""
6945
- :param _ShowTopicName: 展示Topic名
7173
+ :param _ShowTopicName: 主题名称
6946
7174
  :type ShowTopicName: str
6947
7175
  :param _Data: 轨迹详情
6948
7176
  注意:此字段可能返回 null,表示取不到有效值。
@@ -6956,7 +7184,7 @@ class DescribeMessageTraceResponse(AbstractModel):
6956
7184
 
6957
7185
  @property
6958
7186
  def ShowTopicName(self):
6959
- """展示Topic名
7187
+ """主题名称
6960
7188
  :rtype: str
6961
7189
  """
6962
7190
  return self._ShowTopicName
@@ -7674,13 +7902,13 @@ class DescribeRoleListRequest(AbstractModel):
7674
7902
 
7675
7903
  def __init__(self):
7676
7904
  r"""
7677
- :param _InstanceId: 集群ID
7905
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
7678
7906
  :type InstanceId: str
7679
- :param _Offset: 查询起始位置
7907
+ :param _Offset: 查询起始位置,默认为0。
7680
7908
  :type Offset: int
7681
- :param _Limit: 查询结果限制数量
7909
+ :param _Limit: 查询结果限制数量,默认20。
7682
7910
  :type Limit: int
7683
- :param _Filters: 查询条件列表
7911
+ :param _Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
7684
7912
  :type Filters: list of Filter
7685
7913
  """
7686
7914
  self._InstanceId = None
@@ -7690,7 +7918,7 @@ class DescribeRoleListRequest(AbstractModel):
7690
7918
 
7691
7919
  @property
7692
7920
  def InstanceId(self):
7693
- """集群ID
7921
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
7694
7922
  :rtype: str
7695
7923
  """
7696
7924
  return self._InstanceId
@@ -7701,7 +7929,7 @@ class DescribeRoleListRequest(AbstractModel):
7701
7929
 
7702
7930
  @property
7703
7931
  def Offset(self):
7704
- """查询起始位置
7932
+ """查询起始位置,默认为0。
7705
7933
  :rtype: int
7706
7934
  """
7707
7935
  return self._Offset
@@ -7712,7 +7940,7 @@ class DescribeRoleListRequest(AbstractModel):
7712
7940
 
7713
7941
  @property
7714
7942
  def Limit(self):
7715
- """查询结果限制数量
7943
+ """查询结果限制数量,默认20。
7716
7944
  :rtype: int
7717
7945
  """
7718
7946
  return self._Limit
@@ -7723,7 +7951,7 @@ class DescribeRoleListRequest(AbstractModel):
7723
7951
 
7724
7952
  @property
7725
7953
  def Filters(self):
7726
- """查询条件列表
7954
+ """过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
7727
7955
  :rtype: list of Filter
7728
7956
  """
7729
7957
  return self._Filters
@@ -7959,7 +8187,7 @@ class DescribeSourceClusterGroupListRequest(AbstractModel):
7959
8187
 
7960
8188
  def __init__(self):
7961
8189
  r"""
7962
- :param _TaskId: 任务ID,可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
8190
+ :param _TaskId: 任务ID,可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台上获得。
7963
8191
 
7964
8192
  :type TaskId: str
7965
8193
  :param _Limit: 查询结果限制数量,默认20。
@@ -7976,7 +8204,7 @@ class DescribeSourceClusterGroupListRequest(AbstractModel):
7976
8204
 
7977
8205
  @property
7978
8206
  def TaskId(self):
7979
- """任务ID,可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
8207
+ """任务ID,可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台上获得。
7980
8208
 
7981
8209
  :rtype: str
7982
8210
  """
@@ -8274,13 +8502,13 @@ class DescribeTopicListRequest(AbstractModel):
8274
8502
 
8275
8503
  def __init__(self):
8276
8504
  r"""
8277
- :param _InstanceId: 集群ID
8505
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8278
8506
  :type InstanceId: str
8279
- :param _Filters: 查询条件列表
8507
+ :param _Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
8280
8508
  :type Filters: list of Filter
8281
- :param _Offset: 查询起始位置
8509
+ :param _Offset: 查询起始位置,默认为0。
8282
8510
  :type Offset: int
8283
- :param _Limit: 查询结果限制数量
8511
+ :param _Limit: 查询结果限制数量,默认20。
8284
8512
  :type Limit: int
8285
8513
  """
8286
8514
  self._InstanceId = None
@@ -8290,7 +8518,7 @@ class DescribeTopicListRequest(AbstractModel):
8290
8518
 
8291
8519
  @property
8292
8520
  def InstanceId(self):
8293
- """集群ID
8521
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
8294
8522
  :rtype: str
8295
8523
  """
8296
8524
  return self._InstanceId
@@ -8301,7 +8529,7 @@ class DescribeTopicListRequest(AbstractModel):
8301
8529
 
8302
8530
  @property
8303
8531
  def Filters(self):
8304
- """查询条件列表
8532
+ """过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
8305
8533
  :rtype: list of Filter
8306
8534
  """
8307
8535
  return self._Filters
@@ -8312,7 +8540,7 @@ class DescribeTopicListRequest(AbstractModel):
8312
8540
 
8313
8541
  @property
8314
8542
  def Offset(self):
8315
- """查询起始位置
8543
+ """查询起始位置,默认为0。
8316
8544
  :rtype: int
8317
8545
  """
8318
8546
  return self._Offset
@@ -8323,7 +8551,7 @@ class DescribeTopicListRequest(AbstractModel):
8323
8551
 
8324
8552
  @property
8325
8553
  def Limit(self):
8326
- """查询结果限制数量
8554
+ """查询结果限制数量,默认20。
8327
8555
  :rtype: int
8328
8556
  """
8329
8557
  return self._Limit
@@ -8984,10 +9212,13 @@ class Endpoint(AbstractModel):
8984
9212
 
8985
9213
  def __init__(self):
8986
9214
  r"""
8987
- :param _Type: 接入点类型,枚举值如下
8988
- VPC: VPC;
8989
- PUBLIC: 公网;
8990
- INTERNAL: 支撑网;
9215
+ :param _Type: 接入点类型,枚举值如下:
9216
+
9217
+ - VPC:VPC 网络
9218
+
9219
+ - PUBLIC:公网
9220
+
9221
+ - INTERNAL:支撑网
8991
9222
  :type Type: str
8992
9223
  :param _Status: 状态,
8993
9224
  OPEN 开启,
@@ -9030,10 +9261,13 @@ POSTPAID 按量付费
9030
9261
 
9031
9262
  @property
9032
9263
  def Type(self):
9033
- """接入点类型,枚举值如下
9034
- VPC: VPC;
9035
- PUBLIC: 公网;
9036
- INTERNAL: 支撑网;
9264
+ """接入点类型,枚举值如下:
9265
+
9266
+ - VPC:VPC 网络
9267
+
9268
+ - PUBLIC:公网
9269
+
9270
+ - INTERNAL:支撑网
9037
9271
  :rtype: str
9038
9272
  """
9039
9273
  return self._Type
@@ -9254,11 +9488,13 @@ DELETING,删除中
9254
9488
  :type TopicNumLimit: int
9255
9489
  :param _GroupNumLimit: 实例消费组数量上限
9256
9490
  :type GroupNumLimit: int
9257
- :param _PayMode: 计费模式,
9258
- POSTPAID,按量计费
9259
- PREPAID,包年包月
9491
+ :param _PayMode: 计费模式,枚举值如下:
9492
+
9493
+ - POSTPAID:按量计费
9494
+
9495
+ - PREPAID:包年包月
9260
9496
  :type PayMode: str
9261
- :param _ExpiryTime: 到期时间,秒为单位
9497
+ :param _ExpiryTime: 到期时间,**Unix时间戳(毫秒)**
9262
9498
  注意:此字段可能返回 null,表示取不到有效值。
9263
9499
  :type ExpiryTime: int
9264
9500
  :param _Remark: 备注信息
@@ -9277,24 +9513,23 @@ PREPAID,包年包月
9277
9513
  注意:此字段可能返回 null,表示取不到有效值。
9278
9514
  :type TpsLimit: int
9279
9515
  :param _ScaledTpsLimit: 弹性TPS限流值
9280
- 注意:此字段可能返回 null,表示取不到有效值。
9281
9516
  :type ScaledTpsLimit: int
9282
9517
  :param _MessageRetention: 消息保留时间,小时为单位
9283
- 注意:此字段可能返回 null,表示取不到有效值。
9284
9518
  :type MessageRetention: int
9285
9519
  :param _MaxMessageDelay: 延迟消息最大时长,小时为单位
9286
- 注意:此字段可能返回 null,表示取不到有效值。
9287
9520
  :type MaxMessageDelay: int
9288
- :param _RenewFlag: 是否自动续费
9289
- 注意:此字段可能返回 null,表示取不到有效值。
9521
+ :param _RenewFlag: 预付费集群是否自动续费,枚举值如下:
9522
+
9523
+ - 0: 不自动续费
9524
+ - 1: 自动续费
9290
9525
  :type RenewFlag: int
9291
9526
  :param _InstanceItemExtraInfo: 4.x独有数据
9292
9527
  注意:此字段可能返回 null,表示取不到有效值。
9293
9528
  :type InstanceItemExtraInfo: :class:`tencentcloud.trocket.v20230308.models.InstanceItemExtraInfo`
9294
- :param _DestroyTime: 预销毁时间
9529
+ :param _DestroyTime: 预销毁时间,**Unix时间戳(毫秒)**
9295
9530
  注意:此字段可能返回 null,表示取不到有效值。
9296
9531
  :type DestroyTime: int
9297
- :param _ZoneIds: 所属可用区列表
9532
+ :param _ZoneIds: 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
9298
9533
  注意:此字段可能返回 null,表示取不到有效值。
9299
9534
  :type ZoneIds: list of int
9300
9535
  :param _EnableDeletionProtection: 是否开启删除保护
@@ -9417,9 +9652,11 @@ DELETING,删除中
9417
9652
 
9418
9653
  @property
9419
9654
  def PayMode(self):
9420
- """计费模式,
9421
- POSTPAID,按量计费
9422
- PREPAID,包年包月
9655
+ """计费模式,枚举值如下:
9656
+
9657
+ - POSTPAID:按量计费
9658
+
9659
+ - PREPAID:包年包月
9423
9660
  :rtype: str
9424
9661
  """
9425
9662
  return self._PayMode
@@ -9430,7 +9667,7 @@ PREPAID,包年包月
9430
9667
 
9431
9668
  @property
9432
9669
  def ExpiryTime(self):
9433
- """到期时间,秒为单位
9670
+ """到期时间,**Unix时间戳(毫秒)**
9434
9671
  注意:此字段可能返回 null,表示取不到有效值。
9435
9672
  :rtype: int
9436
9673
  """
@@ -9512,7 +9749,6 @@ PREPAID,包年包月
9512
9749
  @property
9513
9750
  def ScaledTpsLimit(self):
9514
9751
  """弹性TPS限流值
9515
- 注意:此字段可能返回 null,表示取不到有效值。
9516
9752
  :rtype: int
9517
9753
  """
9518
9754
  return self._ScaledTpsLimit
@@ -9524,7 +9760,6 @@ PREPAID,包年包月
9524
9760
  @property
9525
9761
  def MessageRetention(self):
9526
9762
  """消息保留时间,小时为单位
9527
- 注意:此字段可能返回 null,表示取不到有效值。
9528
9763
  :rtype: int
9529
9764
  """
9530
9765
  return self._MessageRetention
@@ -9536,7 +9771,6 @@ PREPAID,包年包月
9536
9771
  @property
9537
9772
  def MaxMessageDelay(self):
9538
9773
  """延迟消息最大时长,小时为单位
9539
- 注意:此字段可能返回 null,表示取不到有效值。
9540
9774
  :rtype: int
9541
9775
  """
9542
9776
  return self._MaxMessageDelay
@@ -9547,8 +9781,10 @@ PREPAID,包年包月
9547
9781
 
9548
9782
  @property
9549
9783
  def RenewFlag(self):
9550
- """是否自动续费
9551
- 注意:此字段可能返回 null,表示取不到有效值。
9784
+ """预付费集群是否自动续费,枚举值如下:
9785
+
9786
+ - 0: 不自动续费
9787
+ - 1: 自动续费
9552
9788
  :rtype: int
9553
9789
  """
9554
9790
  return self._RenewFlag
@@ -9571,7 +9807,7 @@ PREPAID,包年包月
9571
9807
 
9572
9808
  @property
9573
9809
  def DestroyTime(self):
9574
- """预销毁时间
9810
+ """预销毁时间,**Unix时间戳(毫秒)**
9575
9811
  注意:此字段可能返回 null,表示取不到有效值。
9576
9812
  :rtype: int
9577
9813
  """
@@ -9583,7 +9819,7 @@ PREPAID,包年包月
9583
9819
 
9584
9820
  @property
9585
9821
  def ZoneIds(self):
9586
- """所属可用区列表
9822
+ """所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
9587
9823
  注意:此字段可能返回 null,表示取不到有效值。
9588
9824
  :rtype: list of int
9589
9825
  """
@@ -9853,11 +10089,13 @@ DELETING,删除中
9853
10089
  :type TopicNumLimit: int
9854
10090
  :param _GroupNumLimit: 实例消费组数量上限
9855
10091
  :type GroupNumLimit: int
9856
- :param _PayMode: 计费模式,
9857
- POSTPAID,按量计费
9858
- PREPAID,包年包月
10092
+ :param _PayMode: 计费模式,枚举值如下:
10093
+
10094
+ - POSTPAID:按量计费
10095
+
10096
+ - PREPAID:包年包月
9859
10097
  :type PayMode: str
9860
- :param _ExpiryTime: 到期时间,秒为单位
10098
+ :param _ExpiryTime: 到期时间戳,**Unix时间戳(毫秒)**
9861
10099
  注意:此字段可能返回 null,表示取不到有效值。
9862
10100
  :type ExpiryTime: int
9863
10101
  :param _Remark: 备注信息
@@ -9873,19 +10111,14 @@ PREPAID,包年包月
9873
10111
  :param _SkuCode: 商品规格
9874
10112
  :type SkuCode: str
9875
10113
  :param _TpsLimit: TPS限流值
9876
- 注意:此字段可能返回 null,表示取不到有效值。
9877
10114
  :type TpsLimit: int
9878
10115
  :param _ScaledTpsLimit: 弹性TPS限流值
9879
- 注意:此字段可能返回 null,表示取不到有效值。
9880
10116
  :type ScaledTpsLimit: int
9881
10117
  :param _MessageRetention: 消息保留时间,小时为单位
9882
- 注意:此字段可能返回 null,表示取不到有效值。
9883
10118
  :type MessageRetention: int
9884
10119
  :param _MaxMessageDelay: 延迟消息最大时长,小时为单位
9885
- 注意:此字段可能返回 null,表示取不到有效值。
9886
10120
  :type MaxMessageDelay: int
9887
- :param _RenewFlag: 是否自动续费
9888
- 注意:此字段可能返回 null,表示取不到有效值。
10121
+ :param _RenewFlag: 是否自动续费,仅针对预付费集群(0: 不自动续费;1:自动续费)
9889
10122
  :type RenewFlag: int
9890
10123
  """
9891
10124
  self._InstanceId = None
@@ -10001,9 +10234,11 @@ DELETING,删除中
10001
10234
 
10002
10235
  @property
10003
10236
  def PayMode(self):
10004
- """计费模式,
10005
- POSTPAID,按量计费
10006
- PREPAID,包年包月
10237
+ """计费模式,枚举值如下:
10238
+
10239
+ - POSTPAID:按量计费
10240
+
10241
+ - PREPAID:包年包月
10007
10242
  :rtype: str
10008
10243
  """
10009
10244
  return self._PayMode
@@ -10014,7 +10249,7 @@ PREPAID,包年包月
10014
10249
 
10015
10250
  @property
10016
10251
  def ExpiryTime(self):
10017
- """到期时间,秒为单位
10252
+ """到期时间戳,**Unix时间戳(毫秒)**
10018
10253
  注意:此字段可能返回 null,表示取不到有效值。
10019
10254
  :rtype: int
10020
10255
  """
@@ -10084,7 +10319,6 @@ PREPAID,包年包月
10084
10319
  @property
10085
10320
  def TpsLimit(self):
10086
10321
  """TPS限流值
10087
- 注意:此字段可能返回 null,表示取不到有效值。
10088
10322
  :rtype: int
10089
10323
  """
10090
10324
  return self._TpsLimit
@@ -10096,7 +10330,6 @@ PREPAID,包年包月
10096
10330
  @property
10097
10331
  def ScaledTpsLimit(self):
10098
10332
  """弹性TPS限流值
10099
- 注意:此字段可能返回 null,表示取不到有效值。
10100
10333
  :rtype: int
10101
10334
  """
10102
10335
  return self._ScaledTpsLimit
@@ -10108,7 +10341,6 @@ PREPAID,包年包月
10108
10341
  @property
10109
10342
  def MessageRetention(self):
10110
10343
  """消息保留时间,小时为单位
10111
- 注意:此字段可能返回 null,表示取不到有效值。
10112
10344
  :rtype: int
10113
10345
  """
10114
10346
  return self._MessageRetention
@@ -10120,7 +10352,6 @@ PREPAID,包年包月
10120
10352
  @property
10121
10353
  def MaxMessageDelay(self):
10122
10354
  """延迟消息最大时长,小时为单位
10123
- 注意:此字段可能返回 null,表示取不到有效值。
10124
10355
  :rtype: int
10125
10356
  """
10126
10357
  return self._MaxMessageDelay
@@ -10131,8 +10362,7 @@ PREPAID,包年包月
10131
10362
 
10132
10363
  @property
10133
10364
  def RenewFlag(self):
10134
- """是否自动续费
10135
- 注意:此字段可能返回 null,表示取不到有效值。
10365
+ """是否自动续费,仅针对预付费集群(0: 不自动续费;1:自动续费)
10136
10366
  :rtype: int
10137
10367
  """
10138
10368
  return self._RenewFlag
@@ -10375,10 +10605,9 @@ class IpRule(AbstractModel):
10375
10605
  r"""
10376
10606
  :param _Ip: IP地址
10377
10607
  :type Ip: str
10378
- :param _Allow: 是否允许放行
10608
+ :param _Allow: 是否允许放行,默认为false表示拒绝
10379
10609
  :type Allow: bool
10380
10610
  :param _Remark: 备注信息
10381
- 注意:此字段可能返回 null,表示取不到有效值。
10382
10611
  :type Remark: str
10383
10612
  """
10384
10613
  self._Ip = None
@@ -10398,7 +10627,7 @@ class IpRule(AbstractModel):
10398
10627
 
10399
10628
  @property
10400
10629
  def Allow(self):
10401
- """是否允许放行
10630
+ """是否允许放行,默认为false表示拒绝
10402
10631
  :rtype: bool
10403
10632
  """
10404
10633
  return self._Allow
@@ -10410,7 +10639,6 @@ class IpRule(AbstractModel):
10410
10639
  @property
10411
10640
  def Remark(self):
10412
10641
  """备注信息
10413
- 注意:此字段可能返回 null,表示取不到有效值。
10414
10642
  :rtype: str
10415
10643
  """
10416
10644
  return self._Remark
@@ -11581,7 +11809,13 @@ class MessageTraceItem(AbstractModel):
11581
11809
 
11582
11810
  def __init__(self):
11583
11811
  r"""
11584
- :param _Stage: 步骤
11812
+ :param _Stage: 消息处理阶段,枚举值如下:
11813
+
11814
+ - produce:消息生产
11815
+
11816
+ - persist:消息存储
11817
+
11818
+ - consume:消息消费
11585
11819
  注意:此字段可能返回 null,表示取不到有效值。
11586
11820
  :type Stage: str
11587
11821
  :param _Data: 轨迹详情
@@ -11593,7 +11827,13 @@ class MessageTraceItem(AbstractModel):
11593
11827
 
11594
11828
  @property
11595
11829
  def Stage(self):
11596
- """步骤
11830
+ """消息处理阶段,枚举值如下:
11831
+
11832
+ - produce:消息生产
11833
+
11834
+ - persist:消息存储
11835
+
11836
+ - consume:消息消费
11597
11837
  注意:此字段可能返回 null,表示取不到有效值。
11598
11838
  :rtype: str
11599
11839
  """
@@ -12160,7 +12400,7 @@ class ModifyInstanceEndpointRequest(AbstractModel):
12160
12400
 
12161
12401
  def __init__(self):
12162
12402
  r"""
12163
- :param _InstanceId: 集群ID
12403
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12164
12404
  :type InstanceId: str
12165
12405
  :param _Type: 接入点类型,
12166
12406
  PUBLIC 公网
@@ -12180,7 +12420,7 @@ PUBLIC 公网
12180
12420
 
12181
12421
  @property
12182
12422
  def InstanceId(self):
12183
- """集群ID
12423
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12184
12424
  :rtype: str
12185
12425
  """
12186
12426
  return self._InstanceId
@@ -12291,25 +12531,32 @@ class ModifyInstanceRequest(AbstractModel):
12291
12531
 
12292
12532
  def __init__(self):
12293
12533
  r"""
12294
- :param _InstanceId: 集群ID
12534
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12295
12535
  :type InstanceId: str
12296
- :param _Name: 实例名称
12536
+ :param _Name: 实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”
12297
12537
  :type Name: str
12298
- :param _Remark: 备注信息
12538
+ :param _Remark: 备注信息,最多 128 个字符
12299
12539
  :type Remark: str
12300
12540
  :param _SendReceiveRatio: 消息发送和接收的比例
12301
12541
  :type SendReceiveRatio: float
12302
- :param _SkuCode: 调整实例规格的商品代号
12542
+ :param _SkuCode: 商品规格,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
12303
12543
  :type SkuCode: str
12304
- :param _MessageRetention: 消息保留时长,小时为单位
12544
+ :param _MessageRetention: 消息保留时长(单位:小时),取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
12545
+
12546
+ - 默认值:DefaultRetention 参数
12547
+ - 最小值:RetentionLowerLimit 参数
12548
+ - 最大值:RetentionUpperLimit 参数
12305
12549
  :type MessageRetention: int
12306
12550
  :param _ScaledTpsEnabled: 是否开启弹性TPS
12307
12551
  :type ScaledTpsEnabled: bool
12308
12552
  :param _AclEnabled: 是否开启ACL
12309
12553
  :type AclEnabled: bool
12310
- :param _MaxTopicNum: 最大可创建主题数
12554
+ :param _MaxTopicNum: 最大可创建主题数,取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
12555
+
12556
+ - 最小值和默认值:TopicNumLimit 参数
12557
+ - 最大值:TopicNumUpperLimit 参数
12311
12558
  :type MaxTopicNum: int
12312
- :param _ExtraTopicNum: 免费额度之外的主题个数
12559
+ :param _ExtraTopicNum: 免费额度之外的主题个数,免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
12313
12560
  :type ExtraTopicNum: str
12314
12561
  :param _EnableDeletionProtection: 是否开启删除保护
12315
12562
  :type EnableDeletionProtection: bool
@@ -12328,7 +12575,7 @@ class ModifyInstanceRequest(AbstractModel):
12328
12575
 
12329
12576
  @property
12330
12577
  def InstanceId(self):
12331
- """集群ID
12578
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
12332
12579
  :rtype: str
12333
12580
  """
12334
12581
  return self._InstanceId
@@ -12339,7 +12586,7 @@ class ModifyInstanceRequest(AbstractModel):
12339
12586
 
12340
12587
  @property
12341
12588
  def Name(self):
12342
- """实例名称
12589
+ """实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”
12343
12590
  :rtype: str
12344
12591
  """
12345
12592
  return self._Name
@@ -12350,7 +12597,7 @@ class ModifyInstanceRequest(AbstractModel):
12350
12597
 
12351
12598
  @property
12352
12599
  def Remark(self):
12353
- """备注信息
12600
+ """备注信息,最多 128 个字符
12354
12601
  :rtype: str
12355
12602
  """
12356
12603
  return self._Remark
@@ -12372,7 +12619,7 @@ class ModifyInstanceRequest(AbstractModel):
12372
12619
 
12373
12620
  @property
12374
12621
  def SkuCode(self):
12375
- """调整实例规格的商品代号
12622
+ """商品规格,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
12376
12623
  :rtype: str
12377
12624
  """
12378
12625
  return self._SkuCode
@@ -12383,7 +12630,11 @@ class ModifyInstanceRequest(AbstractModel):
12383
12630
 
12384
12631
  @property
12385
12632
  def MessageRetention(self):
12386
- """消息保留时长,小时为单位
12633
+ """消息保留时长(单位:小时),取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
12634
+
12635
+ - 默认值:DefaultRetention 参数
12636
+ - 最小值:RetentionLowerLimit 参数
12637
+ - 最大值:RetentionUpperLimit 参数
12387
12638
  :rtype: int
12388
12639
  """
12389
12640
  return self._MessageRetention
@@ -12416,7 +12667,10 @@ class ModifyInstanceRequest(AbstractModel):
12416
12667
 
12417
12668
  @property
12418
12669
  def MaxTopicNum(self):
12419
- """最大可创建主题数
12670
+ """最大可创建主题数,取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
12671
+
12672
+ - 最小值和默认值:TopicNumLimit 参数
12673
+ - 最大值:TopicNumUpperLimit 参数
12420
12674
  :rtype: int
12421
12675
  """
12422
12676
  return self._MaxTopicNum
@@ -12427,7 +12681,7 @@ class ModifyInstanceRequest(AbstractModel):
12427
12681
 
12428
12682
  @property
12429
12683
  def ExtraTopicNum(self):
12430
- """免费额度之外的主题个数
12684
+ """免费额度之外的主题个数,免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
12431
12685
  :rtype: str
12432
12686
  """
12433
12687
  return self._ExtraTopicNum
@@ -13427,35 +13681,26 @@ PLATINUM,铂金版
13427
13681
  :param _SkuCode: 规格代码
13428
13682
  :type SkuCode: str
13429
13683
  :param _TpsLimit: TPS上限
13430
- 注意:此字段可能返回 null,表示取不到有效值。
13431
13684
  :type TpsLimit: int
13432
13685
  :param _ScaledTpsLimit: 弹性TPS上限
13433
- 注意:此字段可能返回 null,表示取不到有效值。
13434
13686
  :type ScaledTpsLimit: int
13435
13687
  :param _TopicNumLimit: 主题数量上限默认值
13436
- 注意:此字段可能返回 null,表示取不到有效值。
13437
13688
  :type TopicNumLimit: int
13438
13689
  :param _GroupNumLimit: 消费组数量上限
13439
- 注意:此字段可能返回 null,表示取不到有效值。
13440
13690
  :type GroupNumLimit: int
13441
13691
  :param _DefaultRetention: 默认消息保留时间,小时为单位
13442
- 注意:此字段可能返回 null,表示取不到有效值。
13443
13692
  :type DefaultRetention: int
13444
13693
  :param _RetentionUpperLimit: 可调整消息保留时间上限,小时为单位
13445
- 注意:此字段可能返回 null,表示取不到有效值。
13446
13694
  :type RetentionUpperLimit: int
13447
13695
  :param _RetentionLowerLimit: 可调整消息保留时间下限,小时为单位
13448
- 注意:此字段可能返回 null,表示取不到有效值。
13449
13696
  :type RetentionLowerLimit: int
13450
13697
  :param _MaxMessageDelay: 延时消息最大时长,小时为单位
13451
- 注意:此字段可能返回 null,表示取不到有效值。
13452
13698
  :type MaxMessageDelay: int
13453
13699
  :param _OnSale: 是否可购买
13454
13700
  :type OnSale: bool
13455
13701
  :param _PriceTags: 计费项信息
13456
13702
  :type PriceTags: list of PriceTag
13457
13703
  :param _TopicNumUpperLimit: 主题数量上限默认最大值
13458
- 注意:此字段可能返回 null,表示取不到有效值。
13459
13704
  :type TopicNumUpperLimit: int
13460
13705
  """
13461
13706
  self._InstanceType = None
@@ -13501,7 +13746,6 @@ PLATINUM,铂金版
13501
13746
  @property
13502
13747
  def TpsLimit(self):
13503
13748
  """TPS上限
13504
- 注意:此字段可能返回 null,表示取不到有效值。
13505
13749
  :rtype: int
13506
13750
  """
13507
13751
  return self._TpsLimit
@@ -13513,7 +13757,6 @@ PLATINUM,铂金版
13513
13757
  @property
13514
13758
  def ScaledTpsLimit(self):
13515
13759
  """弹性TPS上限
13516
- 注意:此字段可能返回 null,表示取不到有效值。
13517
13760
  :rtype: int
13518
13761
  """
13519
13762
  return self._ScaledTpsLimit
@@ -13525,7 +13768,6 @@ PLATINUM,铂金版
13525
13768
  @property
13526
13769
  def TopicNumLimit(self):
13527
13770
  """主题数量上限默认值
13528
- 注意:此字段可能返回 null,表示取不到有效值。
13529
13771
  :rtype: int
13530
13772
  """
13531
13773
  return self._TopicNumLimit
@@ -13537,7 +13779,6 @@ PLATINUM,铂金版
13537
13779
  @property
13538
13780
  def GroupNumLimit(self):
13539
13781
  """消费组数量上限
13540
- 注意:此字段可能返回 null,表示取不到有效值。
13541
13782
  :rtype: int
13542
13783
  """
13543
13784
  return self._GroupNumLimit
@@ -13549,7 +13790,6 @@ PLATINUM,铂金版
13549
13790
  @property
13550
13791
  def DefaultRetention(self):
13551
13792
  """默认消息保留时间,小时为单位
13552
- 注意:此字段可能返回 null,表示取不到有效值。
13553
13793
  :rtype: int
13554
13794
  """
13555
13795
  return self._DefaultRetention
@@ -13561,7 +13801,6 @@ PLATINUM,铂金版
13561
13801
  @property
13562
13802
  def RetentionUpperLimit(self):
13563
13803
  """可调整消息保留时间上限,小时为单位
13564
- 注意:此字段可能返回 null,表示取不到有效值。
13565
13804
  :rtype: int
13566
13805
  """
13567
13806
  return self._RetentionUpperLimit
@@ -13573,7 +13812,6 @@ PLATINUM,铂金版
13573
13812
  @property
13574
13813
  def RetentionLowerLimit(self):
13575
13814
  """可调整消息保留时间下限,小时为单位
13576
- 注意:此字段可能返回 null,表示取不到有效值。
13577
13815
  :rtype: int
13578
13816
  """
13579
13817
  return self._RetentionLowerLimit
@@ -13585,7 +13823,6 @@ PLATINUM,铂金版
13585
13823
  @property
13586
13824
  def MaxMessageDelay(self):
13587
13825
  """延时消息最大时长,小时为单位
13588
- 注意:此字段可能返回 null,表示取不到有效值。
13589
13826
  :rtype: int
13590
13827
  """
13591
13828
  return self._MaxMessageDelay
@@ -13619,7 +13856,6 @@ PLATINUM,铂金版
13619
13856
  @property
13620
13857
  def TopicNumUpperLimit(self):
13621
13858
  """主题数量上限默认最大值
13622
- 注意:此字段可能返回 null,表示取不到有效值。
13623
13859
  :rtype: int
13624
13860
  """
13625
13861
  return self._TopicNumUpperLimit
@@ -13739,7 +13975,8 @@ class RemoveMigratingTopicRequest(AbstractModel):
13739
13975
  r"""
13740
13976
  :param _TaskId: 任务ID,可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
13741
13977
  :type TaskId: str
13742
- :param _TopicName: 消费组名称,可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)或控制台中获取。
13978
+ :param _TopicName: 主题名称,可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
13979
+
13743
13980
  :type TopicName: str
13744
13981
  :param _Namespace: 命名空间,仅迁移至4.x集群有效,可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
13745
13982
  :type Namespace: str
@@ -13761,7 +13998,8 @@ class RemoveMigratingTopicRequest(AbstractModel):
13761
13998
 
13762
13999
  @property
13763
14000
  def TopicName(self):
13764
- """消费组名称,可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)或控制台中获取。
14001
+ """主题名称,可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
14002
+
13765
14003
  :rtype: str
13766
14004
  """
13767
14005
  return self._TopicName
@@ -13942,13 +14180,13 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13942
14180
 
13943
14181
  def __init__(self):
13944
14182
  r"""
13945
- :param _InstanceId: 集群ID
14183
+ :param _InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13946
14184
  :type InstanceId: str
13947
- :param _Topic: 主题名称
14185
+ :param _Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
13948
14186
  :type Topic: str
13949
- :param _ResetTimestamp: 重置位点时间(单位:毫秒)-1表示重置到最新位点
14187
+ :param _ResetTimestamp: 重置位点的时间戳(单位:毫秒),指定为 -1 时表示重置到最新位点
13950
14188
  :type ResetTimestamp: int
13951
- :param _ConsumerGroup: 消费组名称
14189
+ :param _ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
13952
14190
  :type ConsumerGroup: str
13953
14191
  """
13954
14192
  self._InstanceId = None
@@ -13958,7 +14196,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13958
14196
 
13959
14197
  @property
13960
14198
  def InstanceId(self):
13961
- """集群ID
14199
+ """腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
13962
14200
  :rtype: str
13963
14201
  """
13964
14202
  return self._InstanceId
@@ -13969,7 +14207,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13969
14207
 
13970
14208
  @property
13971
14209
  def Topic(self):
13972
- """主题名称
14210
+ """主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
13973
14211
  :rtype: str
13974
14212
  """
13975
14213
  return self._Topic
@@ -13980,7 +14218,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13980
14218
 
13981
14219
  @property
13982
14220
  def ResetTimestamp(self):
13983
- """重置位点时间(单位:毫秒)-1表示重置到最新位点
14221
+ """重置位点的时间戳(单位:毫秒),指定为 -1 时表示重置到最新位点
13984
14222
  :rtype: int
13985
14223
  """
13986
14224
  return self._ResetTimestamp
@@ -13991,7 +14229,7 @@ class ResetConsumerGroupOffsetRequest(AbstractModel):
13991
14229
 
13992
14230
  @property
13993
14231
  def ConsumerGroup(self):
13994
- """消费组名称
14232
+ """消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
13995
14233
  :rtype: str
13996
14234
  """
13997
14235
  return self._ConsumerGroup
@@ -14063,9 +14301,9 @@ class RoleItem(AbstractModel):
14063
14301
  :type SecretKey: str
14064
14302
  :param _Remark: 备注信息
14065
14303
  :type Remark: str
14066
- :param _CreatedTime: 创建时间,秒为单位
14304
+ :param _CreatedTime: 角色的创建时间,**Unix时间戳(毫秒)**
14067
14305
  :type CreatedTime: int
14068
- :param _ModifiedTime: 修改时间,秒为单位
14306
+ :param _ModifiedTime: 角色的更新时间,**Unix时间戳(毫秒)**
14069
14307
  :type ModifiedTime: int
14070
14308
  :param _PermType: 权限类型,默认按集群授权(Cluster:集群级别;TopicAndGroup:主题&消费组级别)
14071
14309
  :type PermType: str
@@ -14152,7 +14390,7 @@ class RoleItem(AbstractModel):
14152
14390
 
14153
14391
  @property
14154
14392
  def CreatedTime(self):
14155
- """创建时间,秒为单位
14393
+ """角色的创建时间,**Unix时间戳(毫秒)**
14156
14394
  :rtype: int
14157
14395
  """
14158
14396
  return self._CreatedTime
@@ -14163,7 +14401,7 @@ class RoleItem(AbstractModel):
14163
14401
 
14164
14402
  @property
14165
14403
  def ModifiedTime(self):
14166
- """修改时间,秒为单位
14404
+ """角色的更新时间,**Unix时间戳(毫秒)**
14167
14405
  :rtype: int
14168
14406
  """
14169
14407
  return self._ModifiedTime