summaryrefslogtreecommitdiff
path: root/data/en_us/smqproxy
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/smqproxy')
-rw-r--r--data/en_us/smqproxy/2026-04-09/api-docs.php752
1 files changed, 752 insertions, 0 deletions
diff --git a/data/en_us/smqproxy/2026-04-09/api-docs.php b/data/en_us/smqproxy/2026-04-09/api-docs.php
new file mode 100644
index 0000000..2ace6cd
--- /dev/null
+++ b/data/en_us/smqproxy/2026-04-09/api-docs.php
@@ -0,0 +1,752 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => ['product' => 'SMQProxy', 'version' => '2026-04-09'],
+ 'directories' => ['BatchDeleteMessage', 'BatchPeekMessage', 'BatchReceiveMessage', 'BatchSendMessage', 'ChangeMessageVisibility', 'DeleteMessage', 'PeekMessage', 'PublishMessage', 'ReceiveMessage', 'SendMessage'],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'BatchDeleteMessage' => [
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiptHandles' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 204 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ ],
+ 'BatchPeekMessage' => [
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'test-queue', 'title' => ''],
+ ],
+ [
+ 'name' => 'peekonly',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'default' => 'true', 'title' => '', 'description' => '', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'numOfMessages',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => '', 'required' => false, 'example' => '16'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Messages' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageId' => ['type' => 'string', 'description' => '', 'example' => 'C0A80255D7D1163042EA3F2814D055F1', 'title' => ''],
+ 'MessageBody' => ['type' => 'string', 'description' => '', 'example' => 'This is a test message', 'title' => ''],
+ 'MessageBodyMD5' => ['type' => 'string', 'description' => '', 'example' => 'F9360F391579E71CA77BC5D50242****', 'title' => ''],
+ 'EnqueueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979248', 'title' => ''],
+ 'FirstDequeueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'DequeueCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '5', 'title' => ''],
+ 'Priority' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
+ 'MessageGroupId' => ['type' => 'string', 'description' => '', 'example' => 'test-group', 'title' => ''],
+ 'UserProperties' => [
+ 'type' => 'string',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataType' => ['type' => 'string'],
+ 'StringValue' => ['type' => 'string'],
+ 'BinaryValue' => ['type' => 'string'],
+ ],
+ ],
+ 'description' => '',
+ 'example' => '{"properties1":"value"}',
+ 'title' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'summary' => '',
+ 'description' => '## 请求说明'."\n"
+ .'- 该接口用于批量查看指定队列中的消息，一次最多可以查看16条消息。'."\n"
+ .'- 使用此接口不会改变消息的状态，消息仍保持为Active状态。'."\n"
+ .'- 不支持长轮询功能。'."\n"
+ .'- 需要提供`queueName`作为路径参数，并通过查询参数设置`peekonly=true`及指定要查看的消息数量`numOfMessages`（范围在1到16之间）。'."\n"
+ .'- 成功响应将返回一个包含所请求消息详细信息的数组，包括但不限于消息ID、正文、入队时间等。'."\n"
+ .'- 如果指定的队列不存在或队列中没有可见消息，则会返回相应的错误码。'."\n",
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Messages\\": [\\n {\\n \\"MessageId\\": \\"C0A80255D7D1163042EA3F2814D055F1\\",\\n \\"MessageBody\\": \\"This is a test message\\",\\n \\"MessageBodyMD5\\": \\"F9360F391579E71CA77BC5D50242****\\",\\n \\"EnqueueTime\\": 1250700979248,\\n \\"FirstDequeueTime\\": 1250700979348,\\n \\"DequeueCount\\": 5,\\n \\"Priority\\": 1,\\n \\"MessageGroupId\\": \\"test-group\\",\\n \\"UserProperties\\": \\"{\\\\\\"properties1\\\\\\":\\\\\\"value\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'BatchReceiveMessage' => [
+ 'summary' => '',
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'MyQueue', 'title' => ''],
+ ],
+ [
+ 'name' => 'numOfMessages',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => '', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'waitseconds',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => '', 'required' => false, 'example' => '0'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Messages' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageId' => ['type' => 'string', 'description' => '', 'example' => '5F290C926D472878214D9529A8FA200000001', 'title' => ''],
+ 'ReceiptHandle' => ['type' => 'string', 'description' => '', 'example' => '1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==', 'title' => ''],
+ 'MessageBody' => ['type' => 'string', 'description' => '', 'example' => 'This is test message 1.', 'title' => ''],
+ 'MessageBodyMD5' => ['type' => 'string', 'description' => '', 'example' => 'C5DD56A39F5F7BB8B3337C6D11B6D8BE', 'title' => ''],
+ 'EnqueueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'NextVisibleTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'FirstDequeueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'DequeueCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
+ 'Priority' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
+ 'MessageGroupId' => ['type' => 'string', 'description' => '', 'example' => 'test-group', 'title' => ''],
+ 'UserProperties' => [
+ 'type' => 'string',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataType' => ['type' => 'string'],
+ 'StringValue' => ['type' => 'string'],
+ 'BinaryValue' => ['type' => 'string'],
+ ],
+ ],
+ 'description' => '',
+ 'example' => '{"properties1":"value"}',
+ 'title' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'description' => '## 请求说明'."\n"
+ ."\n"
+ .'- 该操作会将取得的消息状态变为 Inactive，Inactive 持续时间由队列属性 `VisibilityTimeout` 决定。'."\n"
+ .'- 消费者需在 VisibilityTimeout 时间内调用 DeleteMessage 删除消息，否则消息会重新变为 Active。'."\n"
+ .'- 支持长轮询（Long Polling）：设置 `waitseconds > 0` 后，若队列为空则等待至有消息到达或超时返回。'."\n"
+ .'><notice>进入长轮询后，建议您降低外部调用长轮询的并发数，选择合适的长轮询时间。目前服务端会根据长轮询数量、长轮询等待时间、访问 IP 数量等因素动态调整长轮询防攻击的并发上限值。当队列无消息时，超过长轮询上限值的请求将无法被监听到，并直接返回 404 MessageNotExist（按请求量正常计费）。如果您有临时提升长轮询上限值的需求，请及时提交工单。></notice>',
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Messages\\": [\\n {\\n \\"MessageId\\": \\"5F290C926D472878214D9529A8FA200000001\\",\\n \\"ReceiptHandle\\": \\"1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==\\",\\n \\"MessageBody\\": \\"This is test message 1.\\",\\n \\"MessageBodyMD5\\": \\"C5DD56A39F5F7BB8B3337C6D11B6D8BE\\",\\n \\"EnqueueTime\\": 1250700979348,\\n \\"NextVisibleTime\\": 1250700979348,\\n \\"FirstDequeueTime\\": 1250700979348,\\n \\"DequeueCount\\": 1,\\n \\"Priority\\": 1,\\n \\"MessageGroupId\\": \\"test-group\\",\\n \\"UserProperties\\": \\"{\\\\\\"properties1\\\\\\":\\\\\\"value\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'BatchSendMessage' => [
+ 'summary' => '',
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'MyQueue', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Messages' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageBody' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'This is test message 1.', 'title' => ''],
+ 'DelaySeconds' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '60', 'title' => ''],
+ 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '1', 'title' => ''],
+ 'MessageGroupId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'group1', 'title' => ''],
+ 'UserProperties' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataType' => ['type' => 'string'],
+ 'StringValue' => ['type' => 'string'],
+ 'BinaryValue' => ['type' => 'string'],
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'required' => false,
+ 'example' => '{'."\n"
+ .' "Messages": ['."\n"
+ .' {'."\n"
+ .' "MessageBody": "...",'."\n"
+ .' "DelaySeconds": 60,'."\n"
+ .' "Priority": 1'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Messages' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'MessageBodyMD5' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'description' => '## 请求说明'."\n"
+ .'- 一次 Batch 请求的消息总大小不得超过 64 KB。'."\n"
+ .'- `BatchSendMessage` 与 `SendMessage` 使用相同的 URL 路径，通过 Body 结构区分：包含 `Messages` 数组即为批量发送，否则为单条发送。'."\n"
+ .'- 批量操作的返回结果可能同时包含成功和失败的子消息。'."\n"
+ .'- 每次请求中可以包含多个消息对象，每个消息对象可以设置不同的延迟时间和优先级。'."\n"
+ .'- 对于 FIFO 队列，可以通过 `MessageGroupId` 参数来指定消息分组 ID。'."\n",
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Messages\\": [\\n {\\n \\"MessageId\\": \\"\\",\\n \\"MessageBodyMD5\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ChangeMessageVisibility' => [
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'receiptHandle',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'visibilityTimeout',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiptHandle' => ['type' => 'string'],
+ 'NextVisibleTime' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReceiptHandle\\": \\"\\",\\n \\"NextVisibleTime\\": 0\\n}","type":"json"}]',
+ ],
+ 'DeleteMessage' => [
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'ReceiptHandle',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 204 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ ],
+ 'PeekMessage' => [
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'MyQueue', 'title' => ''],
+ ],
+ [
+ 'name' => 'peekonly',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'default' => 'true', 'title' => '', 'description' => '', 'required' => false, 'example' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageId' => ['type' => 'string', 'description' => '', 'example' => '5F290C926D472878-2-14D9529A8FA-200000001', 'title' => ''],
+ 'MessageBody' => ['type' => 'string', 'description' => '', 'example' => 'Hello MNS', 'title' => ''],
+ 'MessageBodyMD5' => ['type' => 'string', 'description' => '', 'example' => 'C5DD56A39F5F7BB8B3337C6D11B6D8BE', 'title' => ''],
+ 'EnqueueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'FirstDequeueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'DequeueCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
+ 'Priority' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
+ 'MessageGroupId' => ['type' => 'string', 'description' => '', 'example' => 'test-group', 'title' => ''],
+ 'UserProperties' => [
+ 'type' => 'string',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataType' => ['type' => 'string'],
+ 'StringValue' => ['type' => 'string'],
+ 'BinaryValue' => ['type' => 'string'],
+ ],
+ ],
+ 'description' => '',
+ 'example' => '{"xxx":"value"}',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'summary' => '',
+ 'description' => '## 请求说明'."\n"
+ .'- **PeekMessage** 接口用于查看队列顶部的消息，但不会改变消息的状态，消息仍处于 Active 状态可被正常消费。'."\n"
+ .'- 该接口不支持长轮询，如果队列为空则立即返回 `MessageNotExist` 错误。'."\n"
+ .'- 请求时必须设置 `peekonly=true` 参数以表明仅查看消息。'."\n",
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"5F290C926D472878-2-14D9529A8FA-200000001\\",\\n \\"MessageBody\\": \\"Hello MNS\\",\\n \\"MessageBodyMD5\\": \\"C5DD56A39F5F7BB8B3337C6D11B6D8BE\\",\\n \\"EnqueueTime\\": 1250700979348,\\n \\"FirstDequeueTime\\": 1250700979348,\\n \\"DequeueCount\\": 1,\\n \\"Priority\\": 1,\\n \\"MessageGroupId\\": \\"test-group\\",\\n \\"UserProperties\\": \\"{\\\\\\"xxx\\\\\\":\\\\\\"value\\\\\\"}\\"\\n}","type":"json"}]',
+ ],
+ 'PublishMessage' => [
+ 'summary' => '',
+ 'path' => '/topics/{topicName}/messages',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'topicName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'MyTopic', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageBody' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'hello topic', 'title' => ''],
+ 'MessageTag' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'order-event', 'title' => ''],
+ 'MessageGroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'MessageAttributes' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DirectMail' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '详见 https://help.aliyun.com/zh/direct-mail/singlesendmail', 'title' => ''],
+ 'DirectSMS' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '{"FreeSignName":"阿里云","TemplateCode":"SMS_123456","Type":"singleContent","Receiver":"13800000000","SmsParams":"{\\"code\\":\\"1234\\"}"}', 'title' => ''],
+ 'Push' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '移动推送属性示例值', 'title' => ''],
+ ],
+ 'description' => '',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'MessageBodyMD5' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'description' => '## 请求说明'."\n"
+ ."\n"
+ .'- 消息发布后会被推送到该 Topic 下所有 Subscription 的 Endpoint。'."\n"
+ .'- 推送到 Queue 和 HTTP Endpoint 时不需要设置 `MessageAttributes`。'."\n"
+ .'- 推送到邮件、短信或移动推送时需要设置对应的 `MessageAttributes` 子属性。'."\n"
+ .'- 消息内容建议事先进行 Base64 编码以避免特殊字符问题。'."\n",
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"\\",\\n \\"MessageBodyMD5\\": \\"\\"\\n}","type":"json"}]',
+ ],
+ 'ReceiveMessage' => [
+ 'summary' => '',
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'MyQueue', 'title' => ''],
+ ],
+ [
+ 'name' => 'waitseconds',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => '', 'required' => false, 'example' => '0'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageId' => ['type' => 'string', 'description' => '', 'example' => '5F290C926D472878-2-14D9529A8FA-200000001', 'title' => ''],
+ 'ReceiptHandle' => ['type' => 'string', 'description' => '', 'example' => '1-ODU4OTkzNDU5My0xNDM1MTk3NjAwLTItNg==', 'title' => ''],
+ 'MessageBody' => ['type' => 'string', 'description' => '', 'example' => 'Hello MNS', 'title' => ''],
+ 'MessageBodyMD5' => ['type' => 'string', 'description' => '', 'example' => 'C5DD56A39F5F7BB8B3337C6D11B6D8BE', 'title' => ''],
+ 'EnqueueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'NextVisibleTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'FirstDequeueTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1250700979348', 'title' => ''],
+ 'DequeueCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
+ 'Priority' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1', 'title' => ''],
+ 'MessageGroupId' => ['type' => 'string', 'description' => '', 'example' => 'test-group', 'title' => ''],
+ 'UserProperties' => [
+ 'type' => 'string',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataType' => ['type' => 'string'],
+ 'StringValue' => ['type' => 'string'],
+ 'BinaryValue' => ['type' => 'string'],
+ ],
+ ],
+ 'description' => '',
+ 'example' => '{"xxx":"value"}',
+ 'title' => '',
+ ],
+ ],
+ 'title' => '',
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'description' => '## 请求说明'."\n"
+ ."\n"
+ .'- `ReceiveMessage` 操作会将取得的消息状态变为 Inactive，Inactive 持续时间由队列属性 `VisibilityTimeout` 决定。'."\n"
+ .'- 消费者需在 VisibilityTimeout 时间内消费成功后调用 `DeleteMessage` 删除该消息，否则消息将重新变为 Active 状态，被再次消费。'."\n"
+ .'- 支持长轮询（Long Polling）：设置 `waitseconds > 0` 后，若队列为空则等待至有消息到达或超时返回。'."\n"
+ .'><notice>进入长轮询后，建议您降低外部调用长轮询的并发数，选择合适的长轮询时间。目前服务端会根据长轮询数量、长轮询等待时间、访问 IP 数量等因素动态调整长轮询防攻击的并发上限值。当队列无消息时，超过长轮询上限值的请求将无法被监听到，并直接返回 404 MessageNotExist（按请求量正常计费）。如果您有临时提升长轮询上限值的需求，请及时提交工单。></notice>',
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"5F290C926D472878-2-14D9529A8FA-200000001\\",\\n \\"ReceiptHandle\\": \\"1-ODU4OTkzNDU5My0xNDM1MTk3NjAwLTItNg==\\",\\n \\"MessageBody\\": \\"Hello MNS\\",\\n \\"MessageBodyMD5\\": \\"C5DD56A39F5F7BB8B3337C6D11B6D8BE\\",\\n \\"EnqueueTime\\": 1250700979348,\\n \\"NextVisibleTime\\": 1250700979348,\\n \\"FirstDequeueTime\\": 1250700979348,\\n \\"DequeueCount\\": 1,\\n \\"Priority\\": 1,\\n \\"MessageGroupId\\": \\"test-group\\",\\n \\"UserProperties\\": \\"{\\\\\\"xxx\\\\\\":\\\\\\"value\\\\\\"}\\"\\n}","type":"json"}]',
+ ],
+ 'SendMessage' => [
+ 'summary' => '',
+ 'path' => '/queues/{queueName}/messages',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'queueName',
+ 'in' => 'path',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'MyQueue', 'title' => ''],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageBody' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '"Hello MNS"', 'title' => ''],
+ 'DelaySeconds' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '0', 'title' => ''],
+ 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '2', 'title' => ''],
+ 'MessageGroupId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'group-123', 'title' => ''],
+ 'UserProperties' => [
+ 'type' => 'string',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DataType' => ['type' => 'string'],
+ 'StringValue' => ['type' => 'string'],
+ 'BinaryValue' => ['type' => 'string'],
+ ],
+ ],
+ 'description' => '',
+ 'required' => false,
+ 'example' => '{"key1":"value1", "key2":"value2"}',
+ 'title' => '',
+ ],
+ ],
+ 'description' => '',
+ 'required' => false,
+ 'example' => '{'."\n"
+ .' "MessageBody": "Hello MNS",'."\n"
+ .' "DelaySeconds": 60,'."\n"
+ .' "Priority": 1'."\n"
+ .'}',
+ 'title' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MessageId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'MessageBodyMD5' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ReceiptHandle' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '',
+ 'description' => '## 请求说明'."\n"
+ .'- **SendMessage** 接口用于将消息发送至指定队列。'."\n"
+ .'- 消息可以立即被消费或通过设置 `DelaySeconds` 参数来延迟消费。'."\n"
+ .'- 发送的消息可以指定优先级，数值越小表示优先级越高。'."\n"
+ .'- 对于 FIFO 队列，可以通过 `MessageGroupId` 来保证同一分组内消息的顺序投递。'."\n"
+ .'- 用户还可以自定义属性 `UserProperties`，以 JSON 格式字符串形式提供额外信息。'."\n"
+ .'- 当 `DelaySeconds` 大于 0 时，API 返回的 `ReceiptHandle` 可用来在消息变为 Active 状态前删除该延迟消息。'."\n",
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"\\",\\n \\"MessageBodyMD5\\": \\"\\",\\n \\"ReceiptHandle\\": \\"\\"\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [],
+ 'errorCodes' => [],
+ 'changeSet' => [],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 23:41:30 +0000