tccli-intl-en 3.0.1283.1__py2.py3-none-any.whl → 3.1.8.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 (49) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +6 -0
  3. tccli/services/autoscaling/v20180419/api.json +36 -14
  4. tccli/services/ckafka/ckafka_client.py +288 -8
  5. tccli/services/ckafka/v20190819/api.json +494 -76
  6. tccli/services/ckafka/v20190819/examples.json +45 -5
  7. tccli/services/clb/clb_client.py +636 -300
  8. tccli/services/clb/v20180317/api.json +2255 -1017
  9. tccli/services/clb/v20180317/examples.json +184 -124
  10. tccli/services/controlcenter/controlcenter_client.py +224 -0
  11. tccli/services/controlcenter/v20230110/api.json +528 -5
  12. tccli/services/controlcenter/v20230110/examples.json +32 -0
  13. tccli/services/cvm/v20170312/api.json +41 -41
  14. tccli/services/cvm/v20170312/examples.json +21 -21
  15. tccli/services/faceid/v20180301/api.json +31 -3
  16. tccli/services/kms/v20190118/api.json +80 -3
  17. tccli/services/kms/v20190118/examples.json +3 -3
  18. tccli/services/mdl/v20200326/api.json +165 -5
  19. tccli/services/mongodb/mongodb_client.py +1048 -96
  20. tccli/services/mongodb/v20190725/api.json +1765 -108
  21. tccli/services/mongodb/v20190725/examples.json +136 -0
  22. tccli/services/mps/mps_client.py +713 -209
  23. tccli/services/mps/v20190612/api.json +1009 -67
  24. tccli/services/mps/v20190612/examples.json +100 -52
  25. tccli/services/ocr/ocr_client.py +112 -0
  26. tccli/services/ocr/v20181119/api.json +550 -6
  27. tccli/services/ocr/v20181119/examples.json +22 -0
  28. tccli/services/smh/__init__.py +4 -0
  29. tccli/services/smh/smh_client.py +714 -0
  30. tccli/services/smh/v20210712/api.json +1287 -0
  31. tccli/services/smh/v20210712/examples.json +85 -0
  32. tccli/services/tdmq/tdmq_client.py +2406 -278
  33. tccli/services/tdmq/v20200217/api.json +11607 -3958
  34. tccli/services/tdmq/v20200217/examples.json +562 -264
  35. tccli/services/teo/v20220901/api.json +68 -4
  36. tccli/services/teo/v20220901/examples.json +28 -22
  37. tccli/services/trocket/__init__.py +4 -0
  38. tccli/services/trocket/trocket_client.py +2450 -0
  39. tccli/services/trocket/v20230308/api.json +6062 -0
  40. tccli/services/trocket/v20230308/examples.json +339 -0
  41. tccli/services/trtc/v20190722/api.json +5 -5
  42. tccli/services/vpc/v20170312/api.json +19 -16
  43. tccli/services/vpc/v20170312/examples.json +4 -4
  44. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/METADATA +2 -2
  45. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/RECORD +49 -41
  46. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/LICENSE +0 -0
  47. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/WHEEL +0 -0
  48. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/entry_points.txt +0 -0
  49. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,339 @@
1
+ {
2
+ "actions": {
3
+ "ChangeMigratingTopicToNextStage": [
4
+ {
5
+ "document": "",
6
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChangeMigratingTopicToNextStage\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicNameList\": [\n \"TopicTest\"\n ],\n \"NamespaceList\": []\n}",
7
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Results\": [\n {\n \"TopicName\": \"TopicTest\",\n \"Success\": true,\n \"Namespace\": \"\"\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
8
+ "title": "Modify Migration Topic Enter Next Migration Stage"
9
+ }
10
+ ],
11
+ "CreateConsumerGroup": [
12
+ {
13
+ "document": "This example shows you how to create a consumer group successfully.",
14
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"MaxRetryTimes\": 16,\n \"ConsumeEnable\": true,\n \"ConsumeMessageOrderly\": true,\n \"Remark\": \"remark info\"\n}",
15
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ConsumerGroup\": \"test_group\",\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"RequestId\": \"58f60891-002f-4b8a-b71f-3767a645c28e\"\n }\n}",
16
+ "title": "Create consumer groups."
17
+ }
18
+ ],
19
+ "CreateInstance": [
20
+ {
21
+ "document": "This example shows you how to successfully create a RocketMQ 5.x cluster with TPS 2000.",
22
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateInstance\n<Common request parameters>\n\n{\n \"InstanceType\": \"BASIC\",\n \"Name\": \"test_instance\",\n \"SkuCode\": \"basic_2k\",\n \"VpcList\": [\n {\n \"VpcId\": \"vpc-xxxx\",\n \"SubnetId\": \"subnet-xxxx\"\n }\n ]\n}",
23
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"InstanceId\": \"rmq-72mo3a9or\",\n \"RequestId\": \"32759095-0372-4ec0-ae3a-e5a2759fd0ff\"\n }\n}",
24
+ "title": "Normal Response"
25
+ }
26
+ ],
27
+ "CreateRole": [
28
+ {
29
+ "document": "Add a role",
30
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRole\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Role\": \"test_role_name\",\n\"Remark\": \"Test role\"\n \"PermWrite\": true,\n \"PermRead\": true\n}",
31
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"0bb79e96-2531-4088-8d90-e1372c15518a\",\n \"Role\": \"test_role_name\"\n }\n}",
32
+ "title": "Add Role"
33
+ }
34
+ ],
35
+ "DeleteConsumerGroup": [
36
+ {
37
+ "document": "Delete consumer groups.",
38
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\"\n}",
39
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"8221cd04-dafc-438d-bc1f-816fd87df24e\"\n }\n}",
40
+ "title": "Delete consumer groups."
41
+ }
42
+ ],
43
+ "DeleteInstance": [
44
+ {
45
+ "document": "This example shows you how to delete a RocketMQ 5.x cluster.",
46
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\"\n}",
47
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"97f45511-b653-4e2a-ade6-58c8d3ae523b\"\n }\n}",
48
+ "title": "Deleting a cluster"
49
+ }
50
+ ],
51
+ "DeleteRole": [
52
+ {
53
+ "document": "This example shows you how to delete a role.",
54
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRole\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Role\": \"test_role_name\"\n}",
55
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"c6e5472a-231d-4bd0-84cf-447f76a8216e\"\n }\n}",
56
+ "title": "Delete a Role"
57
+ }
58
+ ],
59
+ "DeleteSmoothMigrationTask": [
60
+ {
61
+ "document": "",
62
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteSmoothMigrationTask\n<Common request parameters>\n\n{\n \"TaskId\": \"taskid-123\"\n}",
63
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"requestId\"\n }\n}",
64
+ "title": "Deleting a Smooth Migration Task"
65
+ }
66
+ ],
67
+ "DeleteTopic": [
68
+ {
69
+ "document": "This example shows you how to delete a topic.",
70
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteTopic\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\"\n}",
71
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"4687272f-f35c-4aef-9941-ced81c164d4b\"\n }\n}",
72
+ "title": "Deleting a Topic"
73
+ }
74
+ ],
75
+ "DescribeConsumerClient": [
76
+ {
77
+ "document": "Query consumer client details.",
78
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerClient\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 1,\n \"ConsumerGroup\": \"group\",\n \"ClientId\": \"11.139.244.247@75043#6734858812769343\"\n}",
79
+ "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 \"ChannelProtocol\": \"remoting\"\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}",
80
+ "title": "Query consumer client details."
81
+ }
82
+ ],
83
+ "DescribeConsumerClientList": [
84
+ {
85
+ "document": "Query client connections under a consumer group.",
86
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerClientList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"group\",\n \"Offset\": 0,\n \"Limit\": 1\n}",
87
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [],\n \"RequestId\": \"c2d581fa-d7b2-453c-ba1a-65c0e507a533\",\n \"TotalCount\": 0\n }\n}",
88
+ "title": "Query client connections under a consumer group."
89
+ }
90
+ ],
91
+ "DescribeConsumerGroup": [
92
+ {
93
+ "document": "This example shows you how to query consumer details.",
94
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"group\"\n}",
95
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ConsumeEnable\": true,\n \"ConsumeMessageOrderly\": false,\n \"ConsumeType\": \"PUSH\",\n \"ConsumerLag\": 1580,\n \"ConsumerNum\": 2,\n \"CreatedTime\": 1683613488000,\n \"MaxRetryTimes\": 16,\n\"Remark\": \"Test consumption group\"\n \"RequestId\": \"bc4ffab1-65cc-4ef6-9114-0de06c333b84\",\n \"Tps\": 60\n }\n}",
96
+ "title": "Query consumer group details."
97
+ }
98
+ ],
99
+ "DescribeConsumerLag": [
100
+ {
101
+ "document": "Query the accumulation of successes for the designated client",
102
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerLag\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-24kzek2b\",\n \"ConsumerGroup\": \"test_group\"\n}",
103
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ConsumerLag\": 260,\n \"RequestId\": \"2b9eef15-a8bc-47a3-9445-9edcafccb459\"\n }\n}",
104
+ "title": "Normal Response"
105
+ }
106
+ ],
107
+ "DescribeFusionInstanceList": [
108
+ {
109
+ "document": "",
110
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFusionInstanceList\n<Common request parameters>\n\n{\n \"Offset\": 0,\n \"Limit\": 20\n}",
111
+ "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"Data\": [\n {\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"InstanceName\": \"test_instance5x\",\n \"Version\": \"5.0\",\n \"InstanceType\": \"EXPERIMENT\",\n \"InstanceStatus\": \"RUNNING\",\n \"TopicNumLimit\": 52,\n \"GroupNumLimit\": 520,\n \"PayMode\": \"PREPAID\",\n \"ExpiryTime\": 1731830193435,\n\"Remark\": \"Test cluster of version 5.X\"\n \"TopicNum\": 3,\n \"GroupNum\": 10,\n \"TagList\": [\n {\n \"TagKey\": \"test_tag\",\n \"TagValue\": \"test_tag_key\"\n }\n ],\n \"SkuCode\": \"experiment_500\",\n \"TpsLimit\": 500,\n \"ScaledTpsLimit\": 0,\n \"MessageRetention\": 72,\n \"MaxMessageDelay\": 168,\n \"RenewFlag\": 1,\n \"InstanceItemExtraInfo\": {\n \"IsVip\": false,\n \"VipInstanceStatus\": 0,\n \"MaxBandWidth\": 0,\n \"SpecName\": \"\",\n \"NodeCount\": 0,\n \"MaxStorage\": 0,\n \"MaxRetention\": 0,\n \"MinRetention\": 0,\n \"InstanceStatus\": 0\n },\n \"DestroyTime\": 0\n },\n {\n \"InstanceId\": \"rocketmq-5kze4gr222mx\",\n \"InstanceName\": \"test_instance4x\",\n \"Version\": \"4\",\n \"InstanceType\": \"BASIC\",\n \"InstanceStatus\": \"RUNNING\",\n \"TopicNumLimit\": 400,\n \"GroupNumLimit\": 4000,\n \"PayMode\": \"PREPAID\",\n \"ExpiryTime\": 1730710586538,\n\"Remark\": \"4.X version testing cluster\"\n \"TopicNum\": 1,\n \"GroupNum\": 1,\n \"TagList\": [\n {\n \"TagKey\": \"test_tag\",\n \"TagValue\": \"test_tag_key\"\n }\n ],\n \"SkuCode\": \"\",\n \"TpsLimit\": 8000,\n \"ScaledTpsLimit\": 0,\n \"MessageRetention\": 72,\n \"MaxMessageDelay\": 0,\n \"RenewFlag\": 1,\n \"DestroyTime\": 0,\n \"InstanceItemExtraInfo\": {\n \"IsVip\": true,\n \"InstanceStatus\": 1,\n \"VipInstanceStatus\": 1,\n \"MaxBandWidth\": 80,\n \"NodeCount\": 2,\n \"MaxStorage\": 200,\n \"SpecName\": \"rocket-vip-basic-0\",\n \"MaxRetention\": 168,\n \"MinRetention\": 24\n }\n }\n ],\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}",
112
+ "title": "Retrieve the Full Cluster List"
113
+ }
114
+ ],
115
+ "DescribeInstance": [
116
+ {
117
+ "document": "This example shows you how to query cluster information successfully.",
118
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\"\n}",
119
+ "output": "{\n \"Response\": {\n \"ScaledTpsEnabled\": false,\n \"InstanceType\": \"EXPERIMENT\",\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"InstanceName\": \"test_instance\",\n \"TopicNum\": 2,\n \"TopicNumLimit\": 50,\n \"GroupNum\": 10,\n \"GroupNumLimit\": 500,\n \"MessageRetention\": 72,\n \"RetentionUpperLimit\": 168,\n \"RetentionLowerLimit\": 1,\n \"TpsLimit\": 500,\n \"ScaledTpsLimit\": 0,\n \"MaxMessageDelay\": 168,\n \"CreatedTime\": 1731920303801,\n \"SendReceiveRatio\": 0.5,\n \"TagList\": [\n {\n \"TagKey\": \"test_tag_key\",\n \"TagValue\": \"test_tag_value\"\n }\n ],\n \"EndpointList\": [\n {\n \"Type\": \"VPC\",\n \"Status\": \"OPEN\",\n \"PayMode\": \"PREPAID\",\n \"EndpointUrl\": \"rmq-72mo3a9o.rocketmq.xx.qcloud.tencenttdmq.com:8080\",\n \"VpcId\": \"vpc-be1tvrab\",\n \"SubnetId\": \"subnet-i6fjswac\",\n \"Bandwidth\": 0,\n \"IpRules\": []\n }\n ],\n \"TopicQueueNumUpperLimit\": 32,\n \"TopicQueueNumLowerLimit\": 1,\n\"Remark\": \"Test cluster\"\n \"InstanceStatus\": \"RUNNING\",\n \"SkuCode\": \"experiment_500\",\n \"PayMode\": \"PREPAID\",\n \"RequestId\": \"32759095-0372-4ec0-ae3a-e5a2759fd0ff\"\n }\n}",
120
+ "title": "Query Cluster Information Successfully"
121
+ }
122
+ ],
123
+ "DescribeInstanceList": [
124
+ {
125
+ "document": "This example shows you how to inquiry the cluster list of RocketMQ 5.X.",
126
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceList\n<Common request parameters>\n\n{\n \"Offset\": 0,\n \"Limit\": 20\n}",
127
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"ExpiryTime\": 1683601674000,\n \"GroupNum\": 10,\n \"GroupNumLimit\": 500,\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"InstanceName\": \"test_instance5x\",\n \"InstanceStatus\": \"RUNNING\",\n \"InstanceType\": \"EXPERIMENT\",\n \"MaxMessageDelay\": 48,\n \"MessageRetention\": 72,\n \"PayMode\": \"POSTPAID\",\n\"Remark\": \"Version 5.X test cluster\"\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"experiment_500\",\n \"TagList\": [\n {\n \"TagKey\": \"test_tag_key\",\n \"TagValue\": \"test_tag_value\"\n }\n ],\n \"TopicNum\": 10,\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 500,\n \"Version\": \"5.0\"\n }\n ],\n \"RequestId\": \"561a34ff-965b-4a2d-852e-973c0b2a6f01\",\n \"TotalCount\": 1\n }\n}",
128
+ "title": "Query a Cluster List"
129
+ }
130
+ ],
131
+ "DescribeMessage": [
132
+ {
133
+ "document": "",
134
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessage\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"topic\",\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\"\n}",
135
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Body\": \"testBody\",\n \"MessageId\": \"1EAE3915000721B8D17C2C5BB31638D1\",\n \"MessageTracksCount\": 1,\n \"MessageTracks\": [\n {\n \"ConsumeStatus\": \"CONSUMED\",\n \"ConsumerGroup\": \"group\",\n \"ExceptionDesc\": null,\n \"TrackType\": \"CONSUMED\"\n }\n ],\n \"ProduceTime\": \"2023-05-09 14:43:27\",\n \"ProducerAddr\": \"30.174.57.21\",\n \"Properties\": \"{\\\"TRACE_ON\\\":\\\"true\\\",\\\"MSG_REGION\\\":\\\"cd\\\",\\\"KEYS\\\":\\\"testKey\\\",\\\"UNIQ_KEY\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"CLUSTER\\\":\\\"rmqbroker-cd-1\\\",\\\"WAIT\\\":\\\"true\\\",\\\"TAGS\\\":\\\"testTag\\\"}\",\n \"RequestId\": \"8e97b978-376b-4d94-96cc-db0ead5f2f99\",\n \"ShowTopicName\": \"topic\"\n }\n}",
136
+ "title": "Querying Regular Messages"
137
+ }
138
+ ],
139
+ "DescribeMessageList": [
140
+ {
141
+ "document": " ",
142
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"topic\",\n \"Offset\": 0,\n \"Limit\": 1,\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\",\n \"StartTime\": 1683613796174,\n \"EndTime\": 1683613796174,\n \"TaskRequestId\": \"901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d\"\n}",
143
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"DeadLetterResendSuccessTimes\": null,\n \"DeadLetterResendTimes\": null,\n \"Keys\": \"test_key\",\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\",\n \"ProduceTime\": \"2023-05-09 14:43:27\",\n \"ProducerAddr\": \"30.174.57.21\",\n \"Tags\": \"test_tag\"\n }\n ],\n \"RequestId\": \"7426c613-085b-48c4-9257-87a208a8adcc\",\n \"TaskRequestId\": \"901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d\",\n \"TotalCount\": 1\n }\n}",
144
+ "title": "Query a Message List"
145
+ }
146
+ ],
147
+ "DescribeMessageTrace": [
148
+ {
149
+ "document": "",
150
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageTrace\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"topic\",\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\"\n}",
151
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"Status\\\":0,\\\"ProduceTime\\\":\\\"2023-05-09 14:43:27,127\\\",\\\"ProducerAddr\\\":\\\"30.174.57.21\\\",\\\"MsgKey\\\":\\\"testKey\\\",\\\"MsgTags\\\":\\\"testTag\\\",\\\"Duration\\\":76}\",\n \"Stage\": \"produce\"\n },\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"Status\\\":0,\\\"PersistTime\\\":\\\"2023-05-09 14:43:27,184\\\"}\",\n \"Stage\": \"persist\"\n },\n {\n \"Data\": \"{\\\"TotalCount\\\":1,\\\"RocketMqConsumeLogs\\\":[{\\\"MsgId\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"Status\\\":2,\\\"PushTime\\\":\\\"2023-05-09 14:43:27,205\\\",\\\"ConsumerAddr\\\":\\\"11.139.244.247\\\",\\\"ConsumerGroup\\\":\\\"group\\\",\\\"RetryTimes\\\":1}]}\",\n \"Stage\": \"consume\"\n }\n ],\n \"RequestId\": \"0112153a-8cba-44f1-b7a5-5e412d493940\",\n \"ShowTopicName\": \"test_topic\"\n }\n}",
152
+ "title": "Query the Path of Regular Messages"
153
+ },
154
+ {
155
+ "document": "",
156
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageTrace\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-cdqzmmgz8o\",\n \"Topic\": \"\",\n \"MsgId\": \"010242ECB90067325E06F41EFF00000000\",\n \"QueryDelayMessage\": true\n}",
157
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"010242ECB90067325E06F41EFF00000000\\\",\\\"Status\\\":0,\\\"ProduceTime\\\":\\\"2024-09-12 14:06:55,591\\\",\\\"ProducerAddr\\\":\\\"9.218.232.160:32038\\\",\\\"MsgKey\\\":\\\"topic1\\\",\\\"MsgTags\\\":\\\"tag0\\\",\\\"Duration\\\":2}\",\n \"Stage\": \"produce\"\n },\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"010242ECB90067325E06F41EFF00000000\\\",\\\"Status\\\":0,\\\"PersistTime\\\":\\\"2024-09-12 14:06:55,590\\\"}\",\n \"Stage\": \"persist\"\n },\n {\n \"Data\": \"{\\\"TotalCount\\\":0,\\\"RocketMqConsumeLogs\\\":[]}\",\n \"Stage\": \"consume\"\n }\n ],\n \"RequestId\": \"2e4374f9-0c98-4d77-af20-2bc414ccaefd\",\n \"ShowTopicName\": \"test_topic\"\n }\n}",
158
+ "title": "Query the Path of Delayed Messages"
159
+ }
160
+ ],
161
+ "DescribeMigratingGroupStats": [
162
+ {
163
+ "document": "",
164
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingGroupStats\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"GroupName\": \"group-a\",\n \"Namespace\": \"\"\n}",
165
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"SourceConsumeLag\": 0,\n \"TargetConsumeLag\": 0,\n \"SourceConsumerClients\": [\n {\n \"ClientId\": \"client-a\",\n \"ClientAddr\": \"1.1.1.1\",\n \"Language\": \"JAVA\",\n \"Version\": \"5\",\n \"ConsumerLag\": 0,\n \"ChannelProtocol\": \"\"\n }\n ],\n \"TargetConsumerClients\": [\n {\n \"ClientId\": \"client-b\",\n \"ClientAddr\": \"2.2.2.2\",\n \"Language\": \"JAVA\",\n \"Version\": \"5.0\",\n \"ConsumerLag\": 0\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
166
+ "title": "Viewing Real-Time Information of a Migration Consumption Group"
167
+ }
168
+ ],
169
+ "DescribeMigratingTopicList": [
170
+ {
171
+ "document": "",
172
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingTopicList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 10,\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n}",
173
+ "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}",
174
+ "title": "Querying Migration Topic List"
175
+ }
176
+ ],
177
+ "DescribeMigratingTopicStats": [
178
+ {
179
+ "document": "",
180
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingTopicStats\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicName\": \"TopicTest\",\n \"Namespace\": \"\"\n}",
181
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"SourceClusterConsumerCount\": 0,\n \"TargetClusterConsumerCount\": 0,\n \"SourceClusterConsumerGroups\": [],\n \"TargetClusterConsumerGroups\": [],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
182
+ "title": "Querying Real-Time Data of Migration Topics"
183
+ }
184
+ ],
185
+ "DescribeMigrationTaskList": [
186
+ {
187
+ "document": "",
188
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigrationTaskList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 20\n}",
189
+ "output": "{\n \"Response\": {\n \"RequestId\": \"bd8c6783-04a4-419f-bc51-9af603872490\",\n \"TotalCount\": 1,\n \"Tasks\": [\n {\n \"TaskId\": \"603872-7a11-c67\",\n \"Type\": 1,\n \"InstanceId\": \"rmq-47zbegoa\",\n \"TopicNum\": 4,\n \"GroupNum\": 0,\n \"Status\": 1,\n \"CreateTime\": 1693219938000\n }\n ]\n }\n}",
190
+ "title": "Retrieving the Data Migration Task List"
191
+ }
192
+ ],
193
+ "DescribeProducerList": [
194
+ {
195
+ "document": "This example shows you how to query the producer list.",
196
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProducerList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-9j77qmrm\",\n \"Topic\": \"topic-normal\",\n \"Limit\": 10,\n \"Offset\": 0\n}",
197
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ProducerList\": [\n {\n \"ClientId\": \"169.254.165.243@a3c02f03-5b27-425f-8632-83d1e9f7010b\",\n \"ClientIp\": \"/11.176.16.134:58560\",\n \"Language\": \"JAVA\",\n \"LastUpdateTimestamp\": 1725440379597,\n \"Version\": \"V4_9_3\"\n }\n ],\n \"RequestId\": \"6918ecdb-ee41-4f8a-bf5f-7b313cd5fca0\",\n \"TotalCount\": 1\n }\n}",
198
+ "title": "Querying the Producer List"
199
+ }
200
+ ],
201
+ "DescribeProductSKUs": [
202
+ {
203
+ "document": "This example shows you how to obtain product specification information.",
204
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProductSKUs\n<Common request parameters>\n\n{}",
205
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"EXPERIMENT\",\n \"MaxMessageDelay\": 48,\n \"OnSale\": false,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"experiment_500\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 500\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_1k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 1000\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_2k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 2000\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_4k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 4000\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_6k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 6000\n }\n ],\n \"RequestId\": \"010e2991-4b01-40f9-a4a6-30bdfb175448\"\n }\n}",
206
+ "title": "Obtaining Product Specification Information"
207
+ }
208
+ ],
209
+ "DescribeRoleList": [
210
+ {
211
+ "document": "This example shows you how to successfully query the list of roles.",
212
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRoleList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 20\n}",
213
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"c5d126b6-aeeb-40ad-81c0-a94abd43f157\",\n \"TotalCount\": 1,\n \"Data\": [\n {\n \"RoleName\": \"test_role_name\",\n \"AccessKey\": \"ak0000aaaa\",\n \"SecretKey\": \"sk0000aaaa\",\n \"PermRead\": true,\n \"PermWrite\": true,\n \"Remark\": \"\",\n \"CreatedTime\": 1729153015000,\n \"ModifiedTime\": 1729153015000\n }\n ]\n }\n}",
214
+ "title": "Queries the roles"
215
+ }
216
+ ],
217
+ "DescribeSmoothMigrationTaskList": [
218
+ {
219
+ "document": "",
220
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSmoothMigrationTaskList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 10\n}",
221
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"TotalCount\": 10,\n \"Data\": [\n {\n \"TaskId\": \"28deebbb-d489-471e-bb21-69fab50aed36\",\n \"TaskName\": \"test-task\",\n \"SourceClusterName\": \"source-cluster\",\n \"InstanceId\": \"rmq-1gabcde\",\n \"ConnectionType\": \"VPC\",\n \"SourceNameServer\": \"1.1.1.1:9876\",\n \"TaskStatus\": \"ServiceMigration\",\n \"InstanceVersion\": \"5\"\n }\n ],\n \"RequestId\": \"9b299610-7402-47d3-91d1-f012faf13929\"\n }\n}",
222
+ "title": "Retrieving the Migration Task List"
223
+ }
224
+ ],
225
+ "DescribeSourceClusterGroupList": [
226
+ {
227
+ "document": "",
228
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSourceClusterGroupList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 10,\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n}",
229
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"TotalCount\": 10,\n \"Groups\": [\n {\n \"GroupName\": \"Test\",\n \"Remark\": \"remark\",\n \"Imported\": true,\n \"Namespace\": \"\",\n \"ImportStatus\": \"Success\",\n \"ConsumeMessageOrderly\": false,\n \"FullNamespaceV4\": null,\n \"GroupNameV4\": null,\n \"NamespaceV4\": null\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
230
+ "title": "Querying Source Cluster Consumer Group List"
231
+ }
232
+ ],
233
+ "DescribeTopic": [
234
+ {
235
+ "document": "This example shows you how to query topic details.",
236
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopic\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"Offset\": 0,\n \"Limit\": 10\n}",
237
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"CreatedTime\": 1683601674000,\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"LastUpdateTime\": 1683601674000,\n\"Remark\": \"Test topic\"\n \"RequestId\": \"f7f7ba8a-4335-4adb-9186-680b91502c42\",\n \"SubscriptionCount\": 0,\n \"SubscriptionData\": [],\n \"Topic\": \"test_topic\",\n \"TopicType\": \"NORMAL\"\n }\n}",
238
+ "title": "Query Topic Details"
239
+ }
240
+ ],
241
+ "DescribeTopicList": [
242
+ {
243
+ "document": "This example shows you how to query topic list.",
244
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 20\n}",
245
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"QueueNum\": 16,\n\"Remark\": \"Test topic\"\n \"Topic\": \"test_topic\",\n \"TopicType\": \"NORMAL\"\n }\n ],\n \"RequestId\": \"927cbd2c-be83-410e-a83f-24dcea1d88d9\",\n \"TotalCount\": 1\n }\n}",
246
+ "title": "Query Topic List"
247
+ }
248
+ ],
249
+ "DescribeTopicListByGroup": [
250
+ {
251
+ "document": "",
252
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicListByGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"ConsumerGroup\": \"test_group\"\n}",
253
+ "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}",
254
+ "title": "Querying Subscribed Topic List of Consumption Group"
255
+ }
256
+ ],
257
+ "DoHealthCheckOnMigratingTopic": [
258
+ {
259
+ "document": "",
260
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DoHealthCheckOnMigratingTopic\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicName\": \"Test\",\n \"IgnoreCheck\": true,\n \"Namespace\": \"\"\n}",
261
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Passed\": true,\n \"Reason\": null,\n \"ReasonList\": null,\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
262
+ "title": "Migration Topic Security Check"
263
+ }
264
+ ],
265
+ "ModifyConsumerGroup": [
266
+ {
267
+ "document": "This example shows you how to modify consumer group attributes successfully.",
268
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"ConsumeEnable\": true,\n \"ConsumeMessageOrderly\": true,\n \"MaxRetryTimes\": 16,\n \"Remark\": \"Test modification\"\n}",
269
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"239a3769-8dc6-41e9-bc01-67be452db5a3\"\n }\n}",
270
+ "title": "Modify consumer group attributes."
271
+ }
272
+ ],
273
+ "ModifyInstance": [
274
+ {
275
+ "document": "This example shows you how to modify instance configuration.",
276
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n\"Remark\": \"Test modify message retention duration\"\n \"MessageRetention\": 25\n}",
277
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"becc23c2-b5e1-4df4-9df1-22ba8e5b20c3\"\n }\n}",
278
+ "title": "Modify Instance Configuration"
279
+ }
280
+ ],
281
+ "ModifyInstanceEndpoint": [
282
+ {
283
+ "document": "This example shows you how to modify the public network configuration of an instance.",
284
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceEndpoint\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-cdrgxq94om\",\n \"Type\": \"PUBLIC\",\n \"Bandwidth\": 2,\n \"IpRules\": [\n {\n \"Ip\": \"1.2.3.4\",\n \"Allow\": true,\n \"Remark\": \"test remark\"\n }\n ]\n}",
285
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"999bc587-90d9-4ec2-97e3-3ef170e1da96\"\n }\n}",
286
+ "title": "Modifying Public Network Configuration of an Instance"
287
+ }
288
+ ],
289
+ "ModifyRole": [
290
+ {
291
+ "document": "This example shows you how to modify a role successfully.",
292
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRole\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Role\": \"test_role_name\",\n\"Remark\": \"Test modification\"\n \"PermRead\": false,\n \"PermWrite\": false\n}",
293
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"0608515b-cde2-41d6-933c-169d0d1849c5\"\n }\n}",
294
+ "title": "Modify a Role"
295
+ }
296
+ ],
297
+ "ModifyTopic": [
298
+ {
299
+ "document": "Modify topic attributes.",
300
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyTopic\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"QueueNum\": 6\n}",
301
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"945afc69-1c24-4891-a2ce-c5fa6032ba75\"\n }\n}",
302
+ "title": "Modify topic attributes."
303
+ }
304
+ ],
305
+ "RemoveMigratingTopic": [
306
+ {
307
+ "document": "",
308
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RemoveMigratingTopic\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"Namespace\": \"\",\n \"TopicName\": \"topic-a\"\n}",
309
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
310
+ "title": "Removing a Topic From a Migration Task"
311
+ }
312
+ ],
313
+ "ResendDeadLetterMessage": [
314
+ {
315
+ "document": "",
316
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResendDeadLetterMessage\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"MessageIds\": [\n \"01963F0B14BAF09F27077D244F00000000\"\n ]\n}",
317
+ "output": "{\n \"Response\": {\n \"RequestId\": \"f4f1d3ba-3ed2-4e03-b741-9f6f696b9689\"\n }\n}",
318
+ "title": "Resending Dead Letter Messages"
319
+ }
320
+ ],
321
+ "ResetConsumerGroupOffset": [
322
+ {
323
+ "document": " ",
324
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetConsumerGroupOffset\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"Topic\": \"test_topic\",\n \"ResetTimestamp\": -1\n}",
325
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"707a78e5-019d-41f6-80fc-15743d99c81a\"\n }\n}",
326
+ "title": "Reset the consumption position."
327
+ }
328
+ ],
329
+ "RollbackMigratingTopicStage": [
330
+ {
331
+ "document": "",
332
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollbackMigratingTopicStage\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicName\": \"TopicTest\",\n \"Namespace\": \"\"\n}",
333
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
334
+ "title": "Rolling Back the Streaming State of a Migration Topic"
335
+ }
336
+ ]
337
+ },
338
+ "version": "1.0"
339
+ }
@@ -316,7 +316,7 @@
316
316
  "status": "online"
317
317
  },
318
318
  "StopPublishCdnStream": {
319
- "document": "This API is used to stop a relaying task.",
319
+ "document": "This API is used to stop a relaying task.\nYou can create a relay task before the anchor enters the room. When the relay task is finished, you need to call the stop interface actively. If you do not call the Stop Relay Task Interface, Tencent Cloud will automatically stop the mix relay task when all users participating in the mix have no data uploaded for a period of time exceeding the timeout (AgentParams.MaxIdleTime) set when starting the relay task.",
320
320
  "input": "StopPublishCdnStreamRequest",
321
321
  "name": "Stops a relaying task",
322
322
  "output": "StopPublishCdnStreamResponse",
@@ -5969,7 +5969,7 @@
5969
5969
  {
5970
5970
  "disabled": false,
5971
5971
  "document": "The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.",
5972
- "example": "1400188366",
5972
+ "example": "1400***000",
5973
5973
  "member": "uint64",
5974
5974
  "name": "SdkAppId",
5975
5975
  "required": true,
@@ -5978,7 +5978,7 @@
5978
5978
  {
5979
5979
  "disabled": false,
5980
5980
  "document": "The task ID.",
5981
- "example": "xxxx",
5981
+ "example": "-nHPekVU7h******sceOqAZ1YVQE.",
5982
5982
  "member": "string",
5983
5983
  "name": "TaskId",
5984
5984
  "required": true,
@@ -5993,10 +5993,10 @@
5993
5993
  {
5994
5994
  "disabled": false,
5995
5995
  "document": "The task ID.",
5996
- "example": "xxxxx",
5996
+ "example": "-nHPekVU7h******sceOqAZ1YVQE.",
5997
5997
  "member": "string",
5998
5998
  "name": "TaskId",
5999
- "required": true,
5999
+ "output_required": true,
6000
6000
  "type": "string",
6001
6001
  "value_allowed_null": false
6002
6002
  },
@@ -17376,7 +17376,7 @@
17376
17376
  {
17377
17377
  "disabled": false,
17378
17378
  "document": "The ID of the VPN gateway instance.",
17379
- "example": "",
17379
+ "example": "vpngw-ac13cgez",
17380
17380
  "member": "string",
17381
17381
  "name": "VpnGatewayId",
17382
17382
  "required": true,
@@ -17385,7 +17385,7 @@
17385
17385
  {
17386
17386
  "disabled": false,
17387
17387
  "document": "Specifies the purchased validity period, whether to enable auto-renewal. This parameter is required for monthly-subscription instances.",
17388
- "example": "",
17388
+ "example": "{'Period': 36}",
17389
17389
  "member": "InstanceChargePrepaid",
17390
17390
  "name": "InstanceChargePrepaid",
17391
17391
  "required": true,
@@ -17400,9 +17400,10 @@
17400
17400
  {
17401
17401
  "disabled": false,
17402
17402
  "document": "Product price.",
17403
- "example": "",
17403
+ "example": "",
17404
17404
  "member": "Price",
17405
17405
  "name": "Price",
17406
+ "output_required": true,
17406
17407
  "type": "object"
17407
17408
  },
17408
17409
  {
@@ -17465,9 +17466,10 @@
17465
17466
  {
17466
17467
  "disabled": false,
17467
17468
  "document": "Purchased usage period (in month). Value range: [1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36].",
17468
- "example": "",
17469
+ "example": "1",
17469
17470
  "member": "uint64",
17470
17471
  "name": "Period",
17472
+ "output_required": true,
17471
17473
  "required": true,
17472
17474
  "type": "int",
17473
17475
  "value_allowed_null": false
@@ -17475,9 +17477,10 @@
17475
17477
  {
17476
17478
  "disabled": false,
17477
17479
  "document": "Auto-renewal ID. Value range: NOTIFY_AND_AUTO_RENEW: notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify expiry but do not renew automatically. The default is NOTIFY_AND_MANUAL_RENEW",
17478
- "example": "",
17480
+ "example": "NOTIFY_AND_AUTO_RENEW",
17479
17481
  "member": "string",
17480
17482
  "name": "RenewFlag",
17483
+ "output_required": true,
17481
17484
  "required": false,
17482
17485
  "type": "string",
17483
17486
  "value_allowed_null": false
@@ -17934,13 +17937,13 @@
17934
17937
  "members": [
17935
17938
  {
17936
17939
  "disabled": false,
17937
- "document": "The pay-as-you-go billing method. Unit: CNY.",
17940
+ "document": "The pay-as-you-go billing method. Unit: USD.",
17938
17941
  "example": "1.0",
17939
17942
  "member": "float",
17940
17943
  "name": "UnitPrice",
17941
17944
  "output_required": true,
17942
17945
  "type": "float",
17943
- "value_allowed_null": true
17946
+ "value_allowed_null": false
17944
17947
  },
17945
17948
  {
17946
17949
  "disabled": false,
@@ -17950,27 +17953,27 @@
17950
17953
  "name": "ChargeUnit",
17951
17954
  "output_required": true,
17952
17955
  "type": "string",
17953
- "value_allowed_null": true
17956
+ "value_allowed_null": false
17954
17957
  },
17955
17958
  {
17956
17959
  "disabled": false,
17957
- "document": "Original price of the prepaid product. Unit: CNY.",
17960
+ "document": "Original price of the prepaid product. Unit: USD.",
17958
17961
  "example": "1.0",
17959
17962
  "member": "float",
17960
17963
  "name": "OriginalPrice",
17961
17964
  "output_required": true,
17962
17965
  "type": "float",
17963
- "value_allowed_null": true
17966
+ "value_allowed_null": false
17964
17967
  },
17965
17968
  {
17966
17969
  "disabled": false,
17967
- "document": "Discount price of the prepaid product. Unit: CNY.",
17970
+ "document": "Discount price of the prepaid product. Unit: USD.",
17968
17971
  "example": "0.5",
17969
17972
  "member": "float",
17970
17973
  "name": "DiscountPrice",
17971
17974
  "output_required": true,
17972
17975
  "type": "float",
17973
- "value_allowed_null": true
17976
+ "value_allowed_null": false
17974
17977
  }
17975
17978
  ],
17976
17979
  "usage": "out"
@@ -21834,20 +21837,20 @@
21834
21837
  {
21835
21838
  "disabled": false,
21836
21839
  "document": "Instance price.",
21837
- "example": "null",
21840
+ "example": "{'UnitPrice': 0.58, 'ChargeUnit': 'HOUR', 'OriginalPrice': 0.58, 'DiscountPrice': 0.28}",
21838
21841
  "member": "ItemPrice",
21839
21842
  "name": "InstancePrice",
21840
- "required": false,
21843
+ "output_required": true,
21841
21844
  "type": "object",
21842
21845
  "value_allowed_null": false
21843
21846
  },
21844
21847
  {
21845
21848
  "disabled": false,
21846
21849
  "document": "Bandwidth price",
21847
- "example": "null",
21850
+ "example": "{'UnitPrice': 1, 'ChargeUnit': 'GB', 'OriginalPrice': 1.0, 'DiscountPrice': 0.46}",
21848
21851
  "member": "ItemPrice",
21849
21852
  "name": "BandwidthPrice",
21850
- "required": false,
21853
+ "output_required": true,
21851
21854
  "type": "object",
21852
21855
  "value_allowed_null": false
21853
21856
  }
@@ -1966,10 +1966,10 @@
1966
1966
  ],
1967
1967
  "InquiryPriceRenewVpnGateway": [
1968
1968
  {
1969
- "document": " ",
1970
- "input": "https://vpc.tencentcloudapi.com/?Action=InquiryPriceRenewVpnGateway\r\n&Version=2017-03-12\r\n&VpnGatewayId=vpngw-lazly92z\r\n&InstanceChargePrepaid.Period=2\r\n&<Common request parameters>",
1971
- "output": "{\n \"Response\": {\n \"Price\": {\n \"InstancePrice\": {\n \"OriginalPrice\": 760.0,\n \"DiscountPrice\": 760.0\n }\n },\n \"RequestId\": \"74883e1b-5901-46de-ae1e-d6e2cf591c5b\"\n }\n}",
1972
- "title": "Querying the price for renewing a monthly-subscribed gateway"
1969
+ "document": "This example shows you how to renew an annual/monthly subscription gateway and submit a gateway inquiry.",
1970
+ "input": "POST / HTTP/1.1\nHost: vpc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquiryPriceRenewVpnGateway\n<Common request parameters>\n\n{\n \"VpnGatewayId\": \"vpngw-abcxa123z\",\n \"InstanceChargePrepaid\": {\n \"Period\": 1,\n \"RenewFlag\": \"NOTIFY_AND_AUTO_RENEW\"\n }\n}",
1971
+ "output": "{\n \"Response\": {\n \"Price\": {\n \"InstancePrice\": {\n \"OriginalPrice\": 380.0,\n \"DiscountPrice\": 177.4,\n \"UnitPrice\": 0.0,\n \"ChargeUnit\": \"\"\n },\n \"BandwidthPrice\": {\n \"OriginalPrice\": 0.0,\n \"DiscountPrice\": 0.0,\n \"UnitPrice\": 0.0,\n \"ChargeUnit\": \"\"\n }\n },\n \"RequestId\": \"74883e1b-5901-46de-ae1e-d6e2cf591c5b\"\n }\n}",
1972
+ "title": "Monthly Subscription Gateway Renewal Gateway Inquiry Input"
1973
1973
  }
1974
1974
  ],
1975
1975
  "InquiryPriceResetVpnGatewayInternetMaxBandwidth": [
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tccli-intl-en
3
- Version: 3.0.1283.1
3
+ Version: 3.1.8.1
4
4
  Summary: Universal Command Line Environment for Tencent Cloud
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-cli-intl-en.git
6
6
  Author: Tencent Cloud
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: 3.4
21
21
  Classifier: Programming Language :: Python :: 3.5
22
22
  Classifier: Programming Language :: Python :: 3.6
23
23
  License-File: LICENSE
24
- Requires-Dist: tencentcloud-sdk-python-intl-en >=3.0.1283
24
+ Requires-Dist: tencentcloud-sdk-python-intl-en >=3.1.8
25
25
  Requires-Dist: jmespath ==0.10.0
26
26
  Requires-Dist: six ==1.16.0
27
27