summaryrefslogtreecommitdiff
path: root/data/smqproxy/2026-04-09/api-docs.php
blob: 329660e198d192a57faff7ba1d126e752733794a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
<?php return [
    'version' => '1.0',
    'info' => ['product' => 'SMQProxy', 'version' => '2026-04-09'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'BatchDeleteMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['delete'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'ReceiptHandles' => [
                                'type' => 'array',
                                'required' => false,
                                'items' => ['type' => 'string', 'required' => false],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'BatchPeekMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'peekonly',
                    'in' => 'query',
                    'schema' => ['type' => 'boolean', 'required' => false],
                ],
                [
                    'name' => 'numOfMessages',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
            ],
        ],
        'BatchReceiveMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'numOfMessages',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'waitseconds',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
            ],
        ],
        'BatchSendMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'Messages' => [
                                'type' => 'array',
                                'required' => false,
                                'items' => [
                                    'type' => 'object',
                                    'required' => false,
                                    'properties' => [
                                        'MessageBody' => ['type' => 'string', 'required' => false],
                                        'DelaySeconds' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                        'Priority' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                        'MessageGroupId' => ['type' => 'string', 'required' => false],
                                        'UserProperties' => [
                                            'type' => 'object',
                                            'additionalProperties' => [
                                                'type' => 'object',
                                                'properties' => [
                                                    'DataType' => ['type' => 'string'],
                                                    'StringValue' => ['type' => 'string'],
                                                    'BinaryValue' => ['type' => 'string'],
                                                ],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'ChangeMessageVisibility' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['put'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'receiptHandle',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'visibilityTimeout',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
            ],
        ],
        'DeleteMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['delete'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'ReceiptHandle',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'PeekMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'peekonly',
                    'in' => 'query',
                    'schema' => ['type' => 'boolean', 'required' => false],
                ],
            ],
        ],
        'PublishMessage' => [
            'path' => '/topics/{topicName}/messages',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'topicName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'MessageBody' => ['type' => 'string', 'required' => false],
                            'MessageTag' => ['type' => 'string', 'required' => false],
                            'MessageGroupId' => ['type' => 'string'],
                            'MessageAttributes' => [
                                'type' => 'object',
                                'required' => false,
                                'properties' => [
                                    'DirectMail' => ['type' => 'string', 'required' => false],
                                    'DirectSMS' => ['type' => 'string', 'required' => false],
                                    'Push' => ['type' => 'string', 'required' => false],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'ReceiveMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'waitseconds',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
            ],
        ],
        'SendMessage' => [
            'path' => '/queues/{queueName}/messages',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'queueName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'MessageBody' => ['type' => 'string', 'required' => false],
                            'DelaySeconds' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                            'Priority' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                            'MessageGroupId' => ['type' => 'string', 'required' => false],
                            'UserProperties' => [
                                'type' => 'object',
                                'required' => false,
                                'additionalProperties' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'DataType' => ['type' => 'string'],
                                        'StringValue' => ['type' => 'string'],
                                        'BinaryValue' => ['type' => 'string'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ],
    'endpoints' => [],
];