'1.0',
'info' => ['style' => 'RPC', 'product' => 'Mns-open', 'version' => '2022-01-19'],
'directories' => [
[
'children' => ['CreateTopic', 'SetTopicAttributes', 'GetTopicAttributes', 'DeleteTopic', 'ListTopic'],
'type' => 'directory',
'title' => 'Topic management',
],
[
'children' => ['CreateQueue', 'SetQueueAttributes', 'GetQueueAttributes', 'DeleteQueue', 'ListQueue'],
'type' => 'directory',
'title' => 'Queue management',
],
[
'children' => ['Subscribe', 'SetSubscriptionAttributes', 'GetSubscriptionAttributes', 'Unsubscribe', 'ListSubscriptionByTopic'],
'type' => 'directory',
'title' => 'Subscription management',
],
[
'children' => ['DisableEndpoint', 'EnableEndpoint', 'GetEndpointAttribute', 'RevokeEndpointAcl', 'AuthorizeEndpointAcl'],
'type' => 'directory',
'title' => 'Endpoint management',
],
[
'children' => ['GetEventRule', 'ListEventRules', 'CreateEventRule', 'DeleteEventRule'],
'type' => 'directory',
'title' => 'Event notification management',
],
],
'components' => [
'schemas' => [
'EventMatchRule' => [
'title' => '事件匹配规则对象',
'description' => 'The rule for matching an event.'."\n"
."\n"
.'Note:'."\n"
."\n"
.'- Full name match rule: If you specify this parameter, you cannot specify other parameters.'."\n"
."\n"
.'- Prefix and suffix match rules: You can specify a prefix, a suffix, or both. If you specify both, the rule matches both the prefix and the suffix.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'MatchState' => ['title' => '是否匹配', 'description' => 'Specifies whether to match.', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'matchState', 'default' => 'true', 'example' => 'true'],
'Name' => ['title' => '全名', 'description' => 'The full name to match.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'name', 'example' => 'testBucket/folder1/file1'],
'Prefix' => ['title' => '前缀', 'description' => 'The prefix to match.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'prefix', 'example' => 'testBucket/prefix1xxx'],
'Suffix' => ['title' => '后缀', 'description' => 'The suffix to match.', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'suffix', 'example' => 'suffix/xxxx.test'],
],
],
],
],
'apis' => [
'AuthorizeEndpointAcl' => [
'summary' => 'Adds one or more Access Control List (ACL) rules to an endpoint of a specified type.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '259963',
'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
],
'parameters' => [
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => [
'description' => 'The type of the endpoint. Valid value:'."\n"
."\n"
.'- **public**: An internet endpoint. Only public is supported.',
'enumValueTitles' => ['public' => 'public'],
'type' => 'string',
'required' => true,
'example' => 'public',
'title' => '',
],
],
[
'name' => 'AclStrategy',
'in' => 'query',
'schema' => [
'description' => 'The access control list (ACL) policy. Valid value:'."\n"
."\n"
.'- **allow**: A CIDR whitelist. Only allow is supported.',
'enumValueTitles' => ['allow' => 'allow'],
'type' => 'string',
'required' => true,
'example' => 'allow',
'title' => '',
],
],
[
'name' => 'CidrList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => 'A list of CIDR blocks.',
'type' => 'array',
'items' => ['description' => 'A CIDR block.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1/24', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'AuthorizeEndpointAcl',
'extraInfo' => '本API目前只在：广州、北京、上海地域开放，如果有其他地域需求请提工单进行支持',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mns:AuthorizeEndpointAcl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '259705',
'abilityTreeNodes' => ['FEATUREmns94MK6H', 'FEATUREmnsT1OLHP'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProductName',
'in' => 'query',
'schema' => ['description' => 'The name of the Alibaba Cloud product for which you want to receive event notifications.', 'type' => 'string', 'required' => true, 'example' => 'oss', 'title' => ''],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => 'The name of the event rule.', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW', 'title' => ''],
],
[
'name' => 'EventTypes',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'A list of event types.',
'type' => 'array',
'items' => ['description' => 'The event type.', 'type' => 'string', 'required' => false, 'example' => 'ObjectCreated:PutObject', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
[
'name' => 'MatchRules',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'A list of matching rules. The logical relationship between the rules is OR.',
'type' => 'array',
'items' => [
'description' => 'A list of sub-rules. The logical relationship between the sub-rules is AND.',
'type' => 'array',
'items' => ['description' => 'The atomic event matching rule object.', '$ref' => '#/components/schemas/EventMatchRule', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
'maxItems' => 6,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
[
'name' => 'Endpoints',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'This parameter is deprecated. Use Endpoint instead.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndpointType' => [
'description' => 'Deprecated. Use Endpoint.EndpointType instead.',
'enumValueTitles' => ['http' => 'http', 'topic' => 'topic', 'queue' => 'queue'],
'type' => 'string',
'required' => false,
'example' => 'http',
'title' => '',
],
'EndpointValue' => ['description' => 'Deprecated. Use Endpoint.EndpointValue instead.', 'type' => 'string', 'required' => false, 'example' => 'test-xxx-queue', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request.'."\n"
."\n"
.'Generate a unique value for this parameter from your client for each request.', 'type' => 'string', 'required' => false, 'example' => '06273500-249F-5863-121D-74D51123****'."\n", 'title' => ''],
],
[
'name' => 'Endpoint',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'EndpointType' => ['description' => 'The endpoint type. Valid values:'."\n"
."\n"
.'- **topic**: The endpoint is a topic. A topic can deliver messages to multiple subscribers. You can add or remove subscribers later.'."\n"
."\n"
.'- **queue**: The endpoint is a queue. Messages are delivered directly to the queue. This simplifies the delivery path, but you cannot add new subscribers later.', 'type' => 'string', 'required' => false, 'example' => 'topic', 'title' => ''],
'EndpointValue' => ['description' => 'The value of the endpoint.', 'type' => 'string', 'required' => false, 'example' => 'test-topic', 'title' => ''],
],
'description' => 'The endpoint that receives messages for this subscription.',
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'DeliveryMode',
'in' => 'query',
'schema' => [
'description' => 'This parameter is deprecated.',
'enumValueTitles' => [],
'type' => 'string',
'title' => '',
'enum' => ['DIRECT', 'BROADCAST'],
'required' => false,
'example' => '--',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => ['description' => 'The response data. If the rule is created successfully, the name of the rule is returned.', 'type' => 'string', 'example' => 'rule-xsXDW', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateEventRule',
'summary' => 'Creates an event rule.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'mns:PutEventNotifications',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '121383',
'abilityTreeNodes' => ['FEATUREmnsXP7W6E'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QueueName',
'in' => 'query',
'schema' => ['description' => 'The name of the queue.', 'type' => 'string', 'required' => true, 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
],
[
'name' => 'MaximumMessageSize',
'in' => 'query',
'schema' => ['description' => 'The maximum size of a message body that can be sent to the queue. Unit: bytes.'."\n"
."\n"
.'Valid values: 1024 to 65536.'."\n"
."\n"
.'Default value: 65536.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65536', 'title' => ''],
],
[
'name' => 'MessageRetentionPeriod',
'in' => 'query',
'schema' => ['description' => 'The maximum duration for which a message is retained in the queue. After the specified duration elapses from the time the message is sent to the queue, the message is deleted regardless of whether it has been consumed. Unit: seconds.'."\n"
."\n"
.'Valid values: 60 to 604800.'."\n"
."\n"
.'Default value: 345600.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '604800', 'minimum' => '60', 'example' => '345600', 'title' => ''],
],
[
'name' => 'VisibilityTimeout',
'in' => 'query',
'schema' => ['description' => 'The duration for which a consumed message stays in the Inactive state after it is changed from the Active state. Unit: seconds.'."\n"
."\n"
.'Valid values: 1 to 43200.'."\n"
."\n"
.'Default value: 30.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''],
],
[
'name' => 'PollingWaitSeconds',
'in' => 'query',
'schema' => ['description' => 'The maximum wait time for a ReceiveMessage request when the queue is empty. Unit: seconds.'."\n"
."\n"
.'Valid values: 0 to 30.'."\n"
."\n"
.'Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'EnableLogging',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the log management feature. Valid values:'."\n"
."\n"
.'- true: Enabled.'."\n"
."\n"
.'- false: Disabled.'."\n"
."\n"
.'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'DelaySeconds',
'in' => 'query',
'schema' => ['description' => 'The delay period for all messages sent to the queue. A message sent to the queue can be consumed only after the delay period specified by this parameter elapses. Unit: seconds.'."\n"
."\n"
.'Valid values: 0 to 604800.'."\n"
."\n"
.'Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''],
'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The dead-letter policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Specifies whether to enable dead-letter message delivery.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The target queue for dead-letter message delivery.', 'type' => 'string', 'required' => false, 'example' => 'deadLetterQueue', 'title' => ''],
'MaxReceiveCount' => ['description' => 'The maximum number of times a message can be delivered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'QueueType',
'in' => 'query',
'schema' => ['description' => 'The type of the queue. Valid values:'."\n"
.' * normal: standard queue.'."\n"
.' * fifo: FIFO queue.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The rate limiting policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Specifies whether to enable rate limiting. Valid values:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
'MaxReceivesPerSecond' => ['description' => 'The maximum number of receives per second.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'EnableSSE',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseAlgorithm',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'KmsKeyId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a queue',
'summary' => 'Creates a queue.',
'changeSet' => [],
'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' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '121392',
'abilityTreeNodes' => ['FEATUREmns5OVH2T'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'formData',
'schema' => ['description' => 'The name of the topic to create.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'EnableLogging',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to enable the log management feature. Valid values:'."\n"
."\n"
.'- true: Enabled.'."\n"
."\n"
.'- false: Disabled.'."\n"
.'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'MaxMessageSize',
'in' => 'formData',
'schema' => ['description' => 'The maximum length of the message body sent to the topic. Valid values: 1024 to 65536. Unit: bytes. Default value: 65536.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''],
'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'TopicType',
'in' => 'query',
'schema' => ['description' => 'The type of the topic. Valid values:'."\n"
.' * normal: normal topic'."\n"
.' * fifo: FIFO topic', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'name' => 'EnableSSE',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseType',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseAlgorithm',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'KmsKeyId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a topic',
'summary' => 'Calls the CreateTopic operation to create a topic.',
'changeSet' => [],
'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' => 'Deletes an event rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '261151',
'abilityTreeNodes' => ['FEATUREmns94MK6H', 'FEATUREmnsT1OLHP'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProductName',
'in' => 'query',
'schema' => ['description' => 'The name of the cloud service for the event notification.', 'type' => 'string', 'required' => true, 'example' => 'oss', 'title' => ''],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => 'The name of the event rule.', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteEventRule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'mns:DeleteEventNotifications',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREmnsXP7W6E'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QueueName',
'in' => 'query',
'schema' => ['description' => 'The name of the queue.', 'type' => 'string', 'required' => true, 'example' => 'tf-testAccMNSQueue-525478433321945943', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a queue',
'summary' => 'Calls the DeleteQueue operation to delete a created queue.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteQueue'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'mns:DeleteQueue',
'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 \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
],
'DeleteTopic' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121393',
'abilityTreeNodes' => ['FEATUREmns5OVH2T'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic to delete.', 'type' => 'string', 'required' => true, 'example' => 'tf-testAccMNSTopic-112965059402264645', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => ['description' => 'The response data.', 'type' => 'object', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a topic',
'summary' => 'Calls the DeleteTopic operation to delete a topic.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteTopic'],
],
],
'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' => 'This operation disables an endpoint of a specified type, blocking all subsequent requests from the endpoint and returning an error.',
'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' => 'The type of the endpoint. Valid value:'."\n"
."\n"
.'- **public**: The Internet endpoint. Currently, only public is supported.',
'enumValueTitles' => ['public' => 'public'],
'type' => 'string',
'required' => true,
'example' => 'public',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DisableEndpoint',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mns:DisableEndpoint',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => 'This operation enables an endpoint of a specified type. After the endpoint is enabled, requests that originate from the endpoint and are on the Access Control List (ACL) whitelist are not blocked.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '259960',
'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
],
'parameters' => [
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => [
'description' => 'The type of the endpoint. Valid value:'."\n"
."\n"
.'- **public**: The Internet endpoint. Only public is supported.',
'enumValueTitles' => ['public' => 'public'],
'type' => 'string',
'required' => true,
'example' => 'public',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'EnableEndpoint',
'extraInfo' => '本API目前只在：广州、北京、上海 地域开放，如果有其他地域需求请提工单进行支持',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mns:EnableEndpoint',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => 'Queries the attributes of an endpoint.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '259965',
'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
],
'parameters' => [
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => [
'description' => 'The type of the endpoint. Valid value:'."\n"
."\n"
.'- **public**: An endpoint accessible over the Internet. This is the only supported value.',
'enumValueTitles' => ['public' => 'public'],
'type' => 'string',
'required' => true,
'example' => 'public',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'EndpointEnabled' => ['description' => 'Indicates whether the endpoint is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'CidrList' => [
'description' => 'The list of CIDR blocks.',
'type' => 'array',
'items' => [
'description' => 'A CIDR block.',
'type' => 'object',
'properties' => [
'Cidr' => ['description' => 'The CIDR block.', 'type' => 'string', 'example' => '172.18.0.0/24', 'title' => ''],
'CreateTime' => ['description' => 'The time when the CIDR block was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1701951224000', 'title' => ''],
'AclStrategy' => ['description' => 'The access control list (ACL) policy. Valid value:'."\n"
."\n"
.'- **allow**: The endpoint allows access from the specified CIDR block. This is the only supported value.', 'type' => 'string', 'example' => 'allow', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetEndpointAttribute',
'extraInfo' => '本API目前只在：广州、北京、上海地域开放，如果有其他地域需求请提工单进行支持',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mns:GetEndpointAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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"}]',
],
'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' => 'The name of the Alibaba Cloud product that triggers the event notification.', 'type' => 'string', 'required' => true, 'example' => 'oss', 'title' => ''],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => 'The name of the event notification rule.', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique ID generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Data' => [
'description' => 'The query results.',
'type' => 'object',
'properties' => [
'RuleName' => ['description' => 'The name of the event notification rule.', 'type' => 'string', 'example' => 'event-recorder', 'title' => ''],
'EventTypes' => [
'description' => 'A list of event types.',
'type' => 'array',
'items' => ['description' => 'The full name of the event type.', 'type' => 'string', 'example' => '["oss:ObjectModified:UpdateObjectMeta"]', 'title' => ''],
'title' => '',
'example' => '',
],
'MatchRules' => [
'title' => '',
'description' => 'The event matching rules. The rules have an OR relationship.',
'type' => 'array',
'items' => [
'description' => 'The event matching rules. The rules have an OR relationship.',
'type' => 'array',
'items' => ['description' => 'The event matching rules. The rules have an OR relationship.', '$ref' => '#/components/schemas/EventMatchRule', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'example' => '',
],
'Subscriptions' => [
'description' => 'Subscription endpoints.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndpointType' => ['description' => 'The endpoint type. Valid values:'."\n"
."\n"
.'- **queue**: A queue.'."\n"
."\n"
.'- **topic**: A topic.', 'type' => 'string', 'example' => 'queue', 'title' => ''],
'EndpointValue' => ['description' => 'The value of the endpoint.', 'type' => 'string', 'example' => 'retry-queue', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TopicName' => ['description' => 'The name of the topic.', 'type' => 'string', 'example' => 'demo-topic', 'title' => ''],
'Endpoint' => [
'description' => 'The endpoint address.',
'type' => 'object',
'properties' => [
'EndpointType' => ['description' => 'The endpoint type. Valid values:'."\n"
."\n"
.'- **queue**: A queue.'."\n"
."\n"
.'- **topic**: A topic.', 'type' => 'string', 'example' => 'queue', 'title' => ''],
'EndpointValue' => ['description' => 'The value of the endpoint.', 'type' => 'string', 'example' => 'retry-queue', 'title' => ''],
],
'title' => '',
'example' => '',
],
'DeliveryMode' => ['description' => 'This field is deprecated.', 'type' => 'string', 'example' => '--', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetEventRule',
'summary' => 'Retrieves an event notification rule.',
'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' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121385',
'abilityTreeNodes' => ['FEATUREmnsVLH730'],
],
'parameters' => [
[
'name' => 'QueueName',
'in' => 'query',
'schema' => ['description' => 'The name of the queue.', 'type' => 'string', 'required' => true, 'example' => 'demo-queue', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''],
'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'QueueName' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'demo-queue', 'title' => ''],
'CreateTime' => ['description' => 'The time when the queue was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', 'title' => ''],
'LastModifyTime' => ['description' => 'The most recent time when the queue attributes were modified. The value is a UNIX timestamp representing the number of seconds elapsed since 1970-01-01 00:00:00.', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', 'title' => ''],
'DelaySeconds' => ['description' => 'The delay period for all messages sent to the queue. Messages sent to the queue can be consumed only after the delay period specified by this parameter elapses. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'MaximumMessageSize' => ['description' => 'The maximum length of the message body sent to the queue. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '65536', 'title' => ''],
'MessageRetentionPeriod' => ['description' => 'The maximum duration for which a message is retained in the queue. After the period specified by this parameter elapses since the message is sent to the queue, the message is deleted regardless of whether it has been consumed. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '65536', 'title' => ''],
'VisibilityTimeout' => ['description' => 'The duration for which a message stays in the Inactive state after it is consumed from the queue and changes from the Active state to the Inactive state.'."\n"
.'Valid values: 1 to 43200. Unit: seconds.'."\n"
.'Default value: 30.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'PollingWaitSeconds' => ['description' => 'The maximum wait time for a ReceiveMessage request on the queue when the queue has no messages. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ActiveMessages' => ['description' => 'The approximate total number of messages in the Active state in the queue.'."\n"
."\n"
.'This field will be deprecated and defaults to 0. Use the CloudMonitor API to retrieve this metric instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'InactiveMessages' => ['description' => 'The approximate total number of messages in the Inactive state in the queue.'."\n"
."\n"
.'This field will be deprecated and defaults to 0. Use the CloudMonitor API to retrieve this metric instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'DelayMessages' => ['description' => 'The approximate total number of messages in the Delayed state in the queue.'."\n"
."\n"
.'This field will be deprecated and defaults to 0. Use the CloudMonitor API to retrieve this metric instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'LoggingEnabled' => ['description' => 'Indicates whether the log management feature is enabled.'."\n"
."\n"
.'- True: Enabled.'."\n"
."\n"
.'- False: Disabled.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Tags' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'tag1', 'title' => ''],
'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DlqPolicy' => [
'description' => 'The dead-letter queue policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Indicates whether dead-letter message delivery is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The target queue for dead-letter message delivery.', 'type' => 'string', 'example' => 'deadLetterTargetQueue', 'title' => ''],
'MaxReceiveCount' => ['description' => 'The maximum number of times a message can be delivered.', 'type' => 'string', 'example' => '3', 'title' => ''],
],
'title' => '',
'example' => '',
],
'TenantRateLimitPolicy' => [
'description' => 'The rate limiting policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Specifies whether rate limiting is enabled. Valid values:'."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'MaxReceivesPerSecond' => ['description' => 'The maximum number of receives per second.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'QueueType' => ['description' => 'The type of the queue. Valid values:'."\n"
.' * normal: standard queue'."\n"
.' * fifo: FIFO queue', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'EnableSSE' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'SseType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SseAlgorithm' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'KmsKeyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EncryptionEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Get queue attributes',
'summary' => 'Retrieves the attributes of a created queue.',
'description' => '>'."\n"
.'For optimization of service performance, Simple Message Queue (formerly MNS) will offline the return values of the following fields (the default value will be 0):
'."\n"
.' - ActiveMessages
'."\n"
.' - InactiveMessages
'."\n"
.' - DelayMessages
'."\n"
.'
'."\n"
.' Use the following alternatives to obtain replacement solutions:
'."\n"
.' '."\n"
.' - Use the CloudMonitor OpenAPI to retrieve queue monitoring metrics. For more information, see CloudMonitor OpenAPI documentation
'."\n"
.' - CloudMonitor monitoring metrics documentation. The mapping between deprecated fields and monitoring metrics:'."\n"
.'
'."\n"
.' - ActiveMessages → monitoring metric NumberOfMessagesVisible
'."\n"
.' - InactiveMessages → monitoring metric NumberOfMessagesInvisible
'."\n"
.' - DelayMessages → monitoring metric NumberOfMessagesDelayed
'."\n"
.'
'."\n"
.' '."\n"
.'
'."\n"
.'',
'changeSet' => [],
'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\\": false,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": false\\n }\\n}","type":"json"}]',
],
'GetSubscriptionAttributes' => [
'summary' => 'Retrieves the properties of a 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' => 'The name of the topic to which the subscription belongs.', 'type' => 'string', 'required' => true, 'example' => 'MyTopic', 'title' => ''],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => ['description' => 'The name of the subscription.', 'type' => 'string', 'required' => true, 'example' => 'MySubscription', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'SubscriptionName' => ['description' => 'The name of the subscription.', 'type' => 'string', 'example' => 'MySubscription', 'title' => ''],
'TopicOwner' => ['description' => 'The AccountId of the owner of the topic to which the subscription belongs.', 'type' => 'string', 'example' => '123456789098****', 'title' => ''],
'TopicName' => ['description' => 'The name of the topic to which the subscription belongs.', 'type' => 'string', 'example' => 'MyTopic', 'title' => ''],
'Endpoint' => ['description' => 'The endpoint of the subscription.', 'type' => 'string', 'example' => 'http://example.com', 'title' => ''],
'FilterTag' => ['description' => 'The tag used for message filtering. Only messages that have a matching tag are pushed.', 'type' => 'string', 'example' => 'important', 'title' => ''],
'CreateTime' => ['description' => 'The time when the subscription was created. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 00:00:00 on January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806', 'title' => ''],
'LastModifyTime' => ['description' => 'The time when the subscription properties were last modified. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 00:00:00 on January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962', 'title' => ''],
'NotifyStrategy' => ['description' => 'The retry policy that is used when a message fails to be pushed to an endpoint. Valid values:'."\n"
."\n"
.'- BACKOFF\\_RETRY: backoff retry.'."\n"
."\n"
.'- EXPONENTIAL\\_DECAY\\_RETRY: exponential decay retry.', 'type' => 'string', 'example' => 'BACKOFF_RETRY', 'title' => ''],
'NotifyContentFormat' => ['description' => 'The format of the message content that is pushed to an endpoint.'."\n"
.'Valid values:'."\n"
."\n"
.'- XML'."\n"
."\n"
.'- JSON'."\n"
."\n"
.'- SIMPLIFIED', 'type' => 'string', 'example' => 'XML', 'title' => ''],
'DlqPolicy' => [
'description' => 'The dead-letter queue policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Indicates whether dead-letter message delivery is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The target queue to which dead-letter messages are delivered.', 'type' => 'string', 'example' => 'deadLetterTargetQueue', 'title' => ''],
],
'title' => '',
'example' => '',
],
'TenantRateLimitPolicy' => [
'type' => 'object',
'properties' => [
'Enabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'MaxReceivesPerSecond' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetSubscriptionAttributes',
'changeSet' => [],
'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\\": false,\\n \\"MaxReceivesPerSecond\\": 0\\n }\\n }\\n}","type":"json"}]',
],
'GetTopicAttributes' => [
'summary' => 'Queries the attributes of a topic.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '121395',
'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'demo-topic', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''],
'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'TopicName' => ['description' => 'The name of the topic.', 'type' => 'string', 'example' => 'demo-topic', 'title' => ''],
'MessageCount' => ['description' => 'The number of messages in the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'MaxMessageSize' => ['description' => 'The maximum length of the message body sent to the topic. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '65536', 'title' => ''],
'MessageRetentionPeriod' => ['description' => 'The maximum duration for which a message is retained in the topic. After the period of time specified by this parameter elapses since the message is sent to the topic, the message is deleted regardless of whether it is successfully pushed to the user. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'title' => ''],
'CreateTime' => ['description' => 'The time when the topic was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554277', 'title' => ''],
'LastModifyTime' => ['description' => 'The most recent time when the topic attributes were modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554460', 'title' => ''],
'LoggingEnabled' => ['description' => 'Indicates whether the Log Management feature is enabled. Valid values:'."\n"
."\n"
.'- True: Enabled.'."\n"
."\n"
.'- False: Disabled.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Tags' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'tag1', 'title' => ''],
'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TopicType' => ['description' => 'The type of the topic. Valid values:'."\n"
.' * normal: normal topic'."\n"
.' * fifo: FIFO topic', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'TopicUrl' => ['title' => '', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic', 'description' => ''],
'TopicInnerUrl' => ['title' => '', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic', 'description' => ''],
'EnableSSE' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'SseType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SseAlgorithm' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'KmsKeyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EncryptionEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Get topic attributes',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTopicAttributes'],
],
],
'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\\": false,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": false\\n }\\n}","type":"json"}]',
],
'ListEventRules' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '272940',
'abilityTreeNodes' => ['FEATUREmnsT1OLHP'],
],
'parameters' => [
[
'name' => 'ProductName',
'in' => 'query',
'schema' => ['description' => 'The name of the Alibaba Cloud service for which event notifications are configured.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''],
],
[
'name' => 'ResourceName',
'in' => 'query',
'schema' => ['description' => 'The resource name in the matching rule. This parameter is used to filter rules. For example, for Object Storage Service (OSS), this is the bucket name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-bucket'],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rule-xsXDW'],
],
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-topic'],
],
[
'name' => 'Subscription',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The subscriber.',
'type' => 'object',
'properties' => [
'EndpointType' => ['description' => 'The endpoint type. Valid values:'."\n"
."\n"
.'- **topic**: A topic can deliver messages to multiple subscribers. You can add or remove subscribers later.'."\n"
."\n"
.'- **queue**: Messages are delivered directly to a queue. This simplifies the delivery path, but you cannot add new subscribers later.', 'type' => 'string', 'required' => false, 'example' => 'topic', 'title' => ''],
'EndpointValue' => ['description' => 'The actual value of the endpoint.', 'type' => 'string', 'required' => false, 'example' => 'test-topic', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => ['description' => 'The page number of the results to return.'."\n"
.'Valid values: 1 to 100000.'."\n"
.'If you set this parameter to a value less than 1, the system uses 1. If you set this parameter to a value greater than 100000, the system uses 100000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
.'Valid values: 10 to 50.'."\n"
.'If you set this parameter to a value less than 10, the system uses 10. If you set this parameter to a value greater than 50, the system uses 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. Use PageNum for paged queries.', 'type' => 'string', 'required' => false, 'example' => 'cd7NlPlX4kgKCdsCWMiMR/+HnVzPLQ4/XLvjR64jZ7F9AQ+Mr3T59J6IVkuXeV3w', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. Use PageSize for paged queries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'PageNum' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
'Size' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'Pages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '130', 'title' => ''],
'NextToken' => ['description' => 'This parameter is deprecated. Paged queries are based on PageNum.', 'type' => 'string', 'example' => 'a88f58d504b8b4c4e0b5e8707e68181f', 'title' => ''],
'MaxResults' => ['description' => 'This parameter is deprecated. The maximum number of entries is based on Total.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageData' => [
'description' => 'The data entries.',
'type' => 'array',
'items' => [
'description' => 'The data entries.',
'type' => 'object',
'properties' => [
'RuleName' => ['description' => 'The name of the event notification rule.', 'type' => 'string', 'example' => 'rule-xsXDW', 'title' => ''],
'Subscriptions' => [
'description' => 'The subscribers. A maximum of 20 entries are returned. If there are more subscribers, see [List Subscriptions](~~2804757~~).',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndpointType' => ['description' => 'The endpoint type.', 'type' => 'string', 'example' => 'queue', 'title' => ''],
'EndpointValue' => ['description' => 'The actual value of the endpoint.', 'type' => 'string', 'example' => 'wyx-vp-complete-queue', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TopicName' => ['description' => 'The name of the topic.', 'type' => 'string', 'example' => 'demo-topic', 'title' => ''],
'MatchRules' => [
'title' => '',
'description' => 'The event matching rules. The rules have an OR relationship.',
'type' => 'array',
'items' => [
'description' => 'The event matching rules. The rules have an OR relationship.',
'type' => 'array',
'items' => ['description' => 'The matching rules. Multiple rules have an OR relationship.', '$ref' => '#/components/schemas/EventMatchRule', 'example' => '[[{\\"MatchState\\":true,\\"Prefix\\":\\"cdhxdev1cdh-bba-dto-052901-sem-5seh/\\",\\"Suffix\\":\\"\\"}]]', 'title' => ''],
'title' => '',
'example' => '',
],
'example' => '',
],
'EventTypes' => [
'description' => 'The list of event types.',
'type' => 'array',
'items' => ['description' => 'The list of event types.', 'type' => 'string', 'example' => '["oss:ObjectCreated:CopyObject"]', 'title' => ''],
'title' => '',
'example' => '',
],
'Endpoint' => [
'description' => 'The endpoint of the subscription.',
'type' => 'object',
'properties' => [
'EndpointType' => ['description' => 'The endpoint type. Valid values:'."\n"
."\n"
.'- **topic**: A topic can deliver messages to multiple subscribers. You can add or remove subscribers later.'."\n"
."\n"
.'- **queue**: Messages are delivered directly to a queue. This simplifies the delivery path, but you cannot add new subscribers later.', 'type' => 'string', 'example' => 'topic', 'title' => ''],
'EndpointValue' => ['description' => 'The actual value of the endpoint.', 'type' => 'string', 'example' => 'test-topic', 'title' => ''],
],
'title' => '',
'example' => '',
],
'DeliveryMode' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '--', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListEventRules',
'summary' => 'Queries a list of event notification rules.',
'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' => 'Lists all queues under a specified Alibaba Cloud account with pagination support.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '121378',
'abilityTreeNodes' => ['FEATUREmns5OVH2T'],
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'query',
'schema' => ['description' => 'The page number of the results to return.'."\n"
."\n"
.'Valid values: 1 to 100000000.'."\n"
."\n"
.'If you set this parameter to a value less than 1, the system uses 1 by default. If you set this parameter to a value greater than 100000000, the system uses 100000000 by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
."\n"
.'Valid values: 10 to 50.'."\n"
."\n"
.'If you set this parameter to a value less than 10, the system uses 10 by default. If you set this parameter to a value greater than 50, the system uses 50 by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'QueueName',
'in' => 'query',
'schema' => ['description' => 'The name of the queue.', 'type' => 'string', 'required' => false, 'example' => 'demo-queue', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''],
'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'QueueType',
'in' => 'query',
'schema' => ['description' => 'The type of the queue. Valid values:'."\n"
.' * normal: standard queue'."\n"
.' * fifo: FIFO queue', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'PageNum' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
'Size' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'Pages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '130', 'title' => ''],
'PageData' => [
'description' => 'The results returned on the current page.',
'type' => 'array',
'items' => [
'description' => 'The data entry.',
'type' => 'object',
'properties' => [
'QueueName' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'demo-queue', 'title' => ''],
'CreateTime' => ['description' => 'The time when the queue was created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', 'title' => ''],
'LastModifyTime' => ['description' => 'The most recent time when the queue attributes were modified. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', 'title' => ''],
'DelaySeconds' => ['description' => 'The delay period after which all messages sent to this queue become consumable. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'MaximumMessageSize' => ['description' => 'The maximum size of a message body that can be sent to this queue. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '65536', 'title' => ''],
'MessageRetentionPeriod' => ['description' => 'The maximum period for which a message can be retained in this queue. After the specified period elapses since a message is sent to the queue, the message is deleted regardless of whether it has been consumed. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '65536', 'title' => ''],
'VisibilityTimeout' => ['description' => 'The duration for which a message stays in the Inactive state after it is consumed from the queue.'."\n"
."\n"
.'Valid values: 1 to 43200. Unit: seconds.'."\n"
."\n"
.'Default value: 30.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'PollingWaitSeconds' => ['description' => 'The maximum wait time for a ReceiveMessage request when the queue is empty. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'ActiveMessages' => ['description' => 'The approximate total number of messages in the Active state in this queue.'."\n"
."\n"
.'This field will default to 0 in the future and is not recommended. Use CloudMonitor API to retrieve this metric instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'InactiveMessages' => ['description' => 'The approximate total number of messages in the Inactive state in this queue.'."\n"
."\n"
.'This field will default to 0 in the future and is not recommended. Use CloudMonitor API to retrieve this metric instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'DelayMessages' => ['description' => 'The approximate total number of messages in the Delayed state in this queue.'."\n"
."\n"
.'This field will default to 0 in the future and is not recommended. Use CloudMonitor API to retrieve this metric instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'LoggingEnabled' => ['description' => 'Indicates whether the log management feature is enabled.'."\n"
."\n"
.'- True: Enabled.'."\n"
."\n"
.'- False: Disabled.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Tags' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'tag1', 'title' => ''],
'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DlqPolicy' => [
'description' => 'The dead-letter queue policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Indicates whether dead-letter message delivery is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The target queue for dead-letter message delivery.', 'type' => 'string', 'example' => 'deadLetterTargetQueue', 'title' => ''],
'MaxReceiveCount' => ['description' => 'The maximum number of times a message can be delivered.', 'type' => 'string', 'example' => '3', 'title' => ''],
],
'title' => '',
'example' => '',
],
'QueueType' => ['description' => 'The type of the queue. Valid values:'."\n"
.' * normal: standard queue'."\n"
.' * fifo: FIFO queue', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'EnableSSE' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'SseType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SseAlgorithm' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'KmsKeyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EncryptionEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List all queues under a specified Alibaba Cloud account',
'changeSet' => [],
'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' => 'All Resource', '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 \\"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\\": false,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListSubscriptionByTopic' => [
'summary' => 'You can call the ListSubscriptionByTopic operation to retrieve a paginated list of subscriptions for a topic.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121399',
'abilityTreeNodes' => ['FEATUREmns4BQTE0', 'FEATUREmnsNGE8ZG', 'FEATUREmnsOJMS9M', 'FEATUREmnsIGJWNT', 'FEATUREmnsUVY5DY'],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The topic name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => ['description' => 'The page number of the results to return.'."\n"
.'Valid values: 1 to 100000000.'."\n"
.'If the value is less than 1, the system uses 1. If the value is greater than 100000000, the system uses 100000000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
.'Valid values: 10 to 50.'."\n"
.'If the value is less than 10, the system uses 10. If the value is greater than 50, the system uses 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => ['description' => 'The subscription name.', 'type' => 'string', 'required' => false, 'example' => 'demo-subscription', 'title' => ''],
],
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'EndpointValue',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'PageNum' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
'Size' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'Pages' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '130', 'title' => ''],
'PageData' => [
'description' => 'The entries on the current page.',
'type' => 'array',
'items' => [
'description' => 'The data entries.',
'type' => 'object',
'properties' => [
'SubscriptionName' => ['description' => 'The subscription name.', 'type' => 'string', 'example' => 'MySubscription', 'title' => ''],
'TopicOwner' => ['description' => 'The AccountId of the owner of the topic to which the subscription belongs.', 'type' => 'string', 'example' => '123456789098****', 'title' => ''],
'TopicName' => ['description' => 'The name of the topic to which the subscription belongs.', 'type' => 'string', 'example' => 'MyTopic', 'title' => ''],
'Endpoint' => ['description' => 'The endpoint of the subscription.', 'type' => 'string', 'example' => 'http://example.com', 'title' => ''],
'FilterTag' => ['description' => 'The tag for message filtering in the subscription. Only messages with the same tag are pushed.', 'type' => 'string', 'example' => 'important'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the subscription was created, in Unix time format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806'."\n", 'title' => ''],
'LastModifyTime' => ['description' => 'The time when the subscription properties were last modified. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806'."\n", 'title' => ''],
'NotifyStrategy' => ['description' => 'The retry policy for message push failures to the endpoint. Valid values:'."\n"
."\n"
.'- BACKOFF\\_RETRY: backoff retry.'."\n"
."\n"
.'- EXPONENTIAL\\_DECAY\\_RETRY: exponential decay retry.', 'type' => 'string', 'example' => 'BACKOFF_RETRY', 'title' => ''],
'NotifyContentFormat' => ['description' => 'The format of the message content pushed to the endpoint.'."\n"
.'Valid values:'."\n"
."\n"
.'- XML'."\n"
."\n"
.'- JSON'."\n"
."\n"
.'- SIMPLIFIED', 'type' => 'string', 'example' => 'XML', 'title' => ''],
'DlqPolicy' => [
'description' => 'The dead-letter queue policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Indicates whether dead-letter message delivery is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The destination queue for dead-letter messages.', 'type' => 'string', 'example' => 'dead-letter-queue', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListSubscriptionByTopic',
'changeSet' => [],
'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'],
],
],
],
],
'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"}]',
],
'ListTopic' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '121394',
'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'query',
'schema' => ['description' => 'The page number of the results to return.'."\n"
.'Valid values: 1 to 100000000.'."\n"
.'If you set this parameter to a value less than 1, the system uses 1 by default. If you set this parameter to a value greater than 100000000, the system uses 100000000 by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of results to return on each page.'."\n"
.'Valid values: 10 to 50.'."\n"
.'If you set this parameter to a value less than 10, the system uses 10 by default. If you set this parameter to a value greater than 50, the system uses 50 by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''],
'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'TopicType',
'in' => 'query',
'schema' => ['description' => 'The type of the topic. Valid values:'."\n"
.' * normal: normal topic'."\n"
.' * fifo: FIFO topic', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'PageNum' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of results returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
'Total' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int64', 'example' => '130', 'title' => ''],
'PageData' => [
'description' => 'The results returned on the current page.',
'type' => 'array',
'items' => [
'description' => 'The data entry.',
'type' => 'object',
'properties' => [
'TopicName' => ['description' => 'The name of the topic.', 'type' => 'string', 'example' => 'demo-topic', 'title' => ''],
'MessageCount' => ['description' => 'The number of messages in the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'MaxMessageSize' => ['description' => 'The maximum length of the message body sent to the topic. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '65536', 'title' => ''],
'MessageRetentionPeriod' => ['description' => 'The maximum duration for which a message is retained in the topic. After the time specified by this parameter elapses since the message is sent to the topic, the message is deleted regardless of whether it has been successfully pushed to the user. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'title' => ''],
'CreateTime' => ['description' => 'The time when the subscription was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962', 'title' => ''],
'LastModifyTime' => ['description' => 'The time when the subscription attributes were last modified. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962', 'title' => ''],
'LoggingEnabled' => ['description' => 'Indicates whether the Log Management feature is enabled. Valid values:'."\n"
."\n"
.'- True: Enabled.'."\n"
."\n"
.'- False: Disabled.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'TopicUrl' => ['description' => 'The URL of the topic.', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic', 'title' => ''],
'TopicInnerUrl' => ['description' => 'The internal URL of the topic.', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic', 'title' => ''],
'Tags' => [
'description' => 'The list of resource tags.',
'type' => 'array',
'items' => [
'description' => 'The tag value that corresponds to the tag key.',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'tag1', 'title' => ''],
'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TopicType' => ['description' => 'The type of the topic. Valid values:'."\n"
.' * normal: normal topic'."\n"
.' * fifo: FIFO topic', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'EnableSSE' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'SseType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SseAlgorithm' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'KmsKeyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EncryptionEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query topic list under an Alibaba Cloud account',
'summary' => 'Queries the list of topics under an Alibaba Cloud account with paginated results.',
'changeSet' => [],
'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' => 'All Resource', '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 \\"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\\": false,\\n \\"SseType\\": \\"\\",\\n \\"SseAlgorithm\\": \\"\\",\\n \\"KmsKeyId\\": \\"\\",\\n \\"EncryptionEnabled\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'RevokeEndpointAcl' => [
'summary' => 'Revokes one or more Access Control List (ACL) rules for a specified endpoint type.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '259964',
'abilityTreeNodes' => ['FEATUREmns0M5BDJ'],
],
'parameters' => [
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => [
'description' => 'The endpoint type. Valid values:'."\n"
."\n"
.'- **public**: The Internet endpoint. Currently, only \\`public\\` is supported.',
'enumValueTitles' => ['public' => 'public'],
'type' => 'string',
'required' => true,
'example' => 'public',
'title' => '',
],
],
[
'name' => 'AclStrategy',
'in' => 'query',
'schema' => [
'description' => 'The ACL policy. Valid values:'."\n"
."\n"
.'- **allow**: The operation is for a Classless Inter-Domain Routing (CIDR) whitelist. Currently, only \\`allow\\` is supported.',
'enumValueTitles' => ['allow' => 'allow'],
'type' => 'string',
'required' => true,
'example' => 'allow',
'title' => '',
],
],
[
'name' => 'CidrList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => 'The list of network segments.',
'type' => 'array',
'items' => ['description' => 'The network segment.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.1/24', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'RevokeEndpointAcl',
'extraInfo' => '本API目前只在：广州、北京、上海地域开放，如果有其他地域需求请提工单进行支持',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'mns:RevokeEndpointAcl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => 'Calls the SetQueueAttributes operation to modify queue attributes.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '121386',
'abilityTreeNodes' => ['FEATUREmnsVLH730'],
],
'parameters' => [
[
'name' => 'QueueName',
'in' => 'query',
'schema' => ['description' => 'The name of the queue.', 'type' => 'string', 'required' => true, 'example' => 'testqueue', 'title' => ''],
],
[
'name' => 'DelaySeconds',
'in' => 'query',
'schema' => ['description' => 'The delay time for all messages sent to this queue. Messages sent to the queue can be consumed only after the delay time specified by this parameter has elapsed.'."\n"
."\n"
.'Valid values: 0 to 604800. Unit: seconds.'."\n"
."\n"
.'Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'MaximumMessageSize',
'in' => 'query',
'schema' => ['description' => 'The maximum length of the message body sent to this queue.'."\n"
."\n"
.'Valid values: 1024 to 65536. Unit: bytes.'."\n"
."\n"
.'Default value: 65536.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024', 'title' => ''],
],
[
'name' => 'MessageRetentionPeriod',
'in' => 'query',
'schema' => ['description' => 'The maximum duration for which a message is retained in this queue. After the time specified by this parameter has elapsed since the message was sent to the queue, the message is deleted regardless of whether it has been consumed.'."\n"
."\n"
.'Valid values: 60 to 604800. Unit: seconds.'."\n"
."\n"
.'Default value: 345600.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '120', 'title' => ''],
],
[
'name' => 'VisibilityTimeout',
'in' => 'query',
'schema' => ['description' => 'The duration for which a message stays in the Inactive state after it is consumed from the queue and changes from the Active state to the Inactive state.'."\n"
."\n"
.'Valid values: 1 to 43200. Unit: seconds.'."\n"
."\n"
.'Default value: 30.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''],
],
[
'name' => 'PollingWaitSeconds',
'in' => 'query',
'schema' => ['description' => 'The maximum wait time for a ReceiveMessage request on this queue when no messages are available in the queue.'."\n"
."\n"
.'Valid values: 0 to 30. Unit: seconds.'."\n"
."\n"
.'Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'EnableLogging',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the log management feature. Valid values:'."\n"
."\n"
.'- true: Enabled.'."\n"
."\n"
.'- false: Disabled.'."\n"
."\n"
.'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The dead-letter queue policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Specifies whether to enable dead-letter message delivery.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The target queue for dead-letter message delivery.', 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue', 'title' => ''],
'MaxReceiveCount' => ['description' => 'The maximum number of times a message can be delivered.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'Enabled' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'MaxReceivesPerSecond' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
],
[
'name' => 'EnableSSE',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseAlgorithm',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'KmsKeyId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Modify queue attributes',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetQueueAttributes'],
],
],
'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' => 'Call the SetSubscriptionAttributes operation to modify a subscription\'s attributes.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '121401',
'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => ['description' => 'The name of the subscription.', 'type' => 'string', 'required' => true, 'example' => 'MySubscription', 'title' => ''],
],
[
'name' => 'NotifyStrategy',
'in' => 'query',
'schema' => ['description' => 'The retry policy for message delivery failures to the endpoint. Valid values:'."\n"
."\n"
.'- BACKOFF\\_RETRY: backoff retry.'."\n"
."\n"
.'- EXPONENTIAL\\_DECAY\\_RETRY: exponential decay retry.', 'type' => 'string', 'required' => false, 'example' => 'BACKOFF_RETRY', 'title' => ''],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The dead-letter queue policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Whether to enable dead-letter message delivery.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The destination queue for dead-letter messages.', 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'Enabled' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'MaxReceivesPerSecond' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
],
[
'name' => 'StsRoleArn',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => 'acs:ram::1234567890:role/roleName', 'description' => '', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Success' => ['description' => 'Whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetSubscriptionAttributes',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetSubscriptionAttributes'],
],
],
'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' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121396',
'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'EnableLogging',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the log management feature. Valid values:'."\n"
."\n"
.'- true: Enabled.'."\n"
."\n"
.'- false: Disabled.'."\n"
.'Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'MaxMessageSize',
'in' => 'query',
'schema' => ['description' => 'The maximum length of the message body sent to the topic. Valid values: 1024 to 65536. Unit: bytes. Default value: 65536.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65536', 'title' => ''],
],
[
'name' => 'EnableSSE',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'SseAlgorithm',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'KmsKeyId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Modify topic attributes',
'summary' => 'Calls the SetTopicAttributes operation to modify the attributes of a topic.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetTopicAttributes'],
],
],
'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' => 'Calls the Subscribe operation to create a subscription for a topic.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '121397',
'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'topic****1', 'title' => ''],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => ['description' => 'The name of the subscription.', 'type' => 'string', 'required' => true, 'example' => 'testSubscription ', 'title' => ''],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => ['title' => '', 'description' => '## Push type of the subscription'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- `http`: HTTP/HTTPS push. Pushes messages to a specified HTTP or HTTPS callback URL.'."\n"
.'- `queue`: Queue push. Pushes messages to a specified SMQ queue.'."\n"
.'- `dm`: Email push. Sends notifications through DirectMail. You must also set the `DmAttributes` and `StsRoleArn` parameters.'."\n"
.'- `dysms`: SMS push. Sends notifications through Alibaba Cloud Short Message Service. You must also set the `DysmsAttributes` parameter.'."\n"
."\n"
.'- `fc`: Function Compute push. Pushes messages to Alibaba Cloud Function Compute (FC).'."\n"
.'- `eventbus`: EventBridge push. Pushes messages to an EventBridge event bus.'."\n"
."\n"
.'**Note:**'."\n"
.'The following values are deprecated and are only used for compatibility with legacy subscriptions:'."\n"
."\n"
.'- `mpush`: Mobile push.'."\n"
.'- `alisms`: Legacy SMS.'."\n"
.'- `email`: Legacy email. Use `dm` instead.'."\n"
.'- `kafka`: Kafka push type is deprecated.', 'type' => 'string', 'required' => true, 'example' => 'queue'],
],
[
'name' => 'Endpoint',
'in' => 'query',
'schema' => ['title' => '', 'description' => '## Endpoint address for receiving messages'."\n"
."\n"
.'The format varies depending on the value of `PushType`:'."\n"
."\n"
.'- `PushType=http`: An HTTP/HTTPS callback URL, such as `http://example.com/callback` or `https://example.com/callback`.'."\n"
.'- `PushType=queue`: The ARN of the destination queue, in the format `acs:mns:{RegionId}:{Alibaba Cloud account ID}:queues/{QueueName}`.'."\n"
.'- `PushType=dm`: The email push endpoint, in the fixed format `smq-ep:dm:{Alibaba Cloud account ID}:__dynamic`. Replace `{Alibaba Cloud account ID}` with your Alibaba Cloud account ID.'."\n"
.'- `PushType=dysms`: The SMS push endpoint, in the format `smq-ep:dysms:{Alibaba Cloud account ID}:{PhoneNumber}`.'."\n"
.'- `PushType=kafka`: The Kafka push endpoint. The Kafka push type is deprecated.'."\n"
.'- `PushType=fc`: The Function Compute endpoint, in the format `acs:fc:{RegionId}:{Alibaba Cloud account ID}:services/{ServiceName}/functions/{FunctionName}`.'."\n"
.'- `PushType=eventbus`: The EventBridge endpoint, in the format `acs:eventbridge:{RegionId}:{Alibaba Cloud account ID}:eventbus/{EventBusName}`.', 'type' => 'string', 'required' => true, 'example' => 'http://*****.com/uri1/xxx'],
],
[
'name' => 'NotifyStrategy',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The retry strategy when an error occurs while pushing messages to the endpoint. Valid values:'."\n"
."\n"
.'- BACKOFF_RETRY: backoff retry.'."\n"
."\n"
.'- EXPONENTIAL_DECAY_RETRY: exponential decay retry.', 'type' => 'string', 'example' => 'BACKOFF_RETRY', 'required' => false],
],
[
'name' => 'NotifyContentFormat',
'in' => 'query',
'schema' => ['title' => '', 'description' => '## Format of the pushed message content'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- `XML`: The message body is pushed in XML format. This is the default value.'."\n"
.'- `JSON`: The message body is pushed in JSON format.'."\n"
.'- `SIMPLIFIED`: Only the raw message body content is pushed, without SMQ metadata wrapping.', 'type' => 'string', 'example' => 'XML', 'required' => false],
],
[
'name' => 'MessageTag',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The tag used for message filtering in this subscription. Only messages with a matching tag are pushed. The value is a string of up to 16 characters.'."\n"
."\n"
.'By default, no message filtering is applied.', 'type' => 'string', 'example' => 'important', 'required' => false],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The dead-letter queue policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Specifies whether to enable dead-letter message delivery.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'DeadLetterTargetQueue' => ['description' => 'The destination queue for dead-letter message delivery.', 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The throttling policy.',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => 'Specifies whether to enable the throttling policy. Valid values: true and false.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''],
'MaxReceivesPerSecond' => ['description' => 'The maximum number of pushes or consumptions per second.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'StsRoleArn',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ARN of the RAM role assumed by the service. The format is acs:ram::{Alibaba Cloud account ID}:role/{RoleName}. Replace {Alibaba Cloud account ID} with the Alibaba Cloud account ID that calls the API operation.', 'type' => 'string', 'example' => 'acs:ram::1234567890:role/AliyunMNSNotificationRole', 'required' => false],
],
[
'name' => 'DmAttributes',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The email push attributes. This parameter is required when PushType is set to dm. The value is in JSON format and contains the following fields:'."\n"
."\n"
.'- AccountName: The sender address configured in DirectMail (such as notify@example.com).'."\n"
.'- Subject: The email subject.',
'type' => 'object',
'properties' => [
'AccountName' => ['description' => 'The sender address.', 'type' => 'string', 'required' => false, 'example' => 'notify@example.com', 'title' => ''],
'Subject' => ['description' => 'The email subject.', 'type' => 'string', 'required' => false, 'example' => 'notify', 'title' => ''],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'DysmsAttributes',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The SMS push attributes. This parameter is required when PushType is set to alisms. The value is in JSON format and contains the following fields:'."\n"
."\n"
.'- TemplateCode: The SMS template code, which can be obtained from the Short Message Service console.'."\n"
.'- SignName: The SMS signature name.',
'type' => 'object',
'properties' => [
'TemplateCode' => ['description' => 'The SMS template code.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
'SignName' => ['description' => 'The SMS signature name.', 'type' => 'string', 'required' => false, 'example' => '阿里云短信测试专用', 'title' => ''],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'KafkaAttributes',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'The Kafka push type is deprecated.',
'type' => 'object',
'properties' => [
'BusinessMode' => ['description' => 'The Kafka push type is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'Default empty string', 'title' => ''],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The response status.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => '{\'Code\': 200, \'Success\': True}', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Create a subscription for a topic',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'Subscribe'],
],
],
'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' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121398',
'abilityTreeNodes' => ['FEATUREmnsSAU1G7'],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => ['description' => 'The name of the topic.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => ['description' => 'The name of the subscription.', 'type' => 'string', 'required' => true, 'example' => 'MySubscription', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Status' => ['description' => 'The status of the response.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Unsubscribe',
'summary' => 'You can call Unsubscribe to cancel an existing subscription.',
'changeSet' => [],
'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' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => ''],
['code' => 'InvalidTime', 'message' => 'Please limit the time gap between StartTime and EndTime into %s hours.', 'http_code' => 400, 'description' => 'You must narrow down the time range in which you want to query parameters.'],
['code' => 'InvalidTime', 'message' => 'Please limit the query time range into %s hours, i.e. EndTime minus StartTime.', 'http_code' => 400, 'description' => 'Query the dynamic error codes that are returned from the DescribeRefreshTasks operation.'],
['code' => 'iot.dap.insight.limitedInvoke', 'message' => 'Please check subscribe number and invoke limitation.', 'http_code' => 400, 'description' => 'Check the subscription quota or call quota.'],
['code' => 'iot.device.DeviceNumberExceedInstance', 'message' => 'Exceeds instance device number limit', 'http_code' => 400, 'description' => 'Exceeds instance device number limit'],
['code' => 'iot.tsl.ThingModelNotFound', 'message' => 'the thing model not exist.', 'http_code' => 400, 'description' => 'The TSL module does not exist.'],
['code' => 'RamAuthError', 'message' => 'action rejected by RAM.', 'http_code' => 403, 'description' => 'Operation denied by RAM.'],
['code' => 'ServiceNotEnable', 'message' => 'Service not enbale.', 'http_code' => 403, 'description' => 'The user has not activated the MNS service.'],
],
'changeSet' => [],
'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'],
],
],
'ram' => [
'productCode' => 'MessageService',
'productName' => 'Simple Message Queue (formerly MNS)',
'ramCodes' => ['mns'],
'ramLevel' => 'RESOURCE',
'ramConditions' => [
[
'name' => 'mns:EnableLogging',
'schema' => [
'type' => 'String',
'description' => 'Whether the log function is enabled',
'enums' => ['true', 'false'],
],
],
[
'name' => 'mns:PushType',
'schema' => [
'type' => 'String',
'description' => 'Subscription Type',
'enums' => ['queue', 'http', 'alisms', 'email', 'mpush'],
],
],
],
'ramActions' => [
[
'apiName' => 'CreateEventRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'mns:PutEventNotifications',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetEndpointAttribute',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'mns:GetEndpointAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => '',
'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' => '',
'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' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnableEndpoint',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'mns:EnableEndpoint',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteEventRule',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'mns:DeleteEventNotifications',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RevokeEndpointAcl',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mns:RevokeEndpointAcl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AuthorizeEndpointAcl',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'mns:AuthorizeEndpointAcl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTopic',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'mns:ListTopic',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'MessageService', 'resourceType' => 'All Resource', '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' => '',
'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' => '',
'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' => '',
'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}'],
],
],
],
],
'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'],
],
],
];