tencentcloud-sdk-nodejs 4.0.1009 → 4.0.1010

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