tccli 3.0.1341.1__py2.py3-none-any.whl → 3.0.1342.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/plugins/sso/__init__.py +14 -0
  3. tccli/plugins/sso/login.py +23 -6
  4. tccli/plugins/sso/texts.py +4 -0
  5. tccli/services/__init__.py +3 -0
  6. tccli/services/ams/v20201229/api.json +195 -185
  7. tccli/services/apm/v20210622/api.json +10 -0
  8. tccli/services/cdb/v20170320/api.json +15 -15
  9. tccli/services/cdb/v20170320/examples.json +2 -2
  10. tccli/services/ctem/__init__.py +4 -0
  11. tccli/services/ctem/ctem_client.py +1479 -0
  12. tccli/services/ctem/v20231128/api.json +6138 -0
  13. tccli/services/ctem/v20231128/examples.json +205 -0
  14. tccli/services/dlc/v20210125/api.json +15 -6
  15. tccli/services/hunyuan/v20230901/api.json +10 -1
  16. tccli/services/ims/v20201229/api.json +30 -30
  17. tccli/services/iotexplorer/v20190423/api.json +2 -2
  18. tccli/services/iotexplorer/v20190423/examples.json +1 -1
  19. tccli/services/iotvideo/v20201215/api.json +2 -2
  20. tccli/services/iotvideo/v20201215/examples.json +1 -1
  21. tccli/services/iotvideo/v20211125/api.json +1 -1
  22. tccli/services/iotvideo/v20211125/examples.json +1 -1
  23. tccli/services/lke/v20231130/api.json +22 -1
  24. tccli/services/mongodb/v20190725/api.json +10 -0
  25. tccli/services/mps/v20190612/api.json +113 -25
  26. tccli/services/mqtt/mqtt_client.py +53 -0
  27. tccli/services/mqtt/v20240516/api.json +150 -0
  28. tccli/services/mqtt/v20240516/examples.json +8 -0
  29. tccli/services/redis/v20180412/api.json +3 -3
  30. tccli/services/redis/v20180412/examples.json +19 -1
  31. tccli/services/tke/v20180525/api.json +10 -0
  32. tccli/services/trocket/v20230308/api.json +71 -71
  33. tccli/services/trocket/v20230308/examples.json +4 -4
  34. tccli/services/vm/v20210922/api.json +363 -333
  35. tccli/services/wedata/v20210820/api.json +128 -0
  36. tccli/services/wedata/v20210820/examples.json +8 -0
  37. tccli/services/wedata/wedata_client.py +53 -0
  38. {tccli-3.0.1341.1.dist-info → tccli-3.0.1342.1.dist-info}/METADATA +2 -2
  39. {tccli-3.0.1341.1.dist-info → tccli-3.0.1342.1.dist-info}/RECORD +42 -38
  40. {tccli-3.0.1341.1.dist-info → tccli-3.0.1342.1.dist-info}/WHEEL +0 -0
  41. {tccli-3.0.1341.1.dist-info → tccli-3.0.1342.1.dist-info}/entry_points.txt +0 -0
  42. {tccli-3.0.1341.1.dist-info → tccli-3.0.1342.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/trocket/v20230308/api.json CHANGED
@@ -64,7 +64,7 @@
64
64
  "status": "online"
65
65
  },
66
66
  "DeleteConsumerGroup": {
67
- "document": "删除消费组",
67
+ "document": "删除消费组。消费者组删除后，消费者组的所有配置和相关数据都会被清空，且无法找回。删除后，在线的消费者客户端会出现报错，建议您提前下线客户端。",
68
68
  "input": "DeleteConsumerGroupRequest",
69
69
  "name": "删除消费组",
70
70
  "output": "DeleteConsumerGroupResponse",
@@ -120,7 +120,7 @@
120
120
  "status": "online"
121
121
  },
122
122
  "DeleteTopic": {
123
- "document": "删除主题",
123
+ "document": "删除主题。主题删除后，主题的所有配置和相关数据都会被清空，且无法找回。",
124
124
  "input": "DeleteTopicRequest",
125
125
  "name": "删除主题",
126
126
  "output": "DeleteTopicResponse",
@@ -734,7 +734,7 @@
734
734
  {
735
735
  "disabled": false,
736
736
  "document": "客户端地址",
737
- "example": "11.139.244.248",
737
+ "example": "11.139.244.248:5888",
738
738
  "member": "string",
739
739
  "name": "ClientAddr",
740
740
  "output_required": true,
@@ -789,7 +789,7 @@
789
789
  "members": [
790
790
  {
791
791
  "disabled": false,
792
- "document": "集群ID",
792
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
793
793
  "example": "rmq-72mo3a9o",
794
794
  "member": "string",
795
795
  "name": "InstanceId",
@@ -798,7 +798,7 @@
798
798
  },
799
799
  {
800
800
  "disabled": false,
801
- "document": "最大重试次数",
801
+ "document": "最大重试次数，取值范围0～1000",
802
802
  "example": "16",
803
803
  "member": "int64",
804
804
  "name": "MaxRetryTimes",
@@ -825,7 +825,7 @@
825
825
  },
826
826
  {
827
827
  "disabled": false,
828
- "document": "消费组名称",
828
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
829
829
  "example": "test_group",
830
830
  "member": "string",
831
831
  "name": "ConsumerGroup",
@@ -834,7 +834,7 @@
834
834
  },
835
835
  {
836
836
  "disabled": false,
837
- "document": "备注",
837
+ "document": "备注信息，最多 128 个字符",
838
838
  "example": "test remark info.",
839
839
  "member": "string",
840
840
  "name": "Remark",
@@ -1371,7 +1371,7 @@
1371
1371
  "members": [
1372
1372
  {
1373
1373
  "disabled": false,
1374
- "document": "集群ID",
1374
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
1375
1375
  "example": "rmq-72mo3a9o",
1376
1376
  "member": "string",
1377
1377
  "name": "InstanceId",
@@ -1425,7 +1425,7 @@
1425
1425
  },
1426
1426
  {
1427
1427
  "disabled": false,
1428
- "document": "Topic&Group维度权限配置",
1428
+ "document": "Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填",
1429
1429
  "example": "无",
1430
1430
  "member": "DetailedRolePerm",
1431
1431
  "name": "DetailedPerms",
@@ -1462,7 +1462,7 @@
1462
1462
  "members": [
1463
1463
  {
1464
1464
  "disabled": false,
1465
- "document": "集群ID",
1465
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
1466
1466
  "example": "rmq-72mo3a9o",
1467
1467
  "member": "string",
1468
1468
  "name": "InstanceId",
@@ -1471,7 +1471,7 @@
1471
1471
  },
1472
1472
  {
1473
1473
  "disabled": false,
1474
- "document": "主题名称",
1474
+ "document": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。",
1475
1475
  "example": "test_topic",
1476
1476
  "member": "string",
1477
1477
  "name": "Topic",
@@ -1489,7 +1489,7 @@
1489
1489
  },
1490
1490
  {
1491
1491
  "disabled": false,
1492
- "document": "队列数量",
1492
+ "document": "队列数量，取值范围3～16",
1493
1493
  "example": "3",
1494
1494
  "member": "int64",
1495
1495
  "name": "QueueNum",
@@ -1498,7 +1498,7 @@
1498
1498
  },
1499
1499
  {
1500
1500
  "disabled": false,
1501
- "document": "备注",
1501
+ "document": "备注，最多 128 字符",
1502
1502
  "example": "测试主题",
1503
1503
  "member": "string",
1504
1504
  "name": "Remark",
@@ -1507,7 +1507,7 @@
1507
1507
  },
1508
1508
  {
1509
1509
  "disabled": false,
1510
- "document": "消息保留时长",
1510
+ "document": "消息保留时长（单位：小时）",
1511
1511
  "example": "72",
1512
1512
  "member": "int64",
1513
1513
  "name": "MsgTTL",
@@ -1591,7 +1591,7 @@
1591
1591
  "members": [
1592
1592
  {
1593
1593
  "disabled": false,
1594
- "document": "集群ID",
1594
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
1595
1595
  "example": "rmq-72mo3a9o",
1596
1596
  "member": "string",
1597
1597
  "name": "InstanceId",
@@ -1600,7 +1600,7 @@
1600
1600
  },
1601
1601
  {
1602
1602
  "disabled": false,
1603
- "document": "消费组名称",
1603
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
1604
1604
  "example": "test_group",
1605
1605
  "member": "string",
1606
1606
  "name": "ConsumerGroup",
@@ -1780,7 +1780,7 @@
1780
1780
  "members": [
1781
1781
  {
1782
1782
  "disabled": false,
1783
- "document": "集群ID",
1783
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
1784
1784
  "example": "rmq-72mo3a9o",
1785
1785
  "member": "string",
1786
1786
  "name": "InstanceId",
@@ -1789,7 +1789,7 @@
1789
1789
  },
1790
1790
  {
1791
1791
  "disabled": false,
1792
- "document": "角色名称",
1792
+ "document": "角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。",
1793
1793
  "example": "test_role_name",
1794
1794
  "member": "string",
1795
1795
  "name": "Role",
@@ -1843,7 +1843,7 @@
1843
1843
  "members": [
1844
1844
  {
1845
1845
  "disabled": false,
1846
- "document": "集群ID",
1846
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
1847
1847
  "example": "rmq-72mo3a9o",
1848
1848
  "member": "string",
1849
1849
  "name": "InstanceId",
@@ -1852,7 +1852,7 @@
1852
1852
  },
1853
1853
  {
1854
1854
  "disabled": false,
1855
- "document": "主题名称",
1855
+ "document": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。",
1856
1856
  "example": "test_topic",
1857
1857
  "member": "string",
1858
1858
  "name": "Topic",
@@ -1879,7 +1879,7 @@
1879
1879
  "members": [
1880
1880
  {
1881
1881
  "disabled": false,
1882
- "document": "集群ID",
1882
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
1883
1883
  "example": "rmq-72mo3a9o",
1884
1884
  "member": "string",
1885
1885
  "name": "InstanceId",
@@ -1888,7 +1888,7 @@
1888
1888
  },
1889
1889
  {
1890
1890
  "disabled": false,
1891
- "document": "消费组名称",
1891
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
1892
1892
  "example": "test_group",
1893
1893
  "member": "string",
1894
1894
  "name": "ConsumerGroup",
@@ -1897,7 +1897,7 @@
1897
1897
  },
1898
1898
  {
1899
1899
  "disabled": false,
1900
- "document": "查询条件列表",
1900
+ "document": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。",
1901
1901
  "example": "无",
1902
1902
  "member": "Filter",
1903
1903
  "name": "Filters",
@@ -1906,7 +1906,7 @@
1906
1906
  },
1907
1907
  {
1908
1908
  "disabled": false,
1909
- "document": "查询起始位置",
1909
+ "document": "查询起始位置，默认为0。",
1910
1910
  "example": "0",
1911
1911
  "member": "int64",
1912
1912
  "name": "Offset",
@@ -1915,7 +1915,7 @@
1915
1915
  },
1916
1916
  {
1917
1917
  "disabled": false,
1918
- "document": "查询结果限制数量",
1918
+ "document": "查询结果限制数量，默认20。",
1919
1919
  "example": "20",
1920
1920
  "member": "int64",
1921
1921
  "name": "Limit",
@@ -1962,7 +1962,7 @@
1962
1962
  "members": [
1963
1963
  {
1964
1964
  "disabled": false,
1965
- "document": "集群ID",
1965
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
1966
1966
  "example": "rmq-72mo3a9o",
1967
1967
  "member": "string",
1968
1968
  "name": "InstanceId",
@@ -1971,7 +1971,7 @@
1971
1971
  },
1972
1972
  {
1973
1973
  "disabled": false,
1974
- "document": "客户端ID",
1974
+ "document": "客户端ID，从 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140) 接口中的 [ConsumerClient](https://cloud.tencent.com/document/api/1493/96031#ConsumerClient) 出参中获得。",
1975
1975
  "example": "11.139.244.247@75043#6734858812769343",
1976
1976
  "member": "string",
1977
1977
  "name": "ClientId",
@@ -1980,7 +1980,7 @@
1980
1980
  },
1981
1981
  {
1982
1982
  "disabled": false,
1983
- "document": "查询条件列表",
1983
+ "document": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。",
1984
1984
  "example": "无",
1985
1985
  "member": "Filter",
1986
1986
  "name": "Filters",
@@ -1989,7 +1989,7 @@
1989
1989
  },
1990
1990
  {
1991
1991
  "disabled": false,
1992
- "document": "查询起始位置",
1992
+ "document": "查询起始位置，默认为0。",
1993
1993
  "example": "0",
1994
1994
  "member": "int64",
1995
1995
  "name": "Offset",
@@ -1998,7 +1998,7 @@
1998
1998
  },
1999
1999
  {
2000
2000
  "disabled": false,
2001
- "document": "查询结果限制数量",
2001
+ "document": "查询结果限制数量，默认20。",
2002
2002
  "example": "20",
2003
2003
  "member": "int64",
2004
2004
  "name": "Limit",
@@ -2007,7 +2007,7 @@
2007
2007
  },
2008
2008
  {
2009
2009
  "disabled": false,
2010
- "document": "消费组名称",
2010
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
2011
2011
  "example": "test_group",
2012
2012
  "member": "string",
2013
2013
  "name": "ConsumerGroup",
@@ -2137,7 +2137,7 @@
2137
2137
  "members": [
2138
2138
  {
2139
2139
  "disabled": false,
2140
- "document": "集群ID",
2140
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
2141
2141
  "example": "rmq-72mo3a9o",
2142
2142
  "member": "string",
2143
2143
  "name": "InstanceId",
@@ -2146,7 +2146,7 @@
2146
2146
  },
2147
2147
  {
2148
2148
  "disabled": false,
2149
- "document": "消费组名称",
2149
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
2150
2150
  "example": "test_group",
2151
2151
  "member": "string",
2152
2152
  "name": "ConsumerGroup",
@@ -2191,7 +2191,7 @@
2191
2191
  },
2192
2192
  {
2193
2193
  "disabled": false,
2194
- "document": "消费者类型",
2194
+ "document": "消费类型，枚举值如下：\n\n- PULL：PULL 消费类型\n- PUSH：PUSH 消费类型\n- POP：POP 消费类型",
2195
2195
  "example": "PUSH",
2196
2196
  "member": "string",
2197
2197
  "name": "ConsumeType",
@@ -2201,7 +2201,7 @@
2201
2201
  },
2202
2202
  {
2203
2203
  "disabled": false,
2204
- "document": "创建时间，秒为单位",
2204
+ "document": "创建时间，**Unix时间戳（毫秒）**",
2205
2205
  "example": "1683613488000",
2206
2206
  "member": "int64",
2207
2207
  "name": "CreatedTime",
@@ -2273,7 +2273,7 @@
2273
2273
  "members": [
2274
2274
  {
2275
2275
  "disabled": false,
2276
- "document": "集群ID",
2276
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
2277
2277
  "example": "rmq-72mo3a9o",
2278
2278
  "member": "string",
2279
2279
  "name": "InstanceId",
@@ -2282,7 +2282,7 @@
2282
2282
  },
2283
2283
  {
2284
2284
  "disabled": false,
2285
- "document": "消费组名称",
2285
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
2286
2286
  "example": "test_group",
2287
2287
  "member": "string",
2288
2288
  "name": "ConsumerGroup",
@@ -2291,7 +2291,7 @@
2291
2291
  },
2292
2292
  {
2293
2293
  "disabled": false,
2294
- "document": "命名空间，4.x集群必填",
2294
+ "document": "命名空间，4.x集群必填，从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口或控制台获得。",
2295
2295
  "example": "namespace_test",
2296
2296
  "member": "string",
2297
2297
  "name": "Namespace",
@@ -2300,7 +2300,7 @@
2300
2300
  },
2301
2301
  {
2302
2302
  "disabled": false,
2303
- "document": "订阅主题，不为空则查询订阅了该主题的消费组的堆积",
2303
+ "document": "订阅主题，不为空则查询订阅了该主题的消费组的堆积，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。",
2304
2304
  "example": "topic_test",
2305
2305
  "member": "string",
2306
2306
  "name": "SubscribeTopic",
@@ -4805,7 +4805,7 @@
4805
4805
  "members": [
4806
4806
  {
4807
4807
  "disabled": false,
4808
- "document": "集群ID",
4808
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
4809
4809
  "example": "rmq-72mo3a9o",
4810
4810
  "member": "string",
4811
4811
  "name": "InstanceId",
@@ -4814,7 +4814,7 @@
4814
4814
  },
4815
4815
  {
4816
4816
  "disabled": false,
4817
- "document": "查询起始位置",
4817
+ "document": "查询起始位置，默认为0。",
4818
4818
  "example": "0",
4819
4819
  "member": "int64",
4820
4820
  "name": "Offset",
@@ -4823,7 +4823,7 @@
4823
4823
  },
4824
4824
  {
4825
4825
  "disabled": false,
4826
- "document": "查询结果限制数量",
4826
+ "document": "查询结果限制数量，默认20。",
4827
4827
  "example": "20",
4828
4828
  "member": "int64",
4829
4829
  "name": "Limit",
@@ -4832,7 +4832,7 @@
4832
4832
  },
4833
4833
  {
4834
4834
  "disabled": false,
4835
- "document": "消费组名称",
4835
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
4836
4836
  "example": "test_group",
4837
4837
  "member": "string",
4838
4838
  "name": "ConsumerGroup",
@@ -4841,7 +4841,7 @@
4841
4841
  },
4842
4842
  {
4843
4843
  "disabled": false,
4844
- "document": "查询条件列表",
4844
+ "document": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。",
4845
4845
  "example": "无",
4846
4846
  "member": "Filter",
4847
4847
  "name": "Filters",
@@ -4962,7 +4962,7 @@
4962
4962
  "members": [
4963
4963
  {
4964
4964
  "disabled": false,
4965
- "document": "集群ID",
4965
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
4966
4966
  "example": "rmq-72mo3a9o",
4967
4967
  "member": "string",
4968
4968
  "name": "InstanceId",
@@ -4971,7 +4971,7 @@
4971
4971
  },
4972
4972
  {
4973
4973
  "disabled": false,
4974
- "document": "主题名称",
4974
+ "document": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。",
4975
4975
  "example": "test_topic",
4976
4976
  "member": "string",
4977
4977
  "name": "Topic",
@@ -4980,7 +4980,7 @@
4980
4980
  },
4981
4981
  {
4982
4982
  "disabled": false,
4983
- "document": "查询条件列表",
4983
+ "document": "过滤查询条件列表，请在引用此参数的API说明中了解使用方法。",
4984
4984
  "example": "无",
4985
4985
  "member": "Filter",
4986
4986
  "name": "Filters",
@@ -4989,7 +4989,7 @@
4989
4989
  },
4990
4990
  {
4991
4991
  "disabled": false,
4992
- "document": "查询起始位置",
4992
+ "document": "查询起始位置，默认为0。",
4993
4993
  "example": "0",
4994
4994
  "member": "int64",
4995
4995
  "name": "Offset",
@@ -4998,7 +4998,7 @@
4998
4998
  },
4999
4999
  {
5000
5000
  "disabled": false,
5001
- "document": "查询结果限制数量",
5001
+ "document": "查询结果限制数量，默认20。",
5002
5002
  "example": "20",
5003
5003
  "member": "int64",
5004
5004
  "name": "Limit",
@@ -5115,7 +5115,7 @@
5115
5115
  "members": [
5116
5116
  {
5117
5117
  "disabled": false,
5118
- "document": "权限对应的资源",
5118
+ "document": "权限对应的资源\n可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。\n可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
5119
5119
  "example": "test_topic",
5120
5120
  "member": "string",
5121
5121
  "name": "Resource",
@@ -6908,7 +6908,7 @@
6908
6908
  "members": [
6909
6909
  {
6910
6910
  "disabled": false,
6911
- "document": "集群ID",
6911
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
6912
6912
  "example": "rmq-72mo3a9o",
6913
6913
  "member": "string",
6914
6914
  "name": "InstanceId",
@@ -6917,7 +6917,7 @@
6917
6917
  },
6918
6918
  {
6919
6919
  "disabled": false,
6920
- "document": "消费组名称",
6920
+ "document": "消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。",
6921
6921
  "example": "test_group",
6922
6922
  "member": "string",
6923
6923
  "name": "ConsumerGroup",
@@ -6944,7 +6944,7 @@
6944
6944
  },
6945
6945
  {
6946
6946
  "disabled": false,
6947
- "document": "最大重试次数",
6947
+ "document": "最大重试次数，取值范围0～1000",
6948
6948
  "example": "3",
6949
6949
  "member": "int64",
6950
6950
  "name": "MaxRetryTimes",
@@ -6953,7 +6953,7 @@
6953
6953
  },
6954
6954
  {
6955
6955
  "disabled": false,
6956
- "document": "备注",
6956
+ "document": "备注信息，最多 128 个字符",
6957
6957
  "example": "测试修改",
6958
6958
  "member": "string",
6959
6959
  "name": "Remark",
@@ -7403,7 +7403,7 @@
7403
7403
  "members": [
7404
7404
  {
7405
7405
  "disabled": false,
7406
- "document": "集群ID",
7406
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
7407
7407
  "example": "rmq-72mo3a9o",
7408
7408
  "member": "string",
7409
7409
  "name": "InstanceId",
@@ -7412,7 +7412,7 @@
7412
7412
  },
7413
7413
  {
7414
7414
  "disabled": false,
7415
- "document": "角色名称",
7415
+ "document": "角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。",
7416
7416
  "example": "test_role_name",
7417
7417
  "member": "string",
7418
7418
  "name": "Role",
@@ -7457,7 +7457,7 @@
7457
7457
  },
7458
7458
  {
7459
7459
  "disabled": false,
7460
- "document": "Topic&Group维度权限配置",
7460
+ "document": "Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填",
7461
7461
  "example": "无",
7462
7462
  "member": "DetailedRolePerm",
7463
7463
  "name": "DetailedPerms",
@@ -7484,7 +7484,7 @@
7484
7484
  "members": [
7485
7485
  {
7486
7486
  "disabled": false,
7487
- "document": "集群ID",
7487
+ "document": "腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。",
7488
7488
  "example": "rmq-72mo3a9o",
7489
7489
  "member": "string",
7490
7490
  "name": "InstanceId",
@@ -7493,7 +7493,7 @@
7493
7493
  },
7494
7494
  {
7495
7495
  "disabled": false,
7496
- "document": "主题名称",
7496
+ "document": "主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。",
7497
7497
  "example": "test_topic",
7498
7498
  "member": "string",
7499
7499
  "name": "Topic",
@@ -7502,7 +7502,7 @@
7502
7502
  },
7503
7503
  {
7504
7504
  "disabled": false,
7505
- "document": "队列数量",
7505
+ "document": "队列数量，取值范围3～16",
7506
7506
  "example": "6",
7507
7507
  "member": "int64",
7508
7508
  "name": "QueueNum",
@@ -7511,7 +7511,7 @@
7511
7511
  },
7512
7512
  {
7513
7513
  "disabled": false,
7514
- "document": "备注信息",
7514
+ "document": "备注信息，最多 128 个字符",
7515
7515
  "example": "测试修改",
7516
7516
  "member": "string",
7517
7517
  "name": "Remark",
@@ -7520,7 +7520,7 @@
7520
7520
  },
7521
7521
  {
7522
7522
  "disabled": false,
7523
- "document": "消息保留时长",
7523
+ "document": "消息保留时长（单位：小时）",
7524
7524
  "example": "72",
7525
7525
  "member": "int64",
7526
7526
  "name": "MsgTTL",
@@ -8492,7 +8492,7 @@
8492
8492
  },
8493
8493
  {
8494
8494
  "disabled": false,
8495
- "document": "消费类型\n注意：此字段可能返回 null，表示取不到有效值。",
8495
+ "document": "消费类型，枚举值如下：\n\n- PULL：PULL 消费类型\n- PUSH：PUSH 消费类型\n- POP：POP 消费类型\n注意：此字段可能返回 null，表示取不到有效值。",
8496
8496
  "example": "PULL",
8497
8497
  "member": "string",
8498
8498
  "name": "ConsumeType",
@@ -8522,8 +8522,8 @@
8522
8522
  },
8523
8523
  {
8524
8524
  "disabled": false,
8525
- "document": "订阅一致性\n注意：此字段可能返回 null，表示取不到有效值。",
8526
- "example": "false",
8525
+ "document": "订阅一致性，枚举如下：\n\n- 0: 订阅一致\n- 1: 订阅不一致\n注意：此字段可能返回 null，表示取不到有效值。",
8526
+ "example": "1",
8527
8527
  "member": "int64",
8528
8528
  "name": "Consistency",
8529
8529
  "output_required": true,
@@ -8660,7 +8660,7 @@
8660
8660
  },
8661
8661
  {
8662
8662
  "disabled": false,
8663
- "document": "主题类型",
8663
+ "document": "主题类型，枚举值如下：\n\n- NORMAL：普通消息主题\n- FIFO：顺序消息主题\n- DELAY：延迟消息主题\n- TRANSACTION：事务消息主题",
8664
8664
  "example": "NORMAL",
8665
8665
  "member": "string",
8666
8666
  "name": "TopicType",
@@ -8690,7 +8690,7 @@
8690
8690
  },
8691
8691
  {
8692
8692
  "disabled": false,
8693
- "document": "订阅规则",
8693
+ "document": "订阅规则，`*`表示订阅全部TAG",
8694
8694
  "example": "test_tag",
8695
8695
  "member": "string",
8696
8696
  "name": "SubString",
@@ -8700,7 +8700,7 @@
8700
8700
  },
8701
8701
  {
8702
8702
  "disabled": false,
8703
- "document": "最后消费进度更新时间",
8703
+ "document": "最后消费进度更新时间，**Unix时间戳（毫秒）**",
8704
8704
  "example": "1736050534095",
8705
8705
  "member": "int64",
8706
8706
  "name": "LastUpdateTime",
@@ -8760,7 +8760,7 @@
8760
8760
  },
8761
8761
  {
8762
8762
  "disabled": false,
8763
- "document": "描述",
8763
+ "document": "备注信息",
8764
8764
  "example": "test_remark",
8765
8765
  "member": "string",
8766
8766
  "name": "Remark",
@@ -8815,14 +8815,14 @@
8815
8815
  },
8816
8816
  {
8817
8817
  "disabled": false,
8818
- "document": "消息保留时长\n注意：此字段可能返回 null，表示取不到有效值。",
8818
+ "document": "消息保留时长",
8819
8819
  "example": "72",
8820
8820
  "member": "int64",
8821
8821
  "name": "MsgTTL",
8822
8822
  "output_required": false,
8823
8823
  "required": false,
8824
8824
  "type": "int",
8825
- "value_allowed_null": true
8825
+ "value_allowed_null": false
8826
8826
  }
8827
8827
  ],
8828
8828
  "usage": "both"
tccli/services/trocket/v20230308/examples.json CHANGED
@@ -148,7 +148,7 @@
148
148
  {
149
149
  "document": "查询消费者客户端详情",
150
150
  "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerClient\n<公共请求参数>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 1,\n \"ConsumerGroup\": \"group\",\n \"ClientId\": \"11.139.244.247@75043#6734858812769343\"\n}",
151
- "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Client\": {\n \"ClientAddr\": \"11.139.244.247:58330\",\n \"ClientId\": \"11.139.244.247@75043#6734858812769343\",\n \"ConsumerLag\": 0,\n \"Language\": \"JAVA\",\n \"Version\": \"399\"\n },\n \"RequestId\": \"7e3acbab-5b5f-457f-b276-68c2f7e16f5e\",\n \"TopicList\": [\n {\n \"ConsumerLag\": 0,\n \"LastUpdateTime\": 1683614607184,\n \"QueueNum\": 16,\n \"SubString\": \"test_tag\",\n \"Topic\": \"topic\",\n \"TopicType\": \"NORMAL\"\n }\n ]\n }\n}",
151
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Client\": {\n \"ClientAddr\": \"11.139.244.247:58330\",\n \"ClientId\": \"11.139.244.247@75043#6734858812769343\",\n \"ConsumerLag\": 0,\n \"Language\": \"JAVA\",\n \"Version\": \"V4_9_3\"\n },\n \"RequestId\": \"7e3acbab-5b5f-457f-b276-68c2f7e16f5e\",\n \"TopicList\": [\n {\n \"ConsumerLag\": 0,\n \"LastUpdateTime\": 1683614607184,\n \"QueueNum\": 16,\n \"SubString\": \"test_tag\",\n \"Topic\": \"topic\",\n \"TopicType\": \"NORMAL\"\n }\n ]\n }\n}",
152
152
  "title": "查询消费者客户端详情"
153
153
  }
154
154
  ],
@@ -346,7 +346,7 @@
346
346
  {
347
347
  "document": "",
348
348
  "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingTopicList\n<公共请求参数>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 10,\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n}",
349
- "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"TotalCount\": 10,\n \"MigrateTopics\": [\n {\n \"TopicName\": \"topic-a\",\n \"MigrationStatus\": \"S_RW_D_NA\",\n \"HealthCheckPassed\": true,\n \"HealthCheckError\": \"\",\n \"Namespace\": \"\",\n \"FullNamespaceV4\": null,\n \"NamespaceV4\": null,\n \"TopicNameV4\": null\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
349
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"TotalCount\": 10,\n \"MigrateTopics\": [\n {\n \"TopicName\": \"topic-a\",\n \"MigrationStatus\": \"S_RW_D_NA\",\n \"HealthCheckPassed\": true,\n \"HealthCheckError\": \"\",\n \"Namespace\": \"\",\n \"FullNamespaceV4\": null,\n \"NamespaceV4\": null,\n \"TopicNameV4\": null,\n \"HealthCheckErrorList\": []\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
350
350
  "title": "查询迁移主题列表"
351
351
  }
352
352
  ],
@@ -418,7 +418,7 @@
418
418
  {
419
419
  "document": "",
420
420
  "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicListByGroup\n<公共请求参数>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"ConsumerGroup\": \"test_group\"\n}",
421
- "output": "{\n \"Response\": {\n \"RequestId\": \"fcf7340b-b7b8-48fd-afe2-b061df13a290\",\n \"TotalCount\": 1,\n \"Data\": [\n {\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"TopicType\": \"NORMAL\",\n \"TopicQueueNum\": 3,\n \"ConsumerGroup\": \"test_group\",\n \"IsOnline\": true,\n \"ConsumeType\": \"PUSH\",\n \"SubString\": \"test_tag\",\n \"ExpressionType\": \"TAG\",\n \"Consistency\": 0,\n \"ConsumerLag\": 20,\n \"LastUpdateTime\": 1736935187759,\n \"MaxRetryTimes\": 16,\n \"ConsumeMessageOrderly\": false,\n \"MessageModel\": \"CLUSTERING\"\n }\n ]\n }\n}",
421
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"06a6649b-76ec-4c5d-b4c8-8a48d24be07f\",\n \"TotalCount\": 1,\n \"Data\": [\n {\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"TopicType\": \"NORMAL\",\n \"TopicQueueNum\": 3,\n \"ConsumerGroup\": \"test_group\",\n \"IsOnline\": true,\n \"ConsumeType\": \"PUSH\",\n \"SubString\": \"test_tag\",\n \"ExpressionType\": \"TAG\",\n \"Consistency\": 0,\n \"ClientSubscriptionInfos\": [],\n \"ConsumerLag\": 0,\n \"LastUpdateTime\": 1750853702996,\n \"MaxRetryTimes\": 16,\n \"ConsumeMessageOrderly\": false,\n \"MessageModel\": \"CLUSTERING\"\n }\n ]\n }\n}",
422
422
  "title": "查询消费组订阅的主题列表"
423
423
  }
424
424
  ],
@@ -521,7 +521,7 @@
521
521
  "ModifyTopic": [
522
522
  {
523
523
  "document": "修改主题属性",
524
- "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyTopic\n<公共请求参数>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"QueueNum\": 1\n}",
524
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyTopic\n<公共请求参数>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"QueueNum\": 6\n}",
525
525
  "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"945afc69-1c24-4891-a2ce-c5fa6032ba75\"\n }\n}",
526
526
  "title": "修改主题属性"
527
527
  }