tencentcloud-sdk-nodejs 4.0.1009 → 4.0.1011

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/CHANGELOG.md +332 -0
  2. package/SERVICE_CHANGELOG.md +298 -431
  3. package/package.json +1 -1
  4. package/products.md +30 -30
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aiart/v20221229/aiart_client.ts +52 -19
  7. package/src/services/aiart/v20221229/aiart_models.ts +145 -32
  8. package/src/services/batch/v20170312/batch_models.ts +1 -1
  9. package/src/services/cdb/v20170320/cdb_models.ts +10 -0
  10. package/src/services/cmq/v20190304/cmq_client.ts +6 -208
  11. package/src/services/cmq/v20190304/cmq_models.ts +89 -710
  12. package/src/services/config/v20220802/config_client.ts +54 -29
  13. package/src/services/config/v20220802/config_models.ts +410 -218
  14. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  15. package/src/services/dc/v20180410/dc_client.ts +1 -1
  16. package/src/services/dc/v20180410/dc_models.ts +16 -25
  17. package/src/services/ecm/v20190719/ecm_models.ts +13 -22
  18. package/src/services/es/v20180416/es_models.ts +5 -0
  19. package/src/services/ess/v20201111/ess_client.ts +25 -4
  20. package/src/services/ess/v20201111/ess_models.ts +4 -24
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +4 -9
  22. package/src/services/hai/v20230812/hai_client.ts +17 -4
  23. package/src/services/hai/v20230812/hai_models.ts +136 -47
  24. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +70 -14
  25. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +286 -12
  26. package/src/services/iotvideo/v20211125/iotvideo_client.ts +13 -0
  27. package/src/services/iotvideo/v20211125/iotvideo_models.ts +41 -0
  28. package/src/services/lkeap/v20240522/lkeap_client.ts +1 -1
  29. package/src/services/lkeap/v20240522/lkeap_models.ts +27 -8
  30. package/src/services/mna/v20210119/mna_models.ts +0 -11
  31. package/src/services/redis/v20180412/redis_models.ts +97 -95
  32. package/src/services/sms/v20190711/sms_models.ts +23 -0
  33. package/src/services/sms/v20210111/sms_models.ts +23 -0
  34. package/src/services/tcb/v20180608/tcb_client.ts +2 -3
  35. package/src/services/tcb/v20180608/tcb_models.ts +3 -45
  36. package/src/services/tcr/v20190924/tcr_models.ts +3 -3
  37. package/src/services/tke/v20220501/tke_models.ts +1 -1
  38. package/src/services/trro/v20220325/trro_models.ts +4 -29
  39. package/src/services/trtc/v20190722/trtc_models.ts +54 -54
  40. package/src/services/tse/v20201207/tse_models.ts +8 -0
  41. package/src/services/vpc/v20170312/vpc_models.ts +3 -10
  42. package/src/services/wedata/v20210820/wedata_models.ts +35 -0
  43. package/tencentcloud/common/sdk_version.d.ts +1 -1
  44. package/tencentcloud/common/sdk_version.js +1 -1
  45. package/tencentcloud/services/aiart/v20221229/aiart_client.d.ts +29 -12
  46. package/tencentcloud/services/aiart/v20221229/aiart_client.js +34 -13
  47. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +141 -32
  48. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +1 -1
  49. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +10 -0
  50. package/tencentcloud/services/cmq/v20190304/cmq_client.d.ts +1 -82
  51. package/tencentcloud/services/cmq/v20190304/cmq_client.js +0 -111
  52. package/tencentcloud/services/cmq/v20190304/cmq_models.d.ts +89 -679
  53. package/tencentcloud/services/config/v20220802/config_client.d.ts +15 -7
  54. package/tencentcloud/services/config/v20220802/config_client.js +21 -9
  55. package/tencentcloud/services/config/v20220802/config_models.d.ts +395 -208
  56. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  57. package/tencentcloud/services/dc/v20180410/dc_client.d.ts +1 -1
  58. package/tencentcloud/services/dc/v20180410/dc_client.js +1 -1
  59. package/tencentcloud/services/dc/v20180410/dc_models.d.ts +16 -25
  60. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +13 -22
  61. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -0
  62. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +25 -4
  63. package/tencentcloud/services/ess/v20201111/ess_client.js +25 -4
  64. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +4 -24
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +4 -9
  66. package/tencentcloud/services/hai/v20230812/hai_client.d.ts +5 -1
  67. package/tencentcloud/services/hai/v20230812/hai_client.js +6 -0
  68. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +133 -47
  69. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +21 -5
  70. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +30 -6
  71. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +270 -12
  72. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.d.ts +5 -1
  73. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.js +6 -0
  74. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +38 -0
  75. package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +1 -1
  76. package/tencentcloud/services/lkeap/v20240522/lkeap_client.js +1 -1
  77. package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +27 -8
  78. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +0 -11
  79. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +97 -95
  80. package/tencentcloud/services/sms/v20190711/sms_models.d.ts +23 -0
  81. package/tencentcloud/services/sms/v20210111/sms_models.d.ts +23 -0
  82. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +0 -1
  83. package/tencentcloud/services/tcb/v20180608/tcb_client.js +0 -1
  84. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +3 -45
  85. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +3 -3
  86. package/tencentcloud/services/tke/v20220501/tke_models.d.ts +1 -1
  87. package/tencentcloud/services/trro/v20220325/trro_models.d.ts +4 -29
  88. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +54 -54
  89. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +8 -0
  90. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +1 -8
  91. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +35 -0
  92. package/test/aiart.v20221229.test.js +24 -4
  93. package/test/cmq.v20190304.test.js +0 -150
  94. package/test/config.v20220802.test.js +26 -6
  95. package/test/hai.v20230812.test.js +10 -0
  96. package/test/iotexplorer.v20190423.test.js +44 -4
  97. package/test/iotvideo.v20211125.test.js +10 -0
@@ -16,194 +16,17 @@
16
16
  */
17
17
 
18
18
  /**
19
- * topic返回信息展示字段
20
- */
21
- export interface TopicSet {
22
- /**
23
- * 当前该主题中消息数目(消息堆积数)。
24
- 注意:此字段可能返回 null,表示取不到有效值。
25
- */
26
- MsgCount: number
27
- /**
28
- * 主题的 ID。
29
- 注意:此字段可能返回 null,表示取不到有效值。
30
- */
31
- TopicId: string
32
- /**
33
- * 消息最大长度。取值范围1024 - 1048576Byte(即1 - 1024K),默认值为65536。
34
- 注意:此字段可能返回 null,表示取不到有效值。
35
- */
36
- MaxMsgSize: number
37
- /**
38
- * 消息轨迹。true表示开启,false表示不开启。
39
- 注意:此字段可能返回 null,表示取不到有效值。
40
- */
41
- Trace: boolean
42
- /**
43
- * 关联的标签。
44
- 注意:此字段可能返回 null,表示取不到有效值。
45
- */
46
- Tags: Array<Tag>
47
- /**
48
- * 创建者 Uin,CAM 鉴权 resource 由该字段组合而成。
49
- 注意:此字段可能返回 null,表示取不到有效值。
50
- */
51
- CreateUin: number
52
- /**
53
- * 描述用户创建订阅时选择的过滤策略:
54
- FilterType = 1表示用户使用 FilterTag 标签过滤;
55
- FilterType = 2表示用户使用 BindingKey 过滤。
56
- 注意:此字段可能返回 null,表示取不到有效值。
57
- */
58
- FilterType: number
59
- /**
60
- * 主题名称。
61
- 注意:此字段可能返回 null,表示取不到有效值。
62
- */
63
- TopicName: string
64
- /**
65
- * 最后一次修改主题属性的时间。返回 Unix 时间戳,精确到秒。
66
- 注意:此字段可能返回 null,表示取不到有效值。
67
- */
68
- LastModifyTime: number
69
- /**
70
- * 消息在主题中最长存活时间,从发送到该主题开始经过此参数指定的时间后,不论消息是否被成功推送给用户都将被删除,单位为秒。固定为一天(86400秒),该属性不能修改。
71
- 注意:此字段可能返回 null,表示取不到有效值。
72
- */
73
- MsgRetentionSeconds: number
74
- /**
75
- * 每秒钟发布消息的条数。
76
- 注意:此字段可能返回 null,表示取不到有效值。
77
- */
78
- Qps: number
79
- /**
80
- * 主题的创建时间。返回 Unix 时间戳,精确到秒。
81
- 注意:此字段可能返回 null,表示取不到有效值。
82
- */
83
- CreateTime: number
84
- /**
85
- * 是否迁移到新版本。0 表示未迁移,1 表示迁移中,2 表示已经迁移完毕,3 表示回切状态,曾经迁移过,4 未知状态。
86
- 注意:此字段可能返回 null,表示取不到有效值。
87
- */
88
- Migrate: number
89
- }
90
-
91
- /**
92
- * RewindQueue请求参数结构体
93
- */
94
- export interface RewindQueueRequest {
95
- /**
96
- * 队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
97
- */
98
- QueueName: string
99
- /**
100
- * 设定该时间,则(Batch)receiveMessage接口,会按照生产消息的先后顺序消费该时间戳以后的消息。
101
- */
102
- StartConsumeTime: number
103
- }
104
-
105
- /**
106
- * DescribeSubscriptionDetail请求参数结构体
107
- */
108
- export interface DescribeSubscriptionDetailRequest {
109
- /**
110
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
111
- */
112
- TopicName: string
113
- /**
114
- * 分页时本页获取主题列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0
115
- */
116
- Offset?: number
117
- /**
118
- * 分页时本页获取主题的个数,如果不传递该参数,则该参数默认为20,最大值为50。
119
- */
120
- Limit?: number
121
- /**
122
- * 筛选参数,目前只支持SubscriptionName,且仅支持一个关键字。
123
- */
124
- Filters?: Array<Filter>
125
- }
126
-
127
- /**
128
- * ModifyQueueAttribute返回参数结构体
129
- */
130
- export interface ModifyQueueAttributeResponse {
131
- /**
132
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
133
- */
134
- RequestId?: string
135
- }
136
-
137
- /**
138
- * CreateQueue请求参数结构体
19
+ * DescribeQueueDetail返回参数结构体
139
20
  */
140
- export interface CreateQueueRequest {
141
- /**
142
- * 队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
143
- */
144
- QueueName: string
145
- /**
146
- * 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。
147
- */
148
- MaxMsgHeapNum?: number
149
- /**
150
- * 消息接收长轮询等待时间。取值范围 0-30 秒,默认值 0。
151
- */
152
- PollingWaitSeconds?: number
153
- /**
154
- * 消息可见性超时。取值范围 1-43200 秒(即12小时内),默认值 30。
155
- */
156
- VisibilityTimeout?: number
157
- /**
158
- * 消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。
159
- */
160
- MaxMsgSize?: number
161
- /**
162
- * 消息保留周期。取值范围 60-1296000 秒(1min-15天),默认值 345600 (4 天)。
163
- */
164
- MsgRetentionSeconds?: number
165
- /**
166
- * 队列是否开启回溯消息能力,该参数取值范围0-msgRetentionSeconds,即最大的回溯时间为消息在队列中的保留周期,0表示不开启。
167
- */
168
- RewindSeconds?: number
169
- /**
170
- * 1 表示事务队列,0 表示普通队列
171
- */
172
- Transaction?: number
173
- /**
174
- * 第一次回查间隔
175
- */
176
- FirstQueryInterval?: number
177
- /**
178
- * 最大回查次数
179
- */
180
- MaxQueryCount?: number
181
- /**
182
- * 死信队列名称
183
- */
184
- DeadLetterQueueName?: string
185
- /**
186
- * 死信策略。0为消息被多次消费未删除,1为Time-To-Live过期
187
- */
188
- Policy?: number
189
- /**
190
- * 最大接收次数 1-1000
191
- */
192
- MaxReceiveCount?: number
21
+ export interface DescribeQueueDetailResponse {
193
22
  /**
194
- * policy为1时必选。最大未消费过期时间。范围300-43200,单位秒,需要小于消息最大保留时间msgRetentionSeconds
23
+ * 总队列数。
195
24
  */
196
- MaxTimeToLive?: number
25
+ TotalCount?: number
197
26
  /**
198
- * 是否开启消息轨迹追踪,当不设置字段时,默认为不开启,该字段为true表示开启,为false表示不开启
27
+ * 队列详情列表。
199
28
  */
200
- Trace?: boolean
201
- }
202
-
203
- /**
204
- * ModifySubscriptionAttribute返回参数结构体
205
- */
206
- export interface ModifySubscriptionAttributeResponse {
29
+ QueueSet?: Array<QueueSet>
207
30
  /**
208
31
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
209
32
  */
@@ -242,300 +65,120 @@ export interface DeadLetterPolicy {
242
65
  }
243
66
 
244
67
  /**
245
- * ModifyTopicAttribute返回参数结构体
246
- */
247
- export interface ModifyTopicAttributeResponse {
248
- /**
249
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
250
- */
251
- RequestId?: string
252
- }
253
-
254
- /**
255
- * DeleteSubscribe请求参数结构体
68
+ * 过滤参数
256
69
  */
257
- export interface DeleteSubscribeRequest {
70
+ export interface Filter {
258
71
  /**
259
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
72
+ * 数值
260
73
  */
261
- TopicName: string
74
+ Values?: Array<string>
262
75
  /**
263
- * 订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
76
+ * 过滤参数的名字
264
77
  */
265
- SubscriptionName: string
78
+ Name?: string
266
79
  }
267
80
 
268
81
  /**
269
- * DescribeSubscriptionDetail返回参数结构体
82
+ * topic返回信息展示字段
270
83
  */
271
- export interface DescribeSubscriptionDetailResponse {
272
- /**
273
- * 总数
274
- */
275
- TotalCount?: number
84
+ export interface TopicSet {
276
85
  /**
277
- * Subscription属性集合
86
+ * 当前该主题中消息数目(消息堆积数)。
278
87
  注意:此字段可能返回 null,表示取不到有效值。
279
88
  */
280
- SubscriptionSet?: Array<Subscription>
281
- /**
282
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
283
- */
284
- RequestId?: string
285
- }
286
-
287
- /**
288
- * CreateSubscribe请求参数结构体
289
- */
290
- export interface CreateSubscribeRequest {
291
- /**
292
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
293
- */
294
- TopicName: string
295
- /**
296
- * 订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
297
- */
298
- SubscriptionName: string
299
- /**
300
- * 订阅的协议,目前支持两种协议:http、queue。使用http协议,用户需自己搭建接受消息的web server。使用queue,消息会自动推送到CMQ queue,用户可以并发地拉取消息。
301
- */
302
- Protocol: string
303
- /**
304
- * 接收通知的Endpoint,根据协议Protocol区分:对于http,Endpoint必须以“`http://`”开头,host可以是域名或IP;对于Queue,则填QueueName。 请注意,目前推送服务不能推送到私有网络中,因此Endpoint填写为私有网络域名或地址将接收不到推送的消息,目前支持推送到公网和基础网络。
305
- */
306
- Endpoint: string
307
- /**
308
- * 向Endpoint推送消息出现错误时,CMQ推送服务器的重试策略。取值有:1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息;2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始1s,后面是2s,4s,8s...由于Topic消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是EXPONENTIAL_DECAY_RETRY。
309
- */
310
- NotifyStrategy?: string
311
- /**
312
- * 消息正文。消息标签(用于消息过滤)。标签数量不能超过5个,每个标签不超过16个字符。与(Batch)PublishMessage的MsgTag参数配合使用,规则:1)如果FilterTag没有设置,则无论MsgTag是否有设置,订阅接收所有发布到Topic的消息;2)如果FilterTag数组有值,则只有数组中至少有一个值在MsgTag数组中也存在时(即FilterTag和MsgTag有交集),订阅才接收该发布到Topic的消息;3)如果FilterTag数组有值,但MsgTag没设置,则不接收任何发布到Topic的消息,可以认为是2)的一种特例,此时FilterTag和MsgTag没有交集。规则整体的设计思想是以订阅者的意愿为主。
313
- */
314
- FilterTag?: Array<string>
315
- /**
316
- * BindingKey数量不超过5个, 每个BindingKey长度不超过64字节,该字段表示订阅接收消息的过滤策略,每个BindingKey最多含有15个“.”, 即最多16个词组。
317
- */
318
- BindingKey?: Array<string>
319
- /**
320
- * 推送内容的格式。取值:1)JSON;2)SIMPLIFIED,即raw格式。如果Protocol是queue,则取值必须为SIMPLIFIED。如果Protocol是http,两个值均可以,默认值是JSON。
321
- */
322
- NotifyContentFormat?: string
323
- }
324
-
325
- /**
326
- * ClearQueue请求参数结构体
327
- */
328
- export interface ClearQueueRequest {
329
- /**
330
- * 队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
331
- */
332
- QueueName: string
333
- }
334
-
335
- /**
336
- * CreateTopic返回参数结构体
337
- */
338
- export interface CreateTopicResponse {
339
- /**
340
- * TopicName
341
- */
342
- TopicId?: string
343
- /**
344
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
345
- */
346
- RequestId?: string
347
- }
348
-
349
- /**
350
- * ClearSubscriptionFilterTags返回参数结构体
351
- */
352
- export interface ClearSubscriptionFilterTagsResponse {
353
- /**
354
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
355
- */
356
- RequestId?: string
357
- }
358
-
359
- /**
360
- * UnbindDeadLetter返回参数结构体
361
- */
362
- export interface UnbindDeadLetterResponse {
363
- /**
364
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
365
- */
366
- RequestId?: string
367
- }
368
-
369
- /**
370
- * 事务消息策略
371
- */
372
- export interface TransactionPolicy {
89
+ MsgCount: number
373
90
  /**
374
- * 最大查询次数。
91
+ * 主题的 ID。
375
92
  注意:此字段可能返回 null,表示取不到有效值。
376
93
  */
377
- MaxQueryCount: number
94
+ TopicId: string
378
95
  /**
379
- * 第一次回查时间。
96
+ * 消息最大长度。取值范围1024 - 1048576Byte(即1 - 1024K),默认值为65536。
380
97
  注意:此字段可能返回 null,表示取不到有效值。
381
98
  */
382
- FirstQueryInterval: number
383
- }
384
-
385
- /**
386
- * DescribeTopicDetail请求参数结构体
387
- */
388
- export interface DescribeTopicDetailRequest {
389
- /**
390
- * 标签匹配。
391
- */
392
- TagKey?: string
393
- /**
394
- * 分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50。
395
- */
396
- Limit?: number
397
- /**
398
- * 精确匹配TopicName。
399
- */
400
- TopicName?: string
401
- /**
402
- * 目前只支持过滤TopicName , 且只能填一个过滤值。
403
- */
404
- Filters?: Array<Filter>
405
- /**
406
- * 分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0。
407
- */
408
- Offset?: number
409
- }
410
-
411
- /**
412
- * DeleteTopic请求参数结构体
413
- */
414
- export interface DeleteTopicRequest {
415
- /**
416
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
417
- */
418
- TopicName: string
419
- }
420
-
421
- /**
422
- * DescribeTopicDetail返回参数结构体
423
- */
424
- export interface DescribeTopicDetailResponse {
425
- /**
426
- * 主题列表总数。
427
- */
428
- TotalCount?: number
429
- /**
430
- * 主题详情列表。
431
- */
432
- TopicSet?: Array<TopicSet>
433
- /**
434
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
435
- */
436
- RequestId?: string
437
- }
438
-
439
- /**
440
- * DescribeQueueDetail返回参数结构体
441
- */
442
- export interface DescribeQueueDetailResponse {
99
+ MaxMsgSize: number
443
100
  /**
444
- * 总队列数。
101
+ * 消息轨迹。true表示开启,false表示不开启。
102
+ 注意:此字段可能返回 null,表示取不到有效值。
445
103
  */
446
- TotalCount?: number
104
+ Trace: boolean
447
105
  /**
448
- * 队列详情列表。
106
+ * 关联的标签。
107
+ 注意:此字段可能返回 null,表示取不到有效值。
449
108
  */
450
- QueueSet?: Array<QueueSet>
109
+ Tags: Array<Tag>
451
110
  /**
452
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
111
+ * 创建者 Uin,CAM 鉴权 resource 由该字段组合而成。
112
+ 注意:此字段可能返回 null,表示取不到有效值。
453
113
  */
454
- RequestId?: string
455
- }
456
-
457
- /**
458
- * UnbindDeadLetter请求参数结构体
459
- */
460
- export interface UnbindDeadLetterRequest {
114
+ CreateUin: number
461
115
  /**
462
- * 死信策略源队列名称,调用本接口会清空该队列的死信队列策略。
116
+ * 描述用户创建订阅时选择的过滤策略:
117
+ FilterType = 1表示用户使用 FilterTag 标签过滤;
118
+ FilterType = 2表示用户使用 BindingKey 过滤。
119
+ 注意:此字段可能返回 null,表示取不到有效值。
463
120
  */
464
- QueueName: string
465
- }
466
-
467
- /**
468
- * CreateTopic请求参数结构体
469
- */
470
- export interface CreateTopicRequest {
121
+ FilterType: number
471
122
  /**
472
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
123
+ * 主题名称。
124
+ 注意:此字段可能返回 null,表示取不到有效值。
473
125
  */
474
126
  TopicName: string
475
127
  /**
476
- * 消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。
128
+ * 最后一次修改主题属性的时间。返回 Unix 时间戳,精确到秒。
129
+ 注意:此字段可能返回 null,表示取不到有效值。
477
130
  */
478
- MaxMsgSize?: number
131
+ LastModifyTime: number
479
132
  /**
480
- * 用于指定主题的消息匹配策略。1:表示标签匹配策略;2:表示路由匹配策略,默认值为标签匹配策略。
133
+ * 消息在主题中最长存活时间,从发送到该主题开始经过此参数指定的时间后,不论消息是否被成功推送给用户都将被删除,单位为秒。固定为一天(86400秒),该属性不能修改。
134
+ 注意:此字段可能返回 null,表示取不到有效值。
481
135
  */
482
- FilterType?: number
136
+ MsgRetentionSeconds: number
483
137
  /**
484
- * 消息保存时间。取值范围60 - 86400 s(即1分钟 - 1天),默认值86400。
138
+ * 每秒钟发布消息的条数。
139
+ 注意:此字段可能返回 null,表示取不到有效值。
485
140
  */
486
- MsgRetentionSeconds?: number
141
+ Qps: number
487
142
  /**
488
- * 是否开启消息轨迹标识,true表示开启,false表示不开启,不填表示不开启。
143
+ * 主题的创建时间。返回 Unix 时间戳,精确到秒。
144
+ 注意:此字段可能返回 null,表示取不到有效值。
489
145
  */
490
- Trace?: boolean
491
- }
492
-
493
- /**
494
- * DeleteQueue请求参数结构体
495
- */
496
- export interface DeleteQueueRequest {
146
+ CreateTime: number
497
147
  /**
498
- * 队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
148
+ * 是否迁移到新版本。0 表示未迁移,1 表示迁移中,2 表示已经迁移完毕,3 表示回切状态,曾经迁移过,4 未知状态。
149
+ 注意:此字段可能返回 null,表示取不到有效值。
499
150
  */
500
- QueueName: string
151
+ Migrate: number
501
152
  }
502
153
 
503
154
  /**
504
- * 过滤参数
155
+ * 标签
505
156
  */
506
- export interface Filter {
157
+ export interface Tag {
507
158
  /**
508
- * 数值
159
+ * 标签Key
160
+ 注意:此字段可能返回 null,表示取不到有效值。
509
161
  */
510
- Values?: Array<string>
162
+ TagKey: string
511
163
  /**
512
- * 过滤参数的名字
164
+ * 标签值
165
+ 注意:此字段可能返回 null,表示取不到有效值。
513
166
  */
514
- Name?: string
167
+ TagValue: string
515
168
  }
516
169
 
517
170
  /**
518
- * DescribeDeadLetterSourceQueues返回参数结构体
171
+ * DescribeTopicDetail返回参数结构体
519
172
  */
520
- export interface DescribeDeadLetterSourceQueuesResponse {
173
+ export interface DescribeTopicDetailResponse {
521
174
  /**
522
- * 满足本次条件的队列个数
175
+ * 主题列表总数。
523
176
  */
524
177
  TotalCount?: number
525
178
  /**
526
- * 死信队列源队列
527
- */
528
- QueueSet?: Array<DeadLetterSource>
529
- /**
530
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
179
+ * 主题详情列表。
531
180
  */
532
- RequestId?: string
533
- }
534
-
535
- /**
536
- * RewindQueue返回参数结构体
537
- */
538
- export interface RewindQueueResponse {
181
+ TopicSet?: Array<TopicSet>
539
182
  /**
540
183
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
541
184
  */
@@ -543,33 +186,27 @@ export interface RewindQueueResponse {
543
186
  }
544
187
 
545
188
  /**
546
- * ModifyTopicAttribute请求参数结构体
189
+ * 事务消息策略
547
190
  */
548
- export interface ModifyTopicAttributeRequest {
549
- /**
550
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
551
- */
552
- TopicName: string
553
- /**
554
- * 消息最大长度。取值范围1024 - 65536 Byte(即1 - 64K),默认值65536。
555
- */
556
- MaxMsgSize?: number
191
+ export interface TransactionPolicy {
557
192
  /**
558
- * 消息保存时间。取值范围60 - 86400 s(即1分钟 - 1天),默认值86400。
193
+ * 最大查询次数。
194
+ 注意:此字段可能返回 null,表示取不到有效值。
559
195
  */
560
- MsgRetentionSeconds?: number
196
+ MaxQueryCount: number
561
197
  /**
562
- * 是否开启消息轨迹标识,true表示开启,false表示不开启,不填表示不开启。
198
+ * 第一次回查时间。
199
+ 注意:此字段可能返回 null,表示取不到有效值。
563
200
  */
564
- Trace?: boolean
201
+ FirstQueryInterval: number
565
202
  }
566
203
 
567
204
  /**
568
- * DescribeQueueDetail请求参数结构体
205
+ * DescribeTopicDetail请求参数结构体
569
206
  */
570
- export interface DescribeQueueDetailRequest {
207
+ export interface DescribeTopicDetailRequest {
571
208
  /**
572
- * 标签搜索
209
+ * 标签匹配。
573
210
  */
574
211
  TagKey?: string
575
212
  /**
@@ -577,15 +214,15 @@ export interface DescribeQueueDetailRequest {
577
214
  */
578
215
  Limit?: number
579
216
  /**
580
- * 精确匹配QueueName
217
+ * 精确匹配TopicName。
581
218
  */
582
- QueueName?: string
219
+ TopicName?: string
583
220
  /**
584
- * 筛选参数,目前支持QueueName筛选,且仅支持一个关键字
221
+ * 目前只支持过滤TopicName , 且只能填一个过滤值。
585
222
  */
586
223
  Filters?: Array<Filter>
587
224
  /**
588
- * 分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0
225
+ * 分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0
589
226
  */
590
227
  Offset?: number
591
228
  }
@@ -725,89 +362,29 @@ export interface QueueSet {
725
362
  }
726
363
 
727
364
  /**
728
- * DeleteTopic返回参数结构体
729
- */
730
- export interface DeleteTopicResponse {
731
- /**
732
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
733
- */
734
- RequestId?: string
735
- }
736
-
737
- /**
738
- * ClearSubscriptionFilterTags请求参数结构体
739
- */
740
- export interface ClearSubscriptionFilterTagsRequest {
741
- /**
742
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
743
- */
744
- TopicName: string
745
- /**
746
- * 订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
747
- */
748
- SubscriptionName: string
749
- }
750
-
751
- /**
752
- * CreateQueue返回参数结构体
753
- */
754
- export interface CreateQueueResponse {
755
- /**
756
- * 创建成功的queueId
757
- */
758
- QueueId?: string
759
- /**
760
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
761
- */
762
- RequestId?: string
763
- }
764
-
765
- /**
766
- * DeleteSubscribe返回参数结构体
767
- */
768
- export interface DeleteSubscribeResponse {
769
- /**
770
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
771
- */
772
- RequestId?: string
773
- }
774
-
775
- /**
776
- * DescribeDeadLetterSourceQueues请求参数结构体
365
+ * DescribeQueueDetail请求参数结构体
777
366
  */
778
- export interface DescribeDeadLetterSourceQueuesRequest {
367
+ export interface DescribeQueueDetailRequest {
779
368
  /**
780
- * 死信队列名称
369
+ * 标签搜索
781
370
  */
782
- DeadLetterQueueName: string
371
+ TagKey?: string
783
372
  /**
784
- * 分页时本页获取主题列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0
373
+ * 分页时本页获取队列的个数,如果不传递该参数,则该参数默认为20,最大值为50
785
374
  */
786
375
  Limit?: number
787
376
  /**
788
- * 分页时本页获取主题的个数,如果不传递该参数,则该参数默认为20,最大值为50。
377
+ * 精确匹配QueueName
789
378
  */
790
- Offset?: number
379
+ QueueName?: string
791
380
  /**
792
- * 过滤死信队列源队列名称,目前仅支持SourceQueueName过滤
381
+ * 筛选参数,目前支持QueueName筛选,且仅支持一个关键字
793
382
  */
794
383
  Filters?: Array<Filter>
795
- }
796
-
797
- /**
798
- * 标签
799
- */
800
- export interface Tag {
801
384
  /**
802
- * 标签Key
803
- 注意:此字段可能返回 null,表示取不到有效值。
804
- */
805
- TagKey: string
806
- /**
807
- * 标签值
808
- 注意:此字段可能返回 null,表示取不到有效值。
385
+ * 分页时本页获取队列列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0
809
386
  */
810
- TagValue: string
387
+ Offset?: number
811
388
  }
812
389
 
813
390
  /**
@@ -825,201 +402,3 @@ export interface DeadLetterSource {
825
402
  */
826
403
  QueueName: string
827
404
  }
828
-
829
- /**
830
- * CreateSubscribe返回参数结构体
831
- */
832
- export interface CreateSubscribeResponse {
833
- /**
834
- * SubscriptionId
835
- */
836
- SubscriptionId?: string
837
- /**
838
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
839
- */
840
- RequestId?: string
841
- }
842
-
843
- /**
844
- * ClearQueue返回参数结构体
845
- */
846
- export interface ClearQueueResponse {
847
- /**
848
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
849
- */
850
- RequestId?: string
851
- }
852
-
853
- /**
854
- * ModifySubscriptionAttribute请求参数结构体
855
- */
856
- export interface ModifySubscriptionAttributeRequest {
857
- /**
858
- * 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
859
- */
860
- TopicName: string
861
- /**
862
- * 订阅名字,在单个地域同一帐号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
863
- */
864
- SubscriptionName: string
865
- /**
866
- * 向 Endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值如下:
867
- (1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息。
868
- (2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始1s,后面是2s,4s,8s···由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
869
- */
870
- NotifyStrategy?: string
871
- /**
872
- * 推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 Protocol 是 queue,则取值必须为 SIMPLIFIED。如果 Protocol 是 HTTP,两个值均可以,默认值是 JSON。
873
- */
874
- NotifyContentFormat?: string
875
- /**
876
- * 消息正文。消息标签(用于消息过滤)。标签数量不能超过5个,每个标签不超过16个字符。与(Batch)PublishMessage的MsgTag参数配合使用,规则:1)如果FilterTag没有设置,则无论MsgTag是否有设置,订阅接收所有发布到Topic的消息;2)如果FilterTag数组有值,则只有数组中至少有一个值在MsgTag数组中也存在时(即FilterTag和MsgTag有交集),订阅才接收该发布到Topic的消息;3)如果FilterTag数组有值,但MsgTag没设置,则不接收任何发布到Topic的消息,可以认为是2)的一种特例,此时FilterTag和MsgTag没有交集。规则整体的设计思想是以订阅者的意愿为主。
877
- */
878
- FilterTags?: Array<string>
879
- /**
880
- * BindingKey数量不超过5个, 每个BindingKey长度不超过64字节,该字段表示订阅接收消息的过滤策略,每个BindingKey最多含有15个“.”, 即最多16个词组。
881
- */
882
- BindingKey?: Array<string>
883
- }
884
-
885
- /**
886
- * 订阅返回参数
887
- */
888
- export interface Subscription {
889
- /**
890
- * 该订阅待投递的消息数。
891
- 注意:此字段可能返回 null,表示取不到有效值。
892
- */
893
- MsgCount?: number
894
- /**
895
- * 表示订阅接收消息的过滤策略。
896
- 注意:此字段可能返回 null,表示取不到有效值。
897
- */
898
- BindingKey?: Array<string>
899
- /**
900
- * 接收通知的 endpoint,根据协议 protocol 区分:对于 HTTP,endpoint 必须以http://开头,host 可以是域名或 IP;对于 queue,则填 queueName。
901
- 注意:此字段可能返回 null,表示取不到有效值。
902
- */
903
- Endpoint?: string
904
- /**
905
- * 订阅拥有者的 APPID。
906
- 注意:此字段可能返回 null,表示取不到有效值。
907
- */
908
- TopicOwner?: number
909
- /**
910
- * 向 endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值有:
911
- (1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息;
912
- (2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始 1s,后面是 2s,4s,8s...由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
913
- 注意:此字段可能返回 null,表示取不到有效值。
914
- */
915
- NotifyStrategy?: string
916
- /**
917
- * 推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 protocol 是 queue,则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP,两个值均可以,默认值是 JSON。
918
- 注意:此字段可能返回 null,表示取不到有效值。
919
- */
920
- NotifyContentFormat?: string
921
- /**
922
- * 最后一次修改订阅属性的时间。返回 Unix 时间戳,精确到秒。
923
- 注意:此字段可能返回 null,表示取不到有效值。
924
- */
925
- LastModifyTime?: number
926
- /**
927
- * 描述用户创建订阅时选择的过滤策略:
928
- filterType = 1表示用户使用 filterTag 标签过滤
929
- filterType = 2表示用户使用 bindingKey 过滤。
930
- 注意:此字段可能返回 null,表示取不到有效值。
931
- */
932
- FilterTags?: Array<string>
933
- /**
934
- * 订阅名字,在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
935
- 注意:此字段可能返回 null,表示取不到有效值。
936
- */
937
- SubscriptionName?: string
938
- /**
939
- * 订阅的协议,目前支持两种协议:HTTP、queue。使用 HTTP 协议,用户需自己搭建接受消息的 Web Server。使用 queue,消息会自动推送到 CMQ queue,用户可以并发地拉取消息。
940
- 注意:此字段可能返回 null,表示取不到有效值。
941
- */
942
- Protocol?: string
943
- /**
944
- * 订阅 ID。订阅 ID 在拉取监控数据时会用到。
945
- 注意:此字段可能返回 null,表示取不到有效值。
946
- */
947
- SubscriptionId?: string
948
- /**
949
- * 订阅的创建时间。返回 Unix 时间戳,精确到秒。
950
- 注意:此字段可能返回 null,表示取不到有效值。
951
- */
952
- CreateTime?: number
953
- }
954
-
955
- /**
956
- * DeleteQueue返回参数结构体
957
- */
958
- export interface DeleteQueueResponse {
959
- /**
960
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
961
- */
962
- RequestId?: string
963
- }
964
-
965
- /**
966
- * ModifyQueueAttribute请求参数结构体
967
- */
968
- export interface ModifyQueueAttributeRequest {
969
- /**
970
- * 队列名字,在单个地域同一帐号下唯一。队列名称是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。
971
- */
972
- QueueName: string
973
- /**
974
- * 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。
975
- */
976
- MaxMsgHeapNum?: number
977
- /**
978
- * 消息接收长轮询等待时间。取值范围 0-30 秒,默认值 0。
979
- */
980
- PollingWaitSeconds?: number
981
- /**
982
- * 消息可见性超时。取值范围 1-43200 秒(即12小时内),默认值 30。
983
- */
984
- VisibilityTimeout?: number
985
- /**
986
- * 消息最大长度。取值范围 1024-65536 Byte(即1-64K),默认值 65536。
987
- */
988
- MaxMsgSize?: number
989
- /**
990
- * 消息保留周期。取值范围 60-1296000 秒(1min-15天),默认值 345600 (4 天)。
991
- */
992
- MsgRetentionSeconds?: number
993
- /**
994
- * 消息最长回溯时间,取值范围0-msgRetentionSeconds,消息的最大回溯之间为消息在队列中的保存周期,0表示不开启消息回溯。
995
- */
996
- RewindSeconds?: number
997
- /**
998
- * 第一次查询时间
999
- */
1000
- FirstQueryInterval?: number
1001
- /**
1002
- * 最大查询次数
1003
- */
1004
- MaxQueryCount?: number
1005
- /**
1006
- * 死信队列名称
1007
- */
1008
- DeadLetterQueueName?: string
1009
- /**
1010
- * MaxTimeToLivepolicy为1时必选。最大未消费过期时间。范围300-43200,单位秒,需要小于消息最大保留时间MsgRetentionSeconds
1011
- */
1012
- MaxTimeToLive?: number
1013
- /**
1014
- * 最大接收次数
1015
- */
1016
- MaxReceiveCount?: number
1017
- /**
1018
- * 死信队列策略
1019
- */
1020
- Policy?: number
1021
- /**
1022
- * 是否开启消息轨迹标识,true表示开启,false表示不开启,不填表示不开启。
1023
- */
1024
- Trace?: boolean
1025
- }