summaryrefslogtreecommitdiff
path: root/data/zh_cn/mns-open/2022-01-19/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/mns-open/2022-01-19/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/mns-open/2022-01-19/api-docs.php')
-rw-r--r--data/zh_cn/mns-open/2022-01-19/api-docs.php6000
1 files changed, 2529 insertions, 3471 deletions
diff --git a/data/zh_cn/mns-open/2022-01-19/api-docs.php b/data/zh_cn/mns-open/2022-01-19/api-docs.php
index f0d9173..9a4f747 100644
--- a/data/zh_cn/mns-open/2022-01-19/api-docs.php
+++ b/data/zh_cn/mns-open/2022-01-19/api-docs.php
@@ -1,69 +1,36 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Mns-open',
- 'version' => '2022-01-19',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Mns-open', 'version' => '2022-01-19'],
'directories' => [
[
- 'id' => 320718,
- 'title' => '主题管理',
+ 'children' => ['CreateTopic', 'SetTopicAttributes', 'GetTopicAttributes', 'DeleteTopic', 'ListTopic'],
'type' => 'directory',
- 'children' => [
- 'CreateTopic',
- 'SetTopicAttributes',
- 'GetTopicAttributes',
- 'DeleteTopic',
- 'ListTopic',
- ],
+ 'title' => '主题管理',
+ 'id' => 143295,
],
[
- 'id' => 320724,
- 'title' => '队列管理',
+ 'children' => ['CreateQueue', 'SetQueueAttributes', 'GetQueueAttributes', 'DeleteQueue', 'ListQueue'],
'type' => 'directory',
- 'children' => [
- 'CreateQueue',
- 'SetQueueAttributes',
- 'GetQueueAttributes',
- 'DeleteQueue',
- 'ListQueue',
- ],
+ 'title' => '队列管理',
+ 'id' => 143301,
],
[
- 'id' => 320730,
- 'title' => '订阅管理',
+ 'children' => ['Subscribe', 'SetSubscriptionAttributes', 'GetSubscriptionAttributes', 'Unsubscribe', 'ListSubscriptionByTopic'],
'type' => 'directory',
- 'children' => [
- 'Subscribe',
- 'SetSubscriptionAttributes',
- 'GetSubscriptionAttributes',
- 'Unsubscribe',
- 'ListSubscriptionByTopic',
- ],
+ 'title' => '订阅管理',
+ 'id' => 143307,
],
[
- 'id' => 320736,
- 'title' => '接入点管理',
+ 'children' => ['DisableEndpoint', 'EnableEndpoint', 'GetEndpointAttribute', 'RevokeEndpointAcl', 'AuthorizeEndpointAcl'],
'type' => 'directory',
- 'children' => [
- 'DisableEndpoint',
- 'EnableEndpoint',
- 'GetEndpointAttribute',
- 'RevokeEndpointAcl',
- 'AuthorizeEndpointAcl',
- ],
+ 'title' => '接入点管理',
+ 'id' => 143313,
],
[
- 'id' => 320742,
- 'title' => '事件通知管理',
+ 'children' => ['GetEventRule', 'ListEventRules', 'CreateEventRule', 'DeleteEventRule'],
'type' => 'directory',
- 'children' => [
- 'GetEventRule',
- 'ListEventRules',
- 'CreateEventRule',
- 'DeleteEventRule',
- ],
+ 'title' => '事件通知管理',
+ 'id' => 239274,
],
],
'components' => [
@@ -75,143 +42,72 @@
.'注意:'."\n"
.'- 全名匹配规则:若此项填写,其他项均不可填写'."\n"
.'- 前缀匹配和后缀匹配: 这两项可填写任一一项,若都填写,即前后缀匹配',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'MatchState' => [
- 'title' => '是否匹配',
- 'description' => '是否匹配',
- 'type' => 'boolean',
- 'example' => 'true',
- 'default' => 'true',
- ],
- 'Name' => [
- 'title' => '全名',
- 'description' => '全名匹配规则',
- 'type' => 'string',
- 'example' => 'testBucket/folder1/file1',
- ],
- 'Prefix' => [
- 'title' => '前缀',
- 'description' => '前缀匹配规则',
- 'type' => 'string',
- 'example' => 'testBucket/prefix1xxx',
- ],
- 'Suffix' => [
- 'title' => '后缀',
- 'description' => '后缀匹配规则',
- 'type' => 'string',
- 'example' => 'suffix/xxxx.test',
- ],
+ 'MatchState' => ['title' => '是否匹配', 'description' => '是否匹配', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'matchState', 'default' => 'true'],
+ 'Name' => ['title' => '全名', 'description' => '全名匹配规则', 'visibility' => 'Public', 'type' => 'string', 'example' => 'testBucket/folder1/file1', 'backendName' => 'name'],
+ 'Prefix' => ['title' => '前缀', 'description' => '前缀匹配规则', 'visibility' => 'Public', 'type' => 'string', 'example' => 'testBucket/prefix1xxx', 'backendName' => 'prefix'],
+ 'Suffix' => ['title' => '后缀', 'description' => '后缀匹配规则', 'visibility' => 'Public', 'type' => 'string', 'example' => 'suffix/xxxx.test', 'backendName' => 'suffix'],
],
],
],
],
'apis' => [
- 'CreateTopic' => [
- 'summary' => '调用CreateTopic接口创建主题。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AuthorizeEndpointAcl' => [
+ 'summary' => '本接口用于新增指定类型的接入点的一条或多条Acl规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '121392',
- 'abilityTreeNodes' => [
- 'FEATUREmns5OVH2T',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '259963',
+ 'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
],
'parameters' => [
[
- 'name' => 'TopicName',
- 'in' => 'formData',
+ 'name' => 'EndpointType',
+ 'in' => 'query',
'schema' => [
- 'description' => '需创建的topic的名称。',
+ 'description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **public**:表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
- 'example' => 'test',
+ 'enumValueTitles' => ['public' => 'public'],
+ 'example' => 'public',
],
],
[
- 'name' => 'EnableLogging',
- 'in' => 'formData',
+ 'name' => 'AclStrategy',
+ 'in' => 'query',
'schema' => [
- 'description' => '是否开启日志管理功能。取值说明如下:'."\n"
- ."\n"
- .'- true:启用。'."\n"
+ 'description' => 'Acl策略。取值:'."\n"
."\n"
- .'- false:停用。'."\n"
- .'默认值:false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'MaxMessageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '发送到该主题的消息体最大长度。'."\n"
- .'取值范围:1024~ 65536,单位为Byte。'."\n"
- .'默认值:65536。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10240',
+ .'- **allow**:表示此次操作的为Cidr白名单。(目前仅支持allow)',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['allow' => 'allow'],
+ 'example' => 'allow',
],
],
[
- 'name' => 'Tag',
+ 'name' => 'CidrList',
'in' => 'query',
- 'style' => 'repeatList',
+ 'style' => 'simple',
'schema' => [
- 'description' => '资源标签列表。',
+ 'description' => '网络地址段列表。',
'type' => 'array',
- 'items' => [
- 'description' => '标签列表。'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 20,
- 'minItems' => 1,
- ],
- ],
- [
- 'name' => 'TopicType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '主题类型。可取值如下:'."\n"
- .' * normal: 普通主题'."\n"
- .' * fifo: FIFO主题',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
+ 'items' => ['description' => '网络地址段。', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1/24'],
+ 'required' => true,
],
],
],
@@ -220,123 +116,161 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123E62C',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '创建主题',
- ],
- 'SetTopicAttributes' => [
- 'summary' => '调用SetTopicAttributes接口来修改主题的属性。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '增加接入点Acl规则',
+ 'extraInfo' => '本API目前只在:广州、北京、上海地域开放,如果有其他地域需求请提工单进行支持',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-16T02:03:14.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'mns:AuthorizeEndpointAcl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'CreateEventRule' => [
+ 'summary' => '用于创建事件规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '121396',
- 'abilityTreeNodes' => [
- 'FEATUREmnsSAU1G7',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '259705',
+ 'abilityTreeNodes' => ['FEATUREmns94MK6H', 'FEATUREmnsT1OLHP'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'TopicName',
+ 'name' => 'ProductName',
+ 'in' => 'query',
+ 'schema' => ['description' => '事件通知云产品名称', 'type' => 'string', 'required' => true, 'example' => 'oss'],
+ ],
+ [
+ 'name' => 'RuleName',
'in' => 'query',
+ 'schema' => ['description' => '事件通知规则名称。', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW'],
+ ],
+ [
+ 'name' => 'EventTypes',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Topic的名称。',
- 'type' => 'string',
+ 'description' => '事件类型列表',
+ 'type' => 'array',
+ 'items' => ['description' => '事件类型', 'type' => 'string', 'required' => false, 'example' => 'ObjectCreated:PutObject'],
'required' => true,
- 'example' => 'test',
],
],
[
- 'name' => 'EnableLogging',
+ 'name' => 'MatchRules',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '是否开启日志管理功能。取值说明如下:'."\n"
- ."\n"
- .'- true:启用。'."\n"
- ."\n"
- .'- false:停用。'."\n"
- .'默认值:false。',
- 'type' => 'boolean',
+ 'description' => '匹配规则,多个规则之间 or 关系',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '子项列表,多个规则 and 关系',
+ 'type' => 'array',
+ 'items' => ['description' => '事件原子匹配规则对象', 'required' => false, '$ref' => '#/components/schemas/EventMatchRule'],
+ 'required' => false,
+ 'maxItems' => 6,
+ ],
+ 'required' => true,
+ 'maxItems' => 10,
+ ],
+ ],
+ [
+ 'name' => 'Endpoints',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '已废弃字段。请使用 Endpoint',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EndpointType' => [
+ 'description' => '已废弃。请使用Endpoint.EndpointType',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['http' => 'http', 'topic' => 'topic', 'queue' => 'queue'],
+ 'example' => 'http',
+ ],
+ 'EndpointValue' => ['description' => '已废弃。请使用Endpoint.EndpointValue', 'type' => 'string', 'required' => false, 'example' => 'test-xxx-queue'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 10,
],
],
[
- 'name' => 'MaxMessageSize',
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户端Token,用于保证请求的幂等性。'."\n"
+ ."\n"
+ .'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。', 'type' => 'string', 'required' => false, 'example' => '06273500-249F-5863-121D-74D51123****'."\n"],
+ ],
+ [
+ 'name' => 'Endpoint',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '发送到该主题的消息体最大长度。'."\n"
- .'取值范围:1024~ 65536,单位为Byte。'."\n"
- .'默认值:65536。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '此次订阅中接收消息的终端地址。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndpointType' => ['description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **topic**: 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
+ .'- **queue**: 队列类型。直接投递到队列。可以减少链路路径,但后续不可增加新的订阅接收端。', 'type' => 'string', 'required' => false, 'example' => 'topic'],
+ 'EndpointValue' => ['description' => '接收终端实际值', 'type' => 'string', 'required' => false, 'example' => 'test-topic'],
+ ],
'required' => false,
- 'example' => '65536',
+ ],
+ ],
+ [
+ 'name' => 'DeliveryMode',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => '已废弃字段',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => '--',
+ 'enum' => ['DIRECT', 'BROADCAST'],
],
],
],
@@ -345,97 +279,110 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'RequestId' => ['description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => ['description' => '响应数据,创建规则成功时,返回创建的规则名称', 'type' => 'string', 'example' => 'rule-xsXDW'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '修改主题的属性',
- ],
- 'GetTopicAttributes' => [
- 'summary' => '调用GetTopicAttributes接口获取主题的属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建事件规则',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-23T06:57:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-10T10:45:56.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'mns:PutEventNotifications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"rule-xsXDW\\"\\n}","type":"json"}]',
+ ],
+ 'CreateQueue' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '121395',
- 'abilityTreeNodes' => [
- 'FEATUREmnsSAU1G7',
- ],
+ 'abilityTreeCode' => '121383',
+ 'abilityTreeNodes' => ['FEATUREmnsXP7W6E'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'TopicName',
+ 'name' => 'QueueName',
'in' => 'query',
- 'schema' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-topic',
- ],
+ 'schema' => ['description' => '队列名称。', 'type' => 'string', 'required' => true, 'example' => '06273500-249F-5863-121D-74D51123****'],
+ ],
+ [
+ 'name' => 'MaximumMessageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '发送到该Queue的消息体的最大长度。'."\n"
+ .'取值范围:1024~65536,单位为Byte。'."\n"
+ .'默认值:65536。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65536'],
+ ],
+ [
+ 'name' => 'MessageRetentionPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除。'."\n"
+ .'取值范围:60~604800,单位为秒。'."\n"
+ .'默认值:345600。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '604800', 'minimum' => '60', 'example' => '345600'],
+ ],
+ [
+ 'name' => 'VisibilityTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
+ .'取值范围:1~43200,单位为秒。'."\n"
+ .'默认值:30。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'],
+ ],
+ [
+ 'name' => 'PollingWaitSeconds',
+ 'in' => 'query',
+ 'schema' => ['description' => '当Queue中没有消息时,针对该Queue的ReceiveMessage请求最长的等待时间。'."\n"
+ .'取值范围:0~30,单位为秒。'."\n"
+ .'默认值:0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'EnableLogging',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启日志管理功能。取值说明如下:'."\n"
+ ."\n"
+ .'- true:启用。'."\n"
+ ."\n"
+ .'- false:停用。'."\n"
+ ."\n"
+ .'默认值:false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'DelaySeconds',
+ 'in' => 'query',
+ 'schema' => ['description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费。'."\n"
+ .'取值范围:0~604800,单位为秒。'."\n"
+ .'默认值:0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'Tag',
@@ -445,21 +392,11 @@
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
- 'description' => '标签列表。',
+ 'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'Key' => ['description' => '标签的key。', 'type' => 'string', 'required' => false, 'example' => 'tag1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
'required' => false,
],
@@ -468,223 +405,125 @@
'minItems' => 1,
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'DlqPolicy',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
+ 'description' => '死信策略。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应数据。',
- 'type' => 'object',
- 'properties' => [
- 'TopicName' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'example' => 'demo-topic',
- ],
- 'MessageCount' => [
- 'description' => '当前该主题中消息数目。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'MaxMessageSize' => [
- 'description' => '发送到该主题的消息体最大长度,单位为Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65536',
- ],
- 'MessageRetentionPeriod' => [
- 'description' => '消息在主题中最长存活时间,从发送到该主题开始经过此参数指定的时间后,不论消息是否被成功推送给用户都将被删除,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '86400',
- ],
- 'CreateTime' => [
- 'description' => '主题的创建时间,从1970-01-01 00:00:00到现在的时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554277',
- ],
- 'LastModifyTime' => [
- 'description' => '修改主题属性信息的最近时间,从1970-01-01 00:00:00到现在的时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554460',
- ],
- 'LoggingEnabled' => [
- 'description' => '是否开启日志管理功能。'."\n"
- ."\n"
- .'- True:启用。'."\n"
- ."\n"
- .'- False:停用。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Tags' => [
- 'description' => '资源标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签键对应的标签值。',
- 'type' => 'object',
- 'properties' => [
- 'TagKey' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'example' => 'tag1',
- ],
- 'TagValue' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- 'TopicType' => [
- 'description' => '主题类型。可取值如下:'."\n"
- .' * normal: 普通主题'."\n"
- .' * fifo: FIFO主题',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'TopicUrl' => [
- 'title' => '消息 Topic URL',
- 'description' => '消息 Topic URL',
- 'type' => 'string',
- 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic',
- ],
- 'TopicInnerUrl' => [
- 'title' => '消息 Topic URL(内网访问)。',
- 'description' => '消息 Topic URL(内网访问)。',
- 'type' => 'string',
- 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic',
- ],
- ],
- ],
+ 'Enabled' => ['description' => '是否开启死信消息投递。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列。', 'type' => 'string', 'required' => false, 'example' => 'deadLetterQueue'],
+ 'MaxReceiveCount' => ['description' => '消息最大投递次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
+ 'required' => false,
],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554277,\\n \\"LastModifyTime\\": 1449554460,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\",\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取主题的属性',
- ],
- 'DeleteTopic' => [
- 'summary' => '调用DeleteTopic接口删除主题。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '121393',
- 'abilityTreeNodes' => [
- 'FEATUREmns5OVH2T',
+ 'name' => 'QueueType',
+ 'in' => 'query',
+ 'schema' => ['description' => '队列类型。可取值如下:'."\n"
+ .' * normal: 普通队列'."\n"
+ .' * fifo: FIFO队列', 'type' => 'string', 'required' => false, 'example' => 'normal'],
],
- ],
- 'parameters' => [
[
- 'name' => 'TopicName',
+ 'name' => 'TenantRateLimitPolicy',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '需要删除的topic名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tf-testAccMNSTopic-112965059402264645',
+ 'description' => '限流策略',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['description' => '是否启用限流。取值范围:'."\n"
+ ."\n"
+ .'- true'."\n"
+ .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'MaxReceivesPerSecond' => ['description' => '每秒最大接收次数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'],
+ ],
+ 'required' => false,
],
],
+ [
+ 'name' => 'EnableSSE',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'required' => false],
+ ],
+ [
+ 'name' => 'SseType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'SseAlgorithm',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'KmsKeyId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
- 'title' => '删除主题',
- ],
- 'ListTopic' => [
- 'summary' => '调用ListTopic接口查询阿里云账号下的主题列表,可分页获取数据。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '创建队列',
+ 'summary' => '调用CreateQueue接口创建一个新的队列。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-08T03:11:41.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-10T15:56:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-24T06:19:34.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-05-27T08:39:05.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-20T03:03:34.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateQueue'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'mns:CreateQueue',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateTopic' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -693,74 +532,49 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '121394',
- 'abilityTreeNodes' => [
- 'FEATUREmnsSAU1G7',
- ],
+ 'abilityTreeCode' => '121392',
+ 'abilityTreeNodes' => ['FEATUREmns5OVH2T'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页页码,查询第几页的返回结果。'."\n"
- .'取值范围:1~100000000。'."\n"
- .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000000,则系统默认按照参数值为100000000处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'TopicName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '需创建的topic的名称。', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。'."\n"
- .'取值范围:10~50。'."\n"
- .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'EnableLogging',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否开启日志管理功能。取值说明如下:'."\n"
+ ."\n"
+ .'- true:启用。'."\n"
+ ."\n"
+ .'- false:停用。'."\n"
+ .'默认值:false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'TopicName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'name' => 'MaxMessageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => '发送到该主题的消息体最大长度。'."\n"
+ .'取值范围:1024~ 65536,单位为Byte。'."\n"
+ .'默认值:65536。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '标签列表。',
+ 'description' => '资源标签列表。',
'type' => 'array',
'items' => [
- 'description' => '标签键对应的标签值。',
+ 'description' => '标签列表。'."\n",
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'Key' => ['description' => '标签的key。', 'type' => 'string', 'required' => false, 'example' => 'tag1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
'required' => false,
],
@@ -772,14 +586,29 @@
[
'name' => 'TopicType',
'in' => 'query',
- 'schema' => [
- 'description' => '主题类型。可取值如下:'."\n"
- .' * normal: 普通主题'."\n"
- .' * fifo: FIFO主题',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- ],
+ 'schema' => ['description' => '主题类型。可取值如下:'."\n"
+ .' * normal: 普通主题'."\n"
+ .' * fifo: FIFO主题', 'type' => 'string', 'required' => false, 'example' => 'normal'],
+ ],
+ [
+ 'name' => 'EnableSSE',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'boolean', 'required' => false],
+ ],
+ [
+ 'name' => 'SseType',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'SseAlgorithm',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'KmsKeyId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -787,375 +616,216 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'PageNum' => [
- 'description' => '分页页码,查询第几页的返回结果。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'Total' => [
- 'description' => '总结果数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '130',
- ],
- 'PageData' => [
- 'description' => '当前页返回结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据项',
- 'type' => 'object',
- 'properties' => [
- 'TopicName' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'example' => 'demo-topic',
- ],
- 'MessageCount' => [
- 'description' => '当前该主题中消息数目。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'MaxMessageSize' => [
- 'description' => '发送到该主题的消息体最大长度,单位为Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65536',
- ],
- 'MessageRetentionPeriod' => [
- 'description' => '消息在主题中最长存活时间,从发送到该主题开始经过此参数指定的时间后,不论消息是否被成功推送给用户都将被删除,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '86400',
- ],
- 'CreateTime' => [
- 'description' => 'Subscription的创建时间,从1970-01-01 00:00:00到现在的。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554962',
- ],
- 'LastModifyTime' => [
- 'description' => '最近一次修改Subscription属性信息的时间,从1970-01-01 00:00:00到现在的秒值。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554962',
- ],
- 'LoggingEnabled' => [
- 'description' => '是否开启日志管理功能。'."\n"
- ."\n"
- .'- True:启用。'."\n"
- ."\n"
- .'- False:停用。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'TopicUrl' => [
- 'description' => '消息Topic URL。',
- 'type' => 'string',
- 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic',
- ],
- 'TopicInnerUrl' => [
- 'description' => '消息Topic URL(内网访问)。',
- 'type' => 'string',
- 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic',
- ],
- 'Tags' => [
- 'description' => '资源标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签键对应的标签值。',
- 'type' => 'object',
- 'properties' => [
- 'TagKey' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'example' => 'tag1',
- ],
- 'TagValue' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- 'TopicType' => [
- 'description' => '主题类型。可取值如下:'."\n"
- .' * normal: 普通主题'."\n"
- .' * fifo: FIFO主题',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554962,\\n \\"LastModifyTime\\": 1449554962,\\n \\"LoggingEnabled\\": true,\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '查询阿里云账号下的主题列表',
- ],
- 'CreateQueue' => [
- 'summary' => '调用CreateQueue接口创建一个新的队列。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '创建主题',
+ 'summary' => '调用CreateTopic接口创建主题。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-08T03:11:41.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-05-27T08:39:05.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-20T03:03:34.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTopic'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'mns:CreateTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteEventRule' => [
+ 'summary' => '用于删除事件规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '121383',
- 'abilityTreeNodes' => [
- 'FEATUREmnsXP7W6E',
- ],
+ 'abilityTreeCode' => '261151',
+ 'abilityTreeNodes' => ['FEATUREmns94MK6H', 'FEATUREmnsT1OLHP'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'QueueName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '队列名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- ],
- [
- 'name' => 'MaximumMessageSize',
+ 'name' => 'ProductName',
'in' => 'query',
- 'schema' => [
- 'description' => '发送到该Queue的消息体的最大长度。'."\n"
- .'取值范围:1024~65536,单位为Byte。'."\n"
- .'默认值:65536。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '65536',
- ],
+ 'schema' => ['description' => '事件通知云产品名称', 'type' => 'string', 'required' => true, 'example' => 'oss'],
],
[
- 'name' => 'MessageRetentionPeriod',
+ 'name' => 'RuleName',
'in' => 'query',
- 'schema' => [
- 'description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除。'."\n"
- .'取值范围:60~604800,单位为秒。'."\n"
- .'默认值:345600。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '604800',
- 'minimum' => '60',
- 'example' => '345600',
- ],
+ 'schema' => ['description' => '事件通知规则名称。', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW'],
],
- [
- 'name' => 'VisibilityTimeout',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
- .'取值范围:1~43200,单位为秒。'."\n"
- .'默认值:30。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '60',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
- [
- 'name' => 'PollingWaitSeconds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当Queue中没有消息时,针对该Queue的ReceiveMessage请求最长的等待时间。'."\n"
- .'取值范围:0~30,单位为秒。'."\n"
- .'默认值:0。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除事件规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'mns:DeleteEventNotifications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteQueue' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'EnableLogging',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否开启日志管理功能。取值说明如下:'."\n"
- ."\n"
- .'- true:启用。'."\n"
- ."\n"
- .'- false:停用。'."\n"
- ."\n"
- .'默认值:false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREmnsXP7W6E'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'DelaySeconds',
+ 'name' => 'QueueName',
'in' => 'query',
- 'schema' => [
- 'description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费。'."\n"
- .'取值范围:0~604800,单位为秒。'."\n"
- .'默认值:0。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '队列名称。', 'type' => 'string', 'required' => true, 'example' => 'tf-testAccMNSQueue-525478433321945943'],
],
- [
- 'name' => 'Tag',
- 'in' => 'query',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '资源标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签键对应的标签值。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '响应数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
- 'required' => false,
],
- 'required' => false,
- 'maxItems' => 20,
- 'minItems' => 1,
+ 'description' => '',
],
],
+ ],
+ 'title' => '删除队列',
+ 'summary' => '调用DeleteQueue接口删除已创建的队列。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteQueue'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'DlqPolicy',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '死信策略。',
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deadLetterQueue',
- ],
- 'MaxReceiveCount' => [
- 'description' => '消息最大投递次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'mns:DeleteQueue',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'DeleteTopic' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'QueueType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '队列类型。可取值如下:'."\n"
- .' * normal: 普通队列'."\n"
- .' * fifo: FIFO队列',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '121393',
+ 'abilityTreeNodes' => ['FEATUREmns5OVH2T'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'TenantRateLimitPolicy',
+ 'name' => 'TopicName',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '限流策略',
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'description' => '是否启用限流。取值范围:'."\n"
- ."\n"
- .'- true'."\n"
- .'- false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'MaxReceivesPerSecond' => [
- 'description' => '每秒最大接收次数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1000',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '需要删除的topic名称。', 'type' => 'string', 'required' => true, 'example' => 'tf-testAccMNSTopic-112965059402264645'],
],
],
'responses' => [
@@ -1163,300 +833,396 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123E62C',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => ['description' => '响应数据。', 'type' => 'object'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '创建队列',
- ],
- 'SetQueueAttributes' => [
- 'summary' => '调用SetQueueAttributes接口修改队列属性。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '删除主题',
+ 'summary' => '调用DeleteTopic接口删除主题。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteTopic'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'mns:DeleteTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
+ ],
+ 'DisableEndpoint' => [
+ 'summary' => '本接口用于关闭指定类型接入点。关闭后,所有源自对应接入点的请求都将被拦截并返回错误。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'riskType' => 'high',
+ 'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeCode' => '121386',
- 'abilityTreeNodes' => [
- 'FEATUREmnsVLH730',
- ],
+ 'abilityTreeCode' => '259962',
+ 'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
],
'parameters' => [
[
- 'name' => 'QueueName',
+ 'name' => 'EndpointType',
'in' => 'query',
'schema' => [
- 'description' => 'Queue名称。',
+ 'description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **public**:表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
- 'example' => 'testqueue',
+ 'enumValueTitles' => ['public' => 'public'],
+ 'example' => 'public',
],
],
- [
- 'name' => 'DelaySeconds',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费。'."\n"
- .'取值范围:0~604800,单位为秒。'."\n"
- .'默认值:0。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '关闭接入点',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-16T02:03:14.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'MaximumMessageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '发送到该Queue的消息体的最大长度。'."\n"
- .'取值范围:1024~65536,单位为Byte。'."\n"
- .'默认值:65536。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1024',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'mns:DisableEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'EnableEndpoint' => [
+ 'summary' => '本接口用于启用指定类型的接入点。开启后,源自对应接入点且处于Acl白名单中的请求都将不会被拦截。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'MessageRetentionPeriod',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '259960',
+ 'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EndpointType',
'in' => 'query',
'schema' => [
- 'description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除。'."\n"
- .'取值范围:60~604800,单位为秒。'."\n"
- .'默认值:345600。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '120',
+ 'description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **public**:表示公网接入点。(目前仅支持public)',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['public' => 'public'],
+ 'example' => 'public',
],
],
- [
- 'name' => 'VisibilityTimeout',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
- .'取值范围:1~43200,单位为秒。'."\n"
- .'默认值:30。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '60',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '启用接入点',
+ 'extraInfo' => '本API目前只在:广州、北京、上海 地域开放,如果有其他地域需求请提工单进行支持',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-16T02:03:14.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PollingWaitSeconds',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当Queue中没有消息时,针对该Queue的ReceiveMessage请求最长的等待时间。'."\n"
- .'取值范围:0~30,单位为秒。'."\n"
- .'默认值:0。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'mns:EnableEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetEndpointAttribute' => [
+ 'summary' => 'GetEndpointAttribute',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'EnableLogging',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '259965',
+ 'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EndpointType',
'in' => 'query',
'schema' => [
- 'description' => '是否开启日志管理功能。取值说明如下:'."\n"
- ."\n"
- .'- true:启用。'."\n"
+ 'description' => '接入点类型。取值:'."\n"
."\n"
- .'- false:停用。'."\n"
- .'默认值:false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ .'- **public**:表示公网接入点。(目前仅支持public)',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['public' => 'public'],
+ 'example' => 'public',
],
],
- [
- 'name' => 'DlqPolicy',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deadLetterTargetQueue',
- ],
- 'MaxReceiveCount' => [
- 'description' => '消息最大投递次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '响应数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndpointEnabled' => ['description' => '接入点是否开启。', 'type' => 'boolean', 'example' => 'true'],
+ 'CidrList' => [
+ 'description' => '网络地址段列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '网络地址段。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cidr' => ['description' => '网络地址段。', 'type' => 'string', 'example' => '172.18.0.0/24'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1701951224000'],
+ 'AclStrategy' => ['description' => 'Acl策略。取值:'."\n"
+ ."\n"
+ .'- **allow**:表示当前接入点允许对应Cidr访问。(目前仅支持allow)', 'type' => 'string', 'example' => 'allow'],
+ ],
+ ],
+ ],
+ ],
],
],
- 'required' => false,
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取接入点属性',
+ 'extraInfo' => '本API目前只在:广州、北京、上海地域开放,如果有其他地域需求请提工单进行支持',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-16T02:03:14.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TenantRateLimitPolicy',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'MaxReceivesPerSecond' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'mns:GetEndpointAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"EndpointEnabled\\": true,\\n \\"CidrList\\": [\\n {\\n \\"Cidr\\": \\"172.18.0.0/24\\",\\n \\"CreateTime\\": 1701951224000,\\n \\"AclStrategy\\": \\"allow\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetEventRule' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '273196',
+ 'abilityTreeNodes' => ['FEATUREmnsT1OLHP'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProductName',
+ 'in' => 'query',
+ 'schema' => ['description' => '事件通知云产品名称', 'type' => 'string', 'required' => true, 'example' => 'oss'],
+ ],
+ [
+ 'name' => 'RuleName',
+ 'in' => 'query',
+ 'schema' => ['description' => '事件通知规则名称。', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
'Data' => [
- 'description' => '响应数据。',
+ 'description' => '查询结果。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
+ 'RuleName' => ['description' => '事件通知规则名称。', 'type' => 'string', 'example' => 'event-recorder'],
+ 'EventTypes' => [
+ 'description' => '事件类型列表',
+ 'type' => 'array',
+ 'items' => ['description' => '查询到的事件类型的全名。', 'type' => 'string', 'example' => '["oss:ObjectModified:UpdateObjectMeta"]'],
],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '无',
+ 'MatchRules' => [
+ 'title' => '事件匹配规则,or 关系',
+ 'description' => '事件匹配规则,or 关系',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '事件匹配规则,or 关系',
+ 'type' => 'array',
+ 'items' => ['description' => '事件匹配规则,or 关系', '$ref' => '#/components/schemas/EventMatchRule'],
+ ],
+ ],
+ 'Subscriptions' => [
+ 'description' => '订阅终端',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EndpointType' => ['description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **queue**: 队列类型。'."\n"
+ .'- **topic**: 主题类型。', 'type' => 'string', 'example' => 'queue'],
+ 'EndpointValue' => ['description' => '接收终端实际值', 'type' => 'string', 'example' => 'retry-queue'],
+ ],
+ 'description' => '',
+ ],
],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'TopicName' => ['description' => '主题的名称。', 'type' => 'string', 'example' => 'demo-topic'],
+ 'Endpoint' => [
+ 'description' => '订阅的终端地址。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndpointType' => ['description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **queue**: 队列类型。'."\n"
+ .'- **topic**: 主题类型。', 'type' => 'string', 'example' => 'queue'],
+ 'EndpointValue' => ['description' => '接收终端实际值', 'type' => 'string', 'example' => 'retry-queue'],
+ ],
],
+ 'DeliveryMode' => ['description' => '已废弃字段', 'type' => 'string', 'example' => '--'],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '修改队列属性',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取事件通知规则',
+ 'summary' => '获取事件通知规则。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetEventRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/products/{#ProductName}/rules'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleName\\": \\"event-recorder\\",\\n \\"EventTypes\\": [\\n \\"[\\\\\\"oss:ObjectModified:UpdateObjectMeta\\\\\\"]\\"\\n ],\\n \\"MatchRules\\": [\\n [\\n {\\n \\"MatchState\\": true,\\n \\"Name\\": \\"testBucket/folder1/file1\\",\\n \\"Prefix\\": \\"testBucket/prefix1xxx\\",\\n \\"Suffix\\": \\"suffix/xxxx.test\\"\\n }\\n ]\\n ],\\n \\"Subscriptions\\": [\\n {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"retry-queue\\"\\n }\\n ],\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"Endpoint\\": {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"retry-queue\\"\\n },\\n \\"DeliveryMode\\": \\"--\\"\\n }\\n}","type":"json"}]',
],
'GetQueueAttributes' => [
- 'summary' => '获取某个已创建队列的属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1469,20 +1235,13 @@
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121385',
- 'abilityTreeNodes' => [
- 'FEATUREmnsVLH730',
- ],
+ 'abilityTreeNodes' => ['FEATUREmnsVLH730'],
],
'parameters' => [
[
'name' => 'QueueName',
'in' => 'query',
- 'schema' => [
- 'description' => '队列名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-queue',
- ],
+ 'schema' => ['description' => '队列名称。', 'type' => 'string', 'required' => true, 'example' => 'demo-queue'],
],
[
'name' => 'Tag',
@@ -1495,18 +1254,8 @@
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'Key' => ['description' => '标签的key。', 'type' => 'string', 'required' => false, 'example' => 'tag1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
'required' => false,
],
@@ -1521,118 +1270,39 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'QueueName' => [
- 'description' => 'Queue的名称。',
- 'type' => 'string',
- 'example' => 'demo-queue',
- ],
- 'CreateTime' => [
- 'description' => 'Queue的创建时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1250700999',
- ],
- 'LastModifyTime' => [
- 'description' => '修改Queue属性信息最近时间,从1970-01-01 00:00:00到现在的时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1250700999',
- ],
- 'DelaySeconds' => [
- 'description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30',
- ],
- 'MaximumMessageSize' => [
- 'description' => '发送到该Queue的消息体的最大长度,单位为Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65536',
- ],
- 'MessageRetentionPeriod' => [
- 'description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65536',
- ],
- 'VisibilityTimeout' => [
- 'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
- .'取值范围:1~43200,单位为秒。'."\n"
- .'默认值:30。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'PollingWaitSeconds' => [
- 'description' => '当Queue消息量为空时,针对该Queue的ReceiveMessage请求最长的等待时间,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ActiveMessages' => [
- 'description' => '在该Queue中处于Active状态的消息总数,为近似值。'."\n"
- ."\n"
- .'<warning>后续会下线,默认为0,不推荐使用,请使用云监控api获取指标。</warning>',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'InactiveMessages' => [
- 'description' => '在该Queue中处于Inactive状态的消息总数,为近似值。'."\n"
- ."\n"
- .'<warning>后续会下线,默认为0,不推荐使用,请使用云监控api获取指标。</warning>',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'DelayMessages' => [
- 'description' => '在该Queue中处于Delayed状态的消息总数,为近似值。'."\n"
- ."\n"
- .'<warning>后续会下线,默认为0,不推荐使用,请使用云监控api获取指标。</warning>',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'LoggingEnabled' => [
- 'description' => '是否开启日志管理功能。'."\n"
- ."\n"
- .'- True:启用。'."\n"
- ."\n"
- .'- False:停用。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'QueueName' => ['description' => 'Queue的名称。', 'type' => 'string', 'example' => 'demo-queue'],
+ 'CreateTime' => ['description' => 'Queue的创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999'],
+ 'LastModifyTime' => ['description' => '修改Queue属性信息最近时间,从1970-01-01 00:00:00到现在的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999'],
+ 'DelaySeconds' => ['description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
+ 'MaximumMessageSize' => ['description' => '发送到该Queue的消息体的最大长度,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '65536'],
+ 'MessageRetentionPeriod' => ['description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '65536'],
+ 'VisibilityTimeout' => ['description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
+ .'取值范围:1~43200,单位为秒。'."\n"
+ .'默认值:30。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
+ 'PollingWaitSeconds' => ['description' => '当Queue消息量为空时,针对该Queue的ReceiveMessage请求最长的等待时间,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'ActiveMessages' => ['description' => '在该Queue中处于Active状态的消息总数,为近似值。'."\n"
+ ."\n"
+ .'<warning>后续会下线,默认为0,不推荐使用,请使用云监控api获取指标。</warning>', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'InactiveMessages' => ['description' => '在该Queue中处于Inactive状态的消息总数,为近似值。'."\n"
+ ."\n"
+ .'<warning>后续会下线,默认为0,不推荐使用,请使用云监控api获取指标。</warning>', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'DelayMessages' => ['description' => '在该Queue中处于Delayed状态的消息总数,为近似值。'."\n"
+ ."\n"
+ .'<warning>后续会下线,默认为0,不推荐使用,请使用云监控api获取指标。</warning>', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'LoggingEnabled' => ['description' => '是否开启日志管理功能。'."\n"
+ ."\n"
+ .'- True:启用。'."\n"
+ ."\n"
+ .'- False:停用。', 'type' => 'boolean', 'example' => 'True'],
'Tags' => [
'description' => '资源标签列表。',
'type' => 'array',
@@ -1640,16 +1310,8 @@
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
- 'TagKey' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'example' => 'tag1',
- ],
- 'TagValue' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'test',
- ],
+ 'TagKey' => ['description' => '标签的key。', 'type' => 'string', 'example' => 'tag1'],
+ 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'],
],
],
],
@@ -1657,57 +1319,38 @@
'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列。',
- 'type' => 'string',
- 'example' => 'deadLetterTargetQueue',
- ],
- 'MaxReceiveCount' => [
- 'description' => '消息最大投递次数。',
- 'type' => 'string',
- 'example' => '3',
- ],
+ 'Enabled' => ['description' => '是否开启死信消息投递。', 'type' => 'boolean', 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列。', 'type' => 'string', 'example' => 'deadLetterTargetQueue'],
+ 'MaxReceiveCount' => ['description' => '消息最大投递次数。', 'type' => 'string', 'example' => '3'],
],
],
'TenantRateLimitPolicy' => [
'description' => '限流策略',
'type' => 'object',
'properties' => [
- 'Enabled' => [
- 'description' => '是否启用限流。取值范围:'."\n"
- .'- true'."\n"
- .'- false',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MaxReceivesPerSecond' => [
- 'description' => '每秒最大接收次数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
+ 'Enabled' => ['description' => '是否启用限流。取值范围:'."\n"
+ .'- true'."\n"
+ .'- false', 'type' => 'boolean', 'example' => 'true'],
+ 'MaxReceivesPerSecond' => ['description' => '每秒最大接收次数', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
],
],
- 'QueueType' => [
- 'description' => '队列类型。可取值如下:'."\n"
- .' * normal: 普通队列'."\n"
- .' * fifo: FIFO队列',
- 'type' => 'string',
- 'example' => 'normal',
- ],
+ 'QueueType' => ['description' => '队列类型。可取值如下:'."\n"
+ .' * normal: 普通队列'."\n"
+ .' * fifo: FIFO队列', 'type' => 'string', 'example' => 'normal'],
+ 'EnableSSE' => ['type' => 'boolean'],
+ 'SseType' => ['type' => 'string'],
+ 'SseAlgorithm' => ['type' => 'string'],
+ 'KmsKeyId' => ['type' => 'string'],
+ 'EncryptionEnabled' => ['type' => 'boolean'],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"QueueName\\": \\"demo-queue\\",\\n \\"CreateTime\\": 1250700999,\\n \\"LastModifyTime\\": 1250700999,\\n \\"DelaySeconds\\": 30,\\n \\"MaximumMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 65536,\\n \\"VisibilityTimeout\\": 60,\\n \\"PollingWaitSeconds\\": 0,\\n \\"ActiveMessages\\": 0,\\n \\"InactiveMessages\\": 0,\\n \\"DelayMessages\\": 0,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\",\\n \\"MaxReceiveCount\\": \\"3\\"\\n },\\n \\"TenantRateLimitPolicy\\": {\\n \\"Enabled\\": true,\\n \\"MaxReceivesPerSecond\\": 1000\\n },\\n \\"QueueType\\": \\"normal\\"\\n }\\n}","type":"json"}]',
'title' => '获取队列属性',
+ 'summary' => '获取某个已创建队列的属性。',
'description' => '><warning>'."\n"
.'<p>为优化服务性能,轻量消息队列即将下线以下字段的返回值(后续默认为0):<br>'."\n"
.' - ActiveMessages<br>'."\n"
@@ -1726,17 +1369,36 @@
.' </li>'."\n"
.' </ul>'."\n"
.'</warning>',
- ],
- 'DeleteQueue' => [
- 'summary' => '调用DeleteQueue接口删除已创建的队列。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-08T03:11:41.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-10T15:56:52.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-05-27T08:39:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetQueueAttributes'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetQueueAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"QueueName\\": \\"demo-queue\\",\\n \\"CreateTime\\": 1250700999,\\n \\"LastModifyTime\\": 1250700999,\\n \\"DelaySeconds\\": 30,\\n \\"MaximumMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 65536,\\n \\"VisibilityTimeout\\": 60,\\n \\"PollingWaitSeconds\\": 0,\\n \\"ActiveMessages\\": 0,\\n \\"InactiveMessages\\": 0,\\n \\"DelayMessages\\": 0,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\",\\n \\"MaxReceiveCount\\": \\"3\\"\\n },\\n \\"TenantRateLimitPolicy\\": {\\n \\"Enabled\\": true,\\n \\"MaxReceivesPerSecond\\": 1000\\n },\\n \\"QueueType\\": \\"normal\\",\\n \\"EnableSSE\\": true,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'GetSubscriptionAttributes' => [
+ 'summary' => '调用GetSubscriptionAttributes接口获取Subscription的属性。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1745,23 +1407,22 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREmnsXP7W6E',
- ],
+ 'abilityTreeCode' => '121400',
+ 'abilityTreeNodes' => ['FEATUREmns4BQTE0', 'FEATUREmnsNGE8ZG', 'FEATUREmnsOJMS9M', 'FEATUREmnsIGJWNT', 'FEATUREmnsUVY5DY'],
],
'parameters' => [
[
- 'name' => 'QueueName',
+ 'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => '队列名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tf-testAccMNSQueue-525478433321945943',
- ],
+ 'schema' => ['description' => 'Subscription订阅的主题名称。', 'type' => 'string', 'required' => true, 'example' => 'MyTopic'],
+ ],
+ [
+ 'name' => 'SubscriptionName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Subscription的名称。', 'type' => 'string', 'required' => true, 'example' => 'MySubscription'],
],
],
'responses' => [
@@ -1769,71 +1430,89 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '无',
+ 'SubscriptionName' => ['description' => 'Subscription的名称。', 'type' => 'string', 'example' => 'MySubscription'],
+ 'TopicOwner' => ['description' => 'Subscription订阅的主题所有者的AccountId。', 'type' => 'string', 'example' => '123456789098****'],
+ 'TopicName' => ['description' => 'Subscription订阅的主题名称。', 'type' => 'string', 'example' => 'MyTopic'],
+ 'Endpoint' => ['description' => '订阅的终端地址。', 'type' => 'string', 'example' => 'http://example.com'],
+ 'FilterTag' => ['description' => '描述了该订阅中消息过滤的标签(仅标签一致的消息才会被推送)。', 'type' => 'string', 'example' => 'important'],
+ 'CreateTime' => ['description' => 'Subscription的创建时间,从1970-01-01 00:00:00到现在的。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806'],
+ 'LastModifyTime' => ['description' => '最近一次修改Subscription属性信息的时间,从1970-01-01 00:00:00到现在的秒值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962'],
+ 'NotifyStrategy' => ['description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
+ ."\n"
+ .'- BACKOFF_RETRY:退避重试。'."\n"
+ ."\n"
+ .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。', 'type' => 'string', 'example' => 'BACKOFF_RETRY'],
+ 'NotifyContentFormat' => ['description' => '向Endpoint推送的消息内容格式。'."\n"
+ .'取值说明如下:'."\n"
+ ."\n"
+ .'- XML'."\n"
+ ."\n"
+ .'- JSON'."\n"
+ ."\n"
+ .'- SIMPLIFIED', 'type' => 'string', 'example' => 'XML'],
+ 'DlqPolicy' => [
+ 'description' => '死信队列策略。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['description' => '是否开启死信消息投递。', 'type' => 'boolean', 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列。', 'type' => 'string', 'example' => 'deadLetterTargetQueue'],
+ ],
],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'TenantRateLimitPolicy' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['type' => 'boolean', 'description' => ''],
+ 'MaxReceivesPerSecond' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ 'description' => '',
],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '删除队列',
- ],
- 'ListQueue' => [
- 'summary' => '调用ListQueue接口,列出指定阿里云账号下的所有队列,可分页获取数据。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取Subscription的属性',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-10T15:56:52.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-06-17T13:56:28.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-05-20T03:03:06.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSubscriptionAttributes'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetSubscriptionAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554962,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\"\\n },\\n \\"TenantRateLimitPolicy\\": {\\n \\"Enabled\\": true,\\n \\"MaxReceivesPerSecond\\": 0\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'GetTopicAttributes' => [
+ 'summary' => '调用GetTopicAttributes接口获取主题的属性。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1842,50 +1521,17 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '121378',
- 'abilityTreeNodes' => [
- 'FEATUREmns5OVH2T',
- ],
+ 'abilityTreeCode' => '121395',
+ 'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页页码,查询第几页的返回结果。'."\n"
- .'取值范围:1~100000000。'."\n"
- .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000000,则系统默认按照参数值为100000000处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。'."\n"
- .'取值范围:10~50。'."\n"
- .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'QueueName',
+ 'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => 'Queue名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-queue',
- ],
+ 'schema' => ['description' => '主题的名称。', 'type' => 'string', 'required' => true, 'example' => 'demo-topic'],
],
[
'name' => 'Tag',
@@ -1895,21 +1541,11 @@
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
- 'description' => '标签键对应的标签值。',
+ 'description' => '标签列表。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tag1',
- ],
- 'Value' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'Key' => ['description' => '标签的key。', 'type' => 'string', 'required' => false, 'example' => 'tag1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
'required' => false,
],
@@ -1918,460 +1554,164 @@
'minItems' => 1,
],
],
- [
- 'name' => 'QueueType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '队列类型。可取值如下:'."\n"
- .' * normal: 普通队列'."\n"
- .' * fifo: FIFO队列',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'PageNum' => [
- 'description' => '分页页码,查询第几页的返回结果。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'Size' => [
- 'description' => '当前页结果数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'Pages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Total' => [
- 'description' => '总结果数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '130',
- ],
- 'PageData' => [
- 'description' => '当前页返回结果。',
+ 'TopicName' => ['description' => '主题的名称。', 'type' => 'string', 'example' => 'demo-topic'],
+ 'MessageCount' => ['description' => '当前该主题中消息数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'MaxMessageSize' => ['description' => '发送到该主题的消息体最大长度,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '65536'],
+ 'MessageRetentionPeriod' => ['description' => '消息在主题中最长存活时间,从发送到该主题开始经过此参数指定的时间后,不论消息是否被成功推送给用户都将被删除,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '86400'],
+ 'CreateTime' => ['description' => '主题的创建时间,从1970-01-01 00:00:00到现在的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554277'],
+ 'LastModifyTime' => ['description' => '修改主题属性信息的最近时间,从1970-01-01 00:00:00到现在的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554460'],
+ 'LoggingEnabled' => ['description' => '是否开启日志管理功能。'."\n"
+ ."\n"
+ .'- True:启用。'."\n"
+ ."\n"
+ .'- False:停用。', 'type' => 'boolean', 'example' => 'True'],
+ 'Tags' => [
+ 'description' => '资源标签列表。',
'type' => 'array',
'items' => [
- 'description' => '数据项。',
+ 'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
- 'QueueName' => [
- 'description' => '队列名称。',
- 'type' => 'string',
- 'example' => 'demo-queue',
- ],
- 'CreateTime' => [
- 'description' => 'Queue的创建事件,从1970-01-01 00:00:00到现在的时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1250700999',
- ],
- 'LastModifyTime' => [
- 'description' => '修改Queue属性信息最近时间,从1970-01-01 00:00:00到现在的时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1250700999',
- ],
- 'DelaySeconds' => [
- 'description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30',
- ],
- 'MaximumMessageSize' => [
- 'description' => '发送到该Queue的消息体的最大长度,单位为Byte。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65536',
- ],
- 'MessageRetentionPeriod' => [
- 'description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65536',
- ],
- 'VisibilityTimeout' => [
- 'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
- .'取值范围:1~43200,单位为秒。'."\n"
- .'默认值:30。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'PollingWaitSeconds' => [
- 'description' => '当Queue消息量为空时,针对该Queue的ReceiveMessage请求最长的等待时间,单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ActiveMessages' => [
- 'description' => '在该Queue中处于Active状态的消息总数,为近似值。'."\n"
- .'后续会默认为0,不推荐使用,辛苦用云监控api获取指标',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'InactiveMessages' => [
- 'description' => '在该Queue中处于Inactive状态的消息总数,为近似值。'."\n"
- .'后续会默认为0,不推荐使用,辛苦用云监控api获取指标。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'DelayMessages' => [
- 'description' => '在该Queue中处于Delayed状态的消息总数,为近似值。'."\n"
- .'后续会默认为0,不推荐使用,辛苦用云监控api获取指标。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'LoggingEnabled' => [
- 'description' => '是否开启日志管理功能。'."\n"
- ."\n"
- .'- True:启用。'."\n"
- ."\n"
- .'- False:停用。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Tags' => [
- 'description' => '资源标签列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签键对应的标签值。',
- 'type' => 'object',
- 'properties' => [
- 'TagKey' => [
- 'description' => '标签的key。',
- 'type' => 'string',
- 'example' => 'tag1',
- ],
- 'TagValue' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- ],
- ],
- ],
- 'DlqPolicy' => [
- 'description' => '死信队列策略。',
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列。',
- 'type' => 'string',
- 'example' => 'deadLetterTargetQueue',
- ],
- 'MaxReceiveCount' => [
- 'description' => '消息最大投递次数。',
- 'type' => 'string',
- 'example' => '3',
- ],
- ],
- ],
- 'QueueType' => [
- 'description' => '队列类型。可取值如下:'."\n"
- .' * normal: 普通队列'."\n"
- .' * fifo: FIFO队列',
- 'type' => 'string',
- 'example' => 'normal',
- ],
+ 'TagKey' => ['description' => '标签的key。', 'type' => 'string', 'example' => 'tag1'],
+ 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'],
],
],
],
+ 'TopicType' => ['description' => '主题类型。可取值如下:'."\n"
+ .' * normal: 普通主题'."\n"
+ .' * fifo: FIFO主题', 'type' => 'string', 'example' => 'normal'],
+ 'TopicUrl' => ['title' => '消息 Topic URL', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic'],
+ 'TopicInnerUrl' => ['title' => '消息 Topic URL(内网访问)。', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic'],
+ 'EnableSSE' => ['type' => 'boolean'],
+ 'SseType' => ['type' => 'string'],
+ 'SseAlgorithm' => ['type' => 'string'],
+ 'KmsKeyId' => ['type' => 'string'],
+ 'EncryptionEnabled' => ['type' => 'boolean'],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"QueueName\\": \\"demo-queue\\",\\n \\"CreateTime\\": 1250700999,\\n \\"LastModifyTime\\": 1250700999,\\n \\"DelaySeconds\\": 30,\\n \\"MaximumMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 65536,\\n \\"VisibilityTimeout\\": 60,\\n \\"PollingWaitSeconds\\": 0,\\n \\"ActiveMessages\\": 0,\\n \\"InactiveMessages\\": 0,\\n \\"DelayMessages\\": 0,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\",\\n \\"MaxReceiveCount\\": \\"3\\"\\n },\\n \\"QueueType\\": \\"normal\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '列出指定阿里云账号下的所有队列',
- ],
- 'Subscribe' => [
- 'summary' => '调用Subscribe接口,为主题创建Subscription。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '获取主题的属性',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-08T03:11:41.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-05-27T08:39:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTopicAttributes'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetTopicAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554277,\\n \\"LastModifyTime\\": 1449554460,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\",\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\",\\n \\"EnableSSE\\": true,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'ListEventRules' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '121397',
- 'abilityTreeNodes' => [
- 'FEATUREmnsSAU1G7',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '272940',
+ 'abilityTreeNodes' => ['FEATUREmnsT1OLHP'],
],
'parameters' => [
[
- 'name' => 'TopicName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'topic****1',
- ],
- ],
- [
- 'name' => 'SubscriptionName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '订阅名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testSubscription ',
- ],
- ],
- [
- 'name' => 'PushType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '终端类型。'."\n"
- ."\n"
- .'- http:HTTP推送类型。'."\n"
- ."\n"
- .'- queue:队列推送类型。'."\n"
- ."\n"
- .'- mpush:移动推送类型。'."\n"
- ."\n"
- .'- alisms:阿里短信推送类型。'."\n"
- ."\n"
- .'- email:邮箱推送类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'queue',
- ],
- ],
- [
- 'name' => 'Endpoint',
+ 'name' => 'ProductName',
'in' => 'query',
- 'schema' => [
- 'description' => '此次订阅中接收消息的终端地址,不同终端类型的格式如下:'."\n"
- .'- HTTP格式为: `http(s)://{实际url地址}`'."\n"
- .'- 队列格式为: `{QueueName}`'."\n"
- .'- 移动推送格式为: `{AppKey}`'."\n"
- .'- 阿里短信格式为: `{phoneNumber}`'."\n"
- .'- 邮箱格式为: `{emailAddress}`',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'http://*****.com/uri1/xxx',
- ],
+ 'schema' => ['description' => '事件通知云产品名称', 'type' => 'string', 'required' => false, 'example' => 'oss'],
],
[
- 'name' => 'NotifyStrategy',
+ 'name' => 'ResourceName',
'in' => 'query',
- 'schema' => [
- 'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
- ."\n"
- .'- BACKOFF_RETRY:退避重试。'."\n"
- ."\n"
- .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BACKOFF_RETRY',
- ],
+ 'schema' => ['title' => '匹配规则中的资源名称,用于过滤规则,例:oss 中,此为 oss bucketName', 'description' => '匹配规则中的资源名称,用于过滤规则,例:oss 中,此为 oss bucketName', 'type' => 'string', 'required' => false, 'example' => 'test-bucket'],
],
[
- 'name' => 'NotifyContentFormat',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用于定义向Endpoint推送的消息格式。'."\n"
- .'取值说明如下:'."\n"
- ."\n"
- .'- XML'."\n"
- ."\n"
- .'- JSON'."\n"
- ."\n"
- .'- SIMPLIFIED',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XML',
- ],
- ],
- [
- 'name' => 'MessageTag',
+ 'name' => 'RuleName',
'in' => 'query',
- 'schema' => [
- 'description' => '该订阅中消息过滤的标签(标签一致的消息才会被推送)。'."\n"
- .'取值范围:不超过16个字符的字符串。'."\n"
- ."\n"
- .'默认不进行消息过滤。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'important',
- ],
+ 'schema' => ['title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'required' => false, 'example' => 'rule-xsXDW'],
],
[
- 'name' => 'DlqPolicy',
+ 'name' => 'TopicName',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '死信队列策略。',
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deadLetterTargetQueue',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '', 'description' => '主题的名称。', 'type' => 'string', 'required' => false, 'example' => 'test-topic'],
],
[
- 'name' => 'TenantRateLimitPolicy',
+ 'name' => 'Subscription',
'in' => 'query',
'style' => 'json',
'schema' => [
+ 'description' => '订阅端',
'type' => 'object',
'properties' => [
- 'Enabled' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'MaxReceivesPerSecond' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'EndpointType' => ['description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **topic**: 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
+ .'- **queue**: 队列类型。直接投递到队列。可以减少链路路径,但后续不可增加新的订阅接收端。', 'type' => 'string', 'required' => false, 'example' => 'topic'],
+ 'EndpointValue' => ['description' => '接收终端实际值', 'type' => 'string', 'required' => false, 'example' => 'test-topic'],
],
'required' => false,
],
],
[
- 'name' => 'StsRoleArn',
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '分页页码,查询第几页的返回结果。'."\n"
+ .'取值范围:1~100000。'."\n"
+ .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000,则系统默认按照参数值为100000处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'DmAttributes',
+ 'name' => 'PageSize',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'AccountName' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'Subject' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '分页大小,每页最多显示的返回结果数量。'."\n"
+ .'取值范围:10~50。'."\n"
+ .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'DysmsAttributes',
+ 'name' => 'NextToken',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'TemplateCode' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'SignName' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '已废弃字段。请使用 PageNum 分页查询。', 'type' => 'string', 'required' => false, 'example' => 'cd7NlPlX4kgKCdsCWMiMR/+HnVzPLQ4/XLvjR64jZ7F9AQ+Mr3T59J6IVkuXeV3w'],
],
[
- 'name' => 'KafkaAttributes',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'BusinessMode' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '已废弃字段。请使用 PageSize 分页查询', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
],
'responses' => [
@@ -2379,54 +1719,105 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
- 'type' => 'string',
- 'example' => '{\'Code\': 200, \'Success\': True}',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNum' => ['description' => '分页页码,查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小,每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'Size' => ['description' => '当前页结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'Pages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'Total' => ['description' => '总结果数。', 'type' => 'integer', 'format' => 'int64', 'example' => '130'],
+ 'NextToken' => ['description' => '已废弃字段。分页查询以PageNum为准', 'type' => 'string', 'example' => 'a88f58d504b8b4c4e0b5e8707e68181f'],
+ 'MaxResults' => ['description' => '已废弃字段。分页最大结果集以 Total 为准', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageData' => [
+ 'description' => '数据项',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据项。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => ['description' => '事件通知规则名称。', 'type' => 'string', 'example' => 'rule-xsXDW'],
+ 'Subscriptions' => [
+ 'description' => '订阅端。限制最大返回条数 20,如果超过请使用 [订阅列表](~~2804757~~) 查询。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EndpointType' => ['description' => '接入点类型。', 'type' => 'string', 'example' => 'queue'],
+ 'EndpointValue' => ['description' => '接收终端实际值', 'type' => 'string', 'example' => 'wyx-vp-complete-queue'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'TopicName' => ['description' => '主题的名称。', 'type' => 'string', 'example' => 'demo-topic'],
+ 'MatchRules' => [
+ 'title' => '事件匹配规则,or 关系',
+ 'description' => '事件匹配规则,or 关系',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '事件匹配规则,or 关系',
+ 'type' => 'array',
+ 'items' => ['description' => '匹配规则,多个规则之间 or 关系', 'example' => '[[{\\"MatchState\\":true,\\"Prefix\\":\\"cdhxdev1cdh-bba-dto-052901-sem-5seh/\\",\\"Suffix\\":\\"\\"}]]', '$ref' => '#/components/schemas/EventMatchRule'],
+ ],
+ ],
+ 'EventTypes' => [
+ 'description' => '事件类型列表',
+ 'type' => 'array',
+ 'items' => ['description' => '事件类型列表', 'type' => 'string', 'example' => '["oss:ObjectCreated:CopyObject"]'],
+ ],
+ 'Endpoint' => [
+ 'description' => '订阅的终端地址。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndpointType' => ['description' => '接入点类型。取值:'."\n"
+ ."\n"
+ .'- **topic**: 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
+ .'- **queue**: 队列类型。直接投递到队列。可以减少链路路径,但后续不可增加新的订阅接收端。', 'type' => 'string', 'example' => 'topic'],
+ 'EndpointValue' => ['description' => '接收终端实际值', 'type' => 'string', 'example' => 'test-topic'],
+ ],
+ ],
+ 'DeliveryMode' => ['description' => '已废弃字段', 'type' => 'string', 'example' => '--'],
+ ],
+ ],
+ ],
+ ],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"{\'Code\': 200, \'Success\': True}\\"\\n}","type":"json"}]',
- 'title' => '为主题创建Subscription',
- ],
- 'SetSubscriptionAttributes' => [
- 'summary' => '调用SetSubscriptionAttributes接口修改Subscription的属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '获取事件规则列表',
+ 'summary' => '查询事件通知列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListEventRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/products/{#ProductName}/rules'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"NextToken\\": \\"a88f58d504b8b4c4e0b5e8707e68181f\\",\\n \\"MaxResults\\": 1,\\n \\"PageData\\": [\\n {\\n \\"RuleName\\": \\"rule-xsXDW\\",\\n \\"Subscriptions\\": [\\n {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"wyx-vp-complete-queue\\"\\n }\\n ],\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MatchRules\\": [\\n [\\n {\\n \\"MatchState\\": true,\\n \\"Name\\": \\"testBucket/folder1/file1\\",\\n \\"Prefix\\": \\"testBucket/prefix1xxx\\",\\n \\"Suffix\\": \\"suffix/xxxx.test\\"\\n }\\n ]\\n ],\\n \\"EventTypes\\": [\\n \\"[\\\\\\"oss:ObjectCreated:CopyObject\\\\\\"]\\"\\n ],\\n \\"Endpoint\\": {\\n \\"EndpointType\\": \\"topic\\",\\n \\"EndpointValue\\": \\"test-topic\\"\\n },\\n \\"DeliveryMode\\": \\"--\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListQueue' => [
+ 'summary' => '调用ListQueue接口,列出指定阿里云账号下的所有队列,可分页获取数据。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2435,215 +1826,59 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '121401',
- 'abilityTreeNodes' => [
- 'FEATUREmnsSAU1G7',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '121378',
+ 'abilityTreeNodes' => ['FEATUREmns5OVH2T'],
],
'parameters' => [
[
- 'name' => 'TopicName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Topic的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'SubscriptionName',
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => 'Subscription的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MySubscription',
- ],
+ 'schema' => ['description' => '分页页码,查询第几页的返回结果。'."\n"
+ .'取值范围:1~100000000。'."\n"
+ .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000000,则系统默认按照参数值为100000000处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'NotifyStrategy',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
- ."\n"
- .'- BACKOFF_RETRY:退避重试。'."\n"
- ."\n"
- .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BACKOFF_RETRY',
- ],
+ 'schema' => ['description' => '分页大小,每页最多显示的返回结果数量。'."\n"
+ .'取值范围:10~50。'."\n"
+ .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'DlqPolicy',
+ 'name' => 'QueueName',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '死信队列策略。',
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'deadLetterTargetQueue',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Queue名称。', 'type' => 'string', 'required' => false, 'example' => 'demo-queue'],
],
[
- 'name' => 'TenantRateLimitPolicy',
+ 'name' => 'Tag',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'type' => 'boolean',
- 'required' => false,
- ],
- 'MaxReceivesPerSecond' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
+ 'description' => '资源标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签键对应的标签值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签的key。', 'type' => 'string', 'required' => false, 'example' => 'tag1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
+ 'required' => false,
],
'required' => false,
+ 'maxItems' => 20,
+ 'minItems' => 1,
],
],
[
- 'name' => 'StsRoleArn',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'STS角色ARN',
- 'description' => 'STS角色ARN',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acs:ram::1234567890:role/roleName',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '修改Subscription的属性',
- ],
- 'GetSubscriptionAttributes' => [
- 'summary' => '调用GetSubscriptionAttributes接口获取Subscription的属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '121400',
- 'abilityTreeNodes' => [
- 'FEATUREmns4BQTE0',
- 'FEATUREmnsNGE8ZG',
- 'FEATUREmnsOJMS9M',
- 'FEATUREmnsIGJWNT',
- 'FEATUREmnsUVY5DY',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'TopicName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Subscription订阅的主题名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MyTopic',
- ],
- ],
- [
- 'name' => 'SubscriptionName',
+ 'name' => 'QueueType',
'in' => 'query',
- 'schema' => [
- 'description' => 'Subscription的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MySubscription',
- ],
+ 'schema' => ['description' => '队列类型。可取值如下:'."\n"
+ .' * normal: 普通队列'."\n"
+ .' * fifo: FIFO队列', 'type' => 'string', 'required' => false, 'example' => 'normal'],
],
],
'responses' => [
@@ -2651,249 +1886,119 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'SubscriptionName' => [
- 'description' => 'Subscription的名称。',
- 'type' => 'string',
- 'example' => 'MySubscription',
- ],
- 'TopicOwner' => [
- 'description' => 'Subscription订阅的主题所有者的AccountId。',
- 'type' => 'string',
- 'example' => '123456789098****',
- ],
- 'TopicName' => [
- 'description' => 'Subscription订阅的主题名称。',
- 'type' => 'string',
- 'example' => 'MyTopic',
- ],
- 'Endpoint' => [
- 'description' => '订阅的终端地址。',
- 'type' => 'string',
- 'example' => 'http://example.com',
- ],
- 'FilterTag' => [
- 'description' => '描述了该订阅中消息过滤的标签(仅标签一致的消息才会被推送)。',
- 'type' => 'string',
- 'example' => 'important',
- ],
- 'CreateTime' => [
- 'description' => 'Subscription的创建时间,从1970-01-01 00:00:00到现在的。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554806',
- ],
- 'LastModifyTime' => [
- 'description' => '最近一次修改Subscription属性信息的时间,从1970-01-01 00:00:00到现在的秒值。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554962',
- ],
- 'NotifyStrategy' => [
- 'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
- ."\n"
- .'- BACKOFF_RETRY:退避重试。'."\n"
- ."\n"
- .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。',
- 'type' => 'string',
- 'example' => 'BACKOFF_RETRY',
- ],
- 'NotifyContentFormat' => [
- 'description' => '向Endpoint推送的消息内容格式。'."\n"
- .'取值说明如下:'."\n"
- ."\n"
- .'- XML'."\n"
- ."\n"
- .'- JSON'."\n"
- ."\n"
- .'- SIMPLIFIED',
- 'type' => 'string',
- 'example' => 'XML',
- ],
- 'DlqPolicy' => [
- 'description' => '死信队列策略。',
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列。',
- 'type' => 'string',
- 'example' => 'deadLetterTargetQueue',
- ],
- ],
- ],
- 'TenantRateLimitPolicy' => [
- 'type' => 'object',
- 'properties' => [
- 'Enabled' => [
- 'type' => 'boolean',
- ],
- 'MaxReceivesPerSecond' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'PageNum' => ['description' => '分页页码,查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小,每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'Size' => ['description' => '当前页结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'Pages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'Total' => ['description' => '总结果数。', 'type' => 'integer', 'format' => 'int64', 'example' => '130'],
+ 'PageData' => [
+ 'description' => '当前页返回结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据项。',
+ 'type' => 'object',
+ 'properties' => [
+ 'QueueName' => ['description' => '队列名称。', 'type' => 'string', 'example' => 'demo-queue'],
+ 'CreateTime' => ['description' => 'Queue的创建事件,从1970-01-01 00:00:00到现在的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999'],
+ 'LastModifyTime' => ['description' => '修改Queue属性信息最近时间,从1970-01-01 00:00:00到现在的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999'],
+ 'DelaySeconds' => ['description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
+ 'MaximumMessageSize' => ['description' => '发送到该Queue的消息体的最大长度,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '65536'],
+ 'MessageRetentionPeriod' => ['description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '65536'],
+ 'VisibilityTimeout' => ['description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
+ .'取值范围:1~43200,单位为秒。'."\n"
+ .'默认值:30。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
+ 'PollingWaitSeconds' => ['description' => '当Queue消息量为空时,针对该Queue的ReceiveMessage请求最长的等待时间,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'ActiveMessages' => ['description' => '在该Queue中处于Active状态的消息总数,为近似值。'."\n"
+ .'后续会默认为0,不推荐使用,辛苦用云监控api获取指标', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'InactiveMessages' => ['description' => '在该Queue中处于Inactive状态的消息总数,为近似值。'."\n"
+ .'后续会默认为0,不推荐使用,辛苦用云监控api获取指标。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'DelayMessages' => ['description' => '在该Queue中处于Delayed状态的消息总数,为近似值。'."\n"
+ .'后续会默认为0,不推荐使用,辛苦用云监控api获取指标。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'LoggingEnabled' => ['description' => '是否开启日志管理功能。'."\n"
+ ."\n"
+ .'- True:启用。'."\n"
+ ."\n"
+ .'- False:停用。', 'type' => 'boolean', 'example' => 'True'],
+ 'Tags' => [
+ 'description' => '资源标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签键对应的标签值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => ['description' => '标签的key。', 'type' => 'string', 'example' => 'tag1'],
+ 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'],
+ ],
+ ],
+ ],
+ 'DlqPolicy' => [
+ 'description' => '死信队列策略。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['description' => '是否开启死信消息投递。', 'type' => 'boolean', 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列。', 'type' => 'string', 'example' => 'deadLetterTargetQueue'],
+ 'MaxReceiveCount' => ['description' => '消息最大投递次数。', 'type' => 'string', 'example' => '3'],
+ ],
+ ],
+ 'QueueType' => ['description' => '队列类型。可取值如下:'."\n"
+ .' * normal: 普通队列'."\n"
+ .' * fifo: FIFO队列', 'type' => 'string', 'example' => 'normal'],
+ 'EnableSSE' => ['type' => 'boolean'],
+ 'SseType' => ['type' => 'string'],
+ 'SseAlgorithm' => ['type' => 'string'],
+ 'KmsKeyId' => ['type' => 'string'],
+ 'EncryptionEnabled' => ['type' => 'boolean'],
],
],
],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554962,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\"\\n },\\n \\"TenantRateLimitPolicy\\": {\\n \\"Enabled\\": true,\\n \\"MaxReceivesPerSecond\\": 0\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取Subscription的属性',
- ],
- 'Unsubscribe' => [
- 'summary' => '调用Unsubscribe接口取消一个已创建的Subscription。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '121398',
- 'abilityTreeNodes' => [
- 'FEATUREmnsSAU1G7',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'TopicName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Topic的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'SubscriptionName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Subscription的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MySubscription',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'title' => '列出指定阿里云账号下的所有队列',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-08T03:11:41.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-05-27T08:39:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-01-22T08:20:46.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-01-22T08:20:46.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQueue'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListQueue',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
- 'title' => '取消已创建的Subscription',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"QueueName\\": \\"demo-queue\\",\\n \\"CreateTime\\": 1250700999,\\n \\"LastModifyTime\\": 1250700999,\\n \\"DelaySeconds\\": 30,\\n \\"MaximumMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 65536,\\n \\"VisibilityTimeout\\": 60,\\n \\"PollingWaitSeconds\\": 0,\\n \\"ActiveMessages\\": 0,\\n \\"InactiveMessages\\": 0,\\n \\"DelayMessages\\": 0,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\",\\n \\"MaxReceiveCount\\": \\"3\\"\\n },\\n \\"QueueType\\": \\"normal\\",\\n \\"EnableSSE\\": true,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListSubscriptionByTopic' => [
'summary' => '调用ListSubscriptionByTopic接口列出某个主题下的Subscription列表,可分页获取数据。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2906,76 +2011,42 @@
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121399',
- 'abilityTreeNodes' => [
- 'FEATUREmns4BQTE0',
- 'FEATUREmnsNGE8ZG',
- 'FEATUREmnsOJMS9M',
- 'FEATUREmnsIGJWNT',
- 'FEATUREmnsUVY5DY',
- ],
+ 'abilityTreeNodes' => ['FEATUREmns4BQTE0', 'FEATUREmnsNGE8ZG', 'FEATUREmnsOJMS9M', 'FEATUREmnsIGJWNT', 'FEATUREmnsUVY5DY'],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '主题的名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => '分页页码,查询第几页的返回结果。'."\n"
- .'取值范围:1~100000000。'."\n"
- .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000000,则系统默认按照参数值为100000000处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '分页页码,查询第几页的返回结果。'."\n"
+ .'取值范围:1~100000000。'."\n"
+ .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000000,则系统默认按照参数值为100000000处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。'."\n"
- .'取值范围:10~50。'."\n"
- .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '分页大小,每页最多显示的返回结果数量。'."\n"
+ .'取值范围:10~50。'."\n"
+ .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
- 'schema' => [
- 'description' => 'Subscription的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-subscription',
- ],
+ 'schema' => ['description' => 'Subscription的名称。', 'type' => 'string', 'required' => false, 'example' => 'demo-subscription'],
],
[
'name' => 'EndpointType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'EndpointValue',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
@@ -2983,66 +2054,20 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'PageNum' => [
- 'description' => '分页页码,查询此页的返回结果。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'Size' => [
- 'description' => '当前页结果数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'Pages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Total' => [
- 'description' => '总结果数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '130',
- ],
+ 'PageNum' => ['description' => '分页页码,查询此页的返回结果。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小,每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'Size' => ['description' => '当前页结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'Pages' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'Total' => ['description' => '总结果数。', 'type' => 'integer', 'format' => 'int64', 'example' => '130'],
'PageData' => [
'description' => '当前页返回结果。',
'type' => 'array',
@@ -3050,78 +2075,32 @@
'description' => '数据项',
'type' => 'object',
'properties' => [
- 'SubscriptionName' => [
- 'description' => 'Subscription的名称。',
- 'type' => 'string',
- 'example' => 'MySubscription',
- ],
- 'TopicOwner' => [
- 'description' => 'Subscription订阅的主题所有者的AccountId。',
- 'type' => 'string',
- 'example' => '123456789098****',
- ],
- 'TopicName' => [
- 'description' => 'Subscription订阅的主题名称。',
- 'type' => 'string',
- 'example' => 'MyTopic',
- ],
- 'Endpoint' => [
- 'description' => '订阅的终端地址。',
- 'type' => 'string',
- 'example' => 'http://example.com',
- ],
- 'FilterTag' => [
- 'description' => '描述了该订阅中消息过滤的标签(仅标签一致的消息才会被推送)。',
- 'type' => 'string',
- 'example' => 'important'."\n",
- ],
- 'CreateTime' => [
- 'description' => 'Subscription的创建时间,从1970-01-01 00:00:00到现在的。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554806'."\n",
- ],
- 'LastModifyTime' => [
- 'description' => '最近一次修改Subscription属性信息的时间,从1970-01-01 00:00:00到现在的秒值。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1449554806'."\n",
- ],
- 'NotifyStrategy' => [
- 'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
- ."\n"
- .'- BACKOFF_RETRY:退避重试。'."\n"
- ."\n"
- .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。',
- 'type' => 'string',
- 'example' => 'BACKOFF_RETRY',
- ],
- 'NotifyContentFormat' => [
- 'description' => '向Endpoint推送的消息内容格式。'."\n"
- .'取值说明如下:'."\n"
- ."\n"
- .'- XML'."\n"
- ."\n"
- .'- JSON'."\n"
- ."\n"
- .'- SIMPLIFIED',
- 'type' => 'string',
- 'example' => 'XML',
- ],
+ 'SubscriptionName' => ['description' => 'Subscription的名称。', 'type' => 'string', 'example' => 'MySubscription'],
+ 'TopicOwner' => ['description' => 'Subscription订阅的主题所有者的AccountId。', 'type' => 'string', 'example' => '123456789098****'],
+ 'TopicName' => ['description' => 'Subscription订阅的主题名称。', 'type' => 'string', 'example' => 'MyTopic'],
+ 'Endpoint' => ['description' => '订阅的终端地址。', 'type' => 'string', 'example' => 'http://example.com'],
+ 'FilterTag' => ['description' => '描述了该订阅中消息过滤的标签(仅标签一致的消息才会被推送)。', 'type' => 'string', 'example' => 'important'."\n"],
+ 'CreateTime' => ['description' => 'Subscription的创建时间,从1970-01-01 00:00:00到现在的。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806'."\n"],
+ 'LastModifyTime' => ['description' => '最近一次修改Subscription属性信息的时间,从1970-01-01 00:00:00到现在的秒值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806'."\n"],
+ 'NotifyStrategy' => ['description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
+ ."\n"
+ .'- BACKOFF_RETRY:退避重试。'."\n"
+ ."\n"
+ .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。', 'type' => 'string', 'example' => 'BACKOFF_RETRY'],
+ 'NotifyContentFormat' => ['description' => '向Endpoint推送的消息内容格式。'."\n"
+ .'取值说明如下:'."\n"
+ ."\n"
+ .'- XML'."\n"
+ ."\n"
+ .'- JSON'."\n"
+ ."\n"
+ .'- SIMPLIFIED', 'type' => 'string', 'example' => 'XML'],
'DlqPolicy' => [
'description' => '死信策略',
'type' => 'object',
'properties' => [
- 'Enabled' => [
- 'description' => '是否开启死信消息投递',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DeadLetterTargetQueue' => [
- 'description' => '死信消息投递目标队列',
- 'type' => 'string',
- 'example' => 'dead-letter-queue',
- ],
+ 'Enabled' => ['description' => '是否开启死信消息投递', 'type' => 'boolean', 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列', 'type' => 'string', 'example' => 'dead-letter-queue'],
],
],
],
@@ -3130,307 +2109,203 @@
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\\\n\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554806,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"dead-letter-queue\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '列出主题下的Subscription列表',
- ],
- 'DisableEndpoint' => [
- 'summary' => '本接口用于关闭指定类型接入点。关闭后,所有源自对应接入点的请求都将被拦截并返回错误。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '259962',
- 'abilityTreeNodes' => [
- 'FEATUREmns0M5BDJ',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'EndpointType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **public**:表示公网接入点。(目前仅支持public)',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'public' => 'public',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-25T01:27:25.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-07-31T02:10:05.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-06-17T13:56:28.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-05-20T03:03:06.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSubscriptionByTopic'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListSubscriptionByTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions'],
],
- 'example' => 'public',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '关闭接入点',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\\\n\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554806,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"dead-letter-queue\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'EnableEndpoint' => [
- 'summary' => '本接口用于启用指定类型的接入点。开启后,源自对应接入点且处于Acl白名单中的请求都将不会被拦截。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListTopic' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '259960',
- 'abilityTreeNodes' => [
- 'FEATUREmns0M5BDJ',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '121394',
+ 'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
- 'name' => 'EndpointType',
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **public**:表示公网接入点。(目前仅支持public)',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'public' => 'public',
- ],
- 'example' => 'public',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'schema' => ['description' => '分页页码,查询第几页的返回结果。'."\n"
+ .'取值范围:1~100000000。'."\n"
+ .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000000,则系统默认按照参数值为100000000处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '启用接入点',
- 'extraInfo' => '本API目前只在:广州、北京、上海 地域开放,如果有其他地域需求请提工单进行支持',
- ],
- 'GetEndpointAttribute' => [
- 'summary' => 'GetEndpointAttribute',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小,每页最多显示的返回结果数量。'."\n"
+ .'取值范围:10~50。'."\n"
+ .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '259965',
- 'abilityTreeNodes' => [
- 'FEATUREmns0M5BDJ',
+ [
+ 'name' => 'TopicName',
+ 'in' => 'query',
+ 'schema' => ['description' => '主题的名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
- ],
- 'parameters' => [
[
- 'name' => 'EndpointType',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **public**:表示公网接入点。(目前仅支持public)',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'public' => 'public',
+ 'description' => '标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签键对应的标签值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '标签的key。', 'type' => 'string', 'required' => false, 'example' => 'tag1'],
+ 'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ 'required' => false,
],
- 'example' => 'public',
+ 'required' => false,
+ 'maxItems' => 20,
+ 'minItems' => 1,
],
],
+ [
+ 'name' => 'TopicType',
+ 'in' => 'query',
+ 'schema' => ['description' => '主题类型。可取值如下:'."\n"
+ .' * normal: 普通主题'."\n"
+ .' * fifo: FIFO主题', 'type' => 'string', 'required' => false, 'example' => 'normal'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'EndpointEnabled' => [
- 'description' => '接入点是否开启。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CidrList' => [
- 'description' => '网络地址段列表。',
+ 'PageNum' => ['description' => '分页页码,查询第几页的返回结果。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小,每页最多显示的返回结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'Total' => ['description' => '总结果数。', 'type' => 'integer', 'format' => 'int64', 'example' => '130'],
+ 'PageData' => [
+ 'description' => '当前页返回结果。',
'type' => 'array',
'items' => [
- 'description' => '网络地址段。',
+ 'description' => '数据项',
'type' => 'object',
'properties' => [
- 'Cidr' => [
- 'description' => '网络地址段。',
- 'type' => 'string',
- 'example' => '172.18.0.0/24',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1701951224000',
- ],
- 'AclStrategy' => [
- 'description' => 'Acl策略。取值:'."\n"
- ."\n"
- .'- **allow**:表示当前接入点允许对应Cidr访问。(目前仅支持allow)',
- 'type' => 'string',
- 'example' => 'allow',
+ 'TopicName' => ['description' => '主题的名称。', 'type' => 'string', 'example' => 'demo-topic'],
+ 'MessageCount' => ['description' => '当前该主题中消息数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'MaxMessageSize' => ['description' => '发送到该主题的消息体最大长度,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '65536'],
+ 'MessageRetentionPeriod' => ['description' => '消息在主题中最长存活时间,从发送到该主题开始经过此参数指定的时间后,不论消息是否被成功推送给用户都将被删除,单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '86400'],
+ 'CreateTime' => ['description' => 'Subscription的创建时间,从1970-01-01 00:00:00到现在的。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962'],
+ 'LastModifyTime' => ['description' => '最近一次修改Subscription属性信息的时间,从1970-01-01 00:00:00到现在的秒值。', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962'],
+ 'LoggingEnabled' => ['description' => '是否开启日志管理功能。'."\n"
+ ."\n"
+ .'- True:启用。'."\n"
+ ."\n"
+ .'- False:停用。', 'type' => 'boolean', 'example' => 'True'],
+ 'TopicUrl' => ['description' => '消息Topic URL。', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic'],
+ 'TopicInnerUrl' => ['description' => '消息Topic URL(内网访问)。', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic'],
+ 'Tags' => [
+ 'description' => '资源标签列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签键对应的标签值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => ['description' => '标签的key。', 'type' => 'string', 'example' => 'tag1'],
+ 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'],
+ ],
+ ],
],
+ 'TopicType' => ['description' => '主题类型。可取值如下:'."\n"
+ .' * normal: 普通主题'."\n"
+ .' * fifo: FIFO主题', 'type' => 'string', 'example' => 'normal'],
+ 'EnableSSE' => ['type' => 'boolean'],
+ 'SseType' => ['type' => 'string'],
+ 'SseAlgorithm' => ['type' => 'string'],
+ 'KmsKeyId' => ['type' => 'string'],
+ 'EncryptionEnabled' => ['type' => 'boolean'],
],
],
],
],
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '查询阿里云账号下的主题列表',
+ 'summary' => '调用ListTopic接口查询阿里云账号下的主题列表,可分页获取数据。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-08T03:11:41.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-05-27T08:39:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-05-08T09:12:57.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2022-05-20T03:03:06.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '120', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopic'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"EndpointEnabled\\": true,\\n \\"CidrList\\": [\\n {\\n \\"Cidr\\": \\"172.18.0.0/24\\",\\n \\"CreateTime\\": 1701951224000,\\n \\"AclStrategy\\": \\"allow\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取接入点属性',
- 'extraInfo' => '本API目前只在:广州、北京、上海地域开放,如果有其他地域需求请提工单进行支持',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554962,\\n \\"LastModifyTime\\": 1449554962,\\n \\"LoggingEnabled\\": true,\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\",\\n \\"EnableSSE\\": true,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'RevokeEndpointAcl' => [
'summary' => '本接口用于删除指定类型的接入点的一条或多条Acl规则。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3443,9 +2318,7 @@
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '259964',
- 'abilityTreeNodes' => [
- 'FEATUREmns0M5BDJ',
- ],
+ 'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
],
'parameters' => [
[
@@ -3457,9 +2330,7 @@
.'- **public**:表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'public' => 'public',
- ],
+ 'enumValueTitles' => ['public' => 'public'],
'example' => 'public',
],
],
@@ -3472,9 +2343,7 @@
.'- **allow**:表示此次操作的为Cidr白名单。(目前仅支持allow)',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'allow' => 'allow',
- ],
+ 'enumValueTitles' => ['allow' => 'allow'],
'example' => 'allow',
],
],
@@ -3485,12 +2354,7 @@
'schema' => [
'description' => '网络地址段列表。',
'type' => 'array',
- 'items' => [
- 'description' => '网络地址段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.1.1/24',
- ],
+ 'items' => ['description' => '网络地址段。', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1/24'],
'required' => true,
],
],
@@ -3500,166 +2364,215 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除接入点Acl规则',
'extraInfo' => '本API目前只在:广州、北京、上海地域开放,如果有其他地域需求请提工单进行支持',
- ],
- 'AuthorizeEndpointAcl' => [
- 'summary' => '本接口用于新增指定类型的接入点的一条或多条Acl规则。',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-16T02:03:14.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'mns:RevokeEndpointAcl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SetQueueAttributes' => [
+ 'summary' => '调用SetQueueAttributes接口修改队列属性。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
- 'riskType' => 'none',
+ 'riskType' => 'high',
'chargeType' => 'paid',
- 'abilityTreeCode' => '259963',
- 'abilityTreeNodes' => [
- 'FEATUREmns0M5BDJ',
- ],
+ 'abilityTreeCode' => '121386',
+ 'abilityTreeNodes' => ['FEATUREmnsVLH730'],
],
'parameters' => [
[
- 'name' => 'EndpointType',
+ 'name' => 'QueueName',
'in' => 'query',
- 'schema' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **public**:表示公网接入点。(目前仅支持public)',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'public' => 'public',
- ],
- 'example' => 'public',
- ],
+ 'schema' => ['description' => 'Queue名称。', 'type' => 'string', 'required' => true, 'example' => 'testqueue'],
],
[
- 'name' => 'AclStrategy',
+ 'name' => 'DelaySeconds',
+ 'in' => 'query',
+ 'schema' => ['description' => '发送到该Queue的所有消息的延迟时间,发送到队列的消息经过此参数设定的延时时间后,才能被消费。'."\n"
+ .'取值范围:0~604800,单位为秒。'."\n"
+ .'默认值:0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'MaximumMessageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '发送到该Queue的消息体的最大长度。'."\n"
+ .'取值范围:1024~65536,单位为Byte。'."\n"
+ .'默认值:65536。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024'],
+ ],
+ [
+ 'name' => 'MessageRetentionPeriod',
+ 'in' => 'query',
+ 'schema' => ['description' => '消息在该Queue中最长的存活时间,从发送到该队列开始经过此参数指定的时间后,不论消息是否被取出过都将被删除。'."\n"
+ .'取值范围:60~604800,单位为秒。'."\n"
+ .'默认值:345600。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '120'],
+ ],
+ [
+ 'name' => 'VisibilityTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
+ .'取值范围:1~43200,单位为秒。'."\n"
+ .'默认值:30。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'],
+ ],
+ [
+ 'name' => 'PollingWaitSeconds',
'in' => 'query',
+ 'schema' => ['description' => '当Queue中没有消息时,针对该Queue的ReceiveMessage请求最长的等待时间。'."\n"
+ .'取值范围:0~30,单位为秒。'."\n"
+ .'默认值:0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'EnableLogging',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启日志管理功能。取值说明如下:'."\n"
+ ."\n"
+ .'- true:启用。'."\n"
+ ."\n"
+ .'- false:停用。'."\n"
+ .'默认值:false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'DlqPolicy',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Acl策略。取值:'."\n"
- ."\n"
- .'- **allow**:表示此次操作的为Cidr白名单。(目前仅支持allow)',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'allow' => 'allow',
+ 'description' => '死信队列策略。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['description' => '是否开启死信消息投递。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列。', 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue'],
+ 'MaxReceiveCount' => ['description' => '消息最大投递次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
- 'example' => 'allow',
+ 'required' => false,
],
],
[
- 'name' => 'CidrList',
+ 'name' => 'TenantRateLimitPolicy',
'in' => 'query',
- 'style' => 'simple',
+ 'style' => 'json',
'schema' => [
- 'description' => '网络地址段列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '网络地址段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.1.1/24',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['type' => 'boolean', 'required' => false, 'description' => ''],
+ 'MaxReceivesPerSecond' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
],
- 'required' => true,
+ 'required' => false,
+ 'description' => '',
],
],
+ [
+ 'name' => 'EnableSSE',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'required' => false],
+ ],
+ [
+ 'name' => 'SseType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'SseAlgorithm',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'KmsKeyId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '响应数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '修改队列属性',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-10T15:56:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-20T03:03:34.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '增加接入点Acl规则',
- 'extraInfo' => '本API目前只在:广州、北京、上海地域开放,如果有其他地域需求请提工单进行支持',
- ],
- 'GetEventRule' => [
- 'summary' => '获取事件通知规则。',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetQueueAttributes'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:SetQueueAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'SetSubscriptionAttributes' => [
+ 'summary' => '调用SetSubscriptionAttributes接口修改Subscription的属性。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3668,170 +2581,118 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '273196',
- 'abilityTreeNodes' => [
- 'FEATUREmnsT1OLHP',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '121401',
+ 'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
- 'name' => 'ProductName',
+ 'name' => 'TopicName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Topic的名称。', 'type' => 'string', 'required' => true, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'SubscriptionName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Subscription的名称。', 'type' => 'string', 'required' => true, 'example' => 'MySubscription'],
+ ],
+ [
+ 'name' => 'NotifyStrategy',
+ 'in' => 'query',
+ 'schema' => ['description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
+ ."\n"
+ .'- BACKOFF_RETRY:退避重试。'."\n"
+ ."\n"
+ .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。', 'type' => 'string', 'required' => false, 'example' => 'BACKOFF_RETRY'],
+ ],
+ [
+ 'name' => 'DlqPolicy',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '事件通知云产品名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss',
+ 'description' => '死信队列策略。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['description' => '是否开启死信消息投递。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列。', 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue'],
+ ],
+ 'required' => false,
],
],
[
- 'name' => 'RuleName',
+ 'name' => 'TenantRateLimitPolicy',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '事件通知规则名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rule-xsXDW',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['type' => 'boolean', 'required' => false, 'description' => ''],
+ 'MaxReceivesPerSecond' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
],
],
+ [
+ 'name' => 'StsRoleArn',
+ 'in' => 'query',
+ 'schema' => ['title' => 'STS角色ARN', 'type' => 'string', 'example' => 'acs:ram::1234567890:role/roleName'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '查询结果。',
+ 'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'RuleName' => [
- 'description' => '事件通知规则名称。',
- 'type' => 'string',
- 'example' => 'event-recorder',
- ],
- 'EventTypes' => [
- 'description' => '事件类型列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '查询到的事件类型的全名。',
- 'type' => 'string',
- 'example' => '["oss:ObjectModified:UpdateObjectMeta"]',
- ],
- ],
- 'MatchRules' => [
- 'title' => '事件匹配规则,or 关系',
- 'description' => '事件匹配规则,or 关系',
- 'type' => 'array',
- 'items' => [
- 'description' => '事件匹配规则,or 关系',
- 'type' => 'array',
- 'items' => [
- 'description' => '事件匹配规则,or 关系',
- '$ref' => '#/components/schemas/EventMatchRule',
- ],
- ],
- ],
- 'Subscriptions' => [
- 'description' => '订阅终端',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EndpointType' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **queue**: 队列类型。'."\n"
- .'- **topic**: 主题类型。',
- 'type' => 'string',
- 'example' => 'queue',
- ],
- 'EndpointValue' => [
- 'description' => '接收终端实际值',
- 'type' => 'string',
- 'example' => 'retry-queue',
- ],
- ],
- ],
- ],
- 'TopicName' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'example' => 'demo-topic',
- ],
- 'Endpoint' => [
- 'description' => '订阅的终端地址。',
- 'type' => 'object',
- 'properties' => [
- 'EndpointType' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **queue**: 队列类型。'."\n"
- .'- **topic**: 主题类型。',
- 'type' => 'string',
- 'example' => 'queue',
- ],
- 'EndpointValue' => [
- 'description' => '接收终端实际值',
- 'type' => 'string',
- 'example' => 'retry-queue',
- ],
- ],
- ],
- 'DeliveryMode' => [
- 'description' => '已废弃字段',
- 'type' => 'string',
- 'example' => '--',
- ],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '修改Subscription的属性',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-10T15:56:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleName\\": \\"event-recorder\\",\\n \\"EventTypes\\": [\\n \\"[\\\\\\"oss:ObjectModified:UpdateObjectMeta\\\\\\"]\\"\\n ],\\n \\"MatchRules\\": [\\n [\\n {\\n \\"MatchState\\": true,\\n \\"Name\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"Suffix\\": \\"\\"\\n }\\n ]\\n ],\\n \\"Subscriptions\\": [\\n {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"retry-queue\\"\\n }\\n ],\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"Endpoint\\": {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"retry-queue\\"\\n },\\n \\"DeliveryMode\\": \\"--\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取事件通知规则',
- ],
- 'ListEventRules' => [
- 'summary' => '查询事件通知列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetSubscriptionAttributes'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:SetSubscriptionAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'SetTopicAttributes' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3840,131 +2701,54 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '272940',
- 'abilityTreeNodes' => [
- 'FEATUREmnsT1OLHP',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '121396',
+ 'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
- 'name' => 'ProductName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '事件通知云产品名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss',
- ],
- ],
- [
- 'name' => 'ResourceName',
+ 'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'title' => '匹配规则中的资源名称,用于过滤规则,例:oss 中,此为 oss bucketName',
- 'description' => '匹配规则中的资源名称,用于过滤规则,例:oss 中,此为 oss bucketName',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-bucket',
- ],
+ 'schema' => ['description' => 'Topic的名称。', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
[
- 'name' => 'RuleName',
+ 'name' => 'EnableLogging',
'in' => 'query',
- 'schema' => [
- 'title' => '规则名称',
- 'description' => '规则名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rule-xsXDW',
- ],
+ 'schema' => ['description' => '是否开启日志管理功能。取值说明如下:'."\n"
+ ."\n"
+ .'- true:启用。'."\n"
+ ."\n"
+ .'- false:停用。'."\n"
+ .'默认值:false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'TopicName',
+ 'name' => 'MaxMessageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '',
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-topic',
- ],
+ 'schema' => ['description' => '发送到该主题的消息体最大长度。'."\n"
+ .'取值范围:1024~ 65536,单位为Byte。'."\n"
+ .'默认值:65536。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65536'],
],
[
- 'name' => 'Subscription',
+ 'name' => 'EnableSSE',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '订阅端',
- 'type' => 'object',
- 'properties' => [
- 'EndpointType' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **topic**: 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
- .'- **queue**: 队列类型。直接投递到队列。可以减少链路路径,但后续不可增加新的订阅接收端。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'topic',
- ],
- 'EndpointValue' => [
- 'description' => '接收终端实际值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-topic',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'boolean', 'required' => false],
],
[
- 'name' => 'PageNum',
+ 'name' => 'SseType',
'in' => 'query',
- 'schema' => [
- 'description' => '分页页码,查询第几页的返回结果。'."\n"
- .'取值范围:1~100000。'."\n"
- .'若您设置的参数值小于1,则系统默认按照参数值为1处理;若您设置的参数值大于100000,则系统默认按照参数值为100000处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SseAlgorithm',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。'."\n"
- .'取值范围:10~50。'."\n"
- .'若您设置的参数值小于10,则系统默认按照参数值为10处理;若您设置的参数值大于50,则系统默认按照参数值为50处理。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'NextToken',
+ 'name' => 'KmsKeyId',
'in' => 'query',
- 'schema' => [
- 'description' => '已废弃字段。请使用 PageNum 分页查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cd7NlPlX4kgKCdsCWMiMR/+HnVzPLQ4/XLvjR64jZ7F9AQ+Mr3T59J6IVkuXeV3w',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '已废弃字段。请使用 PageSize 分页查询',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -3972,180 +2756,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求的ID。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123E62C',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
- 'PageNum' => [
- 'description' => '分页页码,查询第几页的返回结果。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小,每页最多显示的返回结果数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'Size' => [
- 'description' => '当前页结果数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'Pages' => [
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Total' => [
- 'description' => '总结果数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '130',
- ],
- 'NextToken' => [
- 'description' => '已废弃字段。分页查询以PageNum为准',
- 'type' => 'string',
- 'example' => 'a88f58d504b8b4c4e0b5e8707e68181f',
- ],
- 'MaxResults' => [
- 'description' => '已废弃字段。分页最大结果集以 Total 为准',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageData' => [
- 'description' => '数据项',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据项。',
- 'type' => 'object',
- 'properties' => [
- 'RuleName' => [
- 'description' => '事件通知规则名称。',
- 'type' => 'string',
- 'example' => 'rule-xsXDW',
- ],
- 'Subscriptions' => [
- 'description' => '订阅端。限制最大返回条数 20,如果超过请使用 [订阅列表](~~2804757~~) 查询。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EndpointType' => [
- 'description' => '接入点类型。',
- 'type' => 'string',
- 'example' => 'queue',
- ],
- 'EndpointValue' => [
- 'description' => '接收终端实际值',
- 'type' => 'string',
- 'example' => 'wyx-vp-complete-queue',
- ],
- ],
- ],
- ],
- 'TopicName' => [
- 'description' => '主题的名称。',
- 'type' => 'string',
- 'example' => 'demo-topic',
- ],
- 'MatchRules' => [
- 'title' => '事件匹配规则,or 关系',
- 'description' => '事件匹配规则,or 关系',
- 'type' => 'array',
- 'items' => [
- 'description' => '事件匹配规则,or 关系',
- 'type' => 'array',
- 'items' => [
- 'description' => '匹配规则,多个规则之间 or 关系',
- 'example' => '[[{\\"MatchState\\":true,\\"Prefix\\":\\"cdhxdev1cdh-bba-dto-052901-sem-5seh/\\",\\"Suffix\\":\\"\\"}]]',
- '$ref' => '#/components/schemas/EventMatchRule',
- ],
- ],
- ],
- 'EventTypes' => [
- 'description' => '事件类型列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '事件类型列表',
- 'type' => 'string',
- 'example' => '["oss:ObjectCreated:CopyObject"]',
- ],
- ],
- 'Endpoint' => [
- 'description' => '订阅的终端地址。',
- 'type' => 'object',
- 'properties' => [
- 'EndpointType' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **topic**: 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
- .'- **queue**: 队列类型。直接投递到队列。可以减少链路路径,但后续不可增加新的订阅接收端。',
- 'type' => 'string',
- 'example' => 'topic',
- ],
- 'EndpointValue' => [
- 'description' => '接收终端实际值',
- 'type' => 'string',
- 'example' => 'test-topic',
- ],
- ],
- ],
- 'DeliveryMode' => [
- 'description' => '已废弃字段',
- 'type' => 'string',
- 'example' => '--',
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"NextToken\\": \\"a88f58d504b8b4c4e0b5e8707e68181f\\",\\n \\"MaxResults\\": 1,\\n \\"PageData\\": [\\n {\\n \\"RuleName\\": \\"rule-xsXDW\\",\\n \\"Subscriptions\\": [\\n {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"wyx-vp-complete-queue\\"\\n }\\n ],\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MatchRules\\": [\\n [\\n {\\n \\"MatchState\\": true,\\n \\"Name\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"Suffix\\": \\"\\"\\n }\\n ]\\n ],\\n \\"EventTypes\\": [\\n \\"[\\\\\\"oss:ObjectCreated:CopyObject\\\\\\"]\\"\\n ],\\n \\"Endpoint\\": {\\n \\"EndpointType\\": \\"topic\\",\\n \\"EndpointValue\\": \\"test-topic\\"\\n },\\n \\"DeliveryMode\\": \\"--\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取事件规则列表',
- ],
- 'CreateEventRule' => [
- 'summary' => '用于创建事件规则。',
- 'methods' => [
- 'post',
+ 'title' => '修改主题的属性',
+ 'summary' => '调用SetTopicAttributes接口来修改主题的属性。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-20T03:03:06.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetTopicAttributes'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:SetTopicAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
+ ],
+ 'Subscribe' => [
+ 'summary' => '调用Subscribe接口,为主题创建Subscription。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4154,163 +2814,170 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '259705',
- 'abilityTreeNodes' => [
- 'FEATUREmns94MK6H',
- 'FEATUREmnsT1OLHP',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '121397',
+ 'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
- 'name' => 'ProductName',
+ 'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => '事件通知云产品名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss',
- ],
+ 'schema' => ['description' => '主题的名称。', 'type' => 'string', 'required' => true, 'example' => 'topic****1'],
],
[
- 'name' => 'RuleName',
+ 'name' => 'SubscriptionName',
'in' => 'query',
- 'schema' => [
- 'description' => '事件通知规则名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rule-xsXDW',
- ],
+ 'schema' => ['description' => '订阅名称。', 'type' => 'string', 'required' => true, 'example' => 'testSubscription '],
],
[
- 'name' => 'EventTypes',
+ 'name' => 'PushType',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '事件类型列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ObjectCreated:PutObject',
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '推送类型', 'description' => '## 订阅的推送类型'."\n"
+ ."\n"
+ .'取值:'."\n"
+ ."\n"
+ .'- `http`:HTTP/HTTPS 推送,将消息推送到指定的 HTTP 或 HTTPS 回调地址。'."\n"
+ .'- `queue`:队列推送,将消息推送到指定的 SMQ 队列。'."\n"
+ .'- `dm`:邮箱推送,通过邮件服务(DirectMail)发送通知。需同时设置 `DmAttributes` 和 `StsRoleArn` 参数。'."\n"
+ .'- `dysms`:短信推送,通过阿里云短信服务发送通知。需同时设置 `DysmsAttributes` 参数。'."\n"
+ ."\n"
+ .'- `fc`:函数计算推送,将消息推送到阿里云函数计算(FC)。'."\n"
+ .'- `eventbus`:事件总线推送,将消息推送到 EventBridge 事件总线。'."\n"
+ ."\n"
+ .'**说明:**'."\n"
+ .'以下值已废弃,仅用于兼容旧订阅:'."\n"
+ ."\n"
+ .'- `mpush`:移动推送'."\n"
+ .'- `alisms`:旧版短信'."\n"
+ .'- `email`:旧版邮箱,请使用 `dm`'."\n"
+ .'- `kafka`:Kafka 推送类型已废弃。', 'type' => 'string', 'required' => true, 'example' => 'queue'],
],
[
- 'name' => 'MatchRules',
+ 'name' => 'Endpoint',
+ 'in' => 'query',
+ 'schema' => ['title' => '推送目标地址', 'description' => '## 接收消息的终端地址'."\n"
+ ."\n"
+ .'格式根据 `PushType` 不同而不同:'."\n"
+ ."\n"
+ .'- `PushType=http`:HTTP/HTTPS 回调 URL,如 `http://example.com/callback` 或 `https://example.com/callback`。'."\n"
+ .'- `PushType=queue`:目标队列 ARN,格式为 `acs:mns:{RegionId}:{主账号UID}:queues/{QueueName}`。'."\n"
+ .'- `PushType=dm`:邮箱推送终端,格式固定为 `smq-ep:dm:{主账号UID}:__dynamic`,其中 `{主账号UID}` 替换为您的阿里云主账号 UID。'."\n"
+ .'- `PushType=dysms`:短信推送终端,格式为 `smq-ep:dysms:{主账号UID}:{手机号码}`。'."\n"
+ .'- `PushType=kafka`:Kafka 推送终端,Kafka 推送类型已废弃。'."\n"
+ .'- `PushType=fc`:函数计算终端,格式为 `acs:fc:{RegionId}:{主账号UID}:services/{ServiceName}/functions/{FunctionName}`。'."\n"
+ .'- `PushType=eventbus`:事件总线终端,格式为 `acs:eventbridge:{RegionId}:{主账号UID}:eventbus/{EventBusName}`。', 'type' => 'string', 'required' => true, 'example' => 'http://*****.com/uri1/xxx'],
+ ],
+ [
+ 'name' => 'NotifyStrategy',
+ 'in' => 'query',
+ 'schema' => ['title' => '重试策略', 'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下:'."\n"
+ ."\n"
+ .'- BACKOFF_RETRY:退避重试。'."\n"
+ ."\n"
+ .'- EXPONENTIAL_DECAY_RETRY:指数衰减重试。', 'type' => 'string', 'required' => false, 'example' => 'BACKOFF_RETRY'],
+ ],
+ [
+ 'name' => 'NotifyContentFormat',
+ 'in' => 'query',
+ 'schema' => ['title' => '推送内容格式', 'description' => '## 推送的消息内容格式'."\n"
+ ."\n"
+ .'取值:'."\n"
+ ."\n"
+ .'- `XML`:消息体以 XML 格式推送(默认)。'."\n"
+ .'- `JSON`:消息体以 JSON 格式推送。'."\n"
+ .'- `SIMPLIFIED`:仅推送消息体原始内容,不包含 SMQ 的元信息包装。', 'type' => 'string', 'required' => false, 'example' => 'XML'],
+ ],
+ [
+ 'name' => 'MessageTag',
+ 'in' => 'query',
+ 'schema' => ['title' => '消息过滤标签', 'description' => '该订阅中消息过滤的标签(标签一致的消息才会被推送)。'."\n"
+ .'取值范围:不超过16个字符的字符串。'."\n"
+ ."\n"
+ .'默认不进行消息过滤。', 'type' => 'string', 'required' => false, 'example' => 'important'],
+ ],
+ [
+ 'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '匹配规则,多个规则之间 or 关系',
- 'type' => 'array',
- 'items' => [
- 'description' => '子项列表,多个规则 and 关系',
- 'type' => 'array',
- 'items' => [
- 'description' => '事件原子匹配规则对象',
- 'required' => false,
- '$ref' => '#/components/schemas/EventMatchRule',
- ],
- 'required' => false,
- 'maxItems' => 6,
+ 'description' => '死信队列策略。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['description' => '是否开启死信消息投递。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'DeadLetterTargetQueue' => ['description' => '死信消息投递目标队列。', 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue'],
],
- 'required' => true,
- 'maxItems' => 10,
+ 'required' => false,
],
],
[
- 'name' => 'Endpoints',
+ 'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '已废弃字段。请使用 Endpoint',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EndpointType' => [
- 'description' => '已废弃。请使用Endpoint.EndpointType',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'http' => 'http',
- 'topic' => 'topic',
- 'queue' => 'queue',
- ],
- 'example' => 'http',
- ],
- 'EndpointValue' => [
- 'description' => '已废弃。请使用Endpoint.EndpointValue',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-xxx-queue',
- ],
- ],
- 'required' => false,
+ 'description' => '限流策略',
+ 'type' => 'object',
+ 'properties' => [
+ 'Enabled' => ['description' => '是否启用限流策略,true 启用,false 关闭', 'type' => 'boolean', 'required' => false],
+ 'MaxReceivesPerSecond' => ['description' => '每秒最大推送/消费次数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
'required' => false,
- 'maxItems' => 10,
],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'StsRoleArn',
'in' => 'query',
+ 'schema' => ['title' => 'STS角色ARN', 'description' => '服务扮演的 RAM 角色 ARN。格式为 acs:ram::{主账号UID}:role/{RoleName},其中 {主账号UID} 必须替换为调用 OpenAPI 的阿里云主账号 UID。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1234567890:role/AliyunMNSNotificationRole'],
+ ],
+ [
+ 'name' => 'DmAttributes',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '客户端Token,用于保证请求的幂等性。'."\n"
+ 'title' => '邮箱推送属性',
+ 'description' => '邮箱推送相关属性,当 PushType=dm 时必填。JSON 格式,包含以下字段:'."\n"
."\n"
- .'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。',
- 'type' => 'string',
+ .'- AccountName:发信地址,即 DirectMail 中配置的发信地址(如 notify@example.com)。'."\n"
+ .'- Subject:邮件主题。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountName' => ['description' => '发信地址', 'type' => 'string', 'required' => false, 'example' => 'notify@example.com'],
+ 'Subject' => ['description' => '邮件主题', 'type' => 'string', 'required' => false, 'example' => 'notify'],
+ ],
'required' => false,
- 'example' => '06273500-249F-5863-121D-74D51123****'."\n",
],
],
[
- 'name' => 'Endpoint',
+ 'name' => 'DysmsAttributes',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '此次订阅中接收消息的终端地址。',
+ 'title' => '短信推送属性',
+ 'description' => '短信推送相关属性,当 PushType=alisms 时必填。JSON 格式,包含以下字段:'."\n"
+ ."\n"
+ .'- TemplateCode:短信模板 Code,在短信服务控制台中获取。'."\n"
+ .'- SignName:短信签名名称。',
'type' => 'object',
'properties' => [
- 'EndpointType' => [
- 'description' => '接入点类型。取值:'."\n"
- ."\n"
- .'- **topic**: 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
- .'- **queue**: 队列类型。直接投递到队列。可以减少链路路径,但后续不可增加新的订阅接收端。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'topic',
- ],
- 'EndpointValue' => [
- 'description' => '接收终端实际值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-topic',
- ],
+ 'TemplateCode' => ['description' => '短信模板 Code', 'type' => 'string', 'required' => false, 'example' => '123456'],
+ 'SignName' => ['description' => '短信签名名称', 'type' => 'string', 'required' => false, 'example' => '阿里云短信测试专用'],
],
'required' => false,
],
],
[
- 'name' => 'DeliveryMode',
+ 'name' => 'KafkaAttributes',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '',
- 'description' => '已废弃字段',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => '--',
- 'enum' => [
- 'DIRECT',
- 'BROADCAST',
+ 'title' => 'Kafka推送属性',
+ 'description' => 'Kafka 推送类型已废弃',
+ 'type' => 'object',
+ 'properties' => [
+ 'BusinessMode' => ['description' => 'Kafka 推送类型已废弃', 'type' => 'string', 'required' => false, 'example' => 'Default empty string'],
],
+ 'required' => false,
],
],
],
@@ -4319,94 +2986,73 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '响应数据,创建规则成功时,返回创建的规则名称',
- 'type' => 'string',
- 'example' => 'rule-xsXDW',
- ],
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => ['description' => '响应数据。', 'type' => 'string', 'example' => '{\'Code\': 200, \'Success\': True}'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"{\'Code\': 200, \'Success\': True}\\"\\n}","type":"json"}]',
+ 'title' => '为主题创建Subscription',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-10T15:56:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-20T02:23:37.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-08T07:09:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-05-20T03:03:06.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"rule-xsXDW\\"\\n}","type":"json"}]',
- 'title' => '创建事件规则',
- ],
- 'DeleteEventRule' => [
- 'summary' => '用于删除事件规则。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'Subscribe'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:Subscribe',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:PushType'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'Unsubscribe' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '261151',
- 'abilityTreeNodes' => [
- 'FEATUREmns94MK6H',
- 'FEATUREmnsT1OLHP',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '121398',
+ 'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
- 'name' => 'ProductName',
+ 'name' => 'TopicName',
'in' => 'query',
- 'schema' => [
- 'description' => '事件通知云产品名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss',
- ],
+ 'schema' => ['description' => 'Topic的名称。', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
[
- 'name' => 'RuleName',
+ 'name' => 'SubscriptionName',
'in' => 'query',
- 'schema' => [
- 'description' => '事件通知规则名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rule-xsXDW',
- ],
+ 'schema' => ['description' => 'Subscription的名称。', 'type' => 'string', 'required' => true, 'example' => 'MySubscription'],
],
],
'responses' => [
@@ -4414,159 +3060,571 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '06273500-249F-5863-121D-74D51123****',
- ],
- 'Code' => [
- 'description' => '响应code。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Status' => [
- 'description' => '响应的状态。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****'],
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Status' => ['description' => '响应的状态。', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'operation success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '响应数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应code。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '取消已创建的Subscription',
+ 'summary' => '调用Unsubscribe接口取消一个已创建的Subscription。',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-20T03:03:06.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除事件规则',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'Unsubscribe'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:Unsubscribe',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'mns-open.cn-wulanchabu.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-beijing.aliyuncs.com', 'endpoint' => 'mns-open.cn-beijing.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-zhengzhou-jva', 'regionName' => '郑州(联通合营)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'mns-open.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-zhengzhou-jva.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-qingdao.aliyuncs.com', 'endpoint' => 'mns-open.cn-qingdao.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-shanghai.aliyuncs.com', 'endpoint' => 'mns-open.cn-shanghai.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-hongkong.aliyuncs.com', 'endpoint' => 'mns-open.cn-hongkong.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-heyuan', 'regionName' => '华南2(河源)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-heyuan.aliyuncs.com', 'endpoint' => 'mns-open.cn-heyuan.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-heyuan.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'mns-open.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-shenzhen.aliyuncs.com', 'endpoint' => 'mns-open.cn-shenzhen.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-2', 'regionName' => '韩国(首尔)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.ap-northeast-2.aliyuncs.com', 'endpoint' => 'mns-open.ap-northeast-2.aliyuncs.com', 'vpc' => 'mns-open-vpc.ap-northeast-2.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.ap-northeast-1.aliyuncs.com', 'endpoint' => 'mns-open.ap-northeast-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-chengdu.aliyuncs.com', 'endpoint' => 'mns-open.cn-chengdu.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => '华南3(广州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-guangzhou.aliyuncs.com', 'endpoint' => 'mns-open.cn-guangzhou.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.ap-southeast-1.aliyuncs.com', 'endpoint' => 'mns-open.ap-southeast-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.ap-southeast-3.aliyuncs.com', 'endpoint' => 'mns-open.ap-southeast-3.aliyuncs.com', 'vpc' => 'mns-open-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-huhehaote.aliyuncs.com', 'endpoint' => 'mns-open.cn-huhehaote.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.ap-southeast-5.aliyuncs.com', 'endpoint' => 'mns-open.ap-southeast-5.aliyuncs.com', 'vpc' => 'mns-open-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-7', 'regionName' => '泰国(曼谷)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.ap-southeast-7.aliyuncs.com', 'endpoint' => 'mns-open.ap-southeast-7.aliyuncs.com', 'vpc' => 'mns-open-vpc.ap-southeast-7.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'mns-open.cn-hangzhou.aliyuncs.com', 'endpoint' => 'mns-open.cn-hangzhou.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'mns-open.us-east-1.aliyuncs.com', 'endpoint' => 'mns-open.us-east-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'mns-open.eu-west-1.aliyuncs.com', 'endpoint' => 'mns-open.eu-west-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.eu-west-1.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'mns-open.us-west-1.aliyuncs.com', 'endpoint' => 'mns-open.us-west-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'mns-open.eu-central-1.aliyuncs.com', 'endpoint' => 'mns-open.eu-central-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'mns-open.me-east-1.aliyuncs.com', 'endpoint' => 'mns-open.me-east-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.me-east-1.aliyuncs.com'],
+ ['regionId' => 'me-central-1', 'regionName' => '沙特(利雅得)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'mns-open.me-central-1.aliyuncs.com', 'endpoint' => 'mns-open.me-central-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.me-central-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'mns-open.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'mns-open.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-hangzhou-finance.aliyuncs.com'],
+ ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => '河源专属云汽车合规', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'mns-open.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'mns-open.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-heyuan-acdr-1.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'mns-open.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'mns-open.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'mns-open.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'mns-open.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'mns-open-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'FifoNotSupport', 'message' => 'FIFO queue or topic is not supported in this region. If you want to use FIFO queue or topic, please contact us.', 'http_code' => 400, 'description' => '当前区域不支持 FIFO (先进先出) 队列或主题。如需使用,请联系我们。'],
+ ['code' => 'InvalidTime', 'message' => 'Please limit the time gap between StartTime and EndTime into %s hours.', 'http_code' => 400, 'description' => '查询参数的时间范围需要缩小'],
+ ['code' => 'InvalidTime', 'message' => 'Please limit the query time range into %s hours, i.e. EndTime minus StartTime.', 'http_code' => 400, 'description' => '查询接口 DescribeRefreshTasks动态错误码'],
+ ['code' => 'iot.dap.insight.limitedInvoke', 'message' => 'Please check subscribe number and invoke limitation.', 'http_code' => 400, 'description' => '请检查订阅额度限额或调用限额。'],
+ ['code' => 'iot.device.DeviceNumberExceedInstance', 'message' => 'Exceeds instance device number limit', 'http_code' => 400, 'description' => '实例下的设备总数超过最大限制。'],
+ ['code' => 'iot.tsl.ThingModelNotFound', 'message' => 'the thing model not exist.', 'http_code' => 400, 'description' => '物模型模块不存在'],
+ ['code' => 'RamAuthError', 'message' => 'action rejected by RAM.', 'http_code' => 403, 'description' => '操作被 RAM 拒绝。'],
+ ['code' => 'ServiceNotEnable', 'message' => 'Service not enbale.', 'http_code' => 403, 'description' => '用户未开通MNS服务。'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'mns-open.cn-qingdao.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'mns-open.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'mns-open.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'mns-open.cn-huhehaote.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'mns-open.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'mns-open.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'mns-open.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'mns-open.cn-chengdu.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'mns-open.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'mns-open.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'mns-open.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'mns-open.ap-southeast-3.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'mns-open.ap-southeast-5.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'mns-open.us-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'mns-open.us-west-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'Subscribe'],
+ ],
+ 'createdAt' => '2025-05-20T02:23:45.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'mns-open.eu-west-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListSubscriptionByTopic'],
+ ],
+ 'createdAt' => '2025-04-25T01:27:33.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'mns-open.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateQueue'],
+ ],
+ 'createdAt' => '2025-02-24T06:19:42.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'me-east-1',
- 'endpoint' => 'mns-open.me-east-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateQueue'],
+ ['description' => '响应参数发生变更', 'api' => 'GetQueueAttributes'],
+ ['description' => '响应参数发生变更', 'api' => 'GetSubscriptionAttributes'],
+ ['description' => '响应参数发生变更', 'api' => 'ListQueue'],
+ ['description' => '响应参数发生变更', 'api' => 'ListSubscriptionByTopic'],
+ ['description' => '请求参数发生变更', 'api' => 'SetQueueAttributes'],
+ ['description' => '请求参数发生变更', 'api' => 'SetSubscriptionAttributes'],
+ ['description' => '请求参数发生变更', 'api' => 'Subscribe'],
+ ],
+ 'createdAt' => '2025-02-08T07:09:11.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'mns-open.cn-hangzhou-finance.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AuthorizeEndpointAcl'],
+ ['description' => '请求参数发生变更', 'api' => 'DisableEndpoint'],
+ ['description' => '请求参数发生变更', 'api' => 'EnableEndpoint'],
+ ['description' => '请求参数发生变更', 'api' => 'GetEndpointAttribute'],
+ ['description' => '请求参数发生变更', 'api' => 'RevokeEndpointAcl'],
+ ],
+ 'createdAt' => '2025-01-16T02:03:20.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'mns-open.cn-shanghai-finance-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ListSubscriptionByTopic'],
+ ],
+ 'createdAt' => '2024-07-31T02:10:13.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'mns-open.cn-shenzhen-finance-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetSubscriptionAttributes'],
+ ['description' => '响应参数发生变更', 'api' => 'ListSubscriptionByTopic'],
+ ],
+ 'createdAt' => '2024-06-17T13:56:33.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhengzhou-jva',
- 'endpoint' => 'mns-open.cn-zhengzhou-jva.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateQueue'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateTopic'],
+ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'GetQueueAttributes'],
+ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'GetTopicAttributes'],
+ ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'ListQueue'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListTopic'],
+ ],
+ 'createdAt' => '2024-05-27T08:39:11.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-heyuan-acdr-1',
- 'endpoint' => 'mns-open.cn-heyuan-acdr-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'ListTopic'],
+ ],
+ 'createdAt' => '2024-05-08T09:13:02.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'mns-open.cn-wulanchabu.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateQueue'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateTopic'],
+ ['description' => '请求参数发生变更', 'api' => 'GetSubscriptionAttributes'],
+ ['description' => '请求参数发生变更', 'api' => 'ListQueue'],
+ ['description' => '请求参数发生变更', 'api' => 'ListSubscriptionByTopic'],
+ ['description' => '请求参数发生变更', 'api' => 'ListTopic'],
+ ['description' => '请求参数发生变更', 'api' => 'SetQueueAttributes'],
+ ['description' => '请求参数发生变更', 'api' => 'SetTopicAttributes'],
+ ],
+ 'createdAt' => '2022-05-24T03:01:10.000Z',
+ 'description' => '修改部分API参数是否必须填写属性',
],
[
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'mns-open.cn-guangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ListQueue'],
+ ],
+ 'createdAt' => '2022-01-25T02:12:16.000Z',
+ 'description' => 'MNS新增open API ListQueue',
],
- [
- 'regionId' => 'me-central-1',
- 'endpoint' => 'mns-open.me-central-1.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteQueue'],
+ ['threshold' => '120', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQueue'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetQueueAttributes'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteTopic'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetQueueAttributes'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'Subscribe'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateQueue'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTopicAttributes'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSubscriptionAttributes'],
+ ['threshold' => '120', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopic'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTopic'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetTopicAttributes'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListSubscriptionByTopic'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'Unsubscribe'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetSubscriptionAttributes'],
],
- [
- 'regionId' => 'ap-southeast-7',
- 'endpoint' => 'mns-open.ap-southeast-7.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'MessageService',
+ 'productName' => '轻量消息队列(原 MNS)',
+ 'ramCodes' => ['mns'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [
+ [
+ 'name' => 'mns:EnableLogging',
+ 'schema' => [
+ 'type' => 'String',
+ 'description' => '是否启用日志功能',
+ 'enums' => ['true', 'false'],
+ ],
+ ],
+ [
+ 'name' => 'mns:PushType',
+ 'schema' => [
+ 'type' => 'String',
+ 'description' => '订阅类型',
+ 'enums' => ['queue', 'http', 'alisms', 'email', 'mpush'],
+ ],
+ ],
],
- [
- 'regionId' => 'ap-northeast-2',
- 'endpoint' => 'mns-open.ap-northeast-2.aliyuncs.com',
+ 'ramActions' => [
+ [
+ 'apiName' => 'CreateEventRule',
+ 'description' => '创建事件规则',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'mns:PutEventNotifications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetQueueAttributes',
+ 'description' => '修改队列属性',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:SetQueueAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTopicAttributes',
+ 'description' => '获取主题的属性',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetTopicAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTopic',
+ 'description' => '创建主题',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'mns:CreateTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableEndpoint',
+ 'description' => '关闭接入点',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:DisableEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEndpointAttribute',
+ 'description' => '获取接入点属性',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetEndpointAttribute',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEventRule',
+ 'description' => '获取事件通知规则',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetEventRule',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/products/{#ProductName}/rules'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteQueue',
+ 'description' => '删除队列',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'mns:DeleteQueue',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Unsubscribe',
+ 'description' => '取消已创建的Subscription',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:Unsubscribe',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSubscriptionAttributes',
+ 'description' => '获取Subscription的属性',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetSubscriptionAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEventRules',
+ 'description' => '获取事件规则列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListEventRules',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/products/{#ProductName}/rules'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListQueue',
+ 'description' => '列出指定阿里云账号下的所有队列',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListQueue',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableEndpoint',
+ 'description' => '启用接入点',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'mns:EnableEndpoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteEventRule',
+ 'description' => '删除事件规则',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'mns:DeleteEventNotifications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RevokeEndpointAcl',
+ 'description' => '删除接入点Acl规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:RevokeEndpointAcl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AuthorizeEndpointAcl',
+ 'description' => '增加接入点Acl规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:AuthorizeEndpointAcl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTopic',
+ 'description' => '查询阿里云账号下的主题列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteTopic',
+ 'description' => '删除主题',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'mns:DeleteTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Subscribe',
+ 'description' => '为主题创建Subscription',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:Subscribe',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:PushType'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetTopicAttributes',
+ 'description' => '修改主题的属性',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:SetTopicAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SetSubscriptionAttributes',
+ 'description' => '修改Subscription的属性',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'mns:SetSubscriptionAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetQueueAttributes',
+ 'description' => '获取队列属性',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'mns:GetQueueAttributes',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSubscriptionByTopic',
+ 'description' => '列出主题下的Subscription列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'mns:ListSubscriptionByTopic',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateQueue',
+ 'description' => '创建队列',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'mns:CreateQueue',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [
+ ['conditionKey' => 'mns:EnableLogging'],
+ ],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ],
+ ],
+ ],
],
- [
- 'regionId' => 'cn-heyuan',
- 'endpoint' => 'mns-open.cn-heyuan.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:messageservice:{#regionId}:{#accountId}:/products/{#ProductName}/rules'],
+ ['validationType' => 'always', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}'],
+ ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}'],
+ ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/products/{#ProductName}/rules'],
+ ['validationType' => 'always', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}'],
+ ['validationType' => 'always', 'resourceType' => 'Queue', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/queues'],
+ ['validationType' => 'always', 'resourceType' => 'Topic', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics'],
+ ['validationType' => 'always', 'resourceType' => 'Subscription', 'arn' => 'acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions'],
],
],
];