tccli 3.0.1248.1__py2.py3-none-any.whl → 3.0.1250.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/aiart/aiart_client.py +113 -7
  3. tccli/services/aiart/v20221229/api.json +191 -0
  4. tccli/services/aiart/v20221229/examples.json +16 -0
  5. tccli/services/batch/v20170312/api.json +1 -1
  6. tccli/services/cbs/v20170312/api.json +6 -0
  7. tccli/services/cdb/v20170320/api.json +9 -0
  8. tccli/services/cfw/v20190904/api.json +5 -3
  9. tccli/services/cmq/cmq_client.py +4 -799
  10. tccli/services/cmq/v20190304/api.json +135 -1329
  11. tccli/services/cmq/v20190304/examples.json +0 -120
  12. tccli/services/config/config_client.py +110 -4
  13. tccli/services/config/v20220802/api.json +374 -0
  14. tccli/services/config/v20220802/examples.json +16 -0
  15. tccli/services/cvm/v20170312/api.json +1 -1
  16. tccli/services/dc/v20180410/api.json +50 -48
  17. tccli/services/dc/v20180410/examples.json +8 -8
  18. tccli/services/ecm/v20190719/api.json +64 -62
  19. tccli/services/ecm/v20190719/examples.json +5 -5
  20. tccli/services/es/v20180416/api.json +10 -0
  21. tccli/services/ess/v20201111/api.json +163 -163
  22. tccli/services/ess/v20201111/examples.json +15 -21
  23. tccli/services/essbasic/v20210526/api.json +89 -89
  24. tccli/services/essbasic/v20210526/examples.json +2 -2
  25. tccli/services/hai/hai_client.py +60 -7
  26. tccli/services/hai/v20230812/api.json +195 -0
  27. tccli/services/hai/v20230812/examples.json +8 -0
  28. tccli/services/iotexplorer/iotexplorer_client.py +228 -16
  29. tccli/services/iotexplorer/v20190423/api.json +536 -0
  30. tccli/services/iotexplorer/v20190423/examples.json +32 -0
  31. tccli/services/iotvideo/iotvideo_client.py +53 -0
  32. tccli/services/iotvideo/v20211125/api.json +80 -0
  33. tccli/services/iotvideo/v20211125/examples.json +8 -0
  34. tccli/services/lkeap/v20240522/api.json +13 -13
  35. tccli/services/lkeap/v20240522/examples.json +2 -2
  36. tccli/services/mna/v20210119/api.json +24 -24
  37. tccli/services/mna/v20210119/examples.json +2 -2
  38. tccli/services/redis/v20180412/api.json +181 -181
  39. tccli/services/redis/v20180412/examples.json +1 -1
  40. tccli/services/sms/v20190711/api.json +48 -0
  41. tccli/services/sms/v20210111/api.json +48 -0
  42. tccli/services/tcb/v20180608/api.json +173 -145
  43. tccli/services/tcb/v20180608/examples.json +8 -8
  44. tccli/services/tcr/v20190924/api.json +5 -5
  45. tccli/services/tke/v20220501/api.json +1 -1
  46. tccli/services/trro/v20220325/api.json +71 -61
  47. tccli/services/trro/v20220325/examples.json +1 -1
  48. tccli/services/trtc/v20190722/api.json +114 -114
  49. tccli/services/tse/v20201207/api.json +18 -0
  50. tccli/services/vpc/v20170312/api.json +35 -33
  51. tccli/services/vpc/v20170312/examples.json +18 -18
  52. tccli/services/wedata/v20210820/api.json +80 -2
  53. tccli/services/wedata/v20210820/examples.json +1 -1
  54. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/METADATA +2 -2
  55. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/RECORD +58 -58
  56. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/WHEEL +0 -0
  57. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/entry_points.txt +0 -0
  58. {tccli-3.0.1248.1.dist-info → tccli-3.0.1250.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,68 +1,5 @@
1
1
  {
2
2
  "actions": {
3
- "ClearQueue": {
4
- "document": "下线老cmq云API 3.0 无调用量接口\n\n清除queue中的所有消息",
5
- "input": "ClearQueueRequest",
6
- "name": "清空消息队列中的消息",
7
- "output": "ClearQueueResponse",
8
- "status": "deprecated"
9
- },
10
- "ClearSubscriptionFilterTags": {
11
- "document": "下线老cmq云API 3.0 无调用量接口\n\n清空订阅者消息标签",
12
- "input": "ClearSubscriptionFilterTagsRequest",
13
- "name": "清空订阅者消息标签",
14
- "output": "ClearSubscriptionFilterTagsResponse",
15
- "status": "deprecated"
16
- },
17
- "CreateQueue": {
18
- "document": "创建队列接口\n",
19
- "input": "CreateQueueRequest",
20
- "name": "创建队列接口",
21
- "output": "CreateQueueResponse",
22
- "status": "online"
23
- },
24
- "CreateSubscribe": {
25
- "document": "下线老cmq云API 3.0 无调用量接口\n\n创建订阅接口",
26
- "input": "CreateSubscribeRequest",
27
- "name": "创建订阅接口",
28
- "output": "CreateSubscribeResponse",
29
- "status": "deprecated"
30
- },
31
- "CreateTopic": {
32
- "document": "创建主题",
33
- "input": "CreateTopicRequest",
34
- "name": "创建主题",
35
- "output": "CreateTopicResponse",
36
- "status": "online"
37
- },
38
- "DeleteQueue": {
39
- "document": "DeleteQueue",
40
- "input": "DeleteQueueRequest",
41
- "name": "删除队列",
42
- "output": "DeleteQueueResponse",
43
- "status": "online"
44
- },
45
- "DeleteSubscribe": {
46
- "document": "下线老cmq云API 3.0 无调用量接口\n\n删除订阅",
47
- "input": "DeleteSubscribeRequest",
48
- "name": "删除订阅",
49
- "output": "DeleteSubscribeResponse",
50
- "status": "deprecated"
51
- },
52
- "DeleteTopic": {
53
- "document": "下线老cmq云API 3.0 无调用量接口\n\n删除主题",
54
- "input": "DeleteTopicRequest",
55
- "name": "删除主题",
56
- "output": "DeleteTopicResponse",
57
- "status": "deprecated"
58
- },
59
- "DescribeDeadLetterSourceQueues": {
60
- "document": "下线老cmq云API 3.0 无调用量接口\n\n枚举死信队列源队列",
61
- "input": "DescribeDeadLetterSourceQueuesRequest",
62
- "name": "枚举死信队列源队列",
63
- "output": "DescribeDeadLetterSourceQueuesResponse",
64
- "status": "deprecated"
65
- },
66
3
  "DescribeQueueDetail": {
67
4
  "document": "枚举队列列表",
68
5
  "input": "DescribeQueueDetailRequest",
@@ -70,54 +7,12 @@
70
7
  "output": "DescribeQueueDetailResponse",
71
8
  "status": "online"
72
9
  },
73
- "DescribeSubscriptionDetail": {
74
- "document": "查询订阅详情",
75
- "input": "DescribeSubscriptionDetailRequest",
76
- "name": "查询订阅详情",
77
- "output": "DescribeSubscriptionDetailResponse",
78
- "status": "online"
79
- },
80
10
  "DescribeTopicDetail": {
81
11
  "document": "查询主题详情",
82
12
  "input": "DescribeTopicDetailRequest",
83
13
  "name": "查询主题列表",
84
14
  "output": "DescribeTopicDetailResponse",
85
15
  "status": "online"
86
- },
87
- "ModifyQueueAttribute": {
88
- "document": "修改队列属性",
89
- "input": "ModifyQueueAttributeRequest",
90
- "name": "修改队列属性",
91
- "output": "ModifyQueueAttributeResponse",
92
- "status": "online"
93
- },
94
- "ModifySubscriptionAttribute": {
95
- "document": "下线老cmq云API 3.0 无调用量接口\n\n修改订阅属性",
96
- "input": "ModifySubscriptionAttributeRequest",
97
- "name": "修改订阅属性",
98
- "output": "ModifySubscriptionAttributeResponse",
99
- "status": "deprecated"
100
- },
101
- "ModifyTopicAttribute": {
102
- "document": "下线老cmq云API 3.0 无调用量接口\n\n修改主题属性",
103
- "input": "ModifyTopicAttributeRequest",
104
- "name": "修改主题属性",
105
- "output": "ModifyTopicAttributeResponse",
106
- "status": "deprecated"
107
- },
108
- "RewindQueue": {
109
- "document": "下线老cmq云API 3.0 无调用量接口\n\n回溯队列",
110
- "input": "RewindQueueRequest",
111
- "name": "回溯队列",
112
- "output": "RewindQueueResponse",
113
- "status": "deprecated"
114
- },
115
- "UnbindDeadLetter": {
116
- "document": "下线老cmq云API 3.0 无调用量接口\n\n解绑死信队列",
117
- "input": "UnbindDeadLetterRequest",
118
- "name": "解绑死信队列",
119
- "output": "UnbindDeadLetterResponse",
120
- "status": "deprecated"
121
16
  }
122
17
  },
123
18
  "metadata": {
@@ -127,860 +22,147 @@
127
22
  "serviceShortName": "cmq"
128
23
  },
129
24
  "objects": {
130
- "ClearQueueRequest": {
131
- "document": "ClearQueue请求参数结构体",
132
- "members": [
133
- {
134
- "disabled": false,
135
- "document": "队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
136
- "example": "",
137
- "member": "string",
138
- "name": "QueueName",
139
- "required": true,
140
- "type": "string"
141
- }
142
- ],
143
- "type": "object"
144
- },
145
- "ClearQueueResponse": {
146
- "document": "ClearQueue返回参数结构体",
147
- "members": [
148
- {
149
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
150
- "member": "string",
151
- "name": "RequestId",
152
- "type": "string"
153
- }
154
- ],
155
- "type": "object"
156
- },
157
- "ClearSubscriptionFilterTagsRequest": {
158
- "document": "ClearSubscriptionFilterTags请求参数结构体",
25
+ "DeadLetterPolicy": {
26
+ "document": "死信队列策略",
159
27
  "members": [
160
28
  {
161
29
  "disabled": false,
162
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
163
- "example": "",
30
+ "document": "死信队列。\n注意:此字段可能返回 null,表示取不到有效值。",
31
+ "example": "queue-xxxxx",
164
32
  "member": "string",
165
- "name": "TopicName",
33
+ "name": "DeadLetterQueue",
166
34
  "required": true,
167
- "type": "string"
35
+ "type": "string",
36
+ "value_allowed_null": true
168
37
  },
169
38
  {
170
39
  "disabled": false,
171
- "document": "订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
172
- "example": "",
173
- "member": "string",
174
- "name": "SubscriptionName",
175
- "required": true,
176
- "type": "string"
177
- }
178
- ],
179
- "type": "object"
180
- },
181
- "ClearSubscriptionFilterTagsResponse": {
182
- "document": "ClearSubscriptionFilterTags返回参数结构体",
183
- "members": [
184
- {
185
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
186
- "member": "string",
187
- "name": "RequestId",
188
- "type": "string"
189
- }
190
- ],
191
- "type": "object"
192
- },
193
- "CreateQueueRequest": {
194
- "document": "CreateQueue请求参数结构体",
195
- "members": [
196
- {
197
- "disabled": false,
198
- "document": "队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
199
- "example": "",
40
+ "document": "死信队列名字。\n注意:此字段可能返回 null,表示取不到有效值。",
41
+ "example": "test",
200
42
  "member": "string",
201
- "name": "QueueName",
43
+ "name": "DeadLetterQueueName",
202
44
  "required": true,
203
- "type": "string"
204
- },
205
- {
206
- "disabled": false,
207
- "document": "最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。",
208
- "example": "",
209
- "member": "uint64",
210
- "name": "MaxMsgHeapNum",
211
- "required": false,
212
- "type": "int"
213
- },
214
- {
215
- "disabled": false,
216
- "document": "消息接收长轮询等待时间。取值范围 0-30 秒,默认值 0。",
217
- "example": "",
218
- "member": "uint64",
219
- "name": "PollingWaitSeconds",
220
- "required": false,
221
- "type": "int"
222
- },
223
- {
224
- "disabled": false,
225
- "document": "消息可见性超时。取值范围 1-43200 秒(即12小时内),默认值 30。",
226
- "example": "",
227
- "member": "uint64",
228
- "name": "VisibilityTimeout",
229
- "required": false,
230
- "type": "int"
231
- },
232
- {
233
- "disabled": false,
234
- "document": "消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。",
235
- "example": "",
236
- "member": "uint64",
237
- "name": "MaxMsgSize",
238
- "required": false,
239
- "type": "int"
240
- },
241
- {
242
- "disabled": false,
243
- "document": "消息保留周期。取值范围 60-1296000 秒(1min-15天),默认值 345600 (4 天)。",
244
- "example": "",
245
- "member": "uint64",
246
- "name": "MsgRetentionSeconds",
247
- "required": false,
248
- "type": "int"
249
- },
250
- {
251
- "disabled": false,
252
- "document": "队列是否开启回溯消息能力,该参数取值范围0-msgRetentionSeconds,即最大的回溯时间为消息在队列中的保留周期,0表示不开启。",
253
- "example": "",
254
- "member": "uint64",
255
- "name": "RewindSeconds",
256
- "required": false,
257
- "type": "int"
258
- },
259
- {
260
- "disabled": false,
261
- "document": "1 表示事务队列,0 表示普通队列",
262
- "example": "",
263
- "member": "uint64",
264
- "name": "Transaction",
265
- "required": false,
266
- "type": "int"
267
- },
268
- {
269
- "disabled": false,
270
- "document": "第一次回查间隔",
271
- "example": "",
272
- "member": "uint64",
273
- "name": "FirstQueryInterval",
274
- "required": false,
275
- "type": "int"
45
+ "type": "string",
46
+ "value_allowed_null": true
276
47
  },
277
48
  {
278
49
  "disabled": false,
279
- "document": "最大回查次数",
280
- "example": "",
50
+ "document": "最大未消费过期时间。Policy为1时必选。范围300-43200,单位秒,需要小于消息最大保留时间MsgRetentionSeconds。\n注意:此字段可能返回 null,表示取不到有效值。",
51
+ "example": "300",
281
52
  "member": "uint64",
282
- "name": "MaxQueryCount",
283
- "required": false,
284
- "type": "int"
285
- },
286
- {
287
- "disabled": false,
288
- "document": "死信队列名称",
289
- "example": "",
290
- "member": "string",
291
- "name": "DeadLetterQueueName",
292
- "required": false,
293
- "type": "string"
53
+ "name": "MaxTimeToLive",
54
+ "required": true,
55
+ "type": "int",
56
+ "value_allowed_null": true
294
57
  },
295
58
  {
296
59
  "disabled": false,
297
- "document": "死信策略。0为消息被多次消费未删除,1为Time-To-Live过期",
298
- "example": "",
60
+ "document": "死信队列策略。\n注意:此字段可能返回 null,表示取不到有效值。",
61
+ "example": "1",
299
62
  "member": "uint64",
300
63
  "name": "Policy",
301
- "required": false,
302
- "type": "int"
64
+ "required": true,
65
+ "type": "int",
66
+ "value_allowed_null": true
303
67
  },
304
68
  {
305
69
  "disabled": false,
306
- "document": "最大接收次数 1-1000",
307
- "example": "",
70
+ "document": "最大接收次数。\n注意:此字段可能返回 null,表示取不到有效值。",
71
+ "example": "1",
308
72
  "member": "uint64",
309
73
  "name": "MaxReceiveCount",
310
- "required": false,
311
- "type": "int"
312
- },
313
- {
314
- "disabled": false,
315
- "document": "policy为1时必选。最大未消费过期时间。范围300-43200,单位秒,需要小于消息最大保留时间msgRetentionSeconds",
316
- "example": "",
317
- "member": "uint64",
318
- "name": "MaxTimeToLive",
319
- "required": false,
320
- "type": "int"
321
- },
322
- {
323
- "disabled": false,
324
- "document": "是否开启消息轨迹追踪,当不设置字段时,默认为不开启,该字段为true表示开启,为false表示不开启",
325
- "example": "",
326
- "member": "bool",
327
- "name": "Trace",
328
- "required": false,
329
- "type": "bool"
74
+ "required": true,
75
+ "type": "int",
76
+ "value_allowed_null": true
330
77
  }
331
78
  ],
332
- "type": "object"
79
+ "usage": "out"
333
80
  },
334
- "CreateQueueResponse": {
335
- "document": "CreateQueue返回参数结构体",
81
+ "DeadLetterSource": {
82
+ "document": "死信源队列信息",
336
83
  "members": [
337
84
  {
338
85
  "disabled": false,
339
- "document": "创建成功的queueId",
340
- "example": "",
86
+ "document": "消息队列ID。\n注意:此字段可能返回 null,表示取不到有效值。",
87
+ "example": "queue-xxxxxxx",
341
88
  "member": "string",
342
89
  "name": "QueueId",
90
+ "required": true,
343
91
  "type": "string",
344
- "value_allowed_null": false
92
+ "value_allowed_null": true
345
93
  },
346
94
  {
347
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
95
+ "disabled": false,
96
+ "document": "消息队列名字。\n注意:此字段可能返回 null,表示取不到有效值。",
97
+ "example": "test",
348
98
  "member": "string",
349
- "name": "RequestId",
350
- "type": "string"
99
+ "name": "QueueName",
100
+ "required": true,
101
+ "type": "string",
102
+ "value_allowed_null": true
351
103
  }
352
104
  ],
353
- "type": "object"
105
+ "usage": "out"
354
106
  },
355
- "CreateSubscribeRequest": {
356
- "document": "CreateSubscribe请求参数结构体",
107
+ "DescribeQueueDetailRequest": {
108
+ "document": "DescribeQueueDetail请求参数结构体",
357
109
  "members": [
358
110
  {
359
111
  "disabled": false,
360
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
361
- "example": "",
362
- "member": "string",
363
- "name": "TopicName",
364
- "required": true,
365
- "type": "string"
366
- },
367
- {
368
- "disabled": false,
369
- "document": "订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
370
- "example": "",
371
- "member": "string",
372
- "name": "SubscriptionName",
373
- "required": true,
374
- "type": "string"
375
- },
376
- {
377
- "disabled": false,
378
- "document": "订阅的协议,目前支持两种协议:http、queue。使用http协议,用户需自己搭建接受消息的web server。使用queue,消息会自动推送到CMQ queue,用户可以并发地拉取消息。",
379
- "example": "",
380
- "member": "string",
381
- "name": "Protocol",
382
- "required": true,
383
- "type": "string"
384
- },
385
- {
386
- "disabled": false,
387
- "document": "接收通知的Endpoint,根据协议Protocol区分:对于http,Endpoint必须以“`http://`”开头,host可以是域名或IP;对于Queue,则填QueueName。 请注意,目前推送服务不能推送到私有网络中,因此Endpoint填写为私有网络域名或地址将接收不到推送的消息,目前支持推送到公网和基础网络。",
388
- "example": "",
112
+ "document": "标签搜索",
113
+ "example": "tag",
389
114
  "member": "string",
390
- "name": "Endpoint",
391
- "required": true,
115
+ "name": "TagKey",
116
+ "required": false,
392
117
  "type": "string"
393
118
  },
394
119
  {
395
120
  "disabled": false,
396
- "document": "向Endpoint推送消息出现错误时,CMQ推送服务器的重试策略。取值有:1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息;2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始1s,后面是2s,4s,8s...由于Topic消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是EXPONENTIAL_DECAY_RETRY。",
397
- "example": "",
398
- "member": "string",
399
- "name": "NotifyStrategy",
121
+ "document": "分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50。",
122
+ "example": "20",
123
+ "member": "uint64",
124
+ "name": "Limit",
400
125
  "required": false,
401
- "type": "string"
126
+ "type": "int"
402
127
  },
403
128
  {
404
129
  "disabled": false,
405
- "document": "消息正文。消息标签(用于消息过滤)。标签数量不能超过5个,每个标签不超过16个字符。与(Batch)PublishMessage的MsgTag参数配合使用,规则:1)如果FilterTag没有设置,则无论MsgTag是否有设置,订阅接收所有发布到Topic的消息;2)如果FilterTag数组有值,则只有数组中至少有一个值在MsgTag数组中也存在时(即FilterTag和MsgTag有交集),订阅才接收该发布到Topic的消息;3)如果FilterTag数组有值,但MsgTag没设置,则不接收任何发布到Topic的消息,可以认为是2)的一种特例,此时FilterTag和MsgTag没有交集。规则整体的设计思想是以订阅者的意愿为主。",
406
- "example": "",
130
+ "document": "精确匹配QueueName",
131
+ "example": "test",
407
132
  "member": "string",
408
- "name": "FilterTag",
133
+ "name": "QueueName",
409
134
  "required": false,
410
- "type": "list"
135
+ "type": "string"
411
136
  },
412
137
  {
413
138
  "disabled": false,
414
- "document": "BindingKey数量不超过5个, 每个BindingKey长度不超过64字节,该字段表示订阅接收消息的过滤策略,每个BindingKey最多含有15个“.”, 即最多16个词组。",
415
- "example": "",
416
- "member": "string",
417
- "name": "BindingKey",
139
+ "document": "筛选参数,目前支持QueueName筛选,且仅支持一个关键字",
140
+ "example": "name",
141
+ "member": "Filter",
142
+ "name": "Filters",
418
143
  "required": false,
419
144
  "type": "list"
420
145
  },
421
146
  {
422
147
  "disabled": false,
423
- "document": "推送内容的格式。取值:1)JSON;2)SIMPLIFIED,即raw格式。如果Protocol是queue,则取值必须为SIMPLIFIED。如果Protocol是http,两个值均可以,默认值是JSON。",
424
- "example": "",
425
- "member": "string",
426
- "name": "NotifyContentFormat",
148
+ "document": "分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0",
149
+ "example": "20",
150
+ "member": "uint64",
151
+ "name": "Offset",
427
152
  "required": false,
428
- "type": "string"
153
+ "type": "int"
429
154
  }
430
155
  ],
431
156
  "type": "object"
432
157
  },
433
- "CreateSubscribeResponse": {
434
- "document": "CreateSubscribe返回参数结构体",
158
+ "DescribeQueueDetailResponse": {
159
+ "document": "DescribeQueueDetail返回参数结构体",
435
160
  "members": [
436
161
  {
437
162
  "disabled": false,
438
- "document": "SubscriptionId",
439
- "example": "",
440
- "member": "string",
441
- "name": "SubscriptionId",
442
- "type": "string",
443
- "value_allowed_null": false
444
- },
445
- {
446
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
447
- "member": "string",
448
- "name": "RequestId",
449
- "type": "string"
450
- }
451
- ],
452
- "type": "object"
453
- },
454
- "CreateTopicRequest": {
455
- "document": "CreateTopic请求参数结构体",
456
- "members": [
457
- {
458
- "disabled": false,
459
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
460
- "example": "",
461
- "member": "string",
462
- "name": "TopicName",
463
- "required": true,
464
- "type": "string"
465
- },
466
- {
467
- "disabled": false,
468
- "document": "消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。",
469
- "example": "",
470
- "member": "uint64",
471
- "name": "MaxMsgSize",
472
- "required": false,
473
- "type": "int"
474
- },
475
- {
476
- "disabled": false,
477
- "document": "用于指定主题的消息匹配策略。1:表示标签匹配策略;2:表示路由匹配策略,默认值为标签匹配策略。",
478
- "example": "",
479
- "member": "uint64",
480
- "name": "FilterType",
481
- "required": false,
482
- "type": "int"
483
- },
484
- {
485
- "disabled": false,
486
- "document": "消息保存时间。取值范围60 - 86400 s(即1分钟 - 1天),默认值86400。",
487
- "example": "",
488
- "member": "uint64",
489
- "name": "MsgRetentionSeconds",
490
- "required": false,
491
- "type": "int"
492
- },
493
- {
494
- "disabled": false,
495
- "document": "是否开启消息轨迹标识,true表示开启,false表示不开启,不填表示不开启。",
496
- "example": "",
497
- "member": "bool",
498
- "name": "Trace",
499
- "required": false,
500
- "type": "bool"
501
- }
502
- ],
503
- "type": "object"
504
- },
505
- "CreateTopicResponse": {
506
- "document": "CreateTopic返回参数结构体",
507
- "members": [
508
- {
509
- "disabled": false,
510
- "document": "TopicName",
511
- "example": "",
512
- "member": "string",
513
- "name": "TopicId",
514
- "type": "string",
515
- "value_allowed_null": false
516
- },
517
- {
518
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
519
- "member": "string",
520
- "name": "RequestId",
521
- "type": "string"
522
- }
523
- ],
524
- "type": "object"
525
- },
526
- "DeadLetterPolicy": {
527
- "document": "死信队列策略",
528
- "members": [
529
- {
530
- "disabled": false,
531
- "document": "死信队列。\n注意:此字段可能返回 null,表示取不到有效值。",
532
- "example": "queue-xxxxx",
533
- "member": "string",
534
- "name": "DeadLetterQueue",
535
- "required": true,
536
- "type": "string",
537
- "value_allowed_null": true
538
- },
539
- {
540
- "disabled": false,
541
- "document": "死信队列名字。\n注意:此字段可能返回 null,表示取不到有效值。",
542
- "example": "test",
543
- "member": "string",
544
- "name": "DeadLetterQueueName",
545
- "required": true,
546
- "type": "string",
547
- "value_allowed_null": true
548
- },
549
- {
550
- "disabled": false,
551
- "document": "最大未消费过期时间。Policy为1时必选。范围300-43200,单位秒,需要小于消息最大保留时间MsgRetentionSeconds。\n注意:此字段可能返回 null,表示取不到有效值。",
552
- "example": "300",
553
- "member": "uint64",
554
- "name": "MaxTimeToLive",
555
- "required": true,
556
- "type": "int",
557
- "value_allowed_null": true
558
- },
559
- {
560
- "disabled": false,
561
- "document": "死信队列策略。\n注意:此字段可能返回 null,表示取不到有效值。",
562
- "example": "1",
563
- "member": "uint64",
564
- "name": "Policy",
565
- "required": true,
566
- "type": "int",
567
- "value_allowed_null": true
568
- },
569
- {
570
- "disabled": false,
571
- "document": "最大接收次数。\n注意:此字段可能返回 null,表示取不到有效值。",
572
- "example": "1",
573
- "member": "uint64",
574
- "name": "MaxReceiveCount",
575
- "required": true,
576
- "type": "int",
577
- "value_allowed_null": true
578
- }
579
- ],
580
- "usage": "out"
581
- },
582
- "DeadLetterSource": {
583
- "document": "死信源队列信息",
584
- "members": [
585
- {
586
- "disabled": false,
587
- "document": "消息队列ID。\n注意:此字段可能返回 null,表示取不到有效值。",
588
- "example": "queue-xxxxxxx",
589
- "member": "string",
590
- "name": "QueueId",
591
- "required": true,
592
- "type": "string",
593
- "value_allowed_null": true
594
- },
595
- {
596
- "disabled": false,
597
- "document": "消息队列名字。\n注意:此字段可能返回 null,表示取不到有效值。",
598
- "example": "test",
599
- "member": "string",
600
- "name": "QueueName",
601
- "required": true,
602
- "type": "string",
603
- "value_allowed_null": true
604
- }
605
- ],
606
- "usage": "out"
607
- },
608
- "DeleteQueueRequest": {
609
- "document": "DeleteQueue请求参数结构体",
610
- "members": [
611
- {
612
- "disabled": false,
613
- "document": "队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
614
- "example": "",
615
- "member": "string",
616
- "name": "QueueName",
617
- "required": true,
618
- "type": "string"
619
- }
620
- ],
621
- "type": "object"
622
- },
623
- "DeleteQueueResponse": {
624
- "document": "DeleteQueue返回参数结构体",
625
- "members": [
626
- {
627
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
628
- "member": "string",
629
- "name": "RequestId",
630
- "type": "string"
631
- }
632
- ],
633
- "type": "object"
634
- },
635
- "DeleteSubscribeRequest": {
636
- "document": "DeleteSubscribe请求参数结构体",
637
- "members": [
638
- {
639
- "disabled": false,
640
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
641
- "example": "",
642
- "member": "string",
643
- "name": "TopicName",
644
- "required": true,
645
- "type": "string"
646
- },
647
- {
648
- "disabled": false,
649
- "document": "订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
650
- "example": "",
651
- "member": "string",
652
- "name": "SubscriptionName",
653
- "required": true,
654
- "type": "string"
655
- }
656
- ],
657
- "type": "object"
658
- },
659
- "DeleteSubscribeResponse": {
660
- "document": "DeleteSubscribe返回参数结构体",
661
- "members": [
662
- {
663
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
664
- "member": "string",
665
- "name": "RequestId",
666
- "type": "string"
667
- }
668
- ],
669
- "type": "object"
670
- },
671
- "DeleteTopicRequest": {
672
- "document": "DeleteTopic请求参数结构体",
673
- "members": [
674
- {
675
- "disabled": false,
676
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
677
- "example": "",
678
- "member": "string",
679
- "name": "TopicName",
680
- "required": true,
681
- "type": "string"
682
- }
683
- ],
684
- "type": "object"
685
- },
686
- "DeleteTopicResponse": {
687
- "document": "DeleteTopic返回参数结构体",
688
- "members": [
689
- {
690
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
691
- "member": "string",
692
- "name": "RequestId",
693
- "type": "string"
694
- }
695
- ],
696
- "type": "object"
697
- },
698
- "DescribeDeadLetterSourceQueuesRequest": {
699
- "document": "DescribeDeadLetterSourceQueues请求参数结构体",
700
- "members": [
701
- {
702
- "disabled": false,
703
- "document": "死信队列名称",
704
- "example": "",
705
- "member": "string",
706
- "name": "DeadLetterQueueName",
707
- "required": true,
708
- "type": "string"
709
- },
710
- {
711
- "disabled": false,
712
- "document": "分页时本页获取主题列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0。",
713
- "example": "",
714
- "member": "uint64",
715
- "name": "Limit",
716
- "required": false,
717
- "type": "int"
718
- },
719
- {
720
- "disabled": false,
721
- "document": "分页时本页获取主题的个数,如果不传递该参数,则该参数默认为20,最大值为50。",
722
- "example": "",
723
- "member": "uint64",
724
- "name": "Offset",
725
- "required": false,
726
- "type": "int"
727
- },
728
- {
729
- "disabled": false,
730
- "document": "过滤死信队列源队列名称,目前仅支持SourceQueueName过滤",
731
- "example": "",
732
- "member": "Filter",
733
- "name": "Filters",
734
- "required": false,
735
- "type": "list"
736
- }
737
- ],
738
- "type": "object"
739
- },
740
- "DescribeDeadLetterSourceQueuesResponse": {
741
- "document": "DescribeDeadLetterSourceQueues返回参数结构体",
742
- "members": [
743
- {
744
- "disabled": false,
745
- "document": "满足本次条件的队列个数",
746
- "example": "",
747
- "member": "uint64",
748
- "name": "TotalCount",
749
- "type": "int",
750
- "value_allowed_null": false
751
- },
752
- {
753
- "disabled": false,
754
- "document": "死信队列源队列",
755
- "example": "",
756
- "member": "DeadLetterSource",
757
- "name": "QueueSet",
758
- "type": "list",
759
- "value_allowed_null": false
760
- },
761
- {
762
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
763
- "member": "string",
764
- "name": "RequestId",
765
- "type": "string"
766
- }
767
- ],
768
- "type": "object"
769
- },
770
- "DescribeQueueDetailRequest": {
771
- "document": "DescribeQueueDetail请求参数结构体",
772
- "members": [
773
- {
774
- "disabled": false,
775
- "document": "标签搜索",
776
- "example": "tag",
777
- "member": "string",
778
- "name": "TagKey",
779
- "required": false,
780
- "type": "string"
781
- },
782
- {
783
- "disabled": false,
784
- "document": "分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50。",
785
- "example": "20",
786
- "member": "uint64",
787
- "name": "Limit",
788
- "required": false,
789
- "type": "int"
790
- },
791
- {
792
- "disabled": false,
793
- "document": "精确匹配QueueName",
794
- "example": "test",
795
- "member": "string",
796
- "name": "QueueName",
797
- "required": false,
798
- "type": "string"
799
- },
800
- {
801
- "disabled": false,
802
- "document": "筛选参数,目前支持QueueName筛选,且仅支持一个关键字",
803
- "example": "name",
804
- "member": "Filter",
805
- "name": "Filters",
806
- "required": false,
807
- "type": "list"
808
- },
809
- {
810
- "disabled": false,
811
- "document": "分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0",
812
- "example": "20",
813
- "member": "uint64",
814
- "name": "Offset",
815
- "required": false,
816
- "type": "int"
817
- }
818
- ],
819
- "type": "object"
820
- },
821
- "DescribeQueueDetailResponse": {
822
- "document": "DescribeQueueDetail返回参数结构体",
823
- "members": [
824
- {
825
- "disabled": false,
826
- "document": "总队列数。",
827
- "example": "20",
828
- "member": "uint64",
829
- "name": "TotalCount",
830
- "output_required": true,
831
- "type": "int",
832
- "value_allowed_null": false
833
- },
834
- {
835
- "disabled": false,
836
- "document": "队列详情列表。",
837
- "example": "[]",
838
- "member": "QueueSet",
839
- "name": "QueueSet",
840
- "output_required": true,
841
- "type": "list",
842
- "value_allowed_null": false
843
- },
844
- {
845
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
846
- "member": "string",
847
- "name": "RequestId",
848
- "type": "string"
849
- }
850
- ],
851
- "type": "object"
852
- },
853
- "DescribeSubscriptionDetailRequest": {
854
- "document": "DescribeSubscriptionDetail请求参数结构体",
855
- "members": [
856
- {
857
- "disabled": false,
858
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
859
- "example": "",
860
- "member": "string",
861
- "name": "TopicName",
862
- "required": true,
863
- "type": "string"
864
- },
865
- {
866
- "disabled": false,
867
- "document": "分页时本页获取主题列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0",
868
- "example": "",
869
- "member": "uint64",
870
- "name": "Offset",
871
- "required": false,
872
- "type": "int"
873
- },
874
- {
875
- "disabled": false,
876
- "document": "分页时本页获取主题的个数,如果不传递该参数,则该参数默认为20,最大值为50。",
877
- "example": "",
878
- "member": "uint64",
879
- "name": "Limit",
880
- "required": false,
881
- "type": "int"
882
- },
883
- {
884
- "disabled": false,
885
- "document": "筛选参数,目前只支持SubscriptionName,且仅支持一个关键字。",
886
- "example": "",
887
- "member": "Filter",
888
- "name": "Filters",
889
- "required": false,
890
- "type": "list"
891
- }
892
- ],
893
- "type": "object"
894
- },
895
- "DescribeSubscriptionDetailResponse": {
896
- "document": "DescribeSubscriptionDetail返回参数结构体",
897
- "members": [
898
- {
899
- "disabled": false,
900
- "document": "总数",
901
- "example": "",
902
- "member": "uint64",
903
- "name": "TotalCount",
904
- "type": "int",
905
- "value_allowed_null": false
906
- },
907
- {
908
- "disabled": false,
909
- "document": "Subscription属性集合\n注意:此字段可能返回 null,表示取不到有效值。",
910
- "example": "",
911
- "member": "Subscription",
912
- "name": "SubscriptionSet",
913
- "type": "list",
914
- "value_allowed_null": true
915
- },
916
- {
917
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
918
- "member": "string",
919
- "name": "RequestId",
920
- "type": "string"
921
- }
922
- ],
923
- "type": "object"
924
- },
925
- "DescribeTopicDetailRequest": {
926
- "document": "DescribeTopicDetail请求参数结构体",
927
- "members": [
928
- {
929
- "disabled": false,
930
- "document": "标签匹配。",
931
- "example": "aa",
932
- "member": "string",
933
- "name": "TagKey",
934
- "required": false,
935
- "type": "string"
936
- },
937
- {
938
- "disabled": false,
939
- "document": "分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50。",
163
+ "document": "总队列数。",
940
164
  "example": "20",
941
165
  "member": "uint64",
942
- "name": "Limit",
943
- "required": false,
944
- "type": "int"
945
- },
946
- {
947
- "disabled": false,
948
- "document": "精确匹配TopicName。",
949
- "example": "topic1",
950
- "member": "string",
951
- "name": "TopicName",
952
- "required": false,
953
- "type": "string"
954
- },
955
- {
956
- "disabled": false,
957
- "document": "目前只支持过滤TopicName , 且只能填一个过滤值。",
958
- "example": "[]",
959
- "member": "Filter",
960
- "name": "Filters",
961
- "required": false,
962
- "type": "list"
963
- },
964
- {
965
- "disabled": false,
966
- "document": "分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0。",
967
- "example": "0",
968
- "member": "uint64",
969
- "name": "Offset",
970
- "required": false,
971
- "type": "int"
972
- }
973
- ],
974
- "type": "object"
975
- },
976
- "DescribeTopicDetailResponse": {
977
- "document": "DescribeTopicDetail返回参数结构体",
978
- "members": [
979
- {
980
- "disabled": false,
981
- "document": "主题列表总数。",
982
- "example": "3",
983
- "member": "uint64",
984
166
  "name": "TotalCount",
985
167
  "output_required": true,
986
168
  "type": "int",
@@ -988,184 +170,14 @@
988
170
  },
989
171
  {
990
172
  "disabled": false,
991
- "document": "主题详情列表。",
173
+ "document": "队列详情列表。",
992
174
  "example": "[]",
993
- "member": "TopicSet",
994
- "name": "TopicSet",
995
- "output_required": true,
996
- "type": "list",
997
- "value_allowed_null": false
998
- },
999
- {
1000
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1001
- "member": "string",
1002
- "name": "RequestId",
1003
- "type": "string"
1004
- }
1005
- ],
1006
- "type": "object"
1007
- },
1008
- "Filter": {
1009
- "document": "过滤参数",
1010
- "members": [
1011
- {
1012
- "disabled": false,
1013
- "document": "数值",
1014
- "example": "[\"test_queue\", \"queue_sync_test\"]",
1015
- "member": "string",
1016
- "name": "Values",
1017
- "required": false,
1018
- "type": "list",
1019
- "value_allowed_null": false
1020
- },
1021
- {
1022
- "disabled": false,
1023
- "document": "过滤参数的名字",
1024
- "example": "InstanceId",
1025
- "member": "string",
1026
- "name": "Name",
1027
- "required": false,
1028
- "type": "string",
1029
- "value_allowed_null": false
1030
- }
1031
- ],
1032
- "usage": "in"
1033
- },
1034
- "ModifyQueueAttributeRequest": {
1035
- "document": "ModifyQueueAttribute请求参数结构体",
1036
- "members": [
1037
- {
1038
- "disabled": false,
1039
- "document": "队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
1040
- "example": "",
1041
- "member": "string",
1042
- "name": "QueueName",
1043
- "required": true,
1044
- "type": "string"
1045
- },
1046
- {
1047
- "disabled": false,
1048
- "document": "最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。",
1049
- "example": "",
1050
- "member": "uint64",
1051
- "name": "MaxMsgHeapNum",
1052
- "required": false,
1053
- "type": "int"
1054
- },
1055
- {
1056
- "disabled": false,
1057
- "document": "消息接收长轮询等待时间。取值范围 0-30 秒,默认值 0。",
1058
- "example": "",
1059
- "member": "uint64",
1060
- "name": "PollingWaitSeconds",
1061
- "required": false,
1062
- "type": "int"
1063
- },
1064
- {
1065
- "disabled": false,
1066
- "document": "消息可见性超时。取值范围 1-43200 秒(即12小时内),默认值 30。",
1067
- "example": "",
1068
- "member": "uint64",
1069
- "name": "VisibilityTimeout",
1070
- "required": false,
1071
- "type": "int"
1072
- },
1073
- {
1074
- "disabled": false,
1075
- "document": "消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。",
1076
- "example": "",
1077
- "member": "uint64",
1078
- "name": "MaxMsgSize",
1079
- "required": false,
1080
- "type": "int"
1081
- },
1082
- {
1083
- "disabled": false,
1084
- "document": "消息保留周期。取值范围 60-1296000 秒(1min-15天),默认值 345600 (4 天)。",
1085
- "example": "",
1086
- "member": "uint64",
1087
- "name": "MsgRetentionSeconds",
1088
- "required": false,
1089
- "type": "int"
1090
- },
1091
- {
1092
- "disabled": false,
1093
- "document": "消息最长回溯时间,取值范围0-msgRetentionSeconds,消息的最大回溯之间为消息在队列中的保存周期,0表示不开启消息回溯。",
1094
- "example": "",
1095
- "member": "uint64",
1096
- "name": "RewindSeconds",
1097
- "required": false,
1098
- "type": "int"
1099
- },
1100
- {
1101
- "disabled": false,
1102
- "document": "第一次查询时间",
1103
- "example": "",
1104
- "member": "uint64",
1105
- "name": "FirstQueryInterval",
1106
- "required": false,
1107
- "type": "int"
1108
- },
1109
- {
1110
- "disabled": false,
1111
- "document": "最大查询次数",
1112
- "example": "",
1113
- "member": "uint64",
1114
- "name": "MaxQueryCount",
1115
- "required": false,
1116
- "type": "int"
1117
- },
1118
- {
1119
- "disabled": false,
1120
- "document": "死信队列名称",
1121
- "example": "",
1122
- "member": "string",
1123
- "name": "DeadLetterQueueName",
1124
- "required": false,
1125
- "type": "string"
1126
- },
1127
- {
1128
- "disabled": false,
1129
- "document": "MaxTimeToLivepolicy为1时必选。最大未消费过期时间。范围300-43200,单位秒,需要小于消息最大保留时间MsgRetentionSeconds",
1130
- "example": "",
1131
- "member": "uint64",
1132
- "name": "MaxTimeToLive",
1133
- "required": false,
1134
- "type": "int"
1135
- },
1136
- {
1137
- "disabled": false,
1138
- "document": "最大接收次数",
1139
- "example": "",
1140
- "member": "uint64",
1141
- "name": "MaxReceiveCount",
1142
- "required": false,
1143
- "type": "int"
1144
- },
1145
- {
1146
- "disabled": false,
1147
- "document": "死信队列策略",
1148
- "example": "",
1149
- "member": "uint64",
1150
- "name": "Policy",
1151
- "required": false,
1152
- "type": "int"
175
+ "member": "QueueSet",
176
+ "name": "QueueSet",
177
+ "output_required": true,
178
+ "type": "list",
179
+ "value_allowed_null": false
1153
180
  },
1154
- {
1155
- "disabled": false,
1156
- "document": "是否开启消息轨迹标识,true表示开启,false表示不开启,不填表示不开启。",
1157
- "example": "",
1158
- "member": "bool",
1159
- "name": "Trace",
1160
- "required": false,
1161
- "type": "bool"
1162
- }
1163
- ],
1164
- "type": "object"
1165
- },
1166
- "ModifyQueueAttributeResponse": {
1167
- "document": "ModifyQueueAttribute返回参数结构体",
1168
- "members": [
1169
181
  {
1170
182
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1171
183
  "member": "string",
@@ -1175,69 +187,80 @@
1175
187
  ],
1176
188
  "type": "object"
1177
189
  },
1178
- "ModifySubscriptionAttributeRequest": {
1179
- "document": "ModifySubscriptionAttribute请求参数结构体",
190
+ "DescribeTopicDetailRequest": {
191
+ "document": "DescribeTopicDetail请求参数结构体",
1180
192
  "members": [
1181
193
  {
1182
194
  "disabled": false,
1183
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
1184
- "example": "",
1185
- "member": "string",
1186
- "name": "TopicName",
1187
- "required": true,
1188
- "type": "string"
1189
- },
1190
- {
1191
- "disabled": false,
1192
- "document": "订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
1193
- "example": "",
195
+ "document": "标签匹配。",
196
+ "example": "aa",
1194
197
  "member": "string",
1195
- "name": "SubscriptionName",
1196
- "required": true,
198
+ "name": "TagKey",
199
+ "required": false,
1197
200
  "type": "string"
1198
201
  },
1199
202
  {
1200
203
  "disabled": false,
1201
- "document": "向 Endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值如下:\n(1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息。\n(2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始1s,后面是2s,4s,8s···由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。",
1202
- "example": "",
1203
- "member": "string",
1204
- "name": "NotifyStrategy",
204
+ "document": "分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50。",
205
+ "example": "20",
206
+ "member": "uint64",
207
+ "name": "Limit",
1205
208
  "required": false,
1206
- "type": "string"
209
+ "type": "int"
1207
210
  },
1208
211
  {
1209
212
  "disabled": false,
1210
- "document": "推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 Protocol 是 queue,则取值必须为 SIMPLIFIED。如果 Protocol 是 HTTP,两个值均可以,默认值是 JSON。",
1211
- "example": "",
213
+ "document": "精确匹配TopicName。",
214
+ "example": "topic1",
1212
215
  "member": "string",
1213
- "name": "NotifyContentFormat",
216
+ "name": "TopicName",
1214
217
  "required": false,
1215
218
  "type": "string"
1216
219
  },
1217
220
  {
1218
221
  "disabled": false,
1219
- "document": "消息正文。消息标签(用于消息过滤)。标签数量不能超过5个,每个标签不超过16个字符。与(Batch)PublishMessage的MsgTag参数配合使用,规则:1)如果FilterTag没有设置,则无论MsgTag是否有设置,订阅接收所有发布到Topic的消息;2)如果FilterTag数组有值,则只有数组中至少有一个值在MsgTag数组中也存在时(即FilterTag和MsgTag有交集),订阅才接收该发布到Topic的消息;3)如果FilterTag数组有值,但MsgTag没设置,则不接收任何发布到Topic的消息,可以认为是2)的一种特例,此时FilterTag和MsgTag没有交集。规则整体的设计思想是以订阅者的意愿为主。",
1220
- "example": "",
1221
- "member": "string",
1222
- "name": "FilterTags",
222
+ "document": "目前只支持过滤TopicName , 且只能填一个过滤值。",
223
+ "example": "[]",
224
+ "member": "Filter",
225
+ "name": "Filters",
1223
226
  "required": false,
1224
227
  "type": "list"
1225
228
  },
1226
229
  {
1227
230
  "disabled": false,
1228
- "document": "BindingKey数量不超过5个, 每个BindingKey长度不超过64字节,该字段表示订阅接收消息的过滤策略,每个BindingKey最多含有15个“.”, 即最多16个词组。",
1229
- "example": "",
1230
- "member": "string",
1231
- "name": "BindingKey",
231
+ "document": "分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0。",
232
+ "example": "0",
233
+ "member": "uint64",
234
+ "name": "Offset",
1232
235
  "required": false,
1233
- "type": "list"
236
+ "type": "int"
1234
237
  }
1235
238
  ],
1236
239
  "type": "object"
1237
240
  },
1238
- "ModifySubscriptionAttributeResponse": {
1239
- "document": "ModifySubscriptionAttribute返回参数结构体",
241
+ "DescribeTopicDetailResponse": {
242
+ "document": "DescribeTopicDetail返回参数结构体",
1240
243
  "members": [
244
+ {
245
+ "disabled": false,
246
+ "document": "主题列表总数。",
247
+ "example": "3",
248
+ "member": "uint64",
249
+ "name": "TotalCount",
250
+ "output_required": true,
251
+ "type": "int",
252
+ "value_allowed_null": false
253
+ },
254
+ {
255
+ "disabled": false,
256
+ "document": "主题详情列表。",
257
+ "example": "[]",
258
+ "member": "TopicSet",
259
+ "name": "TopicSet",
260
+ "output_required": true,
261
+ "type": "list",
262
+ "value_allowed_null": false
263
+ },
1241
264
  {
1242
265
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1243
266
  "member": "string",
@@ -1247,59 +270,31 @@
1247
270
  ],
1248
271
  "type": "object"
1249
272
  },
1250
- "ModifyTopicAttributeRequest": {
1251
- "document": "ModifyTopicAttribute请求参数结构体",
273
+ "Filter": {
274
+ "document": "过滤参数",
1252
275
  "members": [
1253
276
  {
1254
277
  "disabled": false,
1255
- "document": "主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
1256
- "example": "",
278
+ "document": "数值",
279
+ "example": "[\"test_queue\", \"queue_sync_test\"]",
1257
280
  "member": "string",
1258
- "name": "TopicName",
1259
- "required": true,
1260
- "type": "string"
1261
- },
1262
- {
1263
- "disabled": false,
1264
- "document": "消息最大长度。取值范围1024 - 65536 Byte(即1 - 64K),默认值65536。",
1265
- "example": "",
1266
- "member": "uint64",
1267
- "name": "MaxMsgSize",
1268
- "required": false,
1269
- "type": "int"
1270
- },
1271
- {
1272
- "disabled": false,
1273
- "document": "消息保存时间。取值范围60 - 86400 s(即1分钟 - 1天),默认值86400。",
1274
- "example": "",
1275
- "member": "uint64",
1276
- "name": "MsgRetentionSeconds",
281
+ "name": "Values",
1277
282
  "required": false,
1278
- "type": "int"
283
+ "type": "list",
284
+ "value_allowed_null": false
1279
285
  },
1280
286
  {
1281
287
  "disabled": false,
1282
- "document": "是否开启消息轨迹标识,true表示开启,false表示不开启,不填表示不开启。",
1283
- "example": "",
1284
- "member": "bool",
1285
- "name": "Trace",
1286
- "required": false,
1287
- "type": "bool"
1288
- }
1289
- ],
1290
- "type": "object"
1291
- },
1292
- "ModifyTopicAttributeResponse": {
1293
- "document": "ModifyTopicAttribute返回参数结构体",
1294
- "members": [
1295
- {
1296
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
288
+ "document": "过滤参数的名字",
289
+ "example": "InstanceId",
1297
290
  "member": "string",
1298
- "name": "RequestId",
1299
- "type": "string"
291
+ "name": "Name",
292
+ "required": false,
293
+ "type": "string",
294
+ "value_allowed_null": false
1300
295
  }
1301
296
  ],
1302
- "type": "object"
297
+ "usage": "in"
1303
298
  },
1304
299
  "QueueSet": {
1305
300
  "document": "批量queue属性信息",
@@ -1567,168 +562,6 @@
1567
562
  ],
1568
563
  "usage": "out"
1569
564
  },
1570
- "RewindQueueRequest": {
1571
- "document": "RewindQueue请求参数结构体",
1572
- "members": [
1573
- {
1574
- "disabled": false,
1575
- "document": "队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。",
1576
- "example": "",
1577
- "member": "string",
1578
- "name": "QueueName",
1579
- "required": true,
1580
- "type": "string"
1581
- },
1582
- {
1583
- "disabled": false,
1584
- "document": "设定该时间,则(Batch)receiveMessage接口,会按照生产消息的先后顺序消费该时间戳以后的消息。",
1585
- "example": "",
1586
- "member": "uint64",
1587
- "name": "StartConsumeTime",
1588
- "required": true,
1589
- "type": "int"
1590
- }
1591
- ],
1592
- "type": "object"
1593
- },
1594
- "RewindQueueResponse": {
1595
- "document": "RewindQueue返回参数结构体",
1596
- "members": [
1597
- {
1598
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1599
- "member": "string",
1600
- "name": "RequestId",
1601
- "type": "string"
1602
- }
1603
- ],
1604
- "type": "object"
1605
- },
1606
- "Subscription": {
1607
- "document": "订阅返回参数",
1608
- "members": [
1609
- {
1610
- "disabled": false,
1611
- "document": "该订阅待投递的消息数。\n注意:此字段可能返回 null,表示取不到有效值。",
1612
- "example": "10",
1613
- "member": "uint64",
1614
- "name": "MsgCount",
1615
- "output_required": true,
1616
- "type": "int",
1617
- "value_allowed_null": true
1618
- },
1619
- {
1620
- "disabled": false,
1621
- "document": "表示订阅接收消息的过滤策略。\n注意:此字段可能返回 null,表示取不到有效值。",
1622
- "example": "key",
1623
- "member": "string",
1624
- "name": "BindingKey",
1625
- "output_required": true,
1626
- "type": "list",
1627
- "value_allowed_null": true
1628
- },
1629
- {
1630
- "disabled": false,
1631
- "document": "接收通知的 endpoint,根据协议 protocol 区分:对于 HTTP,endpoint 必须以http://开头,host 可以是域名或 IP;对于 queue,则填 queueName。\n注意:此字段可能返回 null,表示取不到有效值。",
1632
- "example": "test-queue",
1633
- "member": "string",
1634
- "name": "Endpoint",
1635
- "output_required": true,
1636
- "type": "string",
1637
- "value_allowed_null": true
1638
- },
1639
- {
1640
- "disabled": false,
1641
- "document": "订阅拥有者的 APPID。\n注意:此字段可能返回 null,表示取不到有效值。",
1642
- "example": "12321889",
1643
- "member": "uint64",
1644
- "name": "TopicOwner",
1645
- "output_required": true,
1646
- "type": "int",
1647
- "value_allowed_null": true
1648
- },
1649
- {
1650
- "disabled": false,
1651
- "document": "向 endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值有:\n(1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息;\n(2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始 1s,后面是 2s,4s,8s...由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。\n注意:此字段可能返回 null,表示取不到有效值。",
1652
- "example": "BACKOFF_RETRY",
1653
- "member": "string",
1654
- "name": "NotifyStrategy",
1655
- "output_required": true,
1656
- "type": "string",
1657
- "value_allowed_null": true
1658
- },
1659
- {
1660
- "disabled": false,
1661
- "document": "推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 protocol 是 queue,则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP,两个值均可以,默认值是 JSON。\n注意:此字段可能返回 null,表示取不到有效值。",
1662
- "example": "JSON",
1663
- "member": "string",
1664
- "name": "NotifyContentFormat",
1665
- "output_required": true,
1666
- "type": "string",
1667
- "value_allowed_null": true
1668
- },
1669
- {
1670
- "disabled": false,
1671
- "document": "最后一次修改订阅属性的时间。返回 Unix 时间戳,精确到秒。\n注意:此字段可能返回 null,表示取不到有效值。",
1672
- "example": "17177728999",
1673
- "member": "uint64",
1674
- "name": "LastModifyTime",
1675
- "output_required": true,
1676
- "type": "int",
1677
- "value_allowed_null": true
1678
- },
1679
- {
1680
- "disabled": false,
1681
- "document": "描述用户创建订阅时选择的过滤策略:\nfilterType = 1表示用户使用 filterTag 标签过滤\nfilterType = 2表示用户使用 bindingKey 过滤。\n注意:此字段可能返回 null,表示取不到有效值。",
1682
- "example": "tag1",
1683
- "member": "string",
1684
- "name": "FilterTags",
1685
- "output_required": true,
1686
- "type": "list",
1687
- "value_allowed_null": true
1688
- },
1689
- {
1690
- "disabled": false,
1691
- "document": "订阅名字,在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。\n注意:此字段可能返回 null,表示取不到有效值。",
1692
- "example": "test-sub",
1693
- "member": "string",
1694
- "name": "SubscriptionName",
1695
- "output_required": true,
1696
- "type": "string",
1697
- "value_allowed_null": true
1698
- },
1699
- {
1700
- "disabled": false,
1701
- "document": "订阅的协议,目前支持两种协议:HTTP、queue。使用 HTTP 协议,用户需自己搭建接受消息的 Web Server。使用 queue,消息会自动推送到 CMQ queue,用户可以并发地拉取消息。\n注意:此字段可能返回 null,表示取不到有效值。",
1702
- "example": "queue",
1703
- "member": "string",
1704
- "name": "Protocol",
1705
- "output_required": true,
1706
- "type": "string",
1707
- "value_allowed_null": true
1708
- },
1709
- {
1710
- "disabled": false,
1711
- "document": "订阅 ID。订阅 ID 在拉取监控数据时会用到。\n注意:此字段可能返回 null,表示取不到有效值。",
1712
- "example": "sub-ayenghj",
1713
- "member": "string",
1714
- "name": "SubscriptionId",
1715
- "output_required": true,
1716
- "type": "string",
1717
- "value_allowed_null": true
1718
- },
1719
- {
1720
- "disabled": false,
1721
- "document": "订阅的创建时间。返回 Unix 时间戳,精确到秒。\n注意:此字段可能返回 null,表示取不到有效值。",
1722
- "example": "17177728999",
1723
- "member": "uint64",
1724
- "name": "CreateTime",
1725
- "output_required": true,
1726
- "type": "int",
1727
- "value_allowed_null": true
1728
- }
1729
- ],
1730
- "usage": "out"
1731
- },
1732
565
  "Tag": {
1733
566
  "document": "标签",
1734
567
  "members": [
@@ -1916,33 +749,6 @@
1916
749
  }
1917
750
  ],
1918
751
  "usage": "out"
1919
- },
1920
- "UnbindDeadLetterRequest": {
1921
- "document": "UnbindDeadLetter请求参数结构体",
1922
- "members": [
1923
- {
1924
- "disabled": false,
1925
- "document": "死信策略源队列名称,调用本接口会清空该队列的死信队列策略。",
1926
- "example": "",
1927
- "member": "string",
1928
- "name": "QueueName",
1929
- "required": true,
1930
- "type": "string"
1931
- }
1932
- ],
1933
- "type": "object"
1934
- },
1935
- "UnbindDeadLetterResponse": {
1936
- "document": "UnbindDeadLetter返回参数结构体",
1937
- "members": [
1938
- {
1939
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1940
- "member": "string",
1941
- "name": "RequestId",
1942
- "type": "string"
1943
- }
1944
- ],
1945
- "type": "object"
1946
752
  }
1947
753
  },
1948
754
  "version": "1.0"