tccli-intl-en 3.1.3.1__py2.py3-none-any.whl → 3.1.4.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.
- tccli/__init__.py +1 -1
- tccli/services/__init__.py +3 -0
- tccli/services/autoscaling/v20180419/api.json +36 -14
- tccli/services/clb/clb_client.py +636 -300
- tccli/services/clb/v20180317/api.json +1245 -367
- tccli/services/clb/v20180317/examples.json +172 -112
- tccli/services/faceid/v20180301/api.json +9 -0
- tccli/services/mongodb/mongodb_client.py +448 -0
- tccli/services/mongodb/v20190725/api.json +928 -103
- tccli/services/mongodb/v20190725/examples.json +64 -0
- tccli/services/ocr/v20181119/api.json +1 -1
- tccli/services/tdmq/tdmq_client.py +2406 -278
- tccli/services/tdmq/v20200217/api.json +11607 -3958
- tccli/services/tdmq/v20200217/examples.json +562 -264
- tccli/services/teo/v20220901/api.json +68 -4
- tccli/services/teo/v20220901/examples.json +28 -22
- tccli/services/trocket/__init__.py +4 -0
- tccli/services/trocket/trocket_client.py +2450 -0
- tccli/services/trocket/v20230308/api.json +6062 -0
- tccli/services/trocket/v20230308/examples.json +339 -0
- {tccli_intl_en-3.1.3.1.dist-info → tccli_intl_en-3.1.4.1.dist-info}/METADATA +2 -2
- {tccli_intl_en-3.1.3.1.dist-info → tccli_intl_en-3.1.4.1.dist-info}/RECORD +26 -22
- {tccli_intl_en-3.1.3.1.dist-info → tccli_intl_en-3.1.4.1.dist-info}/LICENSE +0 -0
- {tccli_intl_en-3.1.3.1.dist-info → tccli_intl_en-3.1.4.1.dist-info}/WHEEL +0 -0
- {tccli_intl_en-3.1.3.1.dist-info → tccli_intl_en-3.1.4.1.dist-info}/entry_points.txt +0 -0
- {tccli_intl_en-3.1.3.1.dist-info → tccli_intl_en-3.1.4.1.dist-info}/top_level.txt +0 -0
|
@@ -4,16 +4,16 @@
|
|
|
4
4
|
{
|
|
5
5
|
"document": " ",
|
|
6
6
|
"input": "https://tdmq.tencentcloudapi.com/?Action=AcknowledgeMessage\n&AckTopic=tenant/namespace/topic\n&MessageId=\"71:12:0\"\n&SubName=\"test-sub\"\n&<Common request parameters>",
|
|
7
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\",\n \"ErrorMsg\": \"
|
|
8
|
-
"title": "
|
|
7
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\",\n \"ErrorMsg\": \"ack error\"\n }\n}",
|
|
8
|
+
"title": "Acknowledge Message"
|
|
9
9
|
}
|
|
10
10
|
],
|
|
11
11
|
"ClearCmqQueue": [
|
|
12
12
|
{
|
|
13
13
|
"document": " ",
|
|
14
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=ClearCmqQueue\n&QueueName=test\n&<Common request parameters>",
|
|
14
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=ClearCmqQueue\n&QueueName=test-queue\n&<Common request parameters>",
|
|
15
15
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
16
|
-
"title": "Clearing
|
|
16
|
+
"title": "Clearing Accumulated Messages in Queue"
|
|
17
17
|
}
|
|
18
18
|
],
|
|
19
19
|
"ClearCmqSubscriptionFilterTags": [
|
|
@@ -27,23 +27,17 @@
|
|
|
27
27
|
"CreateCluster": [
|
|
28
28
|
{
|
|
29
29
|
"document": " ",
|
|
30
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=CreateCluster\n&ClusterName=
|
|
30
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=CreateCluster\n&ClusterName=devName\n&<Common request parameters>",
|
|
31
31
|
"output": "{\n \"Response\": {\n \"ClusterId\": \"pulsar-5r59xd4vnx\",\n \"RequestId\": \"c1e66353-c87b-4a30-804d-94c6c2c8bac5\"\n }\n}",
|
|
32
|
-
"title": "Creating
|
|
32
|
+
"title": "Creating a Cluster"
|
|
33
33
|
}
|
|
34
34
|
],
|
|
35
35
|
"CreateCmqQueue": [
|
|
36
|
-
{
|
|
37
|
-
"document": "This example shows you how to create a queue.",
|
|
38
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCmqQueue\n<Common request parameters>\n\n{\n \"QueueName\": \"test\"\n}",
|
|
39
|
-
"output": "{\n \"Response\": {\n \"QueueId\": \"queue-ges05csc\",\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
40
|
-
"title": "Creating a queue"
|
|
41
|
-
},
|
|
42
36
|
{
|
|
43
37
|
"document": "This example shows you how to create a queue.",
|
|
44
38
|
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCmqQueue\n<Common request parameters>\n\n{\n \"QueueName\": \"test789\"\n}",
|
|
45
39
|
"output": "{\n \"Response\": {\n \"RequestId\": \"864b1295-ed7e-45ed-9602-be53ac23177b\",\n \"QueueId\": \"cmqq-rd42drdeaag9\"\n }\n}",
|
|
46
|
-
"title": "
|
|
40
|
+
"title": "Example"
|
|
47
41
|
}
|
|
48
42
|
],
|
|
49
43
|
"CreateCmqSubscribe": [
|
|
@@ -57,127 +51,167 @@
|
|
|
57
51
|
"CreateCmqTopic": [
|
|
58
52
|
{
|
|
59
53
|
"document": " ",
|
|
60
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCmqTopic\n<Common request parameters>\n\n{\n \"TopicName\": \"
|
|
61
|
-
"output": "{\n \"Response\": {\n \"
|
|
62
|
-
"title": "
|
|
54
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCmqTopic\n<Common request parameters>\n\n{\n \"TopicName\": \"testtopic\"\n}",
|
|
55
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"ae412902-bb35-4237-955d-3e1f9901e0cc\",\n \"TopicId\": \"cmqt-7jwedr3jqb54\"\n }\n}",
|
|
56
|
+
"title": "Example"
|
|
63
57
|
},
|
|
64
58
|
{
|
|
65
59
|
"document": " ",
|
|
66
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCmqTopic\n<Common request parameters>\n\n{\n \"TopicName\": \"
|
|
67
|
-
"output": "{\n \"Response\": {\n \"
|
|
68
|
-
"title": "
|
|
60
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCmqTopic\n<Common request parameters>\n\n{\n \"TopicName\": \"ConnTopic\"\n}",
|
|
61
|
+
"output": "{\n \"Response\": {\n \"TopicId\": \"topic-gzz05csc\",\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
62
|
+
"title": "Create topics."
|
|
69
63
|
}
|
|
70
64
|
],
|
|
71
65
|
"CreateEnvironment": [
|
|
72
66
|
{
|
|
73
|
-
"document": "This example shows you how to
|
|
74
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateEnvironment\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"
|
|
75
|
-
"output": "{\n \"Response\": {\n \"EnvironmentId\": \"
|
|
76
|
-
"title": "Creating a
|
|
67
|
+
"document": "This example shows you how to check whether auto subscription creation is enabled.",
|
|
68
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateEnvironment\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNamespace\",\n \"MsgTTL\": \"100\",\n \"AutoSubscriptionCreation\": true,\n \"ClusterId\": \"pulsar-b843bz38z5mz\"\n}",
|
|
69
|
+
"output": "{\n \"Response\": {\n \"EnvironmentId\": \"devNamespace\",\n \"NamespaceId\": \"namespace-8893gp3428\",\n \"MsgTTL\": 100,\n \"Remark\": \"devRemark\",\n \"RequestId\": \"0843ea4f-d6ba-463b-952c-75708a7e8901\"\n }\n}",
|
|
70
|
+
"title": "Creating a Namespace"
|
|
77
71
|
}
|
|
78
72
|
],
|
|
79
73
|
"CreateEnvironmentRole": [
|
|
80
74
|
{
|
|
81
75
|
"document": " ",
|
|
82
|
-
"input": "
|
|
83
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
84
|
-
"title": "Creating
|
|
76
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateEnvironmentRole\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devDemo\",\n \"RoleName\": \"role1\",\n \"Permissions\": [\n \"produce\"\n ],\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\"\n}",
|
|
77
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
78
|
+
"title": "Creating Environment Role Relationship Mapping"
|
|
79
|
+
}
|
|
80
|
+
],
|
|
81
|
+
"CreateProCluster": [
|
|
82
|
+
{
|
|
83
|
+
"document": "This example shows you how to create a professional cluster using only api invocation.",
|
|
84
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProCluster\n<Common request parameters>\n\n{\n \"ZoneIds\": [\n 200002,\n 200003,\n 200004\n ],\n \"ProductName\": \"devTest\",\n \"StorageSize\": 0,\n \"AutoRenewFlag\": 0,\n \"TimeSpan\": 0,\n \"Vpc\": {\n \"VpcId\": \"vpc-8jiausye\",\n \"SubnetId\": \"subnet-1iuyhzke\"\n },\n \"Tags\": [\n {\n \"TagKey\": \"devTag\",\n \"TagValue\": \"dev\"\n }\n ],\n \"ClusterName\": \"devTest\",\n \"AutoVoucher\": 0\n}",
|
|
85
|
+
"output": "{\n \"Response\": {\n \"DealName\": \"202403206137826783502561 \",\n \"BigDealId\": \"202403206137826783502561 \",\n \"ClusterId\": \"pulsar-x4r939zkwmm2\",\n \"ClusterName\": \"devTest\",\n \"RequestId\": \"0799dd77-707b-40d7-a4b5-4140b11f6c97\"\n }\n}",
|
|
86
|
+
"title": "Creating a Professional Cluster"
|
|
87
|
+
}
|
|
88
|
+
],
|
|
89
|
+
"CreateRabbitMQBinding": [
|
|
90
|
+
{
|
|
91
|
+
"document": " ",
|
|
92
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRabbitMQBinding\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"VirtualHost\": \"testVhost\",\n \"Source\": \"amq.direct\",\n \"DestinationType\": \"queue\",\n \"Destination\": \"prod.queue\",\n \"RoutingKey\": \"permission.created\"\n}",
|
|
93
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"VirtualHost\": \"testVhost\",\n \"BindingId\": 127441\n }\n}",
|
|
94
|
+
"title": "This API is used to create a TDMQ for RabbitMQ routing relationship."
|
|
85
95
|
}
|
|
86
96
|
],
|
|
87
97
|
"CreateRabbitMQUser": [
|
|
88
98
|
{
|
|
89
|
-
"document": "
|
|
90
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQUser\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-
|
|
91
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
92
|
-
"title": "Creating a
|
|
99
|
+
"document": "This example shows you how to create a TDMQ for RabbitMQ user.",
|
|
100
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQUser\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"User\": \"test_user\",\n \"Password\": \"abc123._\"\n}",
|
|
101
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"User\": \"test_user\"\n }\n}",
|
|
102
|
+
"title": "Creating a RabbitMQ User"
|
|
93
103
|
}
|
|
94
104
|
],
|
|
95
105
|
"CreateRabbitMQVipInstance": [
|
|
96
106
|
{
|
|
97
|
-
"document": "This example shows you how to create a
|
|
98
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRabbitMQVipInstance\n<Common request parameters>\n\n{\n \"ZoneIds\": [\n 190001\n ],\n \"NodeSpec\": \"rabbit-vip-basic-2\",\n \"NodeNum\": 1,\n \"StorageSize\": 100,\n \"VpcId\": \"vpc-
|
|
99
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
100
|
-
"title": "Creating a
|
|
107
|
+
"document": "This example shows you how to create a managed version instance of RabbitMQ.",
|
|
108
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRabbitMQVipInstance\n<Common request parameters>\n\n{\n \"ZoneIds\": [\n 190001\n ],\n \"NodeSpec\": \"rabbit-vip-basic-2\",\n \"NodeNum\": 1,\n \"StorageSize\": 100,\n \"VpcId\": \"vpc-5ghsr4p9\",\n \"SubnetId\": \"subnet-67y9wil4\",\n \"ClusterName\": \"ApiCreate\",\n \"EnableCreateDefaultHaMirrorQueue\": false\n}",
|
|
109
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"TranId\": \"20230110002025620411234\",\n \"InstanceId\": \"amqp-jero744g\"\n }\n}",
|
|
110
|
+
"title": "Creating a RabbitMQ Managed Instance"
|
|
101
111
|
}
|
|
102
112
|
],
|
|
103
113
|
"CreateRabbitMQVirtualHost": [
|
|
104
114
|
{
|
|
105
|
-
"document": "
|
|
106
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRabbitMQVirtualHost\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-
|
|
107
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
108
|
-
"title": "
|
|
115
|
+
"document": "This example shows you how to create a TDMQ for RabbitMQ vhost.",
|
|
116
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRabbitMQVirtualHost\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-test\",\n \"VirtualHost\": \"testVhost\",\n \"Description\": \"hello\"\n}",
|
|
117
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"VirtualHost\": \"testVhost\"\n }\n}",
|
|
118
|
+
"title": "This API is used to create a TDMQ for RabbitMQ vhost."
|
|
109
119
|
}
|
|
110
120
|
],
|
|
111
121
|
"CreateRocketMQCluster": [
|
|
112
122
|
{
|
|
113
123
|
"document": " ",
|
|
114
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQCluster\n<Common request parameters>\n\n{\n \"Remark\": \"remark\",\n \"Name\": \"
|
|
115
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"8841a73b-b002-4e92-a76b-123b12cfa9c1\",\n \"ClusterId\": \"
|
|
116
|
-
"title": "Creating a
|
|
124
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQCluster\n<Common request parameters>\n\n{\n \"Remark\": \"remark info\",\n \"Name\": \"test_name\"\n}",
|
|
125
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"8841a73b-b002-4e92-a76b-123b12cfa9c1\",\n \"ClusterId\": \"rocketmq-a52qova7x97b\"\n }\n}",
|
|
126
|
+
"title": "Creating a Cluster"
|
|
127
|
+
}
|
|
128
|
+
],
|
|
129
|
+
"CreateRocketMQEnvironmentRole": [
|
|
130
|
+
{
|
|
131
|
+
"document": "",
|
|
132
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQEnvironmentRole\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"test_namespace\",\n \"RoleName\": \"test_role_name\",\n \"Permissions\": [\n \"produce\"\n ],\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\"\n}",
|
|
133
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
134
|
+
"title": "Creating RocketMQ Environment Role Authorization"
|
|
117
135
|
}
|
|
118
136
|
],
|
|
119
137
|
"CreateRocketMQGroup": [
|
|
120
138
|
{
|
|
121
139
|
"document": " ",
|
|
122
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQGroup\n<Common request parameters>\n\n{\n
|
|
140
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQGroup\n<Common request parameters>\n\n{\n\"Remark\": \"Test creation\"\n \"BroadcastEnable\": \"false\",\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"RetryMaxTimes\": \"16\",\n \"Namespaces\": [\n \"test_namespace\"\n ],\n \"ReadEnable\": \"true\",\n \"GroupType\": \"TCP\",\n \"GroupId\": \"test_group\"\n}",
|
|
123
141
|
"output": "{\n \"Response\": {\n \"RequestId\": \"0604a303-6d5f-40e6-9dfe-6c4ddd8fe2df\"\n }\n}",
|
|
124
|
-
"title": "Creating a
|
|
142
|
+
"title": "Creating a Subscription Group"
|
|
125
143
|
}
|
|
126
144
|
],
|
|
127
145
|
"CreateRocketMQNamespace": [
|
|
128
146
|
{
|
|
129
147
|
"document": "This example shows you how to create a namespace.",
|
|
130
|
-
"input": "
|
|
148
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQNamespace\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"NamespaceId\": \"test_namespace\",\n \"Ttl\": 259200000,\n \"RetentionTime\": 259200000,\n \"Remark\": \"Test namespace\"\n}",
|
|
131
149
|
"output": "{\n \"Response\": {\n \"RequestId\": \"bf71e2ae-8b56-4231-87cf-0cbb6f421caa\"\n }\n}",
|
|
132
|
-
"title": "Creating a
|
|
150
|
+
"title": "Creating a Namespace"
|
|
151
|
+
}
|
|
152
|
+
],
|
|
153
|
+
"CreateRocketMQRole": [
|
|
154
|
+
{
|
|
155
|
+
"document": "",
|
|
156
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQRole\n<Common request parameters>\n\n{\n \"RoleName\": \"test_role_name\",\n \"Remark\": \"Test role\",\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\"\n}",
|
|
157
|
+
"output": "{\n \"Response\": {\n \"RoleName\": \"test_role_name\",\n \"Token\": \"eyJrZXlJZCI6InN1bmdvxxxxx0X3JvbGVfMyJ9.dbHR8m6gc4L4vZUrodhW_O9bDulZQ6lraNswNLtcUcY\",\n \"Remark\": \"Test role\",\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
158
|
+
"title": "Creating a Role"
|
|
133
159
|
}
|
|
134
160
|
],
|
|
135
161
|
"CreateRocketMQTopic": [
|
|
136
162
|
{
|
|
137
|
-
"document": "
|
|
138
|
-
"input": "
|
|
163
|
+
"document": "Create topics.",
|
|
164
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQTopic\n<Common request parameters>\n\n{\n \"Topic\": \"test_topic\",\n \"Namespaces\": [\n \"test_namespace\"\n ],\n \"Type\": \"Normal\",\n \"ClusterId\": \"rocketmq-xj8kr5apevj7\",\n \"Remark\": \"Test topic\",\n \"PartitionNum\": 3\n}",
|
|
139
165
|
"output": "{\n \"Response\": {\n \"RequestId\": \"f844f173-93ed-4d89-979e-86e4e1d63b8a\"\n }\n}",
|
|
140
|
-
"title": "
|
|
166
|
+
"title": "Create topics."
|
|
167
|
+
}
|
|
168
|
+
],
|
|
169
|
+
"CreateRocketMQVipInstance": [
|
|
170
|
+
{
|
|
171
|
+
"document": "This example shows you how to purchase a RocketMQ dedicated instance.",
|
|
172
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRocketMQVipInstance\n<Common request parameters>\n\n{\n \"Name\": \"test_instance\",\n \"Spec\": \"rocket-vip-basic-1\",\n \"NodeCount\": 2,\n \"StorageSize\": 200,\n \"ZoneIds\": [\n \"100001\",\n \"100002\"\n ],\n \"VpcInfo\": {\n \"VpcId\": \"vpc-9dlrd5h1\",\n \"SubnetId\": \"subnet-jadmas\"\n },\n \"TimeSpan\": 1\n}",
|
|
173
|
+
"output": "{\n \"Response\": {\n \"ClusterId\": \"rocketmq-7drjznvjqzee\",\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
174
|
+
"title": "Purchasing a RocketMQ Dedicated Instance"
|
|
141
175
|
}
|
|
142
176
|
],
|
|
143
177
|
"CreateRole": [
|
|
144
178
|
{
|
|
145
179
|
"document": "This example shows you how to create a role.",
|
|
146
|
-
"input": "
|
|
147
|
-
"output": "{\n \"Response\": {\n \"RoleName\": \"
|
|
148
|
-
"title": "Creating a
|
|
180
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRole\n<Common request parameters>\n\n{\n \"RoleName\": \"devName\",\n \"Remark\": \"devRemark\",\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\"\n}",
|
|
181
|
+
"output": "{\n \"Response\": {\n \"RoleName\": \"devName\",\n \"Token\": \"ajdsaiuasdnmasllamm\",\n \"Remark\": \"devRemark\",\n \"EnvironmentRoleSets\": [\n {\n \"EnvironmentId\": \"devNs\",\n \"Permissions\": [\n \"produce\"\n ]\n }\n ],\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
182
|
+
"title": "Creating a Role"
|
|
149
183
|
}
|
|
150
184
|
],
|
|
151
185
|
"CreateSubscription": [
|
|
152
186
|
{
|
|
153
187
|
"document": " ",
|
|
154
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSubscription\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"
|
|
188
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSubscription\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\",\n \"SubscriptionName\": \"devSub\",\n \"Remark\": \"devTest\",\n \"IsIdempotent\": true,\n \"ClusterId\": \"pulsar-5r59xd4vnx\",\n \"AutoCreatePolicyTopic\": true,\n \"PostFixPattern\": \"LEGACY\"\n}",
|
|
155
189
|
"output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"15288803-dadb-4499-9b5b-ff2f631ca68e\"\n }\n}",
|
|
156
|
-
"title": "
|
|
190
|
+
"title": "Create subscription relationship"
|
|
157
191
|
}
|
|
158
192
|
],
|
|
159
193
|
"CreateTopic": [
|
|
160
194
|
{
|
|
161
|
-
"document": "
|
|
162
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateTopic\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"
|
|
163
|
-
"output": "{\n \"Response\": {\n \"EnvironmentId\": \"default\",\n \"TopicName\": \"test_topic\",\n \"Partitions\": 2,\n \"TopicType\": 0,\n
|
|
164
|
-
"title": "
|
|
195
|
+
"document": "Create topics.",
|
|
196
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateTopic\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\",\n \"Partitions\": 1,\n \"Remark\": \"devTest\",\n \"TopicType\": 1,\n \"ClusterId\": \"pulsar-5r59xd4vnx\",\n \"PulsarTopicType\": 0,\n \"MsgTTL\": 1\n}",
|
|
197
|
+
"output": "{\n \"Response\": {\n \"EnvironmentId\": \"default\",\n \"TopicName\": \"test_topic\",\n \"Partitions\": 2,\n \"TopicType\": 0,\n\"Remark\": \"Ordinary message queue with 2 partitions\"\n \"RequestId\": \"d9686bf9-8d7d-4e78-bb44-5140d70a1ffa\"\n }\n}",
|
|
198
|
+
"title": "Create topics."
|
|
165
199
|
}
|
|
166
200
|
],
|
|
167
201
|
"DeleteCluster": [
|
|
168
202
|
{
|
|
169
203
|
"document": " ",
|
|
170
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=DeleteCluster\n&ClusterId=pulsar-
|
|
204
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DeleteCluster\n&ClusterId=pulsar-5r59xd4vnx\n&<Common request parameters>",
|
|
171
205
|
"output": "{\n \"Response\": {\n \"ClusterId\": \"pulsar-5r59xd4vnx\",\n \"RequestId\": \"0f368d07-3648-4546-9c51-65dad19a3234\"\n }\n}",
|
|
172
|
-
"title": "Deleting cluster"
|
|
206
|
+
"title": "Deleting a cluster"
|
|
173
207
|
}
|
|
174
208
|
],
|
|
175
209
|
"DeleteCmqQueue": [
|
|
176
210
|
{
|
|
177
211
|
"document": " ",
|
|
178
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=DeleteCmqQueue\n&QueueName=
|
|
212
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DeleteCmqQueue\n&QueueName=testQueue\n&<Common request parameters>",
|
|
179
213
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
180
|
-
"title": "Deleting a
|
|
214
|
+
"title": "Deleting a Queue"
|
|
181
215
|
}
|
|
182
216
|
],
|
|
183
217
|
"DeleteCmqSubscribe": [
|
|
@@ -199,41 +233,65 @@
|
|
|
199
233
|
"DeleteEnvironmentRoles": [
|
|
200
234
|
{
|
|
201
235
|
"document": " ",
|
|
202
|
-
"input": "
|
|
203
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
204
|
-
"title": "
|
|
236
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteEnvironmentRoles\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"RoleNames\": [\n \"role1\"\n ],\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\"\n}",
|
|
237
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
238
|
+
"title": "Delete Environment Role Authorization"
|
|
205
239
|
}
|
|
206
240
|
],
|
|
207
241
|
"DeleteEnvironments": [
|
|
208
242
|
{
|
|
209
243
|
"document": " ",
|
|
210
|
-
"input": "
|
|
244
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteEnvironments\n<Common request parameters>\n\n{\n \"EnvironmentIds\": [\n \"devNs\"\n ],\n \"ClusterId\": \"pulsar-5r59xd4vnx\"\n}",
|
|
211
245
|
"output": "{\n \"Response\": {\n \"EnvironmentIds\": [\n \"test1\"\n ],\n \"RequestId\": \"db8bd520-496e-4e7c-a4a1-e7414d3c315c\"\n }\n}",
|
|
212
|
-
"title": "Deleting a
|
|
246
|
+
"title": "Deleting a Namespace"
|
|
247
|
+
}
|
|
248
|
+
],
|
|
249
|
+
"DeleteProCluster": [
|
|
250
|
+
{
|
|
251
|
+
"document": "This example shows you how to delete a professional cluster.",
|
|
252
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteProCluster\n<Common request parameters>\n\n{\n \"ClusterId\": \"pulsar-pnvjp9mbd947\"\n}",
|
|
253
|
+
"output": "{\n \"Response\": {\n \"DealName\": \"20231020394041338776131\",\n \"RequestId\": \"722558eb-36dc-4643-854f-aa7436b83125\"\n }\n}",
|
|
254
|
+
"title": "Deleting a Professional Cluster"
|
|
255
|
+
}
|
|
256
|
+
],
|
|
257
|
+
"DeleteRabbitMQBinding": [
|
|
258
|
+
{
|
|
259
|
+
"document": " ",
|
|
260
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRabbitMQBinding\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-jero744g\",\n \"VirtualHost\": \"testVhost\",\n \"BindingId\": 127441\n}",
|
|
261
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"InstanceId\": \"amqp-jero744g\",\n \"VirtualHost\": \"testVhost\",\n \"BindingId\": 127441\n }\n}",
|
|
262
|
+
"title": "This API is used to unbind a TDMQ for RabbitMQ routing relationship."
|
|
263
|
+
}
|
|
264
|
+
],
|
|
265
|
+
"DeleteRabbitMQPermission": [
|
|
266
|
+
{
|
|
267
|
+
"document": "-",
|
|
268
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQVhost\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"User\": \"admin\",\n \"VirtualHost\": \"testVhost\"\n}",
|
|
269
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"b7bd149f-06e1-40ad-82cb-9f0500b5194c\"\n }\n}",
|
|
270
|
+
"title": "Deleting RabbitMQ Permissions"
|
|
213
271
|
}
|
|
214
272
|
],
|
|
215
273
|
"DeleteRabbitMQUser": [
|
|
216
274
|
{
|
|
217
|
-
"document": "
|
|
218
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRabbitMQUser\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-
|
|
219
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
220
|
-
"title": "Deleting a
|
|
275
|
+
"document": "This example shows you how to delete a TDMQ for RabbitMQ user.",
|
|
276
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRabbitMQUser\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"User\": \"test-user\"\n}",
|
|
277
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
278
|
+
"title": "Deleting a RabbitMQ User"
|
|
221
279
|
}
|
|
222
280
|
],
|
|
223
281
|
"DeleteRabbitMQVipInstance": [
|
|
224
282
|
{
|
|
225
|
-
"document": "
|
|
226
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRabbitMQVipInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-
|
|
227
|
-
"output": "{\n \"Response\": {\n \"TranId\": \"
|
|
228
|
-
"title": "
|
|
283
|
+
"document": "",
|
|
284
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRabbitMQVipInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\"\n}",
|
|
285
|
+
"output": "{\n \"Response\": {\n \"TranId\": \"20230110002025620411234\",\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
286
|
+
"title": "Deleting a RabbitMQ Managed Version Instance"
|
|
229
287
|
}
|
|
230
288
|
],
|
|
231
289
|
"DeleteRabbitMQVirtualHost": [
|
|
232
290
|
{
|
|
233
|
-
"document": "
|
|
234
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRabbitMQVirtualHost\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-
|
|
235
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
236
|
-
"title": "
|
|
291
|
+
"document": "This example shows you how to delete a TDMQ for RabbitMQ vhost.",
|
|
292
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRabbitMQVirtualHost\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"VirtualHost\": \"testVhost\"\n}",
|
|
293
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
294
|
+
"title": "This API is used to delete a TDMQ for RabbitMQ vhost."
|
|
237
295
|
}
|
|
238
296
|
],
|
|
239
297
|
"DeleteRocketMQCluster": [
|
|
@@ -244,36 +302,60 @@
|
|
|
244
302
|
"title": "Deleting a cluster"
|
|
245
303
|
}
|
|
246
304
|
],
|
|
305
|
+
"DeleteRocketMQEnvironmentRoles": [
|
|
306
|
+
{
|
|
307
|
+
"document": "",
|
|
308
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRocketMQEnvironmentRoles\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"test_namespace\",\n \"RoleNames\": [\n \"test_role_name\"\n ],\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\"\n}",
|
|
309
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
310
|
+
"title": "Deleting Environment Role Authorization"
|
|
311
|
+
}
|
|
312
|
+
],
|
|
247
313
|
"DeleteRocketMQGroup": [
|
|
248
314
|
{
|
|
249
|
-
"document": " ",
|
|
250
|
-
"input": "
|
|
315
|
+
"document": "https://tdmq.tencentcloudapi.com/?\nAction=DeleteRocketMQGroup\n&ClusterId=\n&NamespaceId=example\n&GroupId=group-example\n&<Common request parameters>",
|
|
316
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRocketMQGroup\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"NamespaceId\": \"test_namespace\",\n \"GroupId\": \"test_group\"\n}",
|
|
251
317
|
"output": "{\n \"Response\": {\n \"RequestId\": \"7fb7d925-a5c7-4b8c-add5-8477917a6260\"\n }\n}",
|
|
252
|
-
"title": "
|
|
318
|
+
"title": "Delete Subscription Group"
|
|
253
319
|
}
|
|
254
320
|
],
|
|
255
321
|
"DeleteRocketMQNamespace": [
|
|
256
322
|
{
|
|
257
323
|
"document": " ",
|
|
258
|
-
"input": "
|
|
324
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRocketMQNamespace\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-rd3545bkkj43\",\n \"NamespaceId\": \"test_namespace\"\n}",
|
|
259
325
|
"output": "{\n \"Response\": {\n \"RequestId\": \"ab274271-a599-4e1d-b044-f3d03699e32a\"\n }\n}",
|
|
260
|
-
"title": "Deleting
|
|
326
|
+
"title": "Deleting a Namespace"
|
|
327
|
+
}
|
|
328
|
+
],
|
|
329
|
+
"DeleteRocketMQRoles": [
|
|
330
|
+
{
|
|
331
|
+
"document": "",
|
|
332
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRocketMQRoles\n<Common request parameters>\n\n{\n \"RoleNames\": [\n \"test_role_name\"\n ],\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\"\n}",
|
|
333
|
+
"output": "{\n \"Response\": {\n \"RoleNames\": [\n \"test_role_name\"\n ],\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
334
|
+
"title": "Deleting a Role"
|
|
261
335
|
}
|
|
262
336
|
],
|
|
263
337
|
"DeleteRocketMQTopic": [
|
|
264
338
|
{
|
|
265
339
|
"document": " ",
|
|
266
|
-
"input": "
|
|
340
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRocketMQTopic\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"NamespaceId\": \"test_namespace\",\n \"Topic\": \"test_topic\"\n}",
|
|
267
341
|
"output": "{\n \"Response\": {\n \"RequestId\": \"5d41e0f7-5668-46f9-a549-9a7540a9966c\"\n }\n}",
|
|
268
|
-
"title": "Deleting
|
|
342
|
+
"title": "Deleting a Topic"
|
|
343
|
+
}
|
|
344
|
+
],
|
|
345
|
+
"DeleteRocketMQVipInstance": [
|
|
346
|
+
{
|
|
347
|
+
"document": "This example shows you how to terminate clusters.",
|
|
348
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRocketMQVipInstance\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-ajknm838qzg4\"\n}",
|
|
349
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"70975bd2-1f19-4103-8f65-eca79dea24d6\"\n }\n}",
|
|
350
|
+
"title": "Terminating Clusters"
|
|
269
351
|
}
|
|
270
352
|
],
|
|
271
353
|
"DeleteRoles": [
|
|
272
354
|
{
|
|
273
355
|
"document": " ",
|
|
274
|
-
"input": "
|
|
275
|
-
"output": "{\n \"Response\": {\n \"RoleNames\": [\n \"test_role_1\"
|
|
276
|
-
"title": "Deleting
|
|
356
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRoles\n<Common request parameters>\n\n{\n \"RoleNames\": [\n \"test_role_1\"\n ],\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\"\n}",
|
|
357
|
+
"output": "{\n \"Response\": {\n \"RoleNames\": [\n \"test_role_1\"\n ],\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
358
|
+
"title": "Deleting a Role"
|
|
277
359
|
}
|
|
278
360
|
],
|
|
279
361
|
"DeleteSubscriptions": [
|
|
@@ -287,65 +369,57 @@
|
|
|
287
369
|
"DeleteTopics": [
|
|
288
370
|
{
|
|
289
371
|
"document": " ",
|
|
290
|
-
"input": "
|
|
372
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteTopics\n<Common request parameters>\n\n{\n \"TopicSets\": [\n {\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\"\n }\n ],\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\",\n \"EnvironmentId\": \"devNs\",\n \"Force\": true\n}",
|
|
291
373
|
"output": "{\n \"Response\": {\n \"TopicSets\": [\n {\n \"EnvironmentId\": \"default\",\n \"TopicName\": \"cloud_test_1\"\n }\n ],\n \"RequestId\": \"5f4eabe4-94f2-4f91-8285-86f24ef8bcfa\"\n }\n}",
|
|
292
|
-
"title": "Deleting a
|
|
374
|
+
"title": "Deleting a Topic List"
|
|
293
375
|
}
|
|
294
376
|
],
|
|
295
377
|
"DescribeBindClusters": [
|
|
296
378
|
{
|
|
297
379
|
"document": " ",
|
|
298
380
|
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeBindClusters\n&<Common request parameters>",
|
|
299
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ClusterSet\": [\n {\n \"ClusterName\": \"
|
|
300
|
-
"title": "
|
|
381
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ClusterSet\": [\n {\n \"ClusterName\": \"devCluster\"\n }\n ],\n \"RequestId\": \"32a34a4c-58a8-445f-80ff-7152399b18f7\"\n }\n}",
|
|
382
|
+
"title": "Obtains the list of exclusive clusters bound to a user"
|
|
301
383
|
}
|
|
302
384
|
],
|
|
303
385
|
"DescribeBindVpcs": [
|
|
304
386
|
{
|
|
305
387
|
"document": " ",
|
|
306
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeBindVpcs\n&ClusterId=pulsar-
|
|
307
|
-
"output": "{\n \"Response\": {\n \"VpcSets\": [\n {\n \"UniqueVpcId\": \"vpc-c96rbu5r\",\n \"UniqueSubnetId\": \"subnet-hiqrqjp6\",\n \"RouterId\": \"pulsar-
|
|
308
|
-
"title": "
|
|
388
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeBindVpcs\n&ClusterId=pulsar-xk3ne8k2qkp8\n&<Common request parameters>",
|
|
389
|
+
"output": "{\n \"Response\": {\n \"VpcSets\": [\n {\n \"UniqueVpcId\": \"vpc-c96rbu5r\",\n \"UniqueSubnetId\": \"subnet-hiqrqjp6\",\n \"RouterId\": \"pulsar-xk3ne8k2qkp8/vpc-c96rbu5r/subnet-hiqrqjp6\",\n \"Ip\": \"192.168.0.1\",\n \"Port\": 6000,\n \"Remark\": \"devRemark\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"b9765efb-62dd-4946-b2bd-61e958c0f7a7\"\n }\n}",
|
|
390
|
+
"title": "Obtains the binding relationship between the tenant and VPC"
|
|
309
391
|
}
|
|
310
392
|
],
|
|
311
393
|
"DescribeClusterDetail": [
|
|
312
394
|
{
|
|
313
395
|
"document": " ",
|
|
314
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeClusterDetail\n&ClusterId=pulsar-
|
|
315
|
-
"output": "{\n \"Response\": {\n \"ClusterSet\": {\n \"ClusterId\": \"pulsar-
|
|
316
|
-
"title": "
|
|
396
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeClusterDetail\n&ClusterId=pulsar-47emajuekabz\n&<Common request parameters>",
|
|
397
|
+
"output": "{\n \"Response\": {\n \"ClusterSet\": {\n \"ClusterId\": \"pulsar-47emajuekabz\",\n \"ClusterName\": \"devName\",\n \"Remark\": \"devRemark\",\n \"EndPointNum\": 0,\n \"HealthyInfo\": \"healthy\",\n \"CreateTime\": \"2023-07-20 10:35:17\",\n \"Healthy\": 1,\n \"Status\": 0,\n \"MaxNamespaceNum\": 0,\n \"MaxTopicNum\": 0,\n \"MaxQps\": 0,\n \"MessageRetentionTime\": 0,\n \"MaxStorageCapacity\": 0,\n \"Version\": \"2.9.2\",\n \"PublicEndPoint\": null,\n \"VpcEndPoint\": null,\n \"NamespaceNum\": 0,\n \"UsedStorageBudget\": 0,\n \"MaxPublishRateInMessages\": 0,\n \"MaxDispatchRateInMessages\": 0,\n \"MaxPublishRateInBytes\": 0,\n \"MaxDispatchRateInBytes\": 0,\n \"TopicNum\": 0,\n \"MaxMessageDelayInSeconds\": 0,\n \"PublicAccessEnabled\": true,\n \"Tags\": [\n {\n \"TagKey\": \"pulsarTag\",\n \"TagValue\": \"dev\"\n }\n ],\n \"PayMode\": 0,\n \"ProjectId\": 0,\n \"ProjectName\": \"dev\"\n },\n \"RequestId\": \"5d6c7091-e82c-4a9c-a18f-34d5fc460iuu\"\n }\n}",
|
|
398
|
+
"title": "Obtains detailed cluster information"
|
|
317
399
|
}
|
|
318
400
|
],
|
|
319
401
|
"DescribeClusters": [
|
|
320
402
|
{
|
|
321
403
|
"document": " ",
|
|
322
404
|
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeClusters\n&<Common request parameters>",
|
|
323
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ClusterSet\": [\n {\n \"MaxQps\": 10000,\n \"HealthyInfo\": \"
|
|
324
|
-
"title": "
|
|
325
|
-
}
|
|
326
|
-
],
|
|
327
|
-
"DescribeCmqDeadLetterSourceQueues": [
|
|
328
|
-
{
|
|
329
|
-
"document": " ",
|
|
330
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeCmqDeadLetterSourceQueues\n&DeadLetterQueueName=test123\n&<Common request parameters>",
|
|
331
|
-
"output": "{\n \"Response\": {\n \"QueueSet\": [\n {\n \"QueueName\": \"test\",\n \"QueueId\": \"queue-kc7m75to\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"83fce81a-7305-49b4-a154-983dd76204da\"\n }\n}",
|
|
332
|
-
"title": "Enumerating the source queues of dead letter queue"
|
|
405
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ClusterSet\": [\n {\n \"MaxQps\": 10000,\n \"HealthyInfo\": \"ok\",\n \"MaxTopicNum\": 1000,\n \"MaxStorageCapacity\": 100,\n \"MaxMessageDelayInSeconds\": 0,\n \"Version\": \"v1\",\n \"Status\": 1,\n \"Tags\": [\n {\n \"TagKey\": \"tag1\",\n \"TagValue\": \"value1\"\n }\n ],\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\",\n \"PayMode\": 0,\n \"EndPointNum\": 0,\n \"Healthy\": 1,\n \"TopicNum\": 0,\n \"Remark\": \"beizhu\",\n \"NamespaceNum\": 0,\n \"PublicEndPoint\": \"http://mq.public.endpoint\",\n \"MaxPublishRateInBytes\": 0,\n \"VpcEndPoint\": \"http://mq.tencent.vpc.end.point\",\n \"MaxDispatchRateInBytes\": 0,\n \"PublicAccessEnabled\": true,\n \"ClusterName\": \"mq-cluster\",\n \"MaxPublishRateInMessages\": 0,\n \"UsedStorageBudget\": 0,\n \"MessageRetentionTime\": 86400,\n \"MaxNamespaceNum\": 10,\n \"CreateTime\": \"2024-10-08 11:38:48,068\",\n \"MaxDispatchRateInMessages\": 0\n }\n ],\n \"RequestId\": \"4446732a-8d0a-4549-9fb3-79949a788fc0\"\n }\n}",
|
|
406
|
+
"title": "Obtain Cluster List"
|
|
333
407
|
}
|
|
334
408
|
],
|
|
335
409
|
"DescribeCmqQueueDetail": [
|
|
336
410
|
{
|
|
337
|
-
"document": "This example shows you how to
|
|
411
|
+
"document": "This example shows you how to get queue detail.",
|
|
338
412
|
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeCmqQueueDetail\n&QueueName=cmq-xxx\n&<Common request parameters>",
|
|
339
|
-
"output": "{\n \"Response\": {\n \"QueueDescribe\": {\n \"QueueId\": \"
|
|
340
|
-
"title": "
|
|
413
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"3d7a859c-4991-4d1d-bb8c-a25676c049d6\",\n \"QueueDescribe\": {\n \"QueueId\": \"cmqq-d88rxnbv2\",\n \"QueueName\": \"test1120\",\n \"Qps\": 5000,\n \"Bps\": 52428800,\n \"MaxDelaySeconds\": 3600,\n \"MaxMsgHeapNum\": 1000000,\n \"PollingWaitSeconds\": 3,\n \"MsgRetentionSeconds\": 7200,\n \"VisibilityTimeout\": 30,\n \"MaxMsgSize\": 1048576,\n \"RewindSeconds\": 0,\n \"RetentionSizeInMB\": 0,\n \"CreateTime\": 1732096676000,\n \"LastModifyTime\": 1732096676000,\n \"ActiveMsgNum\": 20,\n \"InactiveMsgNum\": 0,\n \"DelayMsgNum\": 0,\n \"RewindMsgNum\": null,\n \"MinMsgTime\": null,\n \"MaxUnackedMsgNum\": 100000,\n \"DeadLetterPolicy\": null,\n \"DeadLetterSource\": null,\n \"Transaction\": null,\n \"TransactionPolicy\": null,\n \"CreateUin\": null,\n \"Trace\": null,\n \"Tags\": null,\n \"TenantId\": \"cmq-131242\",\n \"NamespaceName\": \"CMQ_QUEUE-test1120\",\n \"Status\": 1,\n \"MaxMsgBacklogSize\": 10737418240\n }\n }\n}",
|
|
414
|
+
"title": "Retrieving cmq Queue Details"
|
|
341
415
|
}
|
|
342
416
|
],
|
|
343
417
|
"DescribeCmqQueues": [
|
|
344
418
|
{
|
|
345
419
|
"document": " ",
|
|
346
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCmqQueues\n<Common request parameters>\n\n{\n \"Limit\": 1,\n \"Offset\": \"0\"\n}",
|
|
347
|
-
"output": "{\n \"Response\": {\n \"TotalCount\":
|
|
348
|
-
"title": "Enumerating
|
|
420
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCmqQueues\n<Common request parameters>\n\n{\n \"Limit\": \"1\",\n \"Offset\": \"0\"\n}",
|
|
421
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"730b0b3e-4c67-4a11-a15b-90e6f7c18402\",\n \"TotalCount\": 1,\n \"QueueList\": [\n {\n \"QueueId\": \"cmqq-bzgqn83nv\",\n \"QueueName\": \"test0829\",\n \"Qps\": 5000,\n \"Bps\": 52428800,\n \"MaxDelaySeconds\": 3600,\n \"MaxMsgHeapNum\": 1000000,\n \"PollingWaitSeconds\": 3,\n \"MsgRetentionSeconds\": 7200,\n \"VisibilityTimeout\": 30,\n \"MaxMsgSize\": 1048576,\n \"RewindSeconds\": 0,\n \"RetentionSizeInMB\": 0,\n \"CreateTime\": 1724918937000,\n \"LastModifyTime\": 1724924966000,\n \"ActiveMsgNum\": 0,\n \"InactiveMsgNum\": 0,\n \"DelayMsgNum\": null,\n \"RewindMsgNum\": null,\n \"MinMsgTime\": null,\n \"MaxUnackedMsgNum\": 100000,\n \"DeadLetterPolicy\": {\n \"DeadLetterQueue\": \"rmqbroker-nj\",\n \"Policy\": 0,\n \"MaxTimeToLive\": 0,\n \"MaxReceiveCount\": 22\n },\n \"DeadLetterSource\": null,\n \"Transaction\": null,\n \"TransactionPolicy\": null,\n \"CreateUin\": null,\n \"Trace\": null,\n \"Tags\": null,\n \"TenantId\": \"cmq-13179472\",\n \"NamespaceName\": \"CMQ_QUEUE-test0829\",\n \"Status\": 1,\n \"MaxMsgBacklogSize\": 10737418240\n }\n ]\n }\n}",
|
|
422
|
+
"title": "Enumerating Queue (Case-Insensitive User)"
|
|
349
423
|
}
|
|
350
424
|
],
|
|
351
425
|
"DescribeCmqSubscriptionDetail": [
|
|
@@ -360,408 +434,632 @@
|
|
|
360
434
|
{
|
|
361
435
|
"document": " ",
|
|
362
436
|
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeCmqTopicDetail\n&<Common request parameters>",
|
|
363
|
-
"output": "{\n \"Response\": {\n \"TopicDescribe\": {\n \"
|
|
364
|
-
"title": "Querying
|
|
437
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"cbeef60c-6525-484a-83e8-6c590e81e749\",\n \"TopicDescribe\": {\n \"TopicId\": \"cmqt-w4nb4z27\",\n \"TopicName\": \"rmqbroker-nj\",\n \"MaxMsgSize\": 1048576,\n \"FilterType\": 1,\n \"MsgRetentionSeconds\": 86400,\n \"Qps\": 5000,\n \"CreateTime\": 1692691276000,\n \"LastModifyTime\": 1692691276000,\n \"MsgCount\": 0,\n \"CreateUin\": null,\n \"Trace\": null,\n \"Tags\": null,\n \"TenantId\": \"cmq-1317947242\",\n \"NamespaceName\": \"CMQ_TOPIC-rmqbroker-nj\",\n \"Status\": 1,\n \"BrokerType\": 1,\n \"SubscriptionCount\": 1\n }\n }\n}",
|
|
438
|
+
"title": "Querying Topic Details in cmq"
|
|
365
439
|
}
|
|
366
440
|
],
|
|
367
441
|
"DescribeCmqTopics": [
|
|
368
442
|
{
|
|
369
443
|
"document": " ",
|
|
370
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCmqTopics\n<Common request parameters>\n\n{\n \"Limit\": 1,\n \"Offset\": \"0\"\n}",
|
|
371
|
-
"output": "{\n \"Response\": {\n \"TotalCount\":
|
|
372
|
-
"title": "
|
|
444
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCmqTopics\n<Common request parameters>\n\n{\n \"Limit\": \"1\",\n \"Offset\": \"0\"\n}",
|
|
445
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"3fe52209-a1e2-462c-a948-defb864d14e3\",\n \"TotalCount\": 1,\n \"TopicList\": [\n {\n \"TopicId\": \"cmqt-w4nb4zonn\",\n \"TopicName\": \"rtopic\",\n \"MaxMsgSize\": 1048576,\n \"FilterType\": 1,\n \"MsgRetentionSeconds\": 86400,\n \"Qps\": 5000,\n \"CreateTime\": 1692691276000,\n \"LastModifyTime\": 1692691276000,\n \"MsgCount\": 0,\n \"CreateUin\": null,\n \"Trace\": null,\n \"Tags\": null,\n \"TenantId\": \"cmq-1317947242\",\n \"NamespaceName\": \"CMQ_TOPIC-rtopic\",\n \"Status\": 1,\n \"BrokerType\": 1,\n \"SubscriptionCount\": 1\n }\n ]\n }\n}",
|
|
446
|
+
"title": "Enumerate Topics (Case-Insensitive User)"
|
|
373
447
|
}
|
|
374
448
|
],
|
|
375
449
|
"DescribeEnvironmentAttributes": [
|
|
376
450
|
{
|
|
377
451
|
"document": " ",
|
|
378
|
-
"input": "
|
|
379
|
-
"output": "{\n \"Response\": {\n \"MsgTTL\": 2000,\n \"RateInByte\": 0,\n \"RateInSize\": 0,\n \"Replicas\": 2,\n \"RetentionHours\": 0,\n \"RetentionSize\": 0,\n \"EnvironmentId\": \"test1\",\n \"Remark\": \"
|
|
380
|
-
"title": "Listing
|
|
452
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeEnvironmentAttributes\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"ClusterId\": \"pulsar-5r59xd4vnx\"\n}",
|
|
453
|
+
"output": "{\n \"Response\": {\n \"MsgTTL\": 2000,\n \"RateInByte\": 0,\n \"RateInSize\": 0,\n \"Replicas\": 2,\n \"RetentionHours\": 0,\n \"RetentionSize\": 0,\n \"EnvironmentId\": \"test1\",\n \"Remark\": \"Remark\",\n \"RequestId\": \"dec113a8-599a-4e70-b143-14425d48ffc4\"\n }\n}",
|
|
454
|
+
"title": "Listing Specified Namespace Attributes"
|
|
381
455
|
}
|
|
382
456
|
],
|
|
383
457
|
"DescribeEnvironmentRoles": [
|
|
384
458
|
{
|
|
385
459
|
"document": " ",
|
|
386
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeEnvironmentRoles\n&EnvironmentId=default\n&<Common request parameters>",
|
|
387
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"EnvironmentRoleSets\": [\n {\n \"EnvironmentId\": \"default\",\n \"RoleName\": \"test_role\",\n \"Permissions\": [\n \"produce\",\n \"consume\"\n ],\n \"RoleDescribe\": \"Remark1\",\n \"CreateTime\": \"2020-08-03 19:46:37\",\n \"UpdateTime\": \"2020-08-04 15:59:29\"\n }\n ],\n \"RequestId\": \"
|
|
388
|
-
"title": "
|
|
460
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeEnvironmentRoles\n&ClusterId=pulsar-asyewnnedas\n&EnvironmentId=default\n&<Common request parameters>",
|
|
461
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"EnvironmentRoleSets\": [\n {\n \"EnvironmentId\": \"default\",\n \"RoleName\": \"test_role\",\n \"Permissions\": [\n \"produce\",\n \"consume\"\n ],\n \"RoleDescribe\": \"Remark1\",\n \"CreateTime\": \"2020-08-03 19:46:37\",\n \"UpdateTime\": \"2020-08-04 15:59:29\"\n }\n ],\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
462
|
+
"title": "Obtains the namespace role list"
|
|
389
463
|
}
|
|
390
464
|
],
|
|
391
465
|
"DescribeEnvironments": [
|
|
392
466
|
{
|
|
393
467
|
"document": " ",
|
|
394
|
-
"input": "
|
|
395
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"EnvironmentSet\": [\n {\n \"EnvironmentId\": \"
|
|
396
|
-
"title": "
|
|
468
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeEnvironments\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"Offset\": 1,\n \"Limit\": 1,\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\"\n}",
|
|
469
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"EnvironmentSet\": [\n {\n \"EnvironmentId\": \"devNs\",\n \"Remark\": \"devDemo\",\n \"MsgTTL\": 100,\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"NamespaceName\": \"devNs\",\n \"NamespaceId\": \"nsId\",\n \"TopicNum\": 0,\n \"RetentionPolicy\": {\n \"TimeInMinutes\": 0,\n \"SizeInMB\": 0\n },\n \"AutoSubscriptionCreation\": true\n }\n ],\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
470
|
+
"title": "Access the namespace list."
|
|
471
|
+
}
|
|
472
|
+
],
|
|
473
|
+
"DescribeMqMsgTrace": [
|
|
474
|
+
{
|
|
475
|
+
"document": "demo",
|
|
476
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMqMsgTrace\n<Common request parameters>\n\n{\n \"Protocol\": \"pulsar\",\n \"ClusterId\": \"pulsar-pnvjp9mbd947\",\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\",\n \"QueueName\": \"devCmq\",\n \"MsgId\": \"29292216:15:3\",\n \"GroupName\": \"devName\",\n \"QueryDlqMsg\": true\n}",
|
|
477
|
+
"output": "{\n \"Response\": {\n \"Result\": [\n {\n \"Stage\": \"devInfo\",\n \"Data\": \"2023-07-20 10:35:17\"\n }\n ],\n \"ShowTopicName\": \"devTopic\",\n \"RequestId\": \"722558eb-36dc-4643-854f-aa7436b83125\"\n }\n}",
|
|
478
|
+
"title": "Example"
|
|
479
|
+
}
|
|
480
|
+
],
|
|
481
|
+
"DescribeMsg": [
|
|
482
|
+
{
|
|
483
|
+
"document": " ",
|
|
484
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeMsg\n&EnvironmentId=default\n&TopicName=msg_dev\n&MsgId=16836:8:-1\n&<Common request parameters>",
|
|
485
|
+
"output": "{\n \"Response\": {\n \"Properties\": \"{\\\"publish-time\\\": \\\"1597747661679\\\", \\\"X-Pulsar-num-batch-message\\\": \\\"1\\\", \\\"MESSAGE_ID\\\": \\\"16836:8:-1\\\", \\\"X-Pulsar-producer-name\\\": \\\"fisrtProducer\\\", \\\"bookies-address\\\": \\\"9.139.220.16:3181#9.139.220.8:3181\\\"}\",\n \"Body\": \"i just a10 testing!\",\n \"BatchId\": \"1\",\n \"ProduceTime\": \"2020-08-18 18:47:41\",\n \"MsgId\": \"16836:8:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"RequestId\": \"b9c2eff2-e96a-4558-9ffc-d85279cxxxx\",\n \"Metadata\": \"{\\\"X-Pulsar-event-time\\\":\\\"1755674979886\\\",\\\"X-Pulsar-redelivery-count\\\":\\\"0\\\",\\\"X-Pulsar-sequence-id\\\":\\\"11\\\",\\\"X-Pulsar-deliver-at-time\\\":\\\"1755686943517\\\",\\\"X-Pulsar-replicated-to\\\":\\\"[]\\\",\\\"X-Pulsar-ordering-key\\\":\\\"[116, 101, 115, 116, 50]\\\"}\",\n \"Key\": \"test1\"\n }\n}",
|
|
486
|
+
"title": "Retrieving Message Details"
|
|
487
|
+
}
|
|
488
|
+
],
|
|
489
|
+
"DescribeMsgTrace": [
|
|
490
|
+
{
|
|
491
|
+
"document": " ",
|
|
492
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeMsgTrace\n&EnvironmentId=devNs\n&MsgId=16839:8:-1\n&ProduceTime=2020-08-1908:06:19\n&<Common request parameters>",
|
|
493
|
+
"output": "{\n \"Response\": {\n \"ProducerLog\": {\n \"MsgId\": \"16839:8:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-19 08:06:19,211\",\n \"ProducerAddr\": \"9.139.220.17:57234\",\n \"ProduceUseTime\": 5309,\n \"Status\": \"success\"\n },\n \"ServerLog\": {\n \"SaveTime\": \"2020-08-19 08:06:19,211\",\n \"Status\": \"success\"\n },\n \"ConsumerLogs\": {\n \"TotalCount\": 1,\n \"ConsumerLogSets\": [\n {\n \"MsgId\": \"16839:8:-1\",\n \"ConsumerGroup\": \"sun_consumer\",\n \"ConsumerName\": \"7ef60\",\n \"ConsumeTime\": \"2020-08-19 08:06:22,563\",\n \"ConsumerAddr\": \"9.139.220.17:57241\",\n \"ConsumeUseTime\": 875,\n \"Status\": \"success\"\n }\n ]\n },\n \"RequestId\": \"msgs\"\n }\n}",
|
|
494
|
+
"title": "Retrieving Message Trace"
|
|
397
495
|
}
|
|
398
496
|
],
|
|
399
497
|
"DescribePublisherSummary": [
|
|
400
498
|
{
|
|
401
499
|
"document": " ",
|
|
402
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublisherSummary\n<Common request parameters>\n\n{\n \"
|
|
403
|
-
"output": "{\n \"Response\": {\n \"MsgRateIn\": 0
|
|
404
|
-
"title": "
|
|
500
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublisherSummary\n<Common request parameters>\n\n{\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\",\n \"Namespace\": \"devNs\",\n \"Topic\": \"devTopic\"\n}",
|
|
501
|
+
"output": "{\n \"Response\": {\n \"MsgRateIn\": 0,\n \"MsgThroughputIn\": 0,\n \"PublisherCount\": 0,\n \"StorageSize\": 0,\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
502
|
+
"title": "Retrieving Producer Overview"
|
|
405
503
|
}
|
|
406
504
|
],
|
|
407
505
|
"DescribePublishers": [
|
|
408
506
|
{
|
|
409
507
|
"document": " ",
|
|
410
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublishers\n<Common request parameters>\n\n{\n \"
|
|
411
|
-
"output": "{\n \"Response\": {\n \"TotalCount\":
|
|
412
|
-
"title": "
|
|
508
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePublishers\n<Common request parameters>\n\n{\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\",\n \"Namespace\": \"devNs\",\n \"Topic\": \"devTopic\",\n \"Offset\": 0,\n \"Limit\": 0\n}",
|
|
509
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Publishers\": [\n {\n \"ProducerId\": 0,\n \"ProducerName\": \"p1\",\n \"Address\": \"127.0.0.1\",\n \"ClientVersion\": \"2.9\",\n \"MsgRateIn\": 0,\n \"MsgThroughputIn\": 0,\n \"AverageMsgSize\": 0,\n \"ConnectedSince\": \"dev\",\n \"Partition\": 0\n }\n ],\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
510
|
+
"title": "Getting Producer List"
|
|
413
511
|
}
|
|
414
512
|
],
|
|
415
513
|
"DescribePulsarProInstanceDetail": [
|
|
416
514
|
{
|
|
417
515
|
"document": " ",
|
|
418
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePulsarProInstanceDetail\n<Common request parameters>\n\n{\n \"ClusterId\": \"pulsar-
|
|
419
|
-
"output": "{\n \"Response\": {\n \"
|
|
420
|
-
"title": "
|
|
516
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePulsarProInstanceDetail\n<Common request parameters>\n\n{\n \"ClusterId\": \"pulsar-x4r939zkwmm2\"\n}",
|
|
517
|
+
"output": "{\n \"Response\": {\n \"ClusterInfo\": {\n \"ClusterId\": \"pulsar-x4r939zkwmm2\",\n \"ClusterName\": \"devTest\",\n \"Remark\": \"devTest\",\n \"CreateTime\": \"2023-07-20 10:35:17\",\n \"Status\": 0,\n \"Version\": \"2.9.2\",\n \"NodeDistribution\": [\n {\n \"ZoneName\": \"ap-beijing-4\",\n \"ZoneId\": \"800004\",\n \"NodeCount\": 1\n }\n ],\n \"MaxStorage\": 1,\n \"CanEditRoute\": true,\n \"BillingLabelVersion\": \"PULSAR.P1\"\n },\n \"NetworkAccessPointInfos\": [\n {\n \"VpcId\": \"vpc-8jjua83u\",\n \"SubnetId\": \"subnet-1iia83y2\",\n \"Endpoint\": \"http://pulsar-x4r939zkwmm2.tdmq.ap-bj.qcloud.tencenttdmq.com:8080\",\n \"InstanceId\": \"pulsar-x4r939zkwmm2\",\n \"RouteType\": 1,\n \"OperationType\": 1,\n \"AccessPointsType\": null\n }\n ],\n \"ClusterSpecInfo\": {\n \"SpecName\": \"PULSAR.P1.MINI2\",\n \"MaxTps\": 1,\n \"MaxBandWidth\": 1,\n \"MaxNamespaces\": 1,\n \"MaxTopics\": 1,\n \"ScalableTps\": 1\n },\n \"RequestId\": \"0799dd77-707b-40d7-a4b5-4140b11f6c97\"\n }\n}",
|
|
518
|
+
"title": "Retrieve Pulsar Pro Cluster Instance Details"
|
|
421
519
|
}
|
|
422
520
|
],
|
|
423
521
|
"DescribePulsarProInstances": [
|
|
424
522
|
{
|
|
425
523
|
"document": " ",
|
|
426
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePulsarProInstances\n<Common request parameters>\n\n{\n \"
|
|
427
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"
|
|
428
|
-
"title": "
|
|
524
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePulsarProInstances\n<Common request parameters>\n\n{\n \"Filters\": [\n {\n \"Name\": \"instancelds\",\n \"Values\": [\n \"pulsar-aer8pde2z2we\"\n ]\n }\n ],\n \"Limit\": 1,\n \"Offset\": 1\n}",
|
|
525
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"Instances\": [\n {\n \"InstanceId\": \"pulsar-aer8pde2z2we\",\n \"InstanceName\": \"DevName\",\n \"InstanceVersion\": \"2.9.1\",\n \"Status\": 1,\n\"ConfigDisplay\": \"Basic\"\n \"MaxTps\": 1,\n \"MaxStorage\": 1,\n \"ExpireTime\": 1,\n \"AutoRenewFlag\": 1,\n \"PayMode\": 1,\n \"Remark\": \"devRemark\",\n \"SpecName\": \"vip-basic-1\",\n \"ScalableTps\": 1,\n \"VpcId\": \"vpc-xxxx\",\n \"SubnetId\": \"subnet-xxxx\",\n \"MaxBandWidth\": 1,\n \"Tags\": [\n {\n \"TagKey\": \"devKey\",\n \"TagValue\": \"devValue\"\n }\n ],\n \"CreateTime\": \"2023-12-08 10:25:51\",\n \"BillingLabelVersion\": \"PULSAR.P1\"\n }\n ],\n \"RequestId\": \"e83dfdba-ed1a-4460-b175-81430ddf61fa\"\n }\n}",
|
|
526
|
+
"title": "This API is used to obtain instance lists."
|
|
527
|
+
}
|
|
528
|
+
],
|
|
529
|
+
"DescribeRabbitMQBindings": [
|
|
530
|
+
{
|
|
531
|
+
"document": " ",
|
|
532
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQBindings\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-44w9928j\",\n \"VirtualHost\": \"tdmq_data\"\n}",
|
|
533
|
+
"output": "{\n \"Response\": {\n \"BindingInfoList\": [\n {\n \"BindingId\": 127469,\n \"VirtualHost\": \"tdmq_data\",\n \"Source\": \"test-exchange\",\n \"DestinationType\": \"queue\",\n \"Destination\": \"test-queue\",\n \"RoutingKey\": \"test-rk\",\n \"SourceExchangeType\": \"direct\",\n \"CreateTime\": \"2022-12-16 11:19:56\",\n \"ModifyTime\": \"2022-12-16 11:19:56\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
534
|
+
"title": "This API is used to query the list of RabbitMQ route relations."
|
|
535
|
+
}
|
|
536
|
+
],
|
|
537
|
+
"DescribeRabbitMQExchanges": [
|
|
538
|
+
{
|
|
539
|
+
"document": "This API is used to query the list of TDMQ for RabbitMQ exchanges.",
|
|
540
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQExchanges\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"VirtualHost\": \"vhost1\"\n}",
|
|
541
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"request1\",\n \"ExchangeInfoList\": [\n {\n \"ExchangeName\": \"test1\",\n \"ExchangeType\": \"fanout\",\n \"Remark\": \"test1\",\n \"VirtualHost\": \"vhost1\",\n \"ExchangeCreator\": \"user\",\n \"CreateTimeStamp\": \"2022-12-04 01:08:43\",\n \"ModTimeStamp\": \"2022-12-04 01:08:43\"\n },\n {\n \"ExchangeName\": \"test2\",\n \"ExchangeType\": \"direct\",\n \"Remark\": \"test2\",\n \"VirtualHost\": \"vhost1\",\n \"ExchangeCreator\": \"user\",\n \"CreateTimeStamp\": \"2022-12-04 01:08:43\",\n \"ModTimeStamp\": \"2022-12-04 01:08:43\"\n }\n ],\n \"TotalCount\": 2\n }\n}",
|
|
542
|
+
"title": "This API is used to query the list of TDMQ for RabbitMQ exchanges."
|
|
429
543
|
}
|
|
430
544
|
],
|
|
431
545
|
"DescribeRabbitMQNodeList": [
|
|
432
546
|
{
|
|
433
|
-
"document": "This example shows you how to query the list of
|
|
434
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQNodeList\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-
|
|
435
|
-
"output": "{\n \"Response\": {\n \"
|
|
436
|
-
"title": "Querying the
|
|
547
|
+
"document": "This example shows you how to query the node list of the managed version of RabbitMQ.",
|
|
548
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQNodeList\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"Offset\": 0,\n \"Limit\": 3,\n \"NodeName\": \"rabbit@rabbitmq-broker-1.rabbitmq-broker-internal.amqp-2ppxx4rq.svc.cluster.local\",\n \"Filters\": [\n {\n \"Name\": \"nodeStatus\",\n \"Values\": [\n \"running\"\n ]\n }\n ],\n \"SortElement\": \"cpuUsage\",\n \"SortOrder\": \"descend\"\n}",
|
|
549
|
+
"output": "{\n \"Response\": {\n \"NodeList\": [\n {\n \"CPUUsage\": \"0.000%\",\n \"DiskUsage\": \"3.000%\",\n \"Memory\": 171,\n \"NodeName\": \"rabbit@rabbitmq-broker-0.rabbitmq-broker-internal.amqp-2ppxx4rq.svc.cluster.local\",\n \"NodeStatus\": \"running\",\n \"ProcessNumber\": 459\n }\n ],\n \"RequestId\": \"a95bfcfd-8388-4f86-8511-ca3be8ed000c\",\n \"TotalCount\": 1\n }\n}",
|
|
550
|
+
"title": "Querying the RabbitMQ Managed Node List"
|
|
437
551
|
}
|
|
438
552
|
],
|
|
439
|
-
"
|
|
553
|
+
"DescribeRabbitMQPermission": [
|
|
440
554
|
{
|
|
441
|
-
"document": "
|
|
442
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action:
|
|
443
|
-
"output": "{\n \"Response\": {\n \"
|
|
444
|
-
"title": "
|
|
555
|
+
"document": "-",
|
|
556
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQPermission\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\"\n}",
|
|
557
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RabbitMQPermissionList\": [\n {\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"User\": \"admin\",\n \"VirtualHost\": \"testVhost\",\n \"ConfigRegexp\": \".*\",\n \"WriteRegexp\": \".*\",\n \"ReadRegexp\": \".*\",\n \"CreateTime\": \"2022-12-16 11:19:56\",\n \"ModifyTime\": \"2022-12-16 11:29:56\"\n }\n ],\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
558
|
+
"title": "This API is used to query the TDMQ for RabbitMQ permission list."
|
|
445
559
|
}
|
|
446
560
|
],
|
|
447
|
-
"
|
|
561
|
+
"DescribeRabbitMQQueueDetail": [
|
|
448
562
|
{
|
|
449
563
|
"document": " ",
|
|
450
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action:
|
|
451
|
-
"output": "{\n \"Response\": {\n \"
|
|
452
|
-
"title": "
|
|
564
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQQueueDetail\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-jero744g\",\n \"VirtualHost\": \"tdmq_data\",\n \"QueueName\": \"prod.queue\"\n}",
|
|
565
|
+
"output": "{\n \"Response\": {\n \"Arguments\": \"{\\\"x-ordered\\\": false}\",\n \"AutoDelete\": false,\n \"AutoExpire\": 1000,\n \"Consumers\": 1,\n \"CreateTime\": 1728982735,\n \"DeadLetterExchange\": \"dl-exchange\",\n \"DeadLetterRoutingKey\": \"test-dl\",\n \"DeadLetterStrategy\": \"at-most-once\",\n \"DeliveryLimit\": null,\n \"Durable\": true,\n \"Exclusive\": false,\n \"InstanceId\": \"amqp-jero744g\",\n \"LazyMode\": false,\n \"MasterLocator\": \"client-local\",\n \"MaxInMemoryBytes\": null,\n \"MaxInMemoryLength\": null,\n \"MaxLength\": 10000,\n \"MaxLengthBytes\": 1000,\n \"MaximumPriority\": 0,\n \"MessageTTL\": 1000,\n \"Node\": \"rabbit@rabbitmq-broker-0.rabbitmq-broker-internal.amqp-test.svc.cluster.local\",\n \"OverflowBehaviour\": \"drop-head\",\n \"Policy\": \"test-policy\",\n \"QueueLeaderLocator\": null,\n \"QueueName\": \"prod.queue\",\n \"QueueType\": \"classic\",\n \"QuorumInitialGroupSize\": null,\n \"Remark\": \"[System auto batch sync]\",\n \"RequestId\": \"bf6ea82d-213b-4d44-be1f-74cd31f9a22b\",\n \"SingleActiveConsumer\": false,\n \"VirtualHost\": \"tdmq_data\"\n }\n}",
|
|
566
|
+
"title": "Queries RabbitMQ queue details"
|
|
453
567
|
}
|
|
454
568
|
],
|
|
455
|
-
"
|
|
569
|
+
"DescribeRabbitMQQueues": [
|
|
456
570
|
{
|
|
457
|
-
"document": "This example shows you how to query
|
|
458
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action:
|
|
459
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
460
|
-
"title": "
|
|
571
|
+
"document": "This example shows you how to query all queues under the current vhost",
|
|
572
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQQueues\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"VirtualHost\": \"testVhost\"\n}",
|
|
573
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"QueueInfoList\": [\n {\n \"QueueName\": \"prod.queue\",\n \"Remark\": null,\n \"QueueType\": \"classic\",\n \"ConsumerDetail\": {\n \"ConsumersNumber\": 1\n },\n \"MessageHeapCount\": 0,\n \"MessageRateIn\": 0,\n \"MessageRateOut\": 0\n }\n ],\n \"TotalCount\": 1\n }\n}",
|
|
574
|
+
"title": "This API is used to query the list of TDMQ for RabbitMQ queues."
|
|
461
575
|
}
|
|
462
576
|
],
|
|
463
|
-
"
|
|
577
|
+
"DescribeRabbitMQUser": [
|
|
578
|
+
{
|
|
579
|
+
"document": "This example shows you how to query the list of TDMQ for RabbitMQ users.",
|
|
580
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQUser\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\"\n}",
|
|
581
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"RabbitMQUserList\": [\n {\n \"ModifyTime\": \"2024-06-06 22:46:38.000\",\n \"CreateTime\": \"2024-06-06 22:46:38.000\",\n \"MaxChannels\": 1024,\n \"MaxConnections\": 1000,\n \"Type\": \"1\",\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"User\": \"test_user\",\n \"Password\": \"Tencent123\",\n \"Description\": \"user description\",\n \"Tags\": [\n \"user-tag\"\n ]\n }\n ],\n \"TotalCount\": 1\n }\n}",
|
|
582
|
+
"title": "Querying the RabbitMQ User List"
|
|
583
|
+
}
|
|
584
|
+
],
|
|
585
|
+
"DescribeRabbitMQVipInstance": [
|
|
586
|
+
{
|
|
587
|
+
"document": "",
|
|
588
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQVipInstance\n<Common request parameters>\n\n{\n \"ClusterId\": \"amqp-jero744g\"\n}",
|
|
589
|
+
"output": "{\n \"Response\": {\n \"ClusterInfo\": {\n \"AutoRenewFlag\": 1,\n \"ChannelNumber\": 1,\n \"ClusterId\": \"amqp-jero744g\",\n \"ClusterName\": \"tencent_cloud\",\n \"ClusterStatus\": 1,\n \"ClusterVersion\": \"3.8.30\",\n \"ConnectionNumber\": 1,\n \"ConsumerNumber\": 1,\n \"CreateTime\": 1728982428000,\n \"ExceptionInformation\": null,\n \"ExchangeNumber\": 10,\n \"ExpireTime\": 1731660828257,\n \"MessageConsumeRate\": 0,\n \"MessagePublishRate\": 0,\n \"MessageStackNumber\": 3021165,\n \"MirrorQueuePolicyFlag\": 1,\n \"PayMode\": 1,\n \"QueueNumber\": 1112,\n \"Region\": \"ap-qingyuan\",\n \"Remark\": \"\",\n \"VirtualHostNumber\": 1,\n \"Vpcs\": [\n {\n \"SubnetId\": \"subnet-67y9wil4\",\n \"VpcDataStreamEndpointStatus\": \"ON\",\n \"VpcEndpoint\": \"amqp://10.0.0.2:5672\",\n \"VpcId\": \"vpc-5ghsr4p9\"\n }\n ],\n \"ZoneIds\": [\n 540001\n ]\n },\n \"ClusterNetInfo\": {\n \"PrometheusEndpointInfo\": {\n \"NodePrometheusAddress\": [],\n \"PrometheusEndpointStatus\": \"OFF\",\n \"VpcEndpointInfo\": null,\n \"VpcPrometheusEndpoint\": []\n },\n \"PublicAccessEndpoint\": \"amqp://127.0.0.1:5672\",\n \"PublicAccessEndpointStatus\": true,\n \"PublicControlConsoleSwitchStatus\": true,\n \"PublicDataStreamStatus\": \"ON\",\n \"PublicWebConsoleSwitchStatus\": \"ON\",\n \"VpcControlConsoleSwitchStatus\": false,\n \"VpcWebConsoleEndpoint\": \"http://127.0.0.1:15672\",\n \"VpcWebConsoleSwitchStatus\": \"OFF\",\n \"WebConsoleDomainEndpoint\": \"http://amqp-jero744g.dashboard.rabbitmq.xx.public.tencenttdmq.com:15672\",\n \"WebConsoleEndpoint\": \"http://127.0.0.1:15672\",\n \"WebConsolePassword\": \"Fs78DBo2C3IuN4L0\",\n \"WebConsoleUsername\": \"admin\"\n },\n \"ClusterSpecInfo\": {\n \"MaxBandWidth\": 15,\n \"MaxStorage\": 200,\n \"MaxTps\": 800,\n \"NodeCount\": 1,\n \"PublicNetworkTps\": 5,\n \"SpecName\": \"Trial\"\n },\n \"ClusterWhiteListInfo\": {\n \"PublicControlConsoleWhiteList\": \"127.0.0.1\",\n \"PublicControlConsoleWhiteListStatus\": \"ON\",\n \"PublicDataStreamWhiteList\": \"127.0.0.1\",\n \"PublicDataStreamWhiteListStatus\": \"ON\",\n \"WhiteList\": \"127.0.0.1\"\n },\n \"ExchangeQuota\": {\n \"MaxExchange\": 1000,\n \"UsedExchange\": 10\n },\n \"QueueQuota\": {\n \"MaxQueue\": 1000,\n \"UsedQueue\": 1112\n },\n \"RequestId\": \"2a48bbf4-4675-4984-93d9-8ed0f4dfa598\",\n \"VirtualHostQuota\": {\n \"MaxVirtualHost\": 20,\n \"UsedVirtualHost\": 1\n }\n }\n}",
|
|
590
|
+
"title": "Retrieve RabbitMQ Managed Instance Information"
|
|
591
|
+
}
|
|
592
|
+
],
|
|
593
|
+
"DescribeRabbitMQVipInstances": [
|
|
464
594
|
{
|
|
465
595
|
"document": " ",
|
|
466
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action:
|
|
467
|
-
"output": "{\n \"Response\": {\n \"
|
|
468
|
-
"title": "
|
|
596
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQVipInstances\n<Common request parameters>\n\n{\n \"Filters\": [\n {\n \"Name\": \"instanceIds\",\n \"Values\": [\n \"amqp-jero744g\"\n ]\n }\n ],\n \"Limit\": 1,\n \"Offset\": 0\n}",
|
|
597
|
+
"output": "{\n \"Response\": {\n \"Instances\": [\n {\n \"AutoRenewFlag\": 1,\n \"ClusterStatus\": 1,\nTrial\n \"CreateTime\": 1730294244007,\n \"ExceptionInformation\": null,\n \"ExpireTime\": 1732972644007,\n \"InstanceId\": \"amqp-jero744g\",\n \"InstanceName\": \"test1030\",\n \"InstanceVersion\": \"3.11.8\",\n \"MaxBandWidth\": 45,\n \"MaxStorage\": 600,\n \"MaxTps\": 2400,\n \"NodeCount\": 3,\n \"PayMode\": 1,\n \"PublicAccessEndpoint\": \"amqp://106.55.176.111:5672\",\n\"Remark\": \"Production use cluster\",\n \"SpecName\": \"rabbit-vip-basic-5\",\n \"Status\": 1,\n \"Vpcs\": [\n {\n \"SubnetId\": \"subnet-67y9wil4\",\n \"VpcDataStreamEndpointStatus\": \"ON\",\n \"VpcEndpoint\": \"amqp://10.0.4.10:5672\",\n \"VpcId\": \"vpc-5ghsr4p9\"\n }\n ]\n }\n ],\n \"RequestId\": \"db5e4d5f-e2c5-4a17-9fbd-484ec2d98324\",\n \"TotalCount\": 16\n }\n}",
|
|
598
|
+
"title": "This API is used to obtain instance lists."
|
|
599
|
+
}
|
|
600
|
+
],
|
|
601
|
+
"DescribeRabbitMQVirtualHost": [
|
|
602
|
+
{
|
|
603
|
+
"document": "-",
|
|
604
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRabbitMQVhost\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-test\"\n}",
|
|
605
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\",\n \"VirtualHostList\": [\n {\n \"InstanceId\": \"amqp-test\",\n \"VirtualHost\": \"vhost\",\n \"Description\": \"\",\n \"Tags\": [],\n \"CreateTime\": \"2023-07-18 12:55:00.778\",\n \"ModifyTime\": \"2023-07-18 12:55:00.778\",\n \"VirtualHostStatistics\": {\n \"CurrentQueues\": 1,\n \"CurrentExchanges\": 6,\n \"CurrentConnections\": 1,\n \"CurrentChannels\": 1,\n \"CurrentUsers\": 1\n },\n \"TraceFlag\": true,\n \"MessageHeapCount\": 0,\n \"MessageRateIn\": 0,\n \"MessageRateOut\": 0\n },\n {\n \"InstanceId\": \"amqp-test\",\n \"VirtualHost\": \"test2\",\n \"Description\": \"\",\n \"Tags\": [],\n \"CreateTime\": \"2023-07-18 12:55:16.230\",\n \"ModifyTime\": \"2023-07-18 12:55:19.856\",\n \"VirtualHostStatistics\": {\n \"CurrentQueues\": 0,\n \"CurrentExchanges\": 0,\n \"CurrentConnections\": 0,\n \"CurrentChannels\": 0,\n \"CurrentUsers\": 0\n },\n \"TraceFlag\": true,\n \"MessageHeapCount\": 0,\n \"MessageRateIn\": 0,\n \"MessageRateOut\": 0\n }\n ],\n \"TotalCount\": 2\n }\n}",
|
|
606
|
+
"title": "This API is used to query the list of TDMQ for RabbitMQ vhosts."
|
|
469
607
|
}
|
|
470
608
|
],
|
|
471
609
|
"DescribeRocketMQCluster": [
|
|
472
610
|
{
|
|
473
|
-
"document": " ",
|
|
611
|
+
"document": "This example shows you how to get the details of a RocketMQ cluster.",
|
|
474
612
|
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQCluster\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-rd3545bkkj49\"\n}",
|
|
475
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"c6d158b6-89b2-40d1-b1f6-5973f0f00cd5\",\n \"ClusterInfo\": {\n \"ClusterId\": \"rocketmq-rd3545bkkj49\",\n \"ClusterName\": \"test-example\",\n \"Region\": \"ap-beijing\",\n \"CreateTime\": 1620321019000,\n \"Remark\": \"modified\",\n \"PublicEndPoint\": \"pulsar://xxxxx.com:6650\",\n \"VpcEndPoint\": \"pulsar://xxxxx.com:6650\",\n \"Vpcs\": [\n {\n \"SubnetId\": \"
|
|
476
|
-
"title": "
|
|
613
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"c6d158b6-89b2-40d1-b1f6-5973f0f00cd5\",\n \"ClusterInfo\": {\n \"ClusterId\": \"rocketmq-rd3545bkkj49\",\n \"ClusterName\": \"test-example\",\n \"Region\": \"ap-beijing\",\n \"CreateTime\": 1620321019000,\n \"Remark\": \"modified\",\n \"PublicEndPoint\": \"pulsar://xxxxx.com:6650\",\n \"VpcEndPoint\": \"pulsar://xxxxx.com:6650\",\n \"Vpcs\": [\n {\n \"SubnetId\": \"subnet-123\",\n \"VpcId\": \"vpc-12333\"\n }\n ],\n \"SupportNamespaceEndpoint\": true,\n \"RocketMQFlag\": true,\n \"IsVip\": true,\n \"IsolateTime\": 0,\n \"Status\": 1,\n \"AclEnabled\": true,\n \"InternalEndpoint\": \"\",\n \"HttpInternalEndpoint\": \"\",\n \"HttpVpcEndpoint\": \"\",\n \"HttpPublicEndpoint\": \"\"\n },\n \"ClusterConfig\": {\n \"MaxTpsPerNamespace\": 8000,\n \"UsedNamespaceNum\": 1,\n \"MaxTopicNum\": 1000,\n \"UsedTopicNum\": 2,\n \"MaxGroupNum\": 10000,\n \"UsedGroupNum\": 1,\n \"MaxRetentionTime\": 1296000000,\n \"MaxLatencyTime\": 3456000000,\n \"MaxNamespaceNum\": 10,\n \"MaxQueuesPerTopic\": 1,\n \"TopicDistribution\": []\n },\n \"ClusterStats\": {\n \"TopicNum\": 2,\n \"ProducedMsgNum\": 0,\n \"ConsumedMsgNum\": 0,\n \"AccumulativeMsgNum\": 0\n }\n }\n}",
|
|
614
|
+
"title": "Retrieving RocketMQ Cluster Details"
|
|
477
615
|
}
|
|
478
616
|
],
|
|
479
617
|
"DescribeRocketMQClusters": [
|
|
480
618
|
{
|
|
481
619
|
"document": " ",
|
|
482
620
|
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQClusters\n<Common request parameters>\n\n{\n \"Limit\": \"10\",\n \"Offset\": \"0\"\n}",
|
|
483
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"1faeceb2-eaa9-407e-bd9a-d3eff76ca882\",\n \"TotalCount\": 1,\n \"ClusterList\": [\n {\n \"Info\": {\n \"ClusterId\": \"rocketmq-
|
|
484
|
-
"title": "
|
|
621
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"1faeceb2-eaa9-407e-bd9a-d3eff76ca882\",\n \"TotalCount\": 1,\n \"ClusterList\": [\n {\n \"Info\": {\n \"ClusterId\": \"rocketmq-a52qova7x97b\",\n \"ClusterName\": \"test_name\",\n \"Region\": \"ap-beijing\",\n \"Status\": 0,\n \"AclEnabled\": true,\n \"CreateTime\": 1620321019000,\n \"Remark\": \"remark info\",\n \"PublicEndPoint\": \"pulsar://rocketmq-xxxx1.xxxx.com:5678\",\n \"VpcEndPoint\": \"pulsar://rocketmq-xxxx1.xxxx.com:5678\",\n \"HttpPublicEndpoint\": \"http://rocketmq-c1.public.com:5678\",\n \"HttpVpcEndpoint\": \"http://rocketmq-c1.vpc.com:5678\",\n \"InternalEndpoint\": \"http://rocketmq-c1.internal.com:5678\",\n \"HttpInternalEndpoint\": \"\",\n \"Vpcs\": [\n {\n \"SubnetId\": \"mqsubnet32id\",\n \"VpcId\": \"vpcmqid62a\"\n }\n ],\n \"SupportNamespaceEndpoint\": true,\n \"RocketMQFlag\": true,\n \"IsolateTime\": 0,\n \"IsVip\": true\n },\n \"Config\": {\n \"MaxTpsPerNamespace\": 8000,\n \"UsedNamespaceNum\": 1,\n \"MaxTopicNum\": 1000,\n \"UsedTopicNum\": 2,\n \"MaxGroupNum\": 10000,\n \"UsedGroupNum\": 1,\n \"MaxRetentionTime\": 1296000000,\n \"MaxLatencyTime\": 3456000000,\n \"TopicDistribution\": [\n {\n \"TopicType\": \"Normal\",\n \"Count\": 1\n }\n ],\n \"MaxQueuesPerTopic\": 1,\n \"MaxNamespaceNum\": 10\n }\n }\n ]\n }\n}",
|
|
622
|
+
"title": "Obtaining the Cluster Information List Created by a User"
|
|
623
|
+
}
|
|
624
|
+
],
|
|
625
|
+
"DescribeRocketMQEnvironmentRoles": [
|
|
626
|
+
{
|
|
627
|
+
"document": "",
|
|
628
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQEnvironmentRoles\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"test_namespace\",\n \"Offset\": 0,\n \"Limit\": 20,\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"RoleName\": \"test_role_name\",\n \"Filters\": []\n}",
|
|
629
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"EnvironmentRoleSets\": [\n {\n \"EnvironmentId\": \"test_namespace\",\n \"RoleName\": \"test_role_name\",\n \"Permissions\": [\n \"produce\"\n ],\n \"RoleDescribe\": \"Test role\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"UpdateTime\": \"2020-09-22 00:00:00\"\n }\n ],\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
630
|
+
"title": "Retrieving RocketMQ Namespace Role List"
|
|
485
631
|
}
|
|
486
632
|
],
|
|
487
633
|
"DescribeRocketMQGroups": [
|
|
488
634
|
{
|
|
489
635
|
"document": "test",
|
|
490
|
-
"input": "{\n
|
|
491
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"1c127300-fcdd-4087-b1d2-fd75a1cefbe4\",\n \"TotalCount\": 1,\n \"Groups\": [\n {\n \"
|
|
492
|
-
"title": "Querying
|
|
636
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQGroups\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-4k4orqgq\",\n \"NamespaceId\": \"test_ns\",\n \"Offset\": 0,\n \"Limit\": 20,\n \"FilterTopic\": \"test_topic\",\n \"FilterGroup\": \"test_group\",\n \"SortedBy\": \"tps\",\n \"SortOrder\": \"asc\",\n \"FilterOneGroup\": \"test_group\",\n \"Types\": [\n \"TCP\"\n ]\n}",
|
|
637
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"1c127300-fcdd-4087-b1d2-fd75a1cefbe4\",\n \"TotalCount\": 1,\n \"Groups\": [\n {\n \"InstanceId\": \"rocketmq-4k4orqgq\",\n \"Namespace\": \"test_ns\",\n \"Name\": \"test_group\",\n \"ConsumerNum\": 1,\n \"TotalAccumulative\": 380,\n \"RetryMaxTimes\": 10,\n \"ConsumptionMode\": -1,\n \"BroadcastEnabled\": false,\n \"ReadEnabled\": true,\n \"RetryPartitionNum\": 1,\n \"CreateTime\": 1621307489000,\n \"UpdateTime\": 1621307706000,\n \"ClientProtocol\": \"TCP\",\n \"Remark\": \"Test consumption group\",\n \"ConsumerType\": \"PUSH\",\n \"TPS\": 20,\n \"GroupType\": \"TCP\",\n \"SubscribeTopicNum\": \"1\"\n }\n ]\n }\n}",
|
|
638
|
+
"title": "Querying Subscription Group List"
|
|
493
639
|
}
|
|
494
640
|
],
|
|
495
641
|
"DescribeRocketMQMsg": [
|
|
496
642
|
{
|
|
497
|
-
"document": "
|
|
498
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQMsg\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"
|
|
499
|
-
"output": "{\n \"Response\": {\n \"Body\": \"
|
|
500
|
-
"title": "
|
|
643
|
+
"document": "",
|
|
644
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQMsg\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"test_namespace\",\n \"ClusterId\": \"rocketmq-4k4orqgq\",\n \"TopicName\": \"test_topic\",\n \"PulsarMsgId\": \"092BAE5A1656070DEA4E276DF0760089\",\n \"MsgId\": \"092BAE5A1656070DEA4E276DF0760023\",\n \"QueryDlqMsg\": false\n}",
|
|
645
|
+
"output": "{\n \"Response\": {\n \"Body\": \"order-id-2ksn3b23\",\n \"MsgId\": \"092BAE5A1656070DEA4E276DF0760089\",\n \"ProduceTime\": \"2021-11-23 21:21:26\",\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\",\n \"Properties\": \"\",\n \"ProducerAddr\": \"9.43.174.90\",\n \"ShowTopicName\": \"test_topic\",\n \"MessageTracks\": [\n {\n \"Group\": \"test_group\",\n \"ConsumeStatus\": \"CONSUMED\",\n \"TrackType\": \"CONSUMED\",\n \"ExceptionDesc\": \"\"\n }\n ]\n }\n}",
|
|
646
|
+
"title": "Query message details."
|
|
647
|
+
}
|
|
648
|
+
],
|
|
649
|
+
"DescribeRocketMQMsgTrace": [
|
|
650
|
+
{
|
|
651
|
+
"document": "Queries message trajectory",
|
|
652
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQMsgTrace\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-4k4orqgq\",\n \"EnvironmentId\": \"test_namespace\",\n \"TopicName\": \"test_topic\",\n \"MsgId\": \"01963F0B14BAF0B5360728F44800000000\",\n \"GroupName\": \"test_group\",\n \"QueryDLQMsg\": true\n}",
|
|
653
|
+
"output": "{\n \"Response\": {\n \"Result\": [\n {\n \"Stage\": \"produce\",\n \"Data\": \"{\\\"MsgId\\\":\\\"01963F0B14BAF0B5360728F44800000000\\\",\\\"Status\\\":0,\\\"ProduceTime\\\":\\\"2024-10-22 15:54:49,124\\\",\\\"ProducerAddr\\\":\\\"111.206.94.148:47557\\\",\\\"MsgKey\\\":\\\"yourMessageKey-1c151062f96e\\\",\\\"MsgTags\\\":\\\"yourMessageTagA\\\",\\\"Duration\\\":10}\"\n },\n {\n \"Stage\": \"persist\",\n \"Data\": \"{\\\"MsgId\\\":\\\"01963F0B14BAF0B5360728F44800000000\\\",\\\"Status\\\":0,\\\"PersistTime\\\":\\\"2024-10-22 15:54:49,132\\\"}\"\n },\n {\n \"Stage\": \"consume\",\n \"Data\": \"{\\\"TotalCount\\\":1,\\\"RocketMqConsumeLogs\\\":[{\\\"MsgId\\\":\\\"01963F0B14BAF0B5360728F44800000000\\\",\\\"Status\\\":2,\\\"PushTime\\\":\\\"2024-10-22 15:55:00,122\\\",\\\"ConsumerAddr\\\":\\\"111.206.94.148:53792\\\",\\\"ConsumerGroup\\\":\\\"test_group\\\",\\\"RetryTimes\\\":1}]}\"\n }\n ],\n \"ShowTopicName\": \"news-topic\",\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
654
|
+
"title": "Queries message trajectory"
|
|
501
655
|
}
|
|
502
656
|
],
|
|
503
657
|
"DescribeRocketMQNamespaces": [
|
|
504
658
|
{
|
|
505
659
|
"document": " ",
|
|
506
660
|
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeRocketMQNamespaces\n&ClusterId=rocketmq-rd3545bkkj49\n&Offset=0\n&Limit=10\n&<Common request parameters>",
|
|
507
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"
|
|
508
|
-
"title": "
|
|
661
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\",\n \"Namespaces\": [\n {\n \"Remark\": \"info-remark\",\n \"PublicEndpoint\": \"http://public.test.com\",\n \"RetentionTime\": 1,\n \"VpcEndpoint\": \"http://vpc.test.com\",\n \"Ttl\": 1,\n \"NamespaceId\": \"ordernamespace\",\n \"InternalEndpoint\": \"http://internal.test.com\"\n }\n ]\n }\n}",
|
|
662
|
+
"title": "Obtaining User Namespace List"
|
|
663
|
+
}
|
|
664
|
+
],
|
|
665
|
+
"DescribeRocketMQProducers": [
|
|
666
|
+
{
|
|
667
|
+
"document": "This example shows you how to query the producer client list successfully.",
|
|
668
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQProducers\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-5kze4gr222mx\",\n \"NamespaceId\": \"test_ns\",\n \"Topic\": \"test_topic\",\n \"Offset\": 0,\n \"Limit\": 0,\n \"Filters\": [\n {\n \"Name\": \"CliendId\",\n \"Values\": [\n \"10.10.10.10@abc\"\n ]\n }\n ]\n}",
|
|
669
|
+
"output": "{\n \"Response\": {\n \"Producers\": [\n {\n \"ClientId\": \"10.10.10.10@abc\",\n \"ClientIp\": \"10.10.10.10\",\n \"Language\": \"JAVA\",\n \"Version\": \"v5_0_5\",\n \"LastUpdateTimestamp\": 1723195366688\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}",
|
|
670
|
+
"title": "Normal Response"
|
|
671
|
+
}
|
|
672
|
+
],
|
|
673
|
+
"DescribeRocketMQPublicAccessMonitorData": [
|
|
674
|
+
{
|
|
675
|
+
"document": "",
|
|
676
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQPublicAccessMonitorData\n<Common request parameters>\n\n{\n \"InstanceId\": \"rocketmq-a52qova7x97b\",\n \"StartTime\": \"2024-12-04T15:06:49+08:00\",\n \"EndTime\": \"2024-12-04T16:06:49+08:00\",\n \"Period\": 60,\n \"MetricName\": \"RocketmqPublicNetworkIntrafficVipRatio\"\n}",
|
|
677
|
+
"output": "{\n \"Response\": {\n \"StartTime\": \"2024-12-04T15:06:00+08:00\",\n \"EndTime\": \"2024-12-04T16:06:00+08:00\",\n \"Period\": 60,\n \"MetricName\": \"RocketmqPublicNetworkIntrafficVipRatio\",\n \"DataPoints\": [\n {\n \"Timestamps\": [\n 1733295960,\n 1733296020,\n 1733296080,\n 1733296140,\n 1733296200,\n 1733296260,\n 1733296320,\n 1733296380,\n 1733296440,\n 1733296500,\n 1733296560,\n 1733296620,\n 1733296680,\n 1733296740,\n 1733296800,\n 1733296860,\n 1733296920,\n 1733296980,\n 1733297040,\n 1733297100,\n 1733297160,\n 1733297220,\n 1733297280,\n 1733297340,\n 1733297400,\n 1733297460,\n 1733297520,\n 1733297580,\n 1733297640,\n 1733297700,\n 1733297760,\n 1733297820,\n 1733297880,\n 1733297940,\n 1733298000,\n 1733298060,\n 1733298120,\n 1733298180,\n 1733298240,\n 1733298300,\n 1733298360,\n 1733298420,\n 1733298480,\n 1733298540,\n 1733298600,\n 1733298660,\n 1733298720,\n 1733298780,\n 1733298840,\n 1733298900,\n 1733298960,\n 1733299020,\n 1733299080,\n 1733299140,\n 1733299200,\n 1733299260\n ],\n \"Values\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0\n ]\n }\n ],\n \"RequestId\": \"a6ebee33-5790-435a-a204-dda200d360af\",\n \"Msg\": \"\"\n }\n}",
|
|
678
|
+
"title": "Normal Response"
|
|
679
|
+
}
|
|
680
|
+
],
|
|
681
|
+
"DescribeRocketMQPublicAccessPoint": [
|
|
682
|
+
{
|
|
683
|
+
"document": " ",
|
|
684
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQPublicAccessPoint\n<Common request parameters>\n\n{\n \"InstanceId\": \"rocketmq-jxj3wj5j8e7\"\n}",
|
|
685
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"086e9401-0674-41f1-a381-9c6a8ba702ea\",\n \"Status\": 0,\n \"PayStatus\": 1,\n \"AccessUrl\": \"rocketmq-jxj3wj5j8e7.mock-test.com\",\n \"PayMode\": 0,\n \"Bandwidth\": 0,\n \"Rules\": [\n {\n \"IpRule\": \"0.0.0.0/0\",\n \"Allow\": true,\n \"Remark\": \"remark info\"\n }\n ]\n }\n}",
|
|
686
|
+
"title": "Retrieving Public Network Access Point Information"
|
|
687
|
+
}
|
|
688
|
+
],
|
|
689
|
+
"DescribeRocketMQRoles": [
|
|
690
|
+
{
|
|
691
|
+
"document": "",
|
|
692
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQRoles\n<Common request parameters>\n\n{\n \"RoleName\": \"test_role_name\",\n \"Offset\": 0,\n \"Limit\": 20,\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"Filters\": [\n {\n \"Name\": \"RoleName\",\n \"Values\": [\n \"test_role_name\"\n ]\n }\n ]\n}",
|
|
693
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RoleSets\": [\n {\n \"RoleName\": \"test_role_name\",\n \"Token\": \"eyJrZXlJZCI6InN1bmdvxxxxx0X3JvbGVfMyJ9.dbHR8m6gc4L4vZUrodhW_O9bDulZQ6lraNswNLtcUcY\",\n \"Remark\": \"Test role\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"UpdateTime\": \"2020-09-22 00:00:00\"\n }\n ],\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
694
|
+
"title": "Obtains the list of roles"
|
|
695
|
+
}
|
|
696
|
+
],
|
|
697
|
+
"DescribeRocketMQTopUsages": [
|
|
698
|
+
{
|
|
699
|
+
"document": "",
|
|
700
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQTopUsages\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-abc\",\n \"MetricName\": \"consumeLag\",\n \"Limit\": 1\n}",
|
|
701
|
+
"output": "{\n \"Response\": {\n \"Dimensions\": [\n {\n \"Dimensions\": [\n {\n \"Name\": \"tenant\",\n \"Value\": \"rocketmq-vvqb9emabapx\"\n },\n {\n \"Name\": \"namespace\",\n \"Value\": \"test_ns\"\n },\n {\n \"Name\": \"topic\",\n \"Value\": \"test_topic\"\n }\n ]\n },\n {\n \"Dimensions\": [\n {\n \"Name\": \"tenant\",\n \"Value\": \"rocketmq-vvqb9emabapx\"\n },\n {\n \"Name\": \"namespace\",\n \"Value\": \"test_ns\"\n },\n {\n \"Name\": \"topic\",\n \"Value\": \"test_topic2\"\n }\n ]\n }\n ],\n \"RequestId\": \"f0288e86-ee7d-4a73-a788-81ca6680b06c\",\n \"Values\": [\n 309,\n 0\n ]\n }\n}",
|
|
702
|
+
"title": "Retrieving Group Heaped Messages Sorting Order"
|
|
703
|
+
}
|
|
704
|
+
],
|
|
705
|
+
"DescribeRocketMQTopic": [
|
|
706
|
+
{
|
|
707
|
+
"document": "",
|
|
708
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQTopic\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-zpz97455xwap\",\n \"NamespaceId\": \"namespace\",\n \"TopicName\": \"test_topic\",\n \"ConsumerGroup\": \"\"\n}",
|
|
709
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"121e5b17-7e8b-4849-b168-c02b67ebfbba\",\n \"Topic\": {\n \"Name\": \"test_topic\",\n \"Type\": \"Normal\",\n \"GroupNum\": 0,\n \"Remark\": null,\n \"PartitionNum\": 3,\n \"CreateTime\": 1696662165000,\n \"UpdateTime\": 1696662165000,\n \"InstanceId\": \"rocketmq-zpz97455xwap\",\n \"Namespace\": \"namespace\",\n \"LastUpdateTime\": 1696751238307,\n \"SubscriptionCount\": 1,\n \"SubscriptionData\": [\n {\n \"Topic\": \"test_topic\",\n \"Type\": null,\n \"PartitionNum\": null,\n \"ExpressionType\": \"TAG\",\n \"SubString\": \"msgTag\",\n \"Status\": null,\n \"ConsumerLag\": 0,\n \"ClusterId\": \"rocketmq-zpz97455xwap\",\n \"ConsumerGroup\": \"test_group\",\n \"IsOnline\": true,\n \"ConsumeType\": 0,\n \"Consistency\": 0,\n \"LastUpdateTime\": 1696751238307,\n \"MaxRetryTimes\": 16\n }\n ]\n }\n }\n}",
|
|
710
|
+
"title": "Retrieving Topic Details"
|
|
711
|
+
}
|
|
712
|
+
],
|
|
713
|
+
"DescribeRocketMQTopicMsgs": [
|
|
714
|
+
{
|
|
715
|
+
"document": "",
|
|
716
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQTopicMsgs\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-zpz97455xwap\",\n \"EnvironmentId\": \"test_namespace\",\n \"TopicName\": \"test_topic\",\n \"MsgId\": \"092BAE5A1656070DEA4E276DF0760089\",\n \"MsgKey\": \"test_key\",\n \"StartTime\": \"2023-10-08 15:44:59\",\n \"EndTime\": \"2023-10-08 16:14:59\",\n \"Offset\": 0,\n \"Limit\": 20,\n \"TaskRequestId\": \"2e5ecbb3-f2d6-49d3-9c82-8648f8ed8748\",\n \"QueryDlqMsg\": true,\n \"NumOfLatestMsg\": 0,\n \"Tag\": \"test_tag\",\n \"QueryDeadLetterMessage\": true\n}",
|
|
717
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"e3bba45e-876a-4107-ad5d-88006c1ddba2\",\n \"TotalCount\": 1,\n \"TopicMsgLogSets\": [\n {\n \"MsgId\": \"092BAE5A1656070DEA4E276DF0760089\",\n \"MsgTag\": \"test_tag\",\n \"MsgKey\": \"test_key\",\n \"ProducerAddr\": \"9.43.174.90\",\n \"ProduceTime\": \"2023-10-08 15:45:16\",\n \"PulsarMsgId\": \"092BAE5A1656070DEA4E276DF0760089\",\n \"DeadLetterResendTimes\": 10,\n \"ResendSuccessCount\": 10\n }\n ],\n \"TaskRequestId\": \"df71cc0a-3057-416b-b878-f0fe015e9913\"\n }\n}",
|
|
718
|
+
"title": "Obtaining Message List"
|
|
719
|
+
}
|
|
720
|
+
],
|
|
721
|
+
"DescribeRocketMQTopicStats": [
|
|
722
|
+
{
|
|
723
|
+
"document": "",
|
|
724
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQTopicStats\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-7j8m97bqpx5d\",\n \"NamespaceId\": \"test_namespace\",\n \"TopicName\": \"test_topic\"\n}",
|
|
725
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"5d5e666b-48d5-4abd-b628-fd2d15d0ee57\",\n \"TopicStatsList\": [\n {\n \"BrokerName\": \"rocketmq-7j8m97bqpx5d-1\",\n \"QueueId\": 1,\n \"MinOffset\": 0,\n \"MaxOffset\": 100,\n \"MessageCount\": 100,\n \"LastUpdateTimestamp\": 1695298841001\n }\n ]\n }\n}",
|
|
726
|
+
"title": "Retrieving Queue Details"
|
|
509
727
|
}
|
|
510
728
|
],
|
|
511
729
|
"DescribeRocketMQTopics": [
|
|
512
730
|
{
|
|
513
731
|
"document": " ",
|
|
514
|
-
"input": "
|
|
515
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"c017c4d1-13cb-4f14-ab89-2c6530892f90\",\n \"TotalCount\": 1,\n \"Topics\": [\n {\n \"Name\": \"
|
|
516
|
-
"title": "
|
|
732
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQTopics\n<Common request parameters>\n\n{\n \"Offset\": 1,\n \"Limit\": 1,\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"NamespaceId\": \"test_ns\",\n \"FilterGroup\": \"test_group\"\n}",
|
|
733
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"c017c4d1-13cb-4f14-ab89-2c6530892f90\",\n \"TotalCount\": 1,\n \"Topics\": [\n {\n \"Name\": \"test_topic\",\n \"Type\": \"Normal\",\n \"GroupNum\": 1,\n\"Remark\": \"Test topic\"\n \"PartitionNum\": 3,\n \"CreateTime\": 1621308465000,\n \"UpdateTime\": 1621308657000,\n \"InstanceId\": \"rocketmq-2p9vx3ax9jxg\",\n \"Namespace\": \"test_ns\"\n }\n ]\n }\n}",
|
|
734
|
+
"title": "Retrieving Topic List"
|
|
517
735
|
}
|
|
518
736
|
],
|
|
519
|
-
"
|
|
737
|
+
"DescribeRocketMQTopicsByGroup": [
|
|
520
738
|
{
|
|
521
739
|
"document": " ",
|
|
740
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQTopicsByGroup\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"NamespaceId\": \"test_namespace\",\n \"GroupId\": \"test_group\",\n \"Offset\": 0,\n \"Limit\": 20\n}",
|
|
741
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"4668f537-44f3-4aca-bd78-fc26fb8d86ff\",\n \"TotalCount\": 1,\n \"Topics\": [\n \"test_topic\"\n ]\n }\n}",
|
|
742
|
+
"title": "Obtains the list of topics subscribed under a specified consumer group"
|
|
743
|
+
}
|
|
744
|
+
],
|
|
745
|
+
"DescribeRocketMQVipInstanceDetail": [
|
|
746
|
+
{
|
|
747
|
+
"document": "",
|
|
522
748
|
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQVipInstanceDetail\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-rd3545bkkj49\"\n}",
|
|
523
|
-
"output": "{\n \"Response\": {\n \"
|
|
524
|
-
"title": "
|
|
749
|
+
"output": "{\n \"Response\": {\n \"ClusterInfo\": {\n \"ClusterId\": \"rocketmq-rd3545bkkj49\",\n \"ClusterName\": \"rocket-order-cluster\",\n \"Region\": \"ap-guangzhou\",\n \"CreateTime\": 1729478721,\n \"Remark\": \"info- remark\",\n \"PublicEndPoint\": \"rocketmq.access.public.com:9867\",\n \"VpcEndPoint\": \"rocketmq.resource.vpc.com:5010\",\n \"SupportNamespaceEndpoint\": true,\n \"Vpcs\": [\n {\n \"VpcId\": \"vpc-9dlrd5h1\",\n \"SubnetId\": \"subnet-jadmas\"\n }\n ],\n \"IsVip\": true,\n \"RocketMQFlag\": true,\n \"Status\": 1,\n \"IsolateTime\": 1729478721,\n \"HttpPublicEndpoint\": \"http://rocketmq.access.public.com:9867\",\n \"HttpVpcEndpoint\": \"http://rocketmq.resource.vpc.com:5010\",\n \"InternalEndpoint\": \"rocketmq.tencent.internal.com:8080\",\n \"HttpInternalEndpoint\": \"http://rocketmq.tencent.internal.com:8080\",\n \"AclEnabled\": true,\n \"PublicClbId\": \"\",\n \"Vip\": \"\",\n \"VpcId\": \"\",\n \"SupportMigration\": true,\n \"InstanceStatus\": 1,\n \"ZoneId\": 100001,\n \"ZoneIds\": [\n 100001\n ]\n },\n \"InstanceConfig\": {\n \"MaxTpsPerNamespace\": 1,\n \"MaxNamespaceNum\": 1,\n \"UsedNamespaceNum\": 1,\n \"MaxTopicNum\": 1,\n \"UsedTopicNum\": 1,\n \"MaxGroupNum\": 1,\n \"UsedGroupNum\": 1,\n \"ConfigDisplay\": \"\",\n \"NodeCount\": 1,\n \"NodeDistribution\": [\n {\n \"ZoneName\": \"Guangzhou Zone 1\",\n \"ZoneId\": \"100001\",\n \"NodeCount\": 1\n }\n ],\n \"TopicDistribution\": [\n {\n \"TopicType\": \"normal\",\n \"Count\": 1\n }\n ],\n \"MaxQueuesPerTopic\": 1,\n \"MaxRetention\": 0,\n \"MinRetention\": 0,\n \"Retention\": 0,\n \"TopicNumLowerLimit\": 0,\n \"TopicNumUpperLimit\": 0\n },\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
750
|
+
"title": "Obtain the information of a single RocketMQ dedicated cluster."
|
|
525
751
|
}
|
|
526
752
|
],
|
|
527
753
|
"DescribeRocketMQVipInstances": [
|
|
528
754
|
{
|
|
529
|
-
"document": " ",
|
|
530
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQVipInstances\n<Common request parameters>\n\n{\n \"Limit\": 1,\n \"Filters\": [\n {\n \"Values\": [\n \"
|
|
531
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"
|
|
532
|
-
"title": "
|
|
755
|
+
"document": "This API is used to obtain instance lists.",
|
|
756
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRocketMQVipInstances\n<Common request parameters>\n\n{\n \"Limit\": 1,\n \"Filters\": [\n {\n \"Values\": [\n \"rocketmq-1q23swe3\"\n ],\n \"Name\": \"order-instance\"\n }\n ],\n \"Offset\": 1\n}",
|
|
757
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\",\n \"Instances\": [\n {\n \"Status\": 1,\n \"PayMode\": 1,\n \"Remark\": \"remark-info\",\n \"AutoRenewFlag\": 1,\n \"InstanceId\": \"rocketmq-1233\",\n \"NodeCount\": 1,\n \"ExpireTime\": 1,\n \"InstanceVersion\": \"4.9.3\",\n \"MaxStorage\": 1,\n \"MaxBandWidth\": 1,\n \"SpecName\": \"rocket-vip-basic-1\",\n\"ConfigDisplay\": \"Basic\"\n \"InstanceName\": \"order-instance\",\n \"MaxTps\": 1,\n \"AclEnabled\": true,\n \"Retention\": 0,\n \"MinRetention\": 0,\n \"MaxRetention\": 0\n }\n ]\n }\n}",
|
|
758
|
+
"title": "This API is used to obtain instance lists."
|
|
533
759
|
}
|
|
534
760
|
],
|
|
535
761
|
"DescribeRoles": [
|
|
536
762
|
{
|
|
537
763
|
"document": " ",
|
|
538
|
-
"input": "
|
|
539
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 4,\n \"RoleSets\": [\n {\n \"RoleName\": \"test_role_3\",\n \"Token\": \"
|
|
540
|
-
"title": "
|
|
764
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRoles\n<Common request parameters>\n\n{\n \"RoleName\": \"devRole\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\"\n}",
|
|
765
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 4,\n \"RoleSets\": [\n {\n \"RoleName\": \"test_role_3\",\n \"Token\": \"eyJzdddaWIiOiJ0ZXN0X3****O9bDulZQ6lraNswNLtcUcY\",\n \"Remark\": \"devRemark\",\n \"CreateTime\": \"2020-08-04 11:59:06\",\n \"UpdateTime\": \"2020-08-04 11:59:06\"\n },\n {\n \"RoleName\": \"test_role_2\",\n \"Token\": \"eyJzdWIiOiJ0asZsXN0X3Jasdv****AQRmEs-_3da8yU0O61D0\",\n \"Remark\": \"devRemark\",\n \"CreateTime\": \"2020-08-03 20:23:52\",\n \"UpdateTime\": \"2020-08-03 20:23:52\"\n },\n {\n \"RoleName\": \"test_role_1\",\n \"Token\": \"eyJzddassWIiOiJ0ZXN0X3J****QA7vWB0igKr_7eQitbweBoo\",\n \"Remark\": \"devRemark\",\n \"CreateTime\": \"2020-08-03 19:48:36\",\n \"UpdateTime\": \"2020-08-03 20:22:21\"\n },\n {\n \"RoleName\": \"test_role\",\n \"Token\": \"eyJzdWIiOiJ0ZXsas****5wSJ8u6sUJWW\",\n \"Remark\": \"Remark1\",\n \"CreateTime\": \"2020-08-03 17:22:09\",\n \"UpdateTime\": \"2020-08-04 15:59:29\"\n }\n ],\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
766
|
+
"title": "Obtains the list of roles"
|
|
541
767
|
}
|
|
542
768
|
],
|
|
543
769
|
"DescribeSubscriptions": [
|
|
544
770
|
{
|
|
545
771
|
"document": " ",
|
|
546
|
-
"input": "
|
|
547
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"SubscriptionSets\": [\n {\n \"EnvironmentId\": \"
|
|
548
|
-
"title": "
|
|
772
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSubscriptions\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNamespace\",\n \"TopicName\": \"devTopic\",\n \"Offset\": 0,\n \"Limit\": 1,\n \"SubscriptionName\": \"devSub\",\n \"Filters\": [\n {\n \"ConsumerHasCount\": true,\n \"ConsumerHasBacklog\": true,\n \"ConsumerHasExpired\": true,\n \"SubscriptionNames\": [\n \"devSub\"\n ]\n }\n ],\n \"ClusterId\": \"pulsar-b843bz38z5mz\"\n}",
|
|
773
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"SubscriptionSets\": [\n {\n \"EnvironmentId\": \"devNamespace\",\n \"TopicName\": \"devTopic\",\n \"ConnectedSince\": \"2024-10-08 11:38:48\",\n \"ConsumerAddr\": \"127.0.0.1\",\n \"ConsumerCount\": \"6\",\n \"ConsumerName\": \"devName\",\n \"MsgBacklog\": \"1087\",\n \"MsgRateExpired\": \"0.0\",\n \"MsgRateOut\": \"0.0\",\n \"SubType\": null,\n \"MsgThroughputOut\": \"0.0\",\n \"SubscriptionName\": \"devSub\",\n \"BlockedSubscriptionOnUnackedMsgs\": true,\n \"MaxUnackedMsgNum\": 0,\n \"Remark\": \"devRemark\",\n \"CreateTime\": \"2020-09-18 14:32:41\",\n \"UpdateTime\": \"2021-01-13 15:23:35\",\n \"IsOnline\": true,\n \"ConsumerSets\": [\n {\n \"ConnectedSince\": \"2021-01-13T15:19:21.03+08:00\",\n \"ConsumerAddr\": \"/9.219.234.200:9056\",\n \"ConsumerName\": \"axjoy\",\n \"Partition\": 4,\n \"ClientVersion\": \"2.7.2\"\n },\n {\n \"ConnectedSince\": \"2021-01-13T15:22:20.197+08:00\",\n \"ConsumerAddr\": \"/9.219.234.202:6374\",\n \"ConsumerName\": \"dkhtb\",\n \"Partition\": 4,\n \"ClientVersion\": \"2.7.2\"\n },\n {\n \"ConnectedSince\": \"2021-01-13T15:22:50.282+08:00\",\n \"ConsumerAddr\": \"/9.219.237.139:57322\",\n \"ConsumerName\": \"ejbij\",\n \"Partition\": 4,\n \"ClientVersion\": \"2.7.2\"\n },\n {\n \"ConnectedSince\": \"2021-01-13T15:18:50.927+08:00\",\n \"ConsumerAddr\": \"/9.219.233.137:62564\",\n \"ConsumerName\": \"hijsf\",\n \"Partition\": 4,\n \"ClientVersion\": \"2.7.2\"\n },\n {\n \"ConnectedSince\": \"2021-01-13T15:21:50.227+08:00\",\n \"ConsumerAddr\": \"/9.219.234.202:11554\",\n \"ConsumerName\": \"nbcra\",\n \"Partition\": 4,\n \"ClientVersion\": \"2.7.2\"\n },\n {\n \"ConnectedSince\": \"2021-01-13T15:19:51.032+08:00\",\n \"ConsumerAddr\": \"/9.219.232.202:19345\",\n \"ConsumerName\": \"vjmts\",\n \"Partition\": 4,\n \"ClientVersion\": \"2.7.2\"\n }\n ],\n \"ConsumersScheduleSets\": [\n {\n \"NumberOfEntries\": 4642,\n \"Partitions\": 0,\n \"MsgBacklog\": 1087,\n \"MsgRateOut\": \"0.0\",\n \"MsgThroughputOut\": \"0.0\",\n \"MsgRateExpired\": \"0.0\"\n }\n ]\n }\n ],\n \"RequestId\": \"39ab02af-30c8-41d4-9ac4-46cb519ceac0\"\n }\n}",
|
|
774
|
+
"title": "Spending Subscription List"
|
|
775
|
+
}
|
|
776
|
+
],
|
|
777
|
+
"DescribeTopicMsgs": [
|
|
778
|
+
{
|
|
779
|
+
"document": " ",
|
|
780
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=DescribeTopicMsgs\n&EnvironmentId=default\n&TopicName=test-topic3\n&StartTime=2020-09-22 00:00:00\n&EndTime=2020-09-22 00:00:00\n&<Common request parameters>",
|
|
781
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 10000,\n \"TopicMsgLogSets\": [\n {\n \"MsgId\": \"15591:9:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:14,281\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:8:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:14,074\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:7:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:13,867\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:6:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:13,658\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:5:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:13,449\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:4:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:13,242\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:3:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:13,015\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:2:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:12,808\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:1:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:12,600\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n },\n {\n \"MsgId\": \"15591:0:-1\",\n \"ProducerName\": \"fisrtProducer\",\n \"ProduceTime\": \"2020-08-14 16:47:12,390\",\n \"ProducerAddr\": \"9.139.220.17:37960\"\n }\n ],\n \"RequestId\": \"msgs\"\n }\n}",
|
|
782
|
+
"title": "Message Query"
|
|
549
783
|
}
|
|
550
784
|
],
|
|
551
785
|
"DescribeTopics": [
|
|
552
786
|
{
|
|
553
|
-
"document": "
|
|
554
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopics\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"
|
|
555
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"
|
|
556
|
-
"title": "
|
|
787
|
+
"document": "Obtains the list of topics in the environment",
|
|
788
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopics\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\",\n \"Offset\": 1,\n \"Limit\": 1,\n \"TopicType\": 1,\n \"ClusterId\": \"pulsar-uahenidn\",\n \"TopicCreator\": 1\n}",
|
|
789
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"bee03397-31dd-4688-8fe0-81c691c3c1ae\",\n \"TopicSets\": [\n {\n \"PulsarTopicType\": 0,\n \"TopicType\": 1,\n \"ProducerCount\": \"1\",\n \"ConsumerLimit\": \"1000\",\n \"ConsumerCount\": \"200\",\n \"LastLedgerCreatedTimestamp\": \"14578964532\",\n \"MsgThroughputIn\": \"24\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"AverageMsgSize\": \"20\",\n \"Partitions\": 1,\n \"Remark\": \"devRemark\",\n \"LastConfirmedEntry\": \"23\",\n \"TotalSize\": \"1\",\n \"NumberOfEntries\": \"12\",\n \"MsgRateOut\": \"10\",\n \"ProducerLimit\": \"10\",\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\",\n \"MsgRateIn\": \"12\",\n \"MsgThroughputOut\": \"100\",\n \"SubTopicSets\": [\n {\n \"TopicType\": 1,\n \"ProducerCount\": \"1\",\n \"LastConfirmedEntry\": \"100\",\n \"TotalSize\": \"1\",\n \"NumberOfEntries\": \"100\",\n \"ConsumerCount\": \"1\",\n \"MsgRateOut\": \"100\",\n \"AverageMsgSize\": \"1\",\n \"MsgThroughputIn\": \"100\",\n \"MsgRateIn\": \"100\",\n \"Partitions\": 0,\n \"LastLedgerCreatedTimestamp\": \"124567885324\",\n \"MsgThroughputOut\": \"100\"\n }\n ],\n \"CreateTime\": \"2020-09-22 00:00:00\"\n }\n ]\n }\n}",
|
|
790
|
+
"title": "Obtains the list of topics in the environment"
|
|
791
|
+
}
|
|
792
|
+
],
|
|
793
|
+
"ExportRocketMQMessageDetail": [
|
|
794
|
+
{
|
|
795
|
+
"document": "",
|
|
796
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ExportRocketMQMessageDetail\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-a5nzx52ab7jb\",\n \"EnvironmentId\": \"test_namespace\",\n \"TopicName\": \"test_topic\",\n \"MsgId\": \"7F0000013AEC18B4AAC278B640D30002\",\n \"DeadLetterMsg\": true,\n \"IncludeMsgBody\": true\n}",
|
|
797
|
+
"output": "{\n \"Response\": {\n \"MsgId\": \"7F0000013AEC18B4AAC278B640D30002\",\n \"BornTimestamp\": 1729478721,\n \"StoreTimestamp\": 1729478721,\n \"BornHost\": \"10.2.139.175:8080\",\n \"MsgTag\": \"test_tag\",\n \"MsgKey\": \"test_key\",\n \"Properties\": \"\",\n \"ReConsumeTimes\": 1,\n \"MsgBody\": \"This is a normal message for Apache RocketMQ\",\n \"MsgBodyCRC\": 0,\n \"MsgBodySize\": 18,\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
798
|
+
"title": "Export Message Details"
|
|
557
799
|
}
|
|
558
800
|
],
|
|
559
801
|
"ModifyCluster": [
|
|
560
802
|
{
|
|
561
|
-
"document": " ",
|
|
562
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=ModifyCluster\n&ClusterId=pulsar-
|
|
803
|
+
"document": "This example shows you how to update cluster information.",
|
|
804
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=ModifyCluster\n&ClusterId=pulsar-5r59xd4vnx\n&Remark=devRemark\n&<Common request parameters>",
|
|
563
805
|
"output": "{\n \"Response\": {\n \"ClusterId\": \"pulsar-5r59xd4vnx\",\n \"RequestId\": \"b84bf1d8-2794-4c20-a50f-02b7a4698814\"\n }\n}",
|
|
564
|
-
"title": "Updating
|
|
806
|
+
"title": "Updating Cluster Information"
|
|
565
807
|
}
|
|
566
808
|
],
|
|
567
809
|
"ModifyCmqQueueAttribute": [
|
|
568
810
|
{
|
|
569
811
|
"document": " ",
|
|
570
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=ModifyCmqQueueAttribute\n&QueueName=
|
|
812
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=ModifyCmqQueueAttribute\n&QueueName=testQueue\n&MaxMsgSize=1024\n&<Common request parameters>",
|
|
571
813
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
572
|
-
"title": "Modifying
|
|
814
|
+
"title": "Modifying Queue Attributes"
|
|
573
815
|
}
|
|
574
816
|
],
|
|
575
817
|
"ModifyCmqSubscriptionAttribute": [
|
|
576
818
|
{
|
|
577
819
|
"document": " ",
|
|
578
|
-
"input": "
|
|
820
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCmqSubscriptionAttribute\n<Common request parameters>\n\n{\n \"TopicName\": \"check-topic\",\n \"SubscriptionName\": \"check-sub\",\n \"NotifyStrategy\": \"BACKOFF_RETRY\",\n \"FilterTags\": [\n \"ins\"\n ]\n}",
|
|
579
821
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
580
|
-
"title": "Modifying
|
|
822
|
+
"title": "Modifying Subscription Attributes"
|
|
581
823
|
}
|
|
582
824
|
],
|
|
583
825
|
"ModifyCmqTopicAttribute": [
|
|
584
826
|
{
|
|
585
827
|
"document": " ",
|
|
586
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCmqTopicAttribute\n<Common request parameters>\n\n{\n \"
|
|
828
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyCmqTopicAttribute\n<Common request parameters>\n\n{\n \"TopicName\": \"test-topic\",\n \"MaxMsgSize\": 1240,\n \"MsgRetentionSeconds\": 43200,\n \"Trace\": true\n}",
|
|
587
829
|
"output": "{\n \"Response\": {\n \"RequestId\": \"8a04c6b1-dec5-4979-b3b2-34ab3b3402b2\"\n }\n}",
|
|
588
|
-
"title": "
|
|
830
|
+
"title": "Modify topic attributes."
|
|
589
831
|
}
|
|
590
832
|
],
|
|
591
833
|
"ModifyEnvironmentAttributes": [
|
|
592
834
|
{
|
|
593
|
-
"document": "
|
|
594
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyEnvironmentAttributes\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"
|
|
595
|
-
"output": "{\n \"Response\": {\n \"EnvironmentId\": \"
|
|
596
|
-
"title": "
|
|
835
|
+
"document": "Modifies the attribute value of the specified namespace",
|
|
836
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyEnvironmentAttributes\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"MsgTTL\": \"100\",\n \"ClusterId\": \"pulsar-5r59xd4vnx\"\n}",
|
|
837
|
+
"output": "{\n \"Response\": {\n \"EnvironmentId\": \"devNs\",\n \"NamespaceId\": \"namespace-5r59xen74x\",\n \"MsgTTL\": 100,\n \"Remark\": \"devRemark\",\n \"RequestId\": \"7db00a30-933c-4f6f-bba9-79cdf6be7d8c\"\n }\n}",
|
|
838
|
+
"title": "Modifies the attribute value of the specified namespace"
|
|
597
839
|
}
|
|
598
840
|
],
|
|
599
841
|
"ModifyEnvironmentRole": [
|
|
600
842
|
{
|
|
601
843
|
"document": " ",
|
|
602
|
-
"input": "
|
|
603
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
604
|
-
"title": "Modifying
|
|
844
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyEnvironmentRole\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"default\",\n \"RoleName\": \"test_role\",\n \"Permissions\": [\n \"produce\"\n ],\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\"\n}",
|
|
845
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"20846f8d-6438-4cd9-a2a4-09d5f4e8f0db\"\n }\n}",
|
|
846
|
+
"title": "Modifying Environment Role Authorization"
|
|
847
|
+
}
|
|
848
|
+
],
|
|
849
|
+
"ModifyPublicNetworkSecurityPolicy": [
|
|
850
|
+
{
|
|
851
|
+
"document": "",
|
|
852
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyPublicNetworkSecurityPolicy\n<Common request parameters>\n\n{\n \"InstanceId\": \"pulsar-47emajuiaoam\",\n \"PolicyList\": [\n {\n \"Route\": \"1.1.1.1/24\",\n \"Policy\": true,\n \"Remark\": \"allow\"\n }\n ]\n}",
|
|
853
|
+
"output": "{\n \"Response\": {\n \"ModifyResult\": \"SUCCESS\",\n \"InstanceId\": \"pulsar-47emajuiaoam\",\n \"RequestId\": \"5d6c7091-e82c-4a9c-a18f-34d5fc46006e\"\n }\n}",
|
|
854
|
+
"title": "Example"
|
|
855
|
+
}
|
|
856
|
+
],
|
|
857
|
+
"ModifyRabbitMQPermission": [
|
|
858
|
+
{
|
|
859
|
+
"document": "-",
|
|
860
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRabbitMQPermission\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"User\": \"admin\",\n \"VirtualHost\": \"testVhost\",\n \"ConfigRegexp\": \".*\",\n \"WriteRegexp\": \".*\",\n \"ReadRegexp\": \".*\"\n}",
|
|
861
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
862
|
+
"title": "Modifying RabbitMQ Permissions"
|
|
605
863
|
}
|
|
606
864
|
],
|
|
607
865
|
"ModifyRabbitMQUser": [
|
|
608
866
|
{
|
|
609
867
|
"document": "This example shows you how to modify a TDMQ for RabbitMQ user.",
|
|
610
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRabbitMQUser\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-
|
|
611
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
612
|
-
"title": "Modifying
|
|
868
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRabbitMQUser\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-2ppxx4rq\",\n \"User\": \"admin\",\n \"Password\": \"abc123._\"\n}",
|
|
869
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
870
|
+
"title": "Modifying RabbitMQ Users"
|
|
613
871
|
}
|
|
614
872
|
],
|
|
615
873
|
"ModifyRabbitMQVirtualHost": [
|
|
616
874
|
{
|
|
617
875
|
"document": "This example shows you how to modify a TDMQ for RabbitMQ vhost.",
|
|
618
876
|
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRabbitMQVirtualHost\n<Common request parameters>\n\n{\n \"InstanceId\": \"amqp-44w9928j\",\n \"VirtualHost\": \"testVhost\",\n \"Description\": \"hello\"\n}",
|
|
619
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
620
|
-
"title": "
|
|
877
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0\"\n }\n}",
|
|
878
|
+
"title": "This API is used to modify a TDMQ for RabbitMQ vhost."
|
|
621
879
|
}
|
|
622
880
|
],
|
|
623
881
|
"ModifyRocketMQCluster": [
|
|
624
882
|
{
|
|
625
|
-
"document": "This example shows you how to modify
|
|
626
|
-
"input": "
|
|
883
|
+
"document": "This example shows you how to modify cluster information.",
|
|
884
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQCluster\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-a52qova7x97b\",\n \"ClusterName\": \"test_name\",\n \"Remark\": \"remark info\",\n \"PublicAccessEnabled\": false\n}",
|
|
627
885
|
"output": "{\n \"Response\": {\n \"RequestId\": \"ccfb8e00-54ac-40ad-9d24-036279fe3ad9\"\n }\n}",
|
|
628
|
-
"title": "Modifying
|
|
886
|
+
"title": "Modifying Cluster Information"
|
|
887
|
+
}
|
|
888
|
+
],
|
|
889
|
+
"ModifyRocketMQEnvironmentRole": [
|
|
890
|
+
{
|
|
891
|
+
"document": "",
|
|
892
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQEnvironmentRole\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"test_namespace\",\n \"RoleName\": \"test_role_name\",\n \"Permissions\": [\n \"produce\"\n ],\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\"\n}",
|
|
893
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
894
|
+
"title": "Modifying RocketMQ Environment Role Authorization"
|
|
629
895
|
}
|
|
630
896
|
],
|
|
631
897
|
"ModifyRocketMQGroup": [
|
|
632
898
|
{
|
|
633
899
|
"document": " ",
|
|
634
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQGroup\n<Common request parameters>\n\n{\n \"Remark\": \"modified\",\n \"BroadcastEnable\": \"false\",\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"GroupId\": \"
|
|
900
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQGroup\n<Common request parameters>\n\n{\n \"Remark\": \"Test modified consumer group\",\n \"BroadcastEnable\": \"false\",\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"GroupId\": \"test_group\",\n \"RetryMaxTimes\": \"16\",\n \"ReadEnable\": \"true\",\n \"NamespaceId\": \"test_namespace\"\n}",
|
|
635
901
|
"output": "{\n \"Response\": {\n \"RequestId\": \"1f9e837c-aab9-4f93-a373-48e165758529\"\n }\n}",
|
|
636
|
-
"title": "Modifying a
|
|
902
|
+
"title": "Modifying a Subscription Group"
|
|
903
|
+
}
|
|
904
|
+
],
|
|
905
|
+
"ModifyRocketMQInstance": [
|
|
906
|
+
{
|
|
907
|
+
"document": "Modify the RocketMQ dedicated instance.",
|
|
908
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"rocketmq-4k4orqgq\",\n \"Name\": \"order-service-instance\",\n \"Remark\": \"info-mark\",\n \"MessageRetention\": 24\n}",
|
|
909
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
910
|
+
"title": "Modify the RocketMQ dedicated instance."
|
|
637
911
|
}
|
|
638
912
|
],
|
|
639
913
|
"ModifyRocketMQInstanceSpec": [
|
|
640
914
|
{
|
|
641
|
-
"document": "This example shows you how to
|
|
642
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQInstanceSpec\n<Common request parameters>\n\n{\n \"InstanceId\": \"
|
|
643
|
-
"output": "{\n \"Response\": {\n \"OrderId\": \"
|
|
644
|
-
"title": "Modifying the
|
|
915
|
+
"document": "This example shows you how to perform scaling on an instance.",
|
|
916
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQInstanceSpec\n<Common request parameters>\n\n{\n \"InstanceId\": \"rocketmq-4k4orqgq\",\n \"Specification\": \"rocket-vip-basic-1\",\n \"NodeCount\": 2,\n \"StorageSize\": 1000\n}",
|
|
917
|
+
"output": "{\n \"Response\": {\n \"OrderId\": \"TDMQ20121212312322\",\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
918
|
+
"title": "Modifying the RocketMQ Dedicated Instance Specification"
|
|
645
919
|
}
|
|
646
920
|
],
|
|
647
921
|
"ModifyRocketMQNamespace": [
|
|
648
922
|
{
|
|
649
|
-
"document": "This example shows you how to modify
|
|
650
|
-
"input": "
|
|
923
|
+
"document": "This example shows you how to modify namespace information.",
|
|
924
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQNamespace\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-xj8kr5apevj7\",\n \"NamespaceId\": \"test_namespace\",\n \"Ttl\": 259200000,\n \"RetentionTime\": 259200000,\n \"Remark\": \"Test modification\",\n \"PublicAccessEnabled\": true\n}",
|
|
651
925
|
"output": "{\n \"Response\": {\n \"RequestId\": \"7c995fd0-9a78-4985-8874-244a20a1d47b\"\n }\n}",
|
|
652
|
-
"title": "Modifying
|
|
926
|
+
"title": "Modifying Namespace Information"
|
|
927
|
+
}
|
|
928
|
+
],
|
|
929
|
+
"ModifyRocketMQRole": [
|
|
930
|
+
{
|
|
931
|
+
"document": "",
|
|
932
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQRole\n<Common request parameters>\n\n{\n \"RoleName\": \"test_role_name\",\n \"Remark\": \"Modify role\",\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\"\n}",
|
|
933
|
+
"output": "{\n \"Response\": {\n \"RoleName\": \"test_role_name\",\n \"Remark\": \"Modify role\",\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
934
|
+
"title": "Modifying a Role"
|
|
653
935
|
}
|
|
654
936
|
],
|
|
655
937
|
"ModifyRocketMQTopic": [
|
|
656
938
|
{
|
|
657
939
|
"document": " ",
|
|
658
|
-
"input": "
|
|
940
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRocketMQTopic\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"NamespaceId\": \"test_namespace\",\n \"Topic\": \"test_topic\",\n \"Remark\": \"Test modification\",\n \"PartitionNum\": 3\n}",
|
|
659
941
|
"output": "{\n \"Response\": {\n \"RequestId\": \"5d41e0f7-5668-46f9-a549-9a7540a9966c\"\n }\n}",
|
|
660
|
-
"title": "
|
|
942
|
+
"title": "Modify Topic"
|
|
661
943
|
}
|
|
662
944
|
],
|
|
663
945
|
"ModifyRole": [
|
|
664
946
|
{
|
|
665
|
-
"document": " ",
|
|
666
|
-
"input": "
|
|
667
|
-
"output": "{\n \"Response\": {\n \"RoleName\": \"
|
|
668
|
-
"title": "Updating
|
|
947
|
+
"document": "This example shows you how to update a role.",
|
|
948
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRole\n<Common request parameters>\n\n{\n \"RoleName\": \"role1\",\n \"Remark\": \"remarkDemo\",\n \"ClusterId\": \"pulsar-xk3ne8k2qkp8\",\n \"EnvironmentRoleSets\": [\n {\n \"EnvironmentId\": \"devNs\",\n \"Permissions\": [\n \"produce\"\n ]\n }\n ],\n \"UnbindAllEnvironment\": true\n}",
|
|
949
|
+
"output": "{\n \"Response\": {\n \"RoleName\": \"role1\",\n \"Remark\": \"remarkDemo\",\n \"RequestId\": \"1004f1de-6fb8-41d5-965e-3aae8c87183a\"\n }\n}",
|
|
950
|
+
"title": "Updating a Role"
|
|
669
951
|
}
|
|
670
952
|
],
|
|
671
953
|
"ModifyTopic": [
|
|
672
954
|
{
|
|
673
955
|
"document": " ",
|
|
674
|
-
"input": "
|
|
675
|
-
"output": "{\n \"Response\": {\n \"Partitions\": 3,\n
|
|
676
|
-
"title": "
|
|
956
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyTopic\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\",\n \"Partitions\": 1,\n \"Remark\": \"devTest\",\n \"ClusterId\": \"pulsar-5r59xd4vnx\",\n \"MsgTTL\": 1\n}",
|
|
957
|
+
"output": "{\n \"Response\": {\n \"Partitions\": 3,\n\"Remark\": \"Change partition to 3\"\n \"RequestId\": \"c276a96f-1612-47ad-9562-da06d4fdf1ed\"\n }\n}",
|
|
958
|
+
"title": "Modify topic attributes."
|
|
677
959
|
}
|
|
678
960
|
],
|
|
679
961
|
"PublishCmqMsg": [
|
|
680
962
|
{
|
|
681
963
|
"document": " ",
|
|
682
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=PublishCmqMsg\n&TopicName=test-queue\n&MsgContent=
|
|
683
|
-
"output": "{\n \"Response\": {\n \"Result\": true,\n \"MsgId\": \"
|
|
684
|
-
"title": "
|
|
964
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=PublishCmqMsg\n&TopicName=test-queue\n&MsgContent=testForPublish\n&<Common request parameters>",
|
|
965
|
+
"output": "{\n \"Response\": {\n \"Result\": true,\n \"MsgId\": \"1EAD5E05003A6767C1FC9160304F98\",\n \"RequestId\": \"3593f784-fcfb-4f23-b3dd-4751cba3aec7\"\n }\n}",
|
|
966
|
+
"title": "Sends CMQ topic messages"
|
|
685
967
|
}
|
|
686
968
|
],
|
|
687
969
|
"ReceiveMessage": [
|
|
688
970
|
{
|
|
689
971
|
"document": " ",
|
|
690
972
|
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ReceiveMessage\n<Common request parameters>\n\n{\n \"Topic\": \"tenant/namespace/topic\",\n \"SubscriptionName\": \"\\\"test-sub\\\"\"\n}",
|
|
691
|
-
"output": "{\n \"Response\": {\n \"
|
|
692
|
-
"title": "Receiving
|
|
973
|
+
"output": "{\n \"Response\": {\n \"MessageID\": \"931087:81:0\",\n \"MessagePayload\": \"msg send\",\n \"AckTopic\": \"tenant/namespace/topic\",\n \"ErrorMsg\": \"success\",\n \"SubName\": \"test-sub\",\n \"MessageIDList\": \"931087:81:0\",\n \"MessagesPayload\": \"msg send\",\n \"RequestId\": \"bee03397-31dd-4688-8fe0-81c691c3c1ae\"\n }\n}",
|
|
974
|
+
"title": "Receiving Messages"
|
|
693
975
|
}
|
|
694
976
|
],
|
|
695
977
|
"ResetMsgSubOffsetByTimestamp": [
|
|
696
978
|
{
|
|
697
979
|
"document": " ",
|
|
698
|
-
"input": "
|
|
980
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetMsgSubOffsetByTimestamp\n<Common request parameters>\n\n{\n \"EnvironmentId\": \"devNs\",\n \"TopicName\": \"devTopic\",\n \"Subscription\": \"devSub\",\n \"ToTimestamp\": 1730690396152,\n \"ClusterId\": \"pulsar-pnvjp9mbd947\"\n}",
|
|
699
981
|
"output": "{\n \"Response\": {\n \"Result\": true,\n \"RequestId\": \"3593f784-fcfb-4f23-b3dd-4751cba3aec7\"\n }\n}",
|
|
700
|
-
"title": "
|
|
982
|
+
"title": "Rewindable Message"
|
|
701
983
|
}
|
|
702
984
|
],
|
|
703
985
|
"ResetRocketMQConsumerOffSet": [
|
|
704
986
|
{
|
|
705
987
|
"document": " ",
|
|
706
|
-
"input": "
|
|
988
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetRocketMQConsumerOffSet\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-2p9vx3ax9jxg\",\n \"NamespaceId\": \"test_namespace\",\n \"GroupId\": \"test_group\",\n \"Topic\": \"test_topic\",\n \"Type\": 1,\n \"ResetTimestamp\": 1697945990000\n}",
|
|
707
989
|
"output": "{\n \"Response\": {\n \"RequestId\": \"def4f676-27fc-4437-b4a3-cf1509726f98\"\n }\n}",
|
|
708
|
-
"title": "
|
|
990
|
+
"title": "Reset the consumption position."
|
|
991
|
+
}
|
|
992
|
+
],
|
|
993
|
+
"RetryRocketMQDlqMessage": [
|
|
994
|
+
{
|
|
995
|
+
"document": "",
|
|
996
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RetryRocketMQDlqMessage\n<Common request parameters>\n\n{\n \"NamespaceId\": \"test_ns\",\n \"ClusterId\": \"rocketmq-a52qova7x97b\",\n \"GroupName\": \"test_group\",\n \"MessageIds\": [\n \"01963F0B14BAF09F27077D244F00000000\"\n ]\n}",
|
|
997
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"90760e40-5db2-4150-807f-5760c2a03804\"\n }\n}",
|
|
998
|
+
"title": "Resending a Dead Letter Message"
|
|
709
999
|
}
|
|
710
1000
|
],
|
|
711
1001
|
"RewindCmqQueue": [
|
|
712
1002
|
{
|
|
713
1003
|
"document": " ",
|
|
714
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=RewindCmqQueue\n&QueueName=
|
|
1004
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=RewindCmqQueue\n&QueueName=testQueue\n&StartConsumeTime=1582108595000\n&<Common request parameters>",
|
|
715
1005
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
716
|
-
"title": "
|
|
1006
|
+
"title": "Backtracking Queue Consumption Position"
|
|
717
1007
|
}
|
|
718
1008
|
],
|
|
719
1009
|
"SendBatchMessages": [
|
|
720
1010
|
{
|
|
721
1011
|
"document": " ",
|
|
722
1012
|
"input": "https://tdmq.tencentcloudapi.com/?Action=SendBatchMessages\n&Topic=tenant/namespace/topic\n&Payload=\"hello TDMQ\"\n&<Common request parameters>",
|
|
723
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\",\n \"
|
|
724
|
-
"title": "
|
|
1013
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\",\n \"ErrorMsg\": \"success\",\n \"MessageId\": \"71:12:0:0\"\n }\n}",
|
|
1014
|
+
"title": "Successfully Send Multiple Messages"
|
|
725
1015
|
}
|
|
726
1016
|
],
|
|
727
1017
|
"SendCmqMsg": [
|
|
728
1018
|
{
|
|
729
1019
|
"document": " ",
|
|
730
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=SendCmqMsg\n&QueueName=test-queue\n&MsgContent=
|
|
731
|
-
"output": "{\n \"Response\": {\n \"Result\": true,\n \"MsgId\": \"
|
|
732
|
-
"title": "Sending
|
|
1020
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=SendCmqMsg\n&QueueName=test-queue\n&MsgContent=testforSend\n&DelaySeconds=0\n&<Common request parameters>",
|
|
1021
|
+
"output": "{\n \"Response\": {\n \"Result\": true,\n \"MsgId\": \"09A51113003621B8D17C0DF3DC2403DC\",\n \"RequestId\": \"3593f784-fcfb-4f23-b3dd-4751cba3aec7\"\n }\n}",
|
|
1022
|
+
"title": "Sending Messages"
|
|
733
1023
|
}
|
|
734
1024
|
],
|
|
735
1025
|
"SendMessages": [
|
|
736
1026
|
{
|
|
737
|
-
"document": "This example shows you how to send a single message.\
|
|
1027
|
+
"document": "This example shows you how to successfully send a single message.\nThis example shows you how to work with unsupported non-persistent topics.",
|
|
738
1028
|
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SendMessages\n<Common request parameters>\n\n{\n \"Topic\": \"tenant/namespace/topic\",\n \"Payload\": \"\\\"hello TDMQ\\\"\"\n}",
|
|
739
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\",\n \"MessageId\": \"71:11:0:0\",\n \"ErrorMsg\": \"\"\n }\n}",
|
|
740
|
-
"title": "
|
|
1029
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\",\n \"MessageId\": \"71:11:0:0\",\n \"ErrorMsg\": \"success\"\n }\n}",
|
|
1030
|
+
"title": "Successfully Send Single Message"
|
|
741
1031
|
}
|
|
742
1032
|
],
|
|
743
1033
|
"SendMsg": [
|
|
744
1034
|
{
|
|
745
1035
|
"document": " ",
|
|
746
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=SendMsg\n&EnvironmentId=
|
|
1036
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=SendMsg\n&EnvironmentId=userNamespace\n&TopicName=cloud_test\n&MsgContent=one_msg\n&<Common request parameters>",
|
|
747
1037
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3593f784-fcfb-4f23-b3dd-4751cba3aec7\"\n }\n}",
|
|
748
|
-
"title": "Sending
|
|
1038
|
+
"title": "Sending a Message"
|
|
749
1039
|
}
|
|
750
1040
|
],
|
|
751
1041
|
"SendRocketMQMessage": [
|
|
1042
|
+
{
|
|
1043
|
+
"document": "",
|
|
1044
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SendRocketMQMessage\n<Common request parameters>\n\n{\n \"ClusterId\": \"rocketmq-4k4orqgq\",\n \"NamespaceId\": \"test_namespace\",\n \"TopicName\": \"test_topic\",\n \"MsgKey\": \"test_key\",\n \"MsgTag\": \"test_tag\",\n \"MsgBody\": \"This is a normal message for Apache RocketMQ\"\n}",
|
|
1045
|
+
"output": "{\n \"Response\": {\n \"Result\": true,\n \"MsgId\": \"7F0000013AEC18B4AAC278B640D30002\",\n \"RequestId\": \"23ca1a58-0388-4d2d-8465-653a53addda7\"\n }\n}",
|
|
1046
|
+
"title": "Sending a Message Example"
|
|
1047
|
+
}
|
|
1048
|
+
],
|
|
1049
|
+
"SetRocketMQPublicAccessPoint": [
|
|
752
1050
|
{
|
|
753
1051
|
"document": " ",
|
|
754
|
-
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action:
|
|
755
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
756
|
-
"title": "
|
|
1052
|
+
"input": "POST / HTTP/1.1\nHost: tdmq.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetRocketMQPublicAccessPoint\n<Common request parameters>\n\n{\n \"Rules\": [\n {\n \"Remark\": \"remark info\",\n \"IpRule\": \"0.0.0.0/0\",\n \"Allow\": \"true\"\n }\n ],\n \"PayMode\": \"0\",\n \"Bandwidth\": \"2\",\n \"InstanceId\": \"rocketmq-jxj3wj5j8e7\",\n \"Enabled\": \"true\"\n}",
|
|
1053
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"b28ad6c3-059f-4c38-8a97-a66b3b136a3e\"\n }\n}",
|
|
1054
|
+
"title": "Enabling Public Network Access Point"
|
|
757
1055
|
}
|
|
758
1056
|
],
|
|
759
1057
|
"UnbindCmqDeadLetter": [
|
|
760
1058
|
{
|
|
761
1059
|
"document": " ",
|
|
762
|
-
"input": "https://tdmq.tencentcloudapi.com/?Action=UnbindCmqDeadLetter\n&SourceQueueName=
|
|
1060
|
+
"input": "https://tdmq.tencentcloudapi.com/?Action=UnbindCmqDeadLetter\n&SourceQueueName=testQueue\n&<Common request parameters>",
|
|
763
1061
|
"output": "{\n \"Response\": {\n \"RequestId\": \"3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc\"\n }\n}",
|
|
764
|
-
"title": "Unbinding
|
|
1062
|
+
"title": "Unbinding a Dead Letter Queue"
|
|
765
1063
|
}
|
|
766
1064
|
]
|
|
767
1065
|
},
|