'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Mns-open', 'version' => '2022-01-19', ], 'directories' => [ [ 'id' => 320718, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateTopic', 'SetTopicAttributes', 'GetTopicAttributes', 'DeleteTopic', 'ListTopic', ], ], [ 'id' => 320724, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateQueue', 'SetQueueAttributes', 'GetQueueAttributes', 'DeleteQueue', 'ListQueue', ], ], [ 'id' => 320730, 'title' => null, 'type' => 'directory', 'children' => [ 'Subscribe', 'SetSubscriptionAttributes', 'GetSubscriptionAttributes', 'Unsubscribe', 'ListSubscriptionByTopic', ], ], [ 'id' => 320736, 'title' => null, 'type' => 'directory', 'children' => [ 'DisableEndpoint', 'EnableEndpoint', 'GetEndpointAttribute', 'RevokeEndpointAcl', 'AuthorizeEndpointAcl', ], ], [ 'id' => 320742, 'title' => null, 'type' => 'directory', 'children' => [ 'GetEventRule', 'ListEventRules', 'CreateEventRule', 'DeleteEventRule', ], ], ], 'components' => [ 'schemas' => [ 'EventMatchRule' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'MatchState' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'matchState', 'default' => 'true', ], 'Name' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'testBucket/folder1/file1', 'backendName' => 'name', ], 'Prefix' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'testBucket/prefix1xxx', 'backendName' => 'prefix', ], 'Suffix' => [ 'title' => '', 'description' => '', 'visibility' => 'Public', 'type' => 'string', 'example' => 'suffix/xxxx.test', 'backendName' => 'suffix', ], ], ], ], ], 'apis' => [ 'CreateTopic' => [ 'summary' => 'Creates a topic.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '121392', 'abilityTreeNodes' => [ 'FEATUREmns5OVH2T', ], ], 'parameters' => [ [ 'name' => 'TopicName', 'in' => 'formData', 'schema' => [ 'description' => 'The name of the topic that you want to create.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'EnableLogging', 'in' => 'formData', 'schema' => [ 'description' => 'Specifies whether to enable the log management feature. Valid values:'."\n" ."\n" .'* true: enabled.'."\n" .'* false: disabled. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'MaxMessageSize', 'in' => 'formData', 'schema' => [ 'description' => 'The maximum length of the message that is sent to the topic. Valid values: 1024 to 65536. Unit: bytes. Default value: 65536.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'joyce.wang', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ 'name' => 'TopicType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => 'CreateTopic', ], 'SetTopicAttributes' => [ 'summary' => 'Modifies the attributes of a topic.', '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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'EnableLogging', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the log management feature. Valid values:'."\n" ."\n" .'* true: enabled.'."\n" .'* false: disabled. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'True', ], ], [ 'name' => 'MaxMessageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum length of the message that is sent to the topic. Valid values: 1024 to 65536. Unit: bytes. Default value: 65536.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65536', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => 'SetTopicAttributes', ], '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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo-topic', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tag.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'tag1', ], 'Value' => [ 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'TopicName' => [ 'description' => 'The name of the topic.'."\n", 'type' => 'string', 'example' => 'demo-topic', ], 'MessageCount' => [ 'description' => 'The number of messages in the topic.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MaxMessageSize' => [ 'description' => 'The maximum length of the message that is sent to the topic. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '65536', ], 'MessageRetentionPeriod' => [ 'description' => 'The maximum duration for which a message is retained in the topic. After the specified retention period ends, the message is deleted regardless of whether the message is received. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '86400', ], '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.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554277', ], 'LastModifyTime' => [ 'description' => 'The time when the topic was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554460', ], 'LoggingEnabled' => [ 'description' => 'Indicates whether the logging feature is enabled. Valid values:'."\n" ."\n" .'* True'."\n" .'* False'."\n", 'type' => 'boolean', 'example' => 'True', ], 'Tags' => [ 'description' => 'The tags added to the resources.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'tag1', ], 'TagValue' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], 'TopicType' => [ 'type' => 'string', ], 'TopicUrl' => [ 'title' => '消息 Topic URL', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic', ], 'TopicInnerUrl' => [ 'title' => '消息 Topic URL（内网访问）。', 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554277,\\n \\"LastModifyTime\\": 1449554460,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\",\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\"\\n }\\n}","type":"json"}]', 'title' => 'GetTopicAttributes', ], 'DeleteTopic' => [ 'summary' => 'Deletes a topic.', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '121393', 'abilityTreeNodes' => [ 'FEATUREmns5OVH2T', ], ], 'parameters' => [ [ 'name' => 'TopicName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the topic that you want to delete.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tf-testAccMNSTopic-112965059402264645', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', 'title' => 'DeleteTopic', ], 'ListTopic' => [ 'summary' => 'Queries the topics that belong to an Alibaba Cloud account. The topics are displayed by page.', '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. Valid values: 1 to 100000000. If you set this parameter to a value smaller than 1, the value of this parameter is 1 by default. If you set this parameter to a value greater than 100000000, the value of this parameter is 100000000 by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Value values: 10 to 50. If you set this parameter to a value smaller than 10, the value of this parameter is 10 by default. If you set this parameter to a value greater than 50, the value of this parameter is 50 by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'TopicName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the topic.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag value.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ 'name' => 'TopicType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'Total' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '130', ], 'PageData' => [ 'description' => 'The data returned on the current page.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The queried data.'."\n", 'type' => 'object', 'properties' => [ 'TopicName' => [ 'description' => 'The name of the topic.'."\n", 'type' => 'string', 'example' => 'demo-topic', ], 'MessageCount' => [ 'description' => 'The number of messages in the topic.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'MaxMessageSize' => [ 'description' => 'The maximum length of the message that is sent to the topic. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '65536', ], 'MessageRetentionPeriod' => [ 'description' => 'The maximum duration for which a message is retained in the topic. After the specified retention period ends, the message is deleted regardless of whether the message is received. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '86400', ], 'CreateTime' => [ 'description' => 'The time when the subscription was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962', ], 'LastModifyTime' => [ 'description' => 'The time when the subscription was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962', ], 'LoggingEnabled' => [ 'description' => 'Indicates whether the logging feature is enabled.'."\n" ."\n" .'* True'."\n" .'* False'."\n", 'type' => 'boolean', 'example' => 'True', ], 'TopicUrl' => [ 'description' => 'The URL of the message topic.'."\n", 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic', ], 'TopicInnerUrl' => [ 'description' => 'The internal URL of the message topic. The internal URL can be accessed over an internal network.'."\n", 'type' => 'string', 'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic', ], 'Tags' => [ 'description' => 'The tags added to the resources.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'tag1', ], 'TagValue' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], 'TopicType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554962,\\n \\"LastModifyTime\\": 1449554962,\\n \\"LoggingEnabled\\": true,\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListTopic', ], 'CreateQueue' => [ 'summary' => 'Creates a queue.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '121383', 'abilityTreeNodes' => [ 'FEATUREmnsXP7W6E', ], ], 'parameters' => [ [ 'name' => 'QueueName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'required' => true, 'example' => '06273500-249F-5863-121D-74D51123****', ], ], [ 'name' => 'MaximumMessageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum length of the message that is sent to the queue. Valid values: 1024 to 65536. Unit: bytes. Default value: 65536.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '65536', ], ], [ 'name' => 'MessageRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The maximum duration for which a message is retained in the queue. After the specified retention period ends, the message is deleted regardless of whether the message is consumed. Valid values: 60 to 604800. Unit: seconds. Default value: 345600.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '604800', 'minimum' => '60', 'example' => '345600', ], ], [ 'name' => 'VisibilityTimeout', 'in' => 'query', 'schema' => [ 'description' => 'The duration for which a message stays in the Inactive state after the message is received from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', ], ], [ 'name' => 'PollingWaitSeconds', 'in' => 'query', 'schema' => [ 'description' => 'The maximum duration for which long polling requests are held after the ReceiveMessage operation is called. Valid values: 0 to 30. Unit: seconds. Default value: 0'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'EnableLogging', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the log management feature. Valid values:'."\n" ."\n" .'* true: enabled.'."\n" .'* false: disabled.'."\n" ."\n" .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DelaySeconds', 'in' => 'query', 'schema' => [ 'description' => 'The period after which all messages sent to the queue are consumed. Valid values: 0 to 604800. Unit: seconds. Default value: 0'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The key of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ 'name' => 'DlqPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The dead-letter queue policy.', 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.', 'type' => 'string', 'required' => false, 'example' => 'deadLetterQueue', ], 'MaxReceiveCount' => [ 'description' => 'The maximum number of retries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], 'required' => false, ], ], [ 'name' => 'QueueType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'TenantRateLimitPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Enabled' => [ 'type' => 'boolean', ], 'MaxReceivesPerSecond' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => 'CreateQueue', ], 'SetQueueAttributes' => [ 'summary' => 'Modifies a queue.', '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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testqueue', ], ], [ 'name' => 'DelaySeconds', 'in' => 'query', 'schema' => [ 'description' => 'The period after which all messages sent to the queue are consumed. Valid values: 0 to 604800. Unit: seconds. Default value: 0'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'MaximumMessageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum length of the message that is sent to the queue. Valid values: 1024 to 65536. Unit: bytes. Default value: 65536.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024', ], ], [ 'name' => 'MessageRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The maximum duration for which a message is retained in the queue. After the specified retention period ends, the message is deleted regardless of whether the message is received. Valid values: 60 to 604800. Unit: seconds. Default value: 345600.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '120', ], ], [ 'name' => 'VisibilityTimeout', 'in' => 'query', 'schema' => [ 'description' => 'The duration for which a message stays in the Inactive state after the message is received from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', ], ], [ 'name' => 'PollingWaitSeconds', 'in' => 'query', 'schema' => [ 'description' => 'The maximum duration for which long polling requests are held after the ReceiveMessage operation is called. Valid values: 0 to 30. Unit: seconds. Default value: 0'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'EnableLogging', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the log management feature. Valid values:'."\n" ."\n" .'* true: enabled.'."\n" .'* false: disabled. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'True', ], ], [ 'name' => 'DlqPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The dead-letter queue policy.'."\n", 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.'."\n", 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue', ], 'MaxReceiveCount' => [ 'description' => 'The maximum number of retries.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], ], 'required' => false, ], ], [ 'name' => 'TenantRateLimitPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Enabled' => [ 'type' => 'boolean', ], 'MaxReceivesPerSecond' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => 'SetQueueAttributes', ], 'GetQueueAttributes' => [ 'summary' => 'Queries the attributes of an existing queue.', '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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo-queue', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'QueueName' => [ 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'example' => 'demo-queue', ], 'CreateTime' => [ 'description' => 'The time when the queue was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', ], 'LastModifyTime' => [ 'description' => 'The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', ], 'DelaySeconds' => [ 'description' => 'The period after which all messages sent to the queue are consumed. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'MaximumMessageSize' => [ 'description' => 'The maximum length of the message that is sent to the queue. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '65536', ], 'MessageRetentionPeriod' => [ 'description' => 'The maximum duration for which a message is retained in the queue. After the specified retention period ends, the message is deleted regardless of whether the message is received. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '65536', ], 'VisibilityTimeout' => [ 'description' => 'The duration for which a message stays in the Inactive state after the message is received from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], 'PollingWaitSeconds' => [ 'description' => 'The maximum duration for which long polling requests are held after the ReceiveMessage operation is called. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'ActiveMessages' => [ 'description' => 'The total number of messages that are in the Active state in the queue. The value is an approximate value. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'InactiveMessages' => [ 'description' => 'The total number of messages that are in the Inactive state in the queue. The value is an approximate value. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DelayMessages' => [ 'description' => 'The total number of messages that are in the Delayed state in the queue. The value is an approximate value. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'LoggingEnabled' => [ 'description' => 'Indicates whether the logging feature is enabled. Valid values:'."\n" ."\n" .'* True'."\n" .'* False'."\n", 'type' => 'boolean', 'example' => 'True', ], 'Tags' => [ 'description' => 'The tag.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'tag1', ], 'TagValue' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], 'DlqPolicy' => [ 'description' => 'The dead-letter queue policy.'."\n", 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.'."\n", 'type' => 'string', 'example' => 'deadLetterTargetQueue', ], 'MaxReceiveCount' => [ 'description' => 'The maximum number of retries.'."\n", 'type' => 'string', 'example' => '3', ], ], ], 'TenantRateLimitPolicy' => [ 'type' => 'object', 'properties' => [ 'Enabled' => [ 'type' => 'boolean', ], 'MaxReceivesPerSecond' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], 'QueueType' => [ 'type' => 'string', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"QueueName\\": \\"demo-queue\\",\\n \\"CreateTime\\": 1250700999,\\n \\"LastModifyTime\\": 1250700999,\\n \\"DelaySeconds\\": 30,\\n \\"MaximumMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 65536,\\n \\"VisibilityTimeout\\": 60,\\n \\"PollingWaitSeconds\\": 0,\\n \\"ActiveMessages\\": 0,\\n \\"InactiveMessages\\": 0,\\n \\"DelayMessages\\": 0,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\",\\n \\"MaxReceiveCount\\": \\"3\\"\\n },\\n \\"TenantRateLimitPolicy\\": {\\n \\"Enabled\\": true,\\n \\"MaxReceivesPerSecond\\": 1000\\n },\\n \\"QueueType\\": \\"normal\\"\\n }\\n}","type":"json"}]', 'title' => 'GetQueueAttributes', ], 'DeleteQueue' => [ 'summary' => 'Deletes a queue.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREmnsXP7W6E', ], ], 'parameters' => [ [ 'name' => 'QueueName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tf-testAccMNSQueue-525478433321945943', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => 'DeleteQueue', ], 'ListQueue' => [ 'summary' => 'Queries all queues that belong to an Alibaba Cloud account. The queues are displayed by page.', '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. Valid values: 1 to 100000000. If you set this parameter to a value smaller than 1, the value of this parameter is 1 by default. If you set this parameter to a value greater than 100000000, the value of this parameter is 100000000 by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Value values: 10 to 50. If you set this parameter to a value smaller than 10, the value of this parameter is 10 by default. If you set this parameter to a value greater than 50, the value of this parameter is 50 by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'QueueName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demo-queue', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag1', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 1, ], ], [ 'name' => 'QueueType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'Size' => [ 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Pages' => [ 'description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'Total' => [ 'description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '130', ], 'PageData' => [ 'description' => 'The data returned on the current page.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data entries.'."\n", 'type' => 'object', 'properties' => [ 'QueueName' => [ 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'example' => 'demo-queue', ], 'CreateTime' => [ 'description' => 'The time when the queue was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', ], 'LastModifyTime' => [ 'description' => 'The time when the queue was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1250700999', ], 'DelaySeconds' => [ 'description' => 'The period after which all messages sent to the queue are consumed. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'MaximumMessageSize' => [ 'description' => 'The maximum length of the message that is sent to the queue. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '65536', ], 'MessageRetentionPeriod' => [ 'description' => 'The maximum duration for which a message is retained in the queue. After the specified retention period ends, the message is deleted regardless of whether the message is received. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '65536', ], 'VisibilityTimeout' => [ 'description' => 'The duration for which a message stays in the Inactive state after the message is received from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], 'PollingWaitSeconds' => [ 'description' => 'The maximum duration for which long polling requests are held after the ReceiveMessage operation is called. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'ActiveMessages' => [ 'description' => 'The total number of messages that are in the Active state in the queue. The value is an approximate number. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'InactiveMessages' => [ 'description' => 'The total number of the messages that are in the Inactive state in the queue. The value is an approximate number. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DelayMessages' => [ 'description' => 'The total number of the messages that are in the Delayed state in the queue. The value is an approximate number. Default value: 0. We recommend that you do not use the return value and that you call CloudMonitor API operations to query the metric value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'LoggingEnabled' => [ 'description' => 'Indicates whether the logging feature is enabled. Valid values:'."\n" ."\n" .'* True'."\n" .'* False'."\n", 'type' => 'boolean', 'example' => 'True', ], 'Tags' => [ 'description' => 'The tags added to the resources.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'tag1', ], 'TagValue' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], 'DlqPolicy' => [ 'description' => 'The dead-letter queue policy.'."\n", 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.'."\n", 'type' => 'string', 'example' => 'deadLetterTargetQueue', ], 'MaxReceiveCount' => [ 'description' => 'The maximum number of retries.'."\n", 'type' => 'string', 'example' => '3', ], ], ], 'QueueType' => [ 'type' => 'string', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"QueueName\\": \\"demo-queue\\",\\n \\"CreateTime\\": 1250700999,\\n \\"LastModifyTime\\": 1250700999,\\n \\"DelaySeconds\\": 30,\\n \\"MaximumMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 65536,\\n \\"VisibilityTimeout\\": 60,\\n \\"PollingWaitSeconds\\": 0,\\n \\"ActiveMessages\\": 0,\\n \\"InactiveMessages\\": 0,\\n \\"DelayMessages\\": 0,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\",\\n \\"MaxReceiveCount\\": \\"3\\"\\n },\\n \\"QueueType\\": \\"normal\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListQueue', ], 'Subscribe' => [ 'summary' => 'Creates a subscription to 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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'SubscriptionName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the subscription.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testSubscription ', ], ], [ 'name' => 'PushType', 'in' => 'query', 'schema' => [ 'description' => 'The terminal type. Valid values:'."\n" ."\n" .'* http: HTTP services'."\n" .'* queue: queues'."\n" .'* mpush: mobile devices'."\n" .'* alisms: Alibaba Cloud Short Message Service (SMS)'."\n" .'* email: emails'."\n", 'type' => 'string', 'required' => true, 'example' => 'queue', ], ], [ 'name' => 'Endpoint', 'in' => 'query', 'schema' => [ 'description' => 'The receiver endpoint. The format of the endpoint varies based on the terminal type.'."\n" ."\n" .'* If you set PushType to http, set Endpoint to an `HTTP URL that starts with http:// or https://`.'."\n" .'* If you set PushType to queue, set Endpoint to a `queue name`.'."\n" .'* If you set PushType to mpush, set Endpoint to an `AppKey`.'."\n" .'* If you set PushType to alisms, set Endpoint to a `mobile number`.'."\n" .'* If you set PushType to email, set Endpoint to an `email address`.'."\n", 'type' => 'string', 'required' => true, 'example' => 'http://example.com', ], ], [ 'name' => 'NotifyStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The retry policy that is applied if an error occurs when Message Service (MNS) pushes messages to the endpoint. Valid values:'."\n" ."\n" .'* BACKOFF_RETRY'."\n" .'* EXPONENTIAL_DECAY_RETRY'."\n", 'type' => 'string', 'required' => false, 'example' => 'BACKOFF_RETRY', ], ], [ 'name' => 'NotifyContentFormat', 'in' => 'query', 'schema' => [ 'description' => 'The content format of the messages that are pushed to the endpoint. Valid values:'."\n" ."\n" .'* XML'."\n" .'* JSON'."\n" .'* SIMPLIFIED'."\n", 'type' => 'string', 'required' => false, 'example' => 'XML', ], ], [ 'name' => 'MessageTag', 'in' => 'query', 'schema' => [ 'description' => 'The tag that is used to filter messages. Only messages that have the same tag can be pushed. Set the value to a string of no more than 16 characters.'."\n" ."\n" .'By default, no tag is specified to filter messages.'."\n", 'type' => 'string', 'required' => false, 'example' => 'important', ], ], [ 'name' => 'DlqPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The dead-letter queue policy.'."\n", 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.'."\n", 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue', ], ], 'required' => false, ], ], [ 'name' => 'TenantRateLimitPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Enabled' => [ 'type' => 'boolean', ], 'MaxReceivesPerSecond' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], [ 'name' => 'StsRoleArn', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'DmAttributes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'AccountName' => [ 'type' => 'string', ], 'Subject' => [ 'type' => 'string', ], ], ], ], [ 'name' => 'DysmsAttributes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'TemplateCode' => [ 'type' => 'string', ], 'SignName' => [ 'type' => 'string', ], ], ], ], [ 'name' => 'KafkaAttributes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'BusinessMode' => [ 'type' => 'string', ], ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'string', 'example' => '{\'Code\': 200, \'Success\': True}', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"{\'Code\': 200, \'Success\': True}\\"\\n}","type":"json"}]', 'title' => 'Subscribe', ], 'SetSubscriptionAttributes' => [ 'summary' => 'Modifies the attributes of a subscription.', '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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'SubscriptionName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the subscription.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySubscription', ], ], [ 'name' => 'NotifyStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The retry policy that is applied if an error occurs when Message Service (MNS) pushes messages to the endpoint. Valid values:'."\n" ."\n" .'* BACKOFF_RETRY'."\n" .'* EXPONENTIAL_DECAY_RETRY'."\n", 'type' => 'string', 'required' => false, 'example' => 'BACKOFF_RETRY', ], ], [ 'name' => 'DlqPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The dead-letter queue policy.'."\n", 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.'."\n", 'type' => 'string', 'required' => false, 'example' => 'deadLetterTargetQueue', ], ], 'required' => false, ], ], [ 'name' => 'TenantRateLimitPolicy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Enabled' => [ 'type' => 'boolean', ], 'MaxReceivesPerSecond' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], [ 'name' => 'StsRoleArn', 'in' => 'query', 'schema' => [ 'title' => 'STS角色ARN', 'type' => 'string', 'example' => 'acs:ram::1234567890:role/roleName', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => 'SetSubscriptionAttributes', ], 'GetSubscriptionAttributes' => [ 'summary' => 'Queries the attributes 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.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MyTopic', ], ], [ 'name' => 'SubscriptionName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the subscription.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySubscription', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'SubscriptionName' => [ 'description' => 'The name of the subscription.'."\n", 'type' => 'string', 'example' => 'MySubscription', ], 'TopicOwner' => [ 'description' => 'The Alibaba Cloud account ID of the topic owner.'."\n", 'type' => 'string', 'example' => '123456789098****', ], 'TopicName' => [ 'description' => 'The name of the topic.'."\n", 'type' => 'string', 'example' => 'MyTopic', ], 'Endpoint' => [ 'description' => 'The endpoint to which the messages are pushed.'."\n", 'type' => 'string', 'example' => 'http://example.com', ], 'FilterTag' => [ 'description' => 'The tag that is used to filter messages. Only the messages that are attached with the specified tag can be pushed.'."\n", 'type' => 'string', 'example' => 'important', ], 'CreateTime' => [ 'description' => 'The time when the subscription was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806', ], 'LastModifyTime' => [ 'description' => 'The time when the subscription was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554962', ], 'NotifyStrategy' => [ 'description' => 'The retry policy that is applied if an error occurs when Message Service (MNS) pushes messages to the endpoint. Valid values:'."\n" ."\n" .'* BACKOFF_RETRY'."\n" .'* EXPONENTIAL_DECAY_RETRY'."\n", 'type' => 'string', 'example' => 'BACKOFF_RETRY', ], 'NotifyContentFormat' => [ 'description' => 'The content format of the messages that are pushed to the endpoint. Valid values:'."\n" ."\n" .'* XML'."\n" .'* JSON'."\n" .'* SIMPLIFIED'."\n", 'type' => 'string', 'example' => 'XML', ], 'DlqPolicy' => [ 'description' => 'The dead-letter queue policy.'."\n", 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.'."\n", 'type' => 'string', 'example' => 'deadLetterTargetQueue', ], ], ], 'TenantRateLimitPolicy' => [ 'type' => 'object', 'properties' => [ 'Enabled' => [ 'type' => 'boolean', ], 'MaxReceivesPerSecond' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554962,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\"\\n },\\n \\"TenantRateLimitPolicy\\": {\\n \\"Enabled\\": true,\\n \\"MaxReceivesPerSecond\\": 0\\n }\\n }\\n}","type":"json"}]', 'title' => 'GetSubscriptionAttributes', ], 'Unsubscribe' => [ 'summary' => 'Deletes a subscription.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '121398', 'abilityTreeNodes' => [ 'FEATUREmnsSAU1G7', ], ], 'parameters' => [ [ 'name' => 'TopicName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the topic.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'SubscriptionName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the subscription.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySubscription', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => 'Unsubscribe', ], 'ListSubscriptionByTopic' => [ 'summary' => 'Queries all subscriptions to a topic. The subscriptions are displayed by page.', '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.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Valid values: 1 to 100000000. If you set this parameter to a value smaller than 1, the value of this parameter is 1 by default. If you set this parameter to a value greater than 100000000, the value of this parameter is 100000000 by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Value values: 10 to 50. If you set this parameter to a value smaller than 10, the value of this parameter is 10 by default. If you set this parameter to a value greater than 50, the value of this parameter is 50 by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'SubscriptionName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the subscription.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demo-subscription', ], ], [ 'name' => 'EndpointType', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'EndpointValue', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The response code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'Size' => [ 'description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Pages' => [ 'description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'Total' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '130', ], 'PageData' => [ 'description' => 'The data returned on the current page.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data entries.'."\n", 'type' => 'object', 'properties' => [ 'SubscriptionName' => [ 'description' => 'The name of the subscription.'."\n", 'type' => 'string', 'example' => 'MySubscription', ], 'TopicOwner' => [ 'description' => 'The Alibaba Cloud account ID of the topic owner.'."\n", 'type' => 'string', 'example' => '123456789098****', ], 'TopicName' => [ 'description' => 'The name of the topic.'."\n", 'type' => 'string', 'example' => 'MyTopic', ], 'Endpoint' => [ 'description' => 'The endpoint to which the messages are pushed.'."\n", 'type' => 'string', 'example' => 'http://example.com', ], 'FilterTag' => [ 'description' => 'The tag that is used to filter messages. Only the messages that are attached with the specified tag can be pushed.'."\n", 'type' => 'string', 'example' => 'important'."\n", ], 'CreateTime' => [ 'description' => 'The time when the subscription was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806'."\n", ], 'LastModifyTime' => [ 'description' => 'The time when the subscription was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1449554806'."\n", ], 'NotifyStrategy' => [ 'description' => 'The retry policy that is applied if an error occurs when Message Service (MNS) pushes messages to the endpoint. Valid values:'."\n" ."\n" .'* BACKOFF_RETRY'."\n" .'* EXPONENTIAL_DECAY_RETRY'."\n", 'type' => 'string', 'example' => 'BACKOFF_RETRY', ], 'NotifyContentFormat' => [ 'description' => 'The content format of the messages that are pushed to the endpoint. Valid values:'."\n" ."\n" .'* XML'."\n" .'* JSON'."\n" .'* SIMPLIFIED'."\n", 'type' => 'string', 'example' => 'XML', ], 'DlqPolicy' => [ 'description' => 'The dead-letter queue policy.', 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => 'Specifies whether to enable the dead-letter message delivery.', 'type' => 'boolean', 'example' => 'true', ], 'DeadLetterTargetQueue' => [ 'description' => 'The queue to which dead-letter messages are delivered.', 'type' => 'string', 'example' => 'dead-letter-queue', ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\\\n\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554806,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"dead-letter-queue\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListSubscriptionByTopic', ], 'DisableEndpoint' => [ 'summary' => 'You can call this operation to disenable the endpoint of a type. After the endpoint is disabled, all requests from the endpoint are blocked and an error is returned.', '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. Value:'."\n" ."\n" .'* **public**: indicates an public endpoint. (Only the public endpoint is supported.)'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'public' => 'public', ], 'example' => 'public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DisableEndpoint', ], 'EnableEndpoint' => [ 'summary' => 'You can call this operation to enable the endpoint of a type. If the endpoint is enabled, requests from the endpoint that are included in the access control lists (ACLs) 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**: indicates public endpoint. (Only the public is supported.)'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'public' => 'public', ], 'example' => 'public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'EnableEndpoint', ], 'GetEndpointAttribute' => [ 'summary' => 'GetEndpointAttribute', '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. Value:'."\n" ."\n" .'* **public**: indicates public endpoint. (Only the public is supported.)'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'public' => 'public', ], 'example' => 'public', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => 'The response data.'."\n", 'type' => 'object', 'properties' => [ 'EndpointEnabled' => [ 'description' => 'Specifies whether the endpoint is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'CidrList' => [ 'description' => 'The list of CIDR block.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block.'."\n", 'type' => 'object', 'properties' => [ 'Cidr' => [ 'description' => 'The CIDR block.'."\n", 'type' => 'string', 'example' => '172.18.0.0/24', ], 'CreateTime' => [ 'description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1701951224000', ], 'AclStrategy' => [ 'description' => 'The ACL policy. Valid values:'."\n" ."\n" .'* **allow**: indicates that the current endpoint allows access from the corresponding CIDR block. (Only allow is supported.)'."\n", 'type' => 'string', 'example' => 'allow', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"EndpointEnabled\\": true,\\n \\"CidrList\\": [\\n {\\n \\"Cidr\\": \\"172.18.0.0/24\\",\\n \\"CreateTime\\": 1701951224000,\\n \\"AclStrategy\\": \\"allow\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'GetEndpointAttribute', ], 'RevokeEndpointAcl' => [ 'summary' => 'You can call this operation to delete one or more ACL rules for the endpoint of a specified 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 type of the endpoint. Valid values:'."\n" ."\n" .'* **public**: indicates public endpoint. (Only the public is supported.)'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'public' => 'public', ], 'example' => 'public', ], ], [ 'name' => 'AclStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The ACL policy. Value:'."\n" ."\n" .'* **allow**: indicates that this operation is included in the Cidr whitelist. (Only the allow is supported.)'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'allow' => 'allow', ], 'example' => 'allow', ], ], [ 'name' => 'CidrList', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The list of CIDR block.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.1.1/24', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'RevokeEndpointAcl', ], 'AuthorizeEndpointAcl' => [ 'summary' => 'You can call this operation to add one or more access control list (ACL) rules for the 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 values:'."\n" ."\n" .'* **public**: indicates public endpoint. (Only the public endpoint is supported.)'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'public' => 'public', ], 'example' => 'public', ], ], [ 'name' => 'AclStrategy', 'in' => 'query', 'schema' => [ 'description' => 'The ACL policy. Valid values:'."\n" ."\n" .'* **allow**: indicates that this operation is included in the Cidr whitelist. (Only the allow is supported.)'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'allow' => 'allow', ], 'example' => 'allow', ], ], [ 'name' => 'CidrList', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The list of CIDR block.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CIDR block.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.1.1/24', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => 'The response status.'."\n", 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'AuthorizeEndpointAcl', ], 'GetEventRule' => [ 'summary' => 'The GetEventRule operation obtains event notification rules.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '273196', 'abilityTreeNodes' => [ 'FEATUREmnsT1OLHP', ], ], 'parameters' => [ [ 'name' => 'ProductName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'oss', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'True', ], 'Data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RuleName' => [ 'description' => '', 'type' => 'string', 'example' => 'event-recorder', ], 'EventTypes' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '["oss:ObjectModified:UpdateObjectMeta"]', ], ], 'MatchRules' => [ 'title' => '事件匹配规则,or 关系', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', '$ref' => '#/components/schemas/EventMatchRule', ], ], ], 'Subscriptions' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '', 'type' => 'string', 'example' => 'queue', ], 'EndpointValue' => [ 'description' => '', 'type' => 'string', 'example' => 'retry-queue', ], ], ], ], 'TopicName' => [ 'description' => '', 'type' => 'string', 'example' => 'demo-topic', ], 'Endpoint' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '', 'type' => 'string', 'example' => 'queue', ], 'EndpointValue' => [ 'description' => '', 'type' => 'string', 'example' => 'retry-queue', ], ], ], 'DeliveryMode' => [ 'description' => '', 'type' => 'string', 'example' => '--', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RuleName\\": \\"event-recorder\\",\\n \\"EventTypes\\": [\\n \\"[\\\\\\"oss:ObjectModified:UpdateObjectMeta\\\\\\"]\\"\\n ],\\n \\"MatchRules\\": [\\n [\\n {\\n \\"MatchState\\": true,\\n \\"Name\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"Suffix\\": \\"\\"\\n }\\n ]\\n ],\\n \\"Subscriptions\\": [\\n {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"retry-queue\\"\\n }\\n ],\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"Endpoint\\": {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"retry-queue\\"\\n },\\n \\"DeliveryMode\\": \\"--\\"\\n }\\n}","type":"json"}]', 'title' => 'GetEventRule', ], 'ListEventRules' => [ 'summary' => '查询事件通知列表', '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' => '', 'type' => 'string', 'required' => false, 'example' => 'oss', ], ], [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => [ 'title' => '匹配规则中的资源名称，用于过滤规则，例：oss 中，此为 oss bucketName', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test-bucket', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'title' => '规则名称', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rule-xsXDW', ], ], [ 'name' => 'TopicName', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test-topic', ], ], [ 'name' => 'Subscription', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'topic', ], 'EndpointValue' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test-topic', ], ], 'required' => false, ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cd7NlPlX4kgKCdsCWMiMR/+HnVzPLQ4/XLvjR64jZ7F9AQ+Mr3T59J6IVkuXeV3w', ], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123E62C', ], 'Code' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'Size' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Pages' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'Total' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '130', ], 'NextToken' => [ 'description' => '', 'type' => 'string', 'example' => 'a88f58d504b8b4c4e0b5e8707e68181f', ], 'MaxResults' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageData' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RuleName' => [ 'description' => '', 'type' => 'string', 'example' => 'rule-xsXDW', ], 'Subscriptions' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '', 'type' => 'string', 'example' => 'queue', ], 'EndpointValue' => [ 'description' => '', 'type' => 'string', 'example' => 'wyx-vp-complete-queue', ], ], ], ], 'TopicName' => [ 'description' => '', 'type' => 'string', 'example' => 'demo-topic', ], 'MatchRules' => [ 'title' => '事件匹配规则,or 关系', 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'example' => '[[{\\"MatchState\\":true,\\"Prefix\\":\\"cdhxdev1cdh-bba-dto-052901-sem-5seh/\\",\\"Suffix\\":\\"\\"}]]', '$ref' => '#/components/schemas/EventMatchRule', ], ], ], 'EventTypes' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => '["oss:ObjectCreated:CopyObject"]', ], ], 'Endpoint' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '', 'type' => 'string', 'example' => 'topic', ], 'EndpointValue' => [ 'description' => '', 'type' => 'string', 'example' => 'test-topic', ], ], ], 'DeliveryMode' => [ 'description' => '', 'type' => 'string', 'example' => '--', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"NextToken\\": \\"a88f58d504b8b4c4e0b5e8707e68181f\\",\\n \\"MaxResults\\": 1,\\n \\"PageData\\": [\\n {\\n \\"RuleName\\": \\"rule-xsXDW\\",\\n \\"Subscriptions\\": [\\n {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"wyx-vp-complete-queue\\"\\n }\\n ],\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MatchRules\\": [\\n [\\n {\\n \\"MatchState\\": true,\\n \\"Name\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"Suffix\\": \\"\\"\\n }\\n ]\\n ],\\n \\"EventTypes\\": [\\n \\"[\\\\\\"oss:ObjectCreated:CopyObject\\\\\\"]\\"\\n ],\\n \\"Endpoint\\": {\\n \\"EndpointType\\": \\"topic\\",\\n \\"EndpointValue\\": \\"test-topic\\"\\n },\\n \\"DeliveryMode\\": \\"--\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'CreateEventRule' => [ 'summary' => 'Creates an event rule.', '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' => '', 'type' => 'string', 'required' => true, 'example' => 'oss', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW', ], ], [ 'name' => 'EventTypes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ObjectCreated:PutObject', ], 'required' => true, ], ], [ 'name' => 'MatchRules', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'required' => false, '$ref' => '#/components/schemas/EventMatchRule', ], 'required' => false, 'maxItems' => 6, ], 'required' => true, 'maxItems' => 10, ], ], [ 'name' => 'Endpoints', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'http' => 'http', 'topic' => 'topic', 'queue' => 'queue', ], 'example' => 'http', ], 'EndpointValue' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test-xxx-queue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 10, ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'Endpoint', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'type' => 'string', ], 'EndpointValue' => [ 'type' => 'string', ], ], ], ], [ 'name' => 'DeliveryMode', 'in' => 'query', 'schema' => [ 'title' => '', 'type' => 'string', 'enum' => [ 'DIRECT', 'BROADCAST', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'Data' => [ 'description' => '', 'type' => 'string', 'example' => 'rule-xsXDW', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"rule-xsXDW\\"\\n}","type":"json"}]', 'title' => 'CreateEventRule', ], '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' => '', 'type' => 'string', 'required' => true, 'example' => 'oss', ], ], [ 'name' => 'RuleName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'rule-xsXDW', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '06273500-249F-5863-121D-74D51123****', ], 'Code' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Status' => [ 'description' => '', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '', 'type' => 'string', 'example' => 'operation success', ], 'Success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'DeleteEventRule', ], ], 'endpoints' => [ [ 'regionId' => 'cn-qingdao', 'endpoint' => 'mns-open.cn-qingdao.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'mns-open.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'mns-open.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'mns-open.cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'mns-open.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'mns-open.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'mns-open.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'mns-open.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'mns-open.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'mns-open.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'mns-open.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'mns-open.ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'mns-open.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'mns-open.us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'mns-open.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'mns-open.eu-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'mns-open.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'mns-open.me-east-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'mns-open.cn-hangzhou-finance.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'mns-open.cn-shanghai-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'mns-open.cn-shenzhen-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-zhengzhou-jva', 'endpoint' => 'mns-open.cn-zhengzhou-jva.aliyuncs.com', ], [ 'regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'mns-open.cn-heyuan-acdr-1.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'mns-open.cn-wulanchabu.aliyuncs.com', ], [ 'regionId' => 'cn-guangzhou', 'endpoint' => 'mns-open.cn-guangzhou.aliyuncs.com', ], [ 'regionId' => 'me-central-1', 'endpoint' => 'mns-open.me-central-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-7', 'endpoint' => 'mns-open.ap-southeast-7.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2', 'endpoint' => 'mns-open.ap-northeast-2.aliyuncs.com', ], [ 'regionId' => 'cn-heyuan', 'endpoint' => 'mns-open.cn-heyuan.aliyuncs.com', ], ], ];