'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Mns-open',
'version' => '2022-01-19',
],
'directories' => [
[
'id' => 320718,
'title' => '主题管理',
'type' => 'directory',
'children' => [
'CreateTopic',
'SetTopicAttributes',
'GetTopicAttributes',
'DeleteTopic',
'ListTopic',
],
],
[
'id' => 320724,
'title' => '队列管理',
'type' => 'directory',
'children' => [
'CreateQueue',
'SetQueueAttributes',
'GetQueueAttributes',
'DeleteQueue',
'ListQueue',
],
],
[
'id' => 320730,
'title' => '订阅管理',
'type' => 'directory',
'children' => [
'Subscribe',
'SetSubscriptionAttributes',
'GetSubscriptionAttributes',
'Unsubscribe',
'ListSubscriptionByTopic',
],
],
[
'id' => 320736,
'title' => '接入点管理',
'type' => 'directory',
'children' => [
'DisableEndpoint',
'EnableEndpoint',
'GetEndpointAttribute',
'RevokeEndpointAcl',
'AuthorizeEndpointAcl',
],
],
[
'id' => 320742,
'title' => '事件通知管理',
'type' => 'directory',
'children' => [
'GetEventRule',
'ListEventRules',
'CreateEventRule',
'DeleteEventRule',
],
],
],
'components' => [
'schemas' => [
'EventMatchRule' => [
'title' => '事件匹配规则对象',
'description' => '事件匹配规则-原子对象'."\n"
."\n"
.'注意：'."\n"
.'- 全名匹配规则：若此项填写，其他项均不可填写'."\n"
.'- 前缀匹配和后缀匹配： 这两项可填写任一一项，若都填写，即前后缀匹配',
'type' => 'object',
'properties' => [
'MatchState' => [
'title' => '是否匹配',
'description' => '是否匹配',
'type' => 'boolean',
'example' => 'true',
'default' => 'true',
],
'Name' => [
'title' => '全名',
'description' => '全名匹配规则',
'type' => 'string',
'example' => 'testBucket/folder1/file1',
],
'Prefix' => [
'title' => '前缀',
'description' => '前缀匹配规则',
'type' => 'string',
'example' => 'testBucket/prefix1xxx',
],
'Suffix' => [
'title' => '后缀',
'description' => '后缀匹配规则',
'type' => 'string',
'example' => 'suffix/xxxx.test',
],
],
],
],
],
'apis' => [
'CreateTopic' => [
'summary' => '调用CreateTopic接口创建主题。',
'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' => '需创建的topic的名称。',
'type' => 'string',
'required' => true,
'example' => 'test',
],
],
[
'name' => 'EnableLogging',
'in' => 'formData',
'schema' => [
'description' => '是否开启日志管理功能。取值说明如下：'."\n"
."\n"
.'- true：启用。'."\n"
."\n"
.'- false：停用。'."\n"
.'默认值：false。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'MaxMessageSize',
'in' => 'formData',
'schema' => [
'description' => '发送到该主题的消息体最大长度。'."\n"
.'取值范围：1024~ 65536，单位为Byte。'."\n"
.'默认值：65536。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10240',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签列表。'."\n",
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的key。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'TopicType',
'in' => 'query',
'schema' => [
'description' => '主题类型。可取值如下：'."\n"
.' * normal: 普通主题'."\n"
.' * fifo: FIFO主题',
'type' => 'string',
'required' => false,
'example' => 'normal',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123E62C',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => '无',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
'title' => '创建主题',
],
'SetTopicAttributes' => [
'summary' => '调用SetTopicAttributes接口来修改主题的属性。',
'methods' => [
'post',
],
'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' => 'Topic的名称。',
'type' => 'string',
'required' => true,
'example' => 'test',
],
],
[
'name' => 'EnableLogging',
'in' => 'query',
'schema' => [
'description' => '是否开启日志管理功能。取值说明如下：'."\n"
."\n"
.'- true：启用。'."\n"
."\n"
.'- false：停用。'."\n"
.'默认值：false。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'MaxMessageSize',
'in' => 'query',
'schema' => [
'description' => '发送到该主题的消息体最大长度。'."\n"
.'取值范围：1024~ 65536，单位为Byte。'."\n"
.'默认值：65536。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '65536',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => '无',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
'title' => '修改主题的属性',
],
'GetTopicAttributes' => [
'summary' => '调用GetTopicAttributes接口获取主题的属性。',
'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' => '主题的名称。',
'type' => 'string',
'required' => true,
'example' => 'demo-topic',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的key。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'TopicName' => [
'description' => '主题的名称。',
'type' => 'string',
'example' => 'demo-topic',
],
'MessageCount' => [
'description' => '当前该主题中消息数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxMessageSize' => [
'description' => '发送到该主题的消息体最大长度，单位为Byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '65536',
],
'MessageRetentionPeriod' => [
'description' => '消息在主题中最长存活时间，从发送到该主题开始经过此参数指定的时间后，不论消息是否被成功推送给用户都将被删除，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '86400',
],
'CreateTime' => [
'description' => '主题的创建时间，从1970-01-01 00:00:00到现在的时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554277',
],
'LastModifyTime' => [
'description' => '修改主题属性信息的最近时间，从1970-01-01 00:00:00到现在的时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554460',
],
'LoggingEnabled' => [
'description' => '是否开启日志管理功能。'."\n"
."\n"
.'- True：启用。'."\n"
."\n"
.'- False：停用。',
'type' => 'boolean',
'example' => 'True',
],
'Tags' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '标签的key。',
'type' => 'string',
'example' => 'tag1',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'TopicType' => [
'description' => '主题类型。可取值如下：'."\n"
.' * normal: 普通主题'."\n"
.' * fifo: FIFO主题',
'type' => 'string',
'example' => 'normal',
],
'TopicUrl' => [
'title' => '消息 Topic URL',
'description' => '消息 Topic URL',
'type' => 'string',
'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic',
],
'TopicInnerUrl' => [
'title' => '消息 Topic URL（内网访问）。',
'description' => '消息 Topic URL（内网访问）。',
'type' => 'string',
'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554277,\\n \\"LastModifyTime\\": 1449554460,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\",\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\"\\n }\\n}","type":"json"}]',
'title' => '获取主题的属性',
],
'DeleteTopic' => [
'summary' => '调用DeleteTopic接口删除主题。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121393',
'abilityTreeNodes' => [
'FEATUREmns5OVH2T',
],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => [
'description' => '需要删除的topic名称。',
'type' => 'string',
'required' => true,
'example' => 'tf-testAccMNSTopic-112965059402264645',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
'title' => '删除主题',
],
'ListTopic' => [
'summary' => '调用ListTopic接口查询阿里云账号下的主题列表，可分页获取数据。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '121394',
'abilityTreeNodes' => [
'FEATUREmnsSAU1G7',
],
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页页码，查询第几页的返回结果。'."\n"
.'取值范围：1~100000000。'."\n"
.'若您设置的参数值小于1，则系统默认按照参数值为1处理；若您设置的参数值大于100000000，则系统默认按照参数值为100000000处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小，每页最多显示的返回结果数量。'."\n"
.'取值范围：10~50。'."\n"
.'若您设置的参数值小于10，则系统默认按照参数值为10处理；若您设置的参数值大于50，则系统默认按照参数值为50处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'TopicName',
'in' => 'query',
'schema' => [
'description' => '主题的名称。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的key。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'TopicType',
'in' => 'query',
'schema' => [
'description' => '主题类型。可取值如下：'."\n"
.' * normal: 普通主题'."\n"
.' * fifo: FIFO主题',
'type' => 'string',
'required' => false,
'example' => 'normal',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '分页页码，查询第几页的返回结果。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小，每页最多显示的返回结果数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'Total' => [
'description' => '总结果数。',
'type' => 'integer',
'format' => 'int64',
'example' => '130',
],
'PageData' => [
'description' => '当前页返回结果。',
'type' => 'array',
'items' => [
'description' => '数据项',
'type' => 'object',
'properties' => [
'TopicName' => [
'description' => '主题的名称。',
'type' => 'string',
'example' => 'demo-topic',
],
'MessageCount' => [
'description' => '当前该主题中消息数目。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxMessageSize' => [
'description' => '发送到该主题的消息体最大长度，单位为Byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '65536',
],
'MessageRetentionPeriod' => [
'description' => '消息在主题中最长存活时间，从发送到该主题开始经过此参数指定的时间后，不论消息是否被成功推送给用户都将被删除，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '86400',
],
'CreateTime' => [
'description' => 'Subscription的创建时间，从1970-01-01 00:00:00到现在的。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554962',
],
'LastModifyTime' => [
'description' => '最近一次修改Subscription属性信息的时间，从1970-01-01 00:00:00到现在的秒值。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554962',
],
'LoggingEnabled' => [
'description' => '是否开启日志管理功能。'."\n"
."\n"
.'- True：启用。'."\n"
."\n"
.'- False：停用。',
'type' => 'boolean',
'example' => 'True',
],
'TopicUrl' => [
'description' => '消息Topic URL。',
'type' => 'string',
'example' => 'http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic',
],
'TopicInnerUrl' => [
'description' => '消息Topic URL（内网访问）。',
'type' => 'string',
'example' => 'http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic',
],
'Tags' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '标签的key。',
'type' => 'string',
'example' => 'tag1',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'TopicType' => [
'description' => '主题类型。可取值如下：'."\n"
.' * normal: 普通主题'."\n"
.' * fifo: FIFO主题',
'type' => 'string',
'example' => 'normal',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MessageCount\\": 0,\\n \\"MaxMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 86400,\\n \\"CreateTime\\": 1449554962,\\n \\"LastModifyTime\\": 1449554962,\\n \\"LoggingEnabled\\": true,\\n \\"TopicUrl\\": \\"http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic\\",\\n \\"TopicInnerUrl\\": \\"http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"TopicType\\": \\"normal\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询阿里云账号下的主题列表',
],
'CreateQueue' => [
'summary' => '调用CreateQueue接口创建一个新的队列。',
'methods' => [
'get',
'post',
],
'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' => '队列名称。',
'type' => 'string',
'required' => true,
'example' => '06273500-249F-5863-121D-74D51123****',
],
],
[
'name' => 'MaximumMessageSize',
'in' => 'query',
'schema' => [
'description' => '发送到该Queue的消息体的最大长度。'."\n"
.'取值范围：1024~65536，单位为Byte。'."\n"
.'默认值：65536。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '65536',
],
],
[
'name' => 'MessageRetentionPeriod',
'in' => 'query',
'schema' => [
'description' => '消息在该Queue中最长的存活时间，从发送到该队列开始经过此参数指定的时间后，不论消息是否被取出过都将被删除。'."\n"
.'取值范围：60~604800，单位为秒。'."\n"
.'默认值：345600。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '604800',
'minimum' => '60',
'example' => '345600',
],
],
[
'name' => 'VisibilityTimeout',
'in' => 'query',
'schema' => [
'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
.'取值范围：1~43200，单位为秒。'."\n"
.'默认值：30。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '60',
],
],
[
'name' => 'PollingWaitSeconds',
'in' => 'query',
'schema' => [
'description' => '当Queue中没有消息时，针对该Queue的ReceiveMessage请求最长的等待时间。'."\n"
.'取值范围：0~30，单位为秒。'."\n"
.'默认值：0。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'EnableLogging',
'in' => 'query',
'schema' => [
'description' => '是否开启日志管理功能。取值说明如下：'."\n"
."\n"
.'- true：启用。'."\n"
."\n"
.'- false：停用。'."\n"
."\n"
.'默认值：false。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'DelaySeconds',
'in' => 'query',
'schema' => [
'description' => '发送到该Queue的所有消息的延迟时间，发送到队列的消息经过此参数设定的延时时间后，才能被消费。'."\n"
.'取值范围：0~604800，单位为秒。'."\n"
.'默认值：0。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的key。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '死信策略。',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列。',
'type' => 'string',
'required' => false,
'example' => 'deadLetterQueue',
],
'MaxReceiveCount' => [
'description' => '消息最大投递次数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
],
'required' => false,
],
],
[
'name' => 'QueueType',
'in' => 'query',
'schema' => [
'description' => '队列类型。可取值如下：'."\n"
.' * normal: 普通队列'."\n"
.' * fifo: FIFO队列',
'type' => 'string',
'required' => false,
'example' => 'normal',
],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '限流策略',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否启用限流。取值范围：'."\n"
."\n"
.'- true'."\n"
.'- false',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'MaxReceivesPerSecond' => [
'description' => '每秒最大接收次数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1000',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123E62C',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => '无',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
'title' => '创建队列',
],
'SetQueueAttributes' => [
'summary' => '调用SetQueueAttributes接口修改队列属性。',
'methods' => [
'get',
'post',
],
'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' => 'Queue名称。',
'type' => 'string',
'required' => true,
'example' => 'testqueue',
],
],
[
'name' => 'DelaySeconds',
'in' => 'query',
'schema' => [
'description' => '发送到该Queue的所有消息的延迟时间，发送到队列的消息经过此参数设定的延时时间后，才能被消费。'."\n"
.'取值范围：0~604800，单位为秒。'."\n"
.'默认值：0。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'MaximumMessageSize',
'in' => 'query',
'schema' => [
'description' => '发送到该Queue的消息体的最大长度。'."\n"
.'取值范围：1024~65536，单位为Byte。'."\n"
.'默认值：65536。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1024',
],
],
[
'name' => 'MessageRetentionPeriod',
'in' => 'query',
'schema' => [
'description' => '消息在该Queue中最长的存活时间，从发送到该队列开始经过此参数指定的时间后，不论消息是否被取出过都将被删除。'."\n"
.'取值范围：60~604800，单位为秒。'."\n"
.'默认值：345600。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '120',
],
],
[
'name' => 'VisibilityTimeout',
'in' => 'query',
'schema' => [
'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
.'取值范围：1~43200，单位为秒。'."\n"
.'默认值：30。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '60',
],
],
[
'name' => 'PollingWaitSeconds',
'in' => 'query',
'schema' => [
'description' => '当Queue中没有消息时，针对该Queue的ReceiveMessage请求最长的等待时间。'."\n"
.'取值范围：0~30，单位为秒。'."\n"
.'默认值：0。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'EnableLogging',
'in' => 'query',
'schema' => [
'description' => '是否开启日志管理功能。取值说明如下：'."\n"
."\n"
.'- true：启用。'."\n"
."\n"
.'- false：停用。'."\n"
.'默认值：false。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列。',
'type' => 'string',
'required' => false,
'example' => 'deadLetterTargetQueue',
],
'MaxReceiveCount' => [
'description' => '消息最大投递次数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
],
'required' => false,
],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'Enabled' => [
'type' => 'boolean',
'required' => false,
],
'MaxReceivesPerSecond' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => '无',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
'title' => '修改队列属性',
],
'GetQueueAttributes' => [
'summary' => '获取某个已创建队列的属性。',
'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' => '队列名称。',
'type' => 'string',
'required' => true,
'example' => 'demo-queue',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的key。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'QueueName' => [
'description' => 'Queue的名称。',
'type' => 'string',
'example' => 'demo-queue',
],
'CreateTime' => [
'description' => 'Queue的创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1250700999',
],
'LastModifyTime' => [
'description' => '修改Queue属性信息最近时间，从1970-01-01 00:00:00到现在的时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1250700999',
],
'DelaySeconds' => [
'description' => '发送到该Queue的所有消息的延迟时间，发送到队列的消息经过此参数设定的延时时间后，才能被消费，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'MaximumMessageSize' => [
'description' => '发送到该Queue的消息体的最大长度，单位为Byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '65536',
],
'MessageRetentionPeriod' => [
'description' => '消息在该Queue中最长的存活时间，从发送到该队列开始经过此参数指定的时间后，不论消息是否被取出过都将被删除，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '65536',
],
'VisibilityTimeout' => [
'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
.'取值范围：1~43200，单位为秒。'."\n"
.'默认值：30。',
'type' => 'integer',
'format' => 'int64',
'example' => '60',
],
'PollingWaitSeconds' => [
'description' => '当Queue消息量为空时，针对该Queue的ReceiveMessage请求最长的等待时间，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ActiveMessages' => [
'description' => '在该Queue中处于Active状态的消息总数，为近似值。'."\n"
."\n"
.'后续会下线，默认为0，不推荐使用，请使用云监控api获取指标。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'InactiveMessages' => [
'description' => '在该Queue中处于Inactive状态的消息总数，为近似值。'."\n"
."\n"
.'后续会下线，默认为0，不推荐使用，请使用云监控api获取指标。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'DelayMessages' => [
'description' => '在该Queue中处于Delayed状态的消息总数，为近似值。'."\n"
."\n"
.'后续会下线，默认为0，不推荐使用，请使用云监控api获取指标。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'LoggingEnabled' => [
'description' => '是否开启日志管理功能。'."\n"
."\n"
.'- True：启用。'."\n"
."\n"
.'- False：停用。',
'type' => 'boolean',
'example' => 'True',
],
'Tags' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '标签的key。',
'type' => 'string',
'example' => 'tag1',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'DlqPolicy' => [
'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递。',
'type' => 'boolean',
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列。',
'type' => 'string',
'example' => 'deadLetterTargetQueue',
],
'MaxReceiveCount' => [
'description' => '消息最大投递次数。',
'type' => 'string',
'example' => '3',
],
],
],
'TenantRateLimitPolicy' => [
'description' => '限流策略',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否启用限流。取值范围：'."\n"
.'- true'."\n"
.'- false',
'type' => 'boolean',
'example' => 'true',
],
'MaxReceivesPerSecond' => [
'description' => '每秒最大接收次数',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
],
],
'QueueType' => [
'description' => '队列类型。可取值如下：'."\n"
.' * normal: 普通队列'."\n"
.' * fifo: FIFO队列',
'type' => 'string',
'example' => 'normal',
],
],
],
],
],
],
],
'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' => '获取队列属性',
'description' => '>'."\n"
.'为优化服务性能，轻量消息队列即将下线以下字段的返回值（后续默认为0）：
'."\n"
.' - ActiveMessages
'."\n"
.' - InactiveMessages
'."\n"
.' - DelayMessages
'."\n"
.'
'."\n"
.' 请通过以下方式获取替代方案：
'."\n"
.' '."\n"
.' - 使用云监控OpenAPI获取队列指标，请参考 云监控OpenAPI文档
'."\n"
.' - 云监控指标说明文档，替代字段对应关系：'."\n"
.'
'."\n"
.' - ActiveMessages → 云监控指标 NumberOfMessagesVisible
'."\n"
.' - InactiveMessages → 云监控指标 NumberOfMessagesInvisible
'."\n"
.' - DelayMessages → 云监控指标 NumberOfMessagesDelayed
'."\n"
.'
'."\n"
.' '."\n"
.'
'."\n"
.'',
],
'DeleteQueue' => [
'summary' => '调用DeleteQueue接口删除已创建的队列。',
'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' => '队列名称。',
'type' => 'string',
'required' => true,
'example' => 'tf-testAccMNSQueue-525478433321945943',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => '无',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
'title' => '删除队列',
],
'ListQueue' => [
'summary' => '调用ListQueue接口，列出指定阿里云账号下的所有队列，可分页获取数据。',
'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' => '分页页码，查询第几页的返回结果。'."\n"
.'取值范围：1~100000000。'."\n"
.'若您设置的参数值小于1，则系统默认按照参数值为1处理；若您设置的参数值大于100000000，则系统默认按照参数值为100000000处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小，每页最多显示的返回结果数量。'."\n"
.'取值范围：10~50。'."\n"
.'若您设置的参数值小于10，则系统默认按照参数值为10处理；若您设置的参数值大于50，则系统默认按照参数值为50处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'QueueName',
'in' => 'query',
'schema' => [
'description' => 'Queue名称。',
'type' => 'string',
'required' => false,
'example' => 'demo-queue',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签的key。',
'type' => 'string',
'required' => false,
'example' => 'tag1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'QueueType',
'in' => 'query',
'schema' => [
'description' => '队列类型。可取值如下：'."\n"
.' * normal: 普通队列'."\n"
.' * fifo: FIFO队列',
'type' => 'string',
'required' => false,
'example' => 'normal',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '分页页码，查询第几页的返回结果。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小，每页最多显示的返回结果数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'Size' => [
'description' => '当前页结果数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Pages' => [
'description' => '总页数',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'Total' => [
'description' => '总结果数。',
'type' => 'integer',
'format' => 'int64',
'example' => '130',
],
'PageData' => [
'description' => '当前页返回结果。',
'type' => 'array',
'items' => [
'description' => '数据项。',
'type' => 'object',
'properties' => [
'QueueName' => [
'description' => '队列名称。',
'type' => 'string',
'example' => 'demo-queue',
],
'CreateTime' => [
'description' => 'Queue的创建事件，从1970-01-01 00:00:00到现在的时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1250700999',
],
'LastModifyTime' => [
'description' => '修改Queue属性信息最近时间，从1970-01-01 00:00:00到现在的时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1250700999',
],
'DelaySeconds' => [
'description' => '发送到该Queue的所有消息的延迟时间，发送到队列的消息经过此参数设定的延时时间后，才能被消费，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'MaximumMessageSize' => [
'description' => '发送到该Queue的消息体的最大长度，单位为Byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '65536',
],
'MessageRetentionPeriod' => [
'description' => '消息在该Queue中最长的存活时间，从发送到该队列开始经过此参数指定的时间后，不论消息是否被取出过都将被删除，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '65536',
],
'VisibilityTimeout' => [
'description' => '消息从该Queue中取出后从Active状态变成Inactive状态后的持续时间。'."\n"
.'取值范围：1~43200，单位为秒。'."\n"
.'默认值：30。',
'type' => 'integer',
'format' => 'int64',
'example' => '60',
],
'PollingWaitSeconds' => [
'description' => '当Queue消息量为空时，针对该Queue的ReceiveMessage请求最长的等待时间，单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ActiveMessages' => [
'description' => '在该Queue中处于Active状态的消息总数，为近似值。'."\n"
.'后续会默认为0，不推荐使用，辛苦用云监控api获取指标',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'InactiveMessages' => [
'description' => '在该Queue中处于Inactive状态的消息总数，为近似值。'."\n"
.'后续会默认为0，不推荐使用，辛苦用云监控api获取指标。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'DelayMessages' => [
'description' => '在该Queue中处于Delayed状态的消息总数，为近似值。'."\n"
.'后续会默认为0，不推荐使用，辛苦用云监控api获取指标。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'LoggingEnabled' => [
'description' => '是否开启日志管理功能。'."\n"
."\n"
.'- True：启用。'."\n"
."\n"
.'- False：停用。',
'type' => 'boolean',
'example' => 'True',
],
'Tags' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '标签键对应的标签值。',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '标签的key。',
'type' => 'string',
'example' => 'tag1',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'test',
],
],
],
],
'DlqPolicy' => [
'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递。',
'type' => 'boolean',
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列。',
'type' => 'string',
'example' => 'deadLetterTargetQueue',
],
'MaxReceiveCount' => [
'description' => '消息最大投递次数。',
'type' => 'string',
'example' => '3',
],
],
],
'QueueType' => [
'description' => '队列类型。可取值如下：'."\n"
.' * normal: 普通队列'."\n"
.' * fifo: FIFO队列',
'type' => 'string',
'example' => 'normal',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"QueueName\\": \\"demo-queue\\",\\n \\"CreateTime\\": 1250700999,\\n \\"LastModifyTime\\": 1250700999,\\n \\"DelaySeconds\\": 30,\\n \\"MaximumMessageSize\\": 65536,\\n \\"MessageRetentionPeriod\\": 65536,\\n \\"VisibilityTimeout\\": 60,\\n \\"PollingWaitSeconds\\": 0,\\n \\"ActiveMessages\\": 0,\\n \\"InactiveMessages\\": 0,\\n \\"DelayMessages\\": 0,\\n \\"LoggingEnabled\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"test\\"\\n }\\n ],\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\",\\n \\"MaxReceiveCount\\": \\"3\\"\\n },\\n \\"QueueType\\": \\"normal\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '列出指定阿里云账号下的所有队列',
],
'Subscribe' => [
'summary' => '调用Subscribe接口，为主题创建Subscription。',
'methods' => [
'get',
'post',
],
'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' => '主题的名称。',
'type' => 'string',
'required' => true,
'example' => 'topic****1',
],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => [
'description' => '订阅名称。',
'type' => 'string',
'required' => true,
'example' => 'testSubscription ',
],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => [
'description' => '终端类型。'."\n"
."\n"
.'- http：HTTP推送类型。'."\n"
."\n"
.'- queue：队列推送类型。'."\n"
."\n"
.'- mpush：移动推送类型。'."\n"
."\n"
.'- alisms：阿里短信推送类型。'."\n"
."\n"
.'- email：邮箱推送类型。',
'type' => 'string',
'required' => true,
'example' => 'queue',
],
],
[
'name' => 'Endpoint',
'in' => 'query',
'schema' => [
'description' => '此次订阅中接收消息的终端地址，不同终端类型的格式如下：'."\n"
.'- HTTP格式为： `http(s)://{实际url地址}`'."\n"
.'- 队列格式为： `{QueueName}`'."\n"
.'- 移动推送格式为： `{AppKey}`'."\n"
.'- 阿里短信格式为： `{phoneNumber}`'."\n"
.'- 邮箱格式为： `{emailAddress}`',
'type' => 'string',
'required' => true,
'example' => 'http://*****.com/uri1/xxx',
],
],
[
'name' => 'NotifyStrategy',
'in' => 'query',
'schema' => [
'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下：'."\n"
."\n"
.'- BACKOFF_RETRY：退避重试。'."\n"
."\n"
.'- EXPONENTIAL_DECAY_RETRY：指数衰减重试。',
'type' => 'string',
'required' => false,
'example' => 'BACKOFF_RETRY',
],
],
[
'name' => 'NotifyContentFormat',
'in' => 'query',
'schema' => [
'description' => '用于定义向Endpoint推送的消息格式。'."\n"
.'取值说明如下：'."\n"
."\n"
.'- XML'."\n"
."\n"
.'- JSON'."\n"
."\n"
.'- SIMPLIFIED',
'type' => 'string',
'required' => false,
'example' => 'XML',
],
],
[
'name' => 'MessageTag',
'in' => 'query',
'schema' => [
'description' => '该订阅中消息过滤的标签（标签一致的消息才会被推送）。'."\n"
.'取值范围：不超过16个字符的字符串。'."\n"
."\n"
.'默认不进行消息过滤。',
'type' => 'string',
'required' => false,
'example' => 'important',
],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列。',
'type' => 'string',
'required' => false,
'example' => 'deadLetterTargetQueue',
],
],
'required' => false,
],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'Enabled' => [
'type' => 'boolean',
'required' => false,
],
'MaxReceivesPerSecond' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'StsRoleArn',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DmAttributes',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'AccountName' => [
'type' => 'string',
'required' => false,
],
'Subject' => [
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'DysmsAttributes',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'TemplateCode' => [
'type' => 'string',
'required' => false,
],
'SignName' => [
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'KafkaAttributes',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'BusinessMode' => [
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'string',
'example' => '{\'Code\': 200, \'Success\': True}',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"{\'Code\': 200, \'Success\': True}\\"\\n}","type":"json"}]',
'title' => '为主题创建Subscription',
],
'SetSubscriptionAttributes' => [
'summary' => '调用SetSubscriptionAttributes接口修改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' => 'Topic的名称。',
'type' => 'string',
'required' => true,
'example' => 'test',
],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => [
'description' => 'Subscription的名称。',
'type' => 'string',
'required' => true,
'example' => 'MySubscription',
],
],
[
'name' => 'NotifyStrategy',
'in' => 'query',
'schema' => [
'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下：'."\n"
."\n"
.'- BACKOFF_RETRY：退避重试。'."\n"
."\n"
.'- EXPONENTIAL_DECAY_RETRY：指数衰减重试。',
'type' => 'string',
'required' => false,
'example' => 'BACKOFF_RETRY',
],
],
[
'name' => 'DlqPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列。',
'type' => 'string',
'required' => false,
'example' => 'deadLetterTargetQueue',
],
],
'required' => false,
],
],
[
'name' => 'TenantRateLimitPolicy',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'Enabled' => [
'type' => 'boolean',
'required' => false,
],
'MaxReceivesPerSecond' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'StsRoleArn',
'in' => 'query',
'schema' => [
'title' => 'STS角色ARN',
'description' => 'STS角色ARN',
'type' => 'string',
'required' => false,
'example' => 'acs:ram::1234567890:role/roleName',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => '无',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
'title' => '修改Subscription的属性',
],
'GetSubscriptionAttributes' => [
'summary' => '调用GetSubscriptionAttributes接口获取Subscription的属性。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121400',
'abilityTreeNodes' => [
'FEATUREmns4BQTE0',
'FEATUREmnsNGE8ZG',
'FEATUREmnsOJMS9M',
'FEATUREmnsIGJWNT',
'FEATUREmnsUVY5DY',
],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => [
'description' => 'Subscription订阅的主题名称。',
'type' => 'string',
'required' => true,
'example' => 'MyTopic',
],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => [
'description' => 'Subscription的名称。',
'type' => 'string',
'required' => true,
'example' => 'MySubscription',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'SubscriptionName' => [
'description' => 'Subscription的名称。',
'type' => 'string',
'example' => 'MySubscription',
],
'TopicOwner' => [
'description' => 'Subscription订阅的主题所有者的AccountId。',
'type' => 'string',
'example' => '123456789098****',
],
'TopicName' => [
'description' => 'Subscription订阅的主题名称。',
'type' => 'string',
'example' => 'MyTopic',
],
'Endpoint' => [
'description' => '订阅的终端地址。',
'type' => 'string',
'example' => 'http://example.com',
],
'FilterTag' => [
'description' => '描述了该订阅中消息过滤的标签（仅标签一致的消息才会被推送）。',
'type' => 'string',
'example' => 'important',
],
'CreateTime' => [
'description' => 'Subscription的创建时间，从1970-01-01 00:00:00到现在的。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554806',
],
'LastModifyTime' => [
'description' => '最近一次修改Subscription属性信息的时间，从1970-01-01 00:00:00到现在的秒值。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554962',
],
'NotifyStrategy' => [
'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下：'."\n"
."\n"
.'- BACKOFF_RETRY：退避重试。'."\n"
."\n"
.'- EXPONENTIAL_DECAY_RETRY：指数衰减重试。',
'type' => 'string',
'example' => 'BACKOFF_RETRY',
],
'NotifyContentFormat' => [
'description' => '向Endpoint推送的消息内容格式。'."\n"
.'取值说明如下：'."\n"
."\n"
.'- XML'."\n"
."\n"
.'- JSON'."\n"
."\n"
.'- SIMPLIFIED',
'type' => 'string',
'example' => 'XML',
],
'DlqPolicy' => [
'description' => '死信队列策略。',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递。',
'type' => 'boolean',
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列。',
'type' => 'string',
'example' => 'deadLetterTargetQueue',
],
],
],
'TenantRateLimitPolicy' => [
'type' => 'object',
'properties' => [
'Enabled' => [
'type' => 'boolean',
],
'MaxReceivesPerSecond' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554962,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"deadLetterTargetQueue\\"\\n },\\n \\"TenantRateLimitPolicy\\": {\\n \\"Enabled\\": true,\\n \\"MaxReceivesPerSecond\\": 0\\n }\\n }\\n}","type":"json"}]',
'title' => '获取Subscription的属性',
],
'Unsubscribe' => [
'summary' => '调用Unsubscribe接口取消一个已创建的Subscription。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '121398',
'abilityTreeNodes' => [
'FEATUREmnsSAU1G7',
],
],
'parameters' => [
[
'name' => 'TopicName',
'in' => 'query',
'schema' => [
'description' => 'Topic的名称。',
'type' => 'string',
'required' => true,
'example' => 'test',
],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => [
'description' => 'Subscription的名称。',
'type' => 'string',
'required' => true,
'example' => 'MySubscription',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => '无',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Code\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
'title' => '取消已创建的Subscription',
],
'ListSubscriptionByTopic' => [
'summary' => '调用ListSubscriptionByTopic接口列出某个主题下的Subscription列表，可分页获取数据。',
'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' => '主题的名称。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页页码，查询第几页的返回结果。'."\n"
.'取值范围：1~100000000。'."\n"
.'若您设置的参数值小于1，则系统默认按照参数值为1处理；若您设置的参数值大于100000000，则系统默认按照参数值为100000000处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小，每页最多显示的返回结果数量。'."\n"
.'取值范围：10~50。'."\n"
.'若您设置的参数值小于10，则系统默认按照参数值为10处理；若您设置的参数值大于50，则系统默认按照参数值为50处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'SubscriptionName',
'in' => 'query',
'schema' => [
'description' => 'Subscription的名称。',
'type' => 'string',
'required' => false,
'example' => 'demo-subscription',
],
],
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'EndpointValue',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '分页页码，查询此页的返回结果。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小，每页最多显示的返回结果数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'Size' => [
'description' => '当前页结果数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Pages' => [
'description' => '总页数',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'Total' => [
'description' => '总结果数。',
'type' => 'integer',
'format' => 'int64',
'example' => '130',
],
'PageData' => [
'description' => '当前页返回结果。',
'type' => 'array',
'items' => [
'description' => '数据项',
'type' => 'object',
'properties' => [
'SubscriptionName' => [
'description' => 'Subscription的名称。',
'type' => 'string',
'example' => 'MySubscription',
],
'TopicOwner' => [
'description' => 'Subscription订阅的主题所有者的AccountId。',
'type' => 'string',
'example' => '123456789098****',
],
'TopicName' => [
'description' => 'Subscription订阅的主题名称。',
'type' => 'string',
'example' => 'MyTopic',
],
'Endpoint' => [
'description' => '订阅的终端地址。',
'type' => 'string',
'example' => 'http://example.com',
],
'FilterTag' => [
'description' => '描述了该订阅中消息过滤的标签（仅标签一致的消息才会被推送）。',
'type' => 'string',
'example' => 'important'."\n",
],
'CreateTime' => [
'description' => 'Subscription的创建时间，从1970-01-01 00:00:00到现在的。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554806'."\n",
],
'LastModifyTime' => [
'description' => '最近一次修改Subscription属性信息的时间，从1970-01-01 00:00:00到现在的秒值。',
'type' => 'integer',
'format' => 'int64',
'example' => '1449554806'."\n",
],
'NotifyStrategy' => [
'description' => '向Endpoint推送消息错误时的重试策略。取值说明如下：'."\n"
."\n"
.'- BACKOFF_RETRY：退避重试。'."\n"
."\n"
.'- EXPONENTIAL_DECAY_RETRY：指数衰减重试。',
'type' => 'string',
'example' => 'BACKOFF_RETRY',
],
'NotifyContentFormat' => [
'description' => '向Endpoint推送的消息内容格式。'."\n"
.'取值说明如下：'."\n"
."\n"
.'- XML'."\n"
."\n"
.'- JSON'."\n"
."\n"
.'- SIMPLIFIED',
'type' => 'string',
'example' => 'XML',
],
'DlqPolicy' => [
'description' => '死信策略',
'type' => 'object',
'properties' => [
'Enabled' => [
'description' => '是否开启死信消息投递',
'type' => 'boolean',
'example' => 'true',
],
'DeadLetterTargetQueue' => [
'description' => '死信消息投递目标队列',
'type' => 'string',
'example' => 'dead-letter-queue',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"PageData\\": [\\n {\\n \\"SubscriptionName\\": \\"MySubscription\\",\\n \\"TopicOwner\\": \\"123456789098****\\",\\n \\"TopicName\\": \\"MyTopic\\",\\n \\"Endpoint\\": \\"http://example.com\\",\\n \\"FilterTag\\": \\"important\\\\n\\",\\n \\"CreateTime\\": 1449554806,\\n \\"LastModifyTime\\": 1449554806,\\n \\"NotifyStrategy\\": \\"BACKOFF_RETRY\\",\\n \\"NotifyContentFormat\\": \\"XML\\",\\n \\"DlqPolicy\\": {\\n \\"Enabled\\": true,\\n \\"DeadLetterTargetQueue\\": \\"dead-letter-queue\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '列出主题下的Subscription列表',
],
'DisableEndpoint' => [
'summary' => '本接口用于关闭指定类型接入点。关闭后，所有源自对应接入点的请求都将被拦截并返回错误。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '259962',
'abilityTreeNodes' => [
'FEATUREmns0M5BDJ',
],
],
'parameters' => [
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => [
'description' => '接入点类型。取值：'."\n"
."\n"
.'- **public**：表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'public' => 'public',
],
'example' => 'public',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '关闭接入点',
],
'EnableEndpoint' => [
'summary' => '本接口用于启用指定类型的接入点。开启后，源自对应接入点且处于Acl白名单中的请求都将不会被拦截。',
'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' => '接入点类型。取值：'."\n"
."\n"
.'- **public**：表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'public' => 'public',
],
'example' => 'public',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '启用接入点',
'extraInfo' => '本API目前只在：广州、北京、上海 地域开放，如果有其他地域需求请提工单进行支持',
],
'GetEndpointAttribute' => [
'summary' => 'GetEndpointAttribute',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '259965',
'abilityTreeNodes' => [
'FEATUREmns0M5BDJ',
],
],
'parameters' => [
[
'name' => 'EndpointType',
'in' => 'query',
'schema' => [
'description' => '接入点类型。取值：'."\n"
."\n"
.'- **public**：表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'public' => 'public',
],
'example' => 'public',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'EndpointEnabled' => [
'description' => '接入点是否开启。',
'type' => 'boolean',
'example' => 'true',
],
'CidrList' => [
'description' => '网络地址段列表。',
'type' => 'array',
'items' => [
'description' => '网络地址段。',
'type' => 'object',
'properties' => [
'Cidr' => [
'description' => '网络地址段。',
'type' => 'string',
'example' => '172.18.0.0/24',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1701951224000',
],
'AclStrategy' => [
'description' => 'Acl策略。取值：'."\n"
."\n"
.'- **allow**：表示当前接入点允许对应Cidr访问。(目前仅支持allow)',
'type' => 'string',
'example' => 'allow',
],
],
],
],
],
],
],
],
],
],
'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' => '获取接入点属性',
'extraInfo' => '本API目前只在：广州、北京、上海地域开放，如果有其他地域需求请提工单进行支持',
],
'RevokeEndpointAcl' => [
'summary' => '本接口用于删除指定类型的接入点的一条或多条Acl规则。',
'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' => '接入点类型。取值：'."\n"
."\n"
.'- **public**：表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'public' => 'public',
],
'example' => 'public',
],
],
[
'name' => 'AclStrategy',
'in' => 'query',
'schema' => [
'description' => 'Acl策略。取值：'."\n"
."\n"
.'- **allow**：表示此次操作的为Cidr白名单。(目前仅支持allow)',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'allow' => 'allow',
],
'example' => 'allow',
],
],
[
'name' => 'CidrList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => '网络地址段列表。',
'type' => 'array',
'items' => [
'description' => '网络地址段。',
'type' => 'string',
'required' => false,
'example' => '192.168.1.1/24',
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除接入点Acl规则',
'extraInfo' => '本API目前只在：广州、北京、上海地域开放，如果有其他地域需求请提工单进行支持',
],
'AuthorizeEndpointAcl' => [
'summary' => '本接口用于新增指定类型的接入点的一条或多条Acl规则。',
'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' => '接入点类型。取值：'."\n"
."\n"
.'- **public**：表示公网接入点。(目前仅支持public)',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'public' => 'public',
],
'example' => 'public',
],
],
[
'name' => 'AclStrategy',
'in' => 'query',
'schema' => [
'description' => 'Acl策略。取值：'."\n"
."\n"
.'- **allow**：表示此次操作的为Cidr白名单。(目前仅支持allow)',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'allow' => 'allow',
],
'example' => 'allow',
],
],
[
'name' => 'CidrList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => '网络地址段列表。',
'type' => 'array',
'items' => [
'description' => '网络地址段。',
'type' => 'string',
'required' => false,
'example' => '192.168.1.1/24',
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '增加接入点Acl规则',
'extraInfo' => '本API目前只在：广州、北京、上海地域开放，如果有其他地域需求请提工单进行支持',
],
'GetEventRule' => [
'summary' => '获取事件通知规则。',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '273196',
'abilityTreeNodes' => [
'FEATUREmnsT1OLHP',
],
],
'parameters' => [
[
'name' => 'ProductName',
'in' => 'query',
'schema' => [
'description' => '事件通知云产品名称',
'type' => 'string',
'required' => true,
'example' => 'oss',
],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => [
'description' => '事件通知规则名称。',
'type' => 'string',
'required' => true,
'example' => 'rule-xsXDW',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'True',
],
'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' => '事件匹配规则,or 关系',
'type' => 'array',
'items' => [
'description' => '事件匹配规则,or 关系',
'type' => 'array',
'items' => [
'description' => '事件匹配规则,or 关系',
'$ref' => '#/components/schemas/EventMatchRule',
],
],
],
'Subscriptions' => [
'description' => '订阅终端',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndpointType' => [
'description' => '接入点类型。取值：'."\n"
."\n"
.'- **queue**： 队列类型。'."\n"
.'- **topic**： 主题类型。',
'type' => 'string',
'example' => 'queue',
],
'EndpointValue' => [
'description' => '接收终端实际值',
'type' => 'string',
'example' => 'retry-queue',
],
],
],
],
'TopicName' => [
'description' => '主题的名称。',
'type' => 'string',
'example' => 'demo-topic',
],
'Endpoint' => [
'description' => '订阅的终端地址。',
'type' => 'object',
'properties' => [
'EndpointType' => [
'description' => '接入点类型。取值：'."\n"
."\n"
.'- **queue**： 队列类型。'."\n"
.'- **topic**： 主题类型。',
'type' => 'string',
'example' => 'queue',
],
'EndpointValue' => [
'description' => '接收终端实际值',
'type' => 'string',
'example' => 'retry-queue',
],
],
],
'DeliveryMode' => [
'description' => '已废弃字段',
'type' => 'string',
'example' => '--',
],
],
],
],
],
],
],
'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' => '获取事件通知规则',
],
'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' => '匹配规则中的资源名称，用于过滤规则，例：oss 中，此为 oss bucketName',
'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' => '接入点类型。取值：'."\n"
."\n"
.'- **topic**： 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
.'- **queue**： 队列类型。直接投递到队列。可以减少链路路径，但后续不可增加新的订阅接收端。',
'type' => 'string',
'required' => false,
'example' => 'topic',
],
'EndpointValue' => [
'description' => '接收终端实际值',
'type' => 'string',
'required' => false,
'example' => 'test-topic',
],
],
'required' => false,
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页页码，查询第几页的返回结果。'."\n"
.'取值范围：1~100000。'."\n"
.'若您设置的参数值小于1，则系统默认按照参数值为1处理；若您设置的参数值大于100000，则系统默认按照参数值为100000处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小，每页最多显示的返回结果数量。'."\n"
.'取值范围：10~50。'."\n"
.'若您设置的参数值小于10，则系统默认按照参数值为10处理；若您设置的参数值大于50，则系统默认按照参数值为50处理。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '已废弃字段。请使用 PageNum 分页查询。',
'type' => 'string',
'required' => false,
'example' => 'cd7NlPlX4kgKCdsCWMiMR/+HnVzPLQ4/XLvjR64jZ7F9AQ+Mr3T59J6IVkuXeV3w',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => [
'description' => '已废弃字段。请使用 PageSize 分页查询',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '50',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求的ID。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123E62C',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据。',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '分页页码，查询第几页的返回结果。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小，每页最多显示的返回结果数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'Size' => [
'description' => '当前页结果数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Pages' => [
'description' => '总页数',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'Total' => [
'description' => '总结果数。',
'type' => 'integer',
'format' => 'int64',
'example' => '130',
],
'NextToken' => [
'description' => '已废弃字段。分页查询以PageNum为准',
'type' => 'string',
'example' => 'a88f58d504b8b4c4e0b5e8707e68181f',
],
'MaxResults' => [
'description' => '已废弃字段。分页最大结果集以 Total 为准',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageData' => [
'description' => '数据项',
'type' => 'array',
'items' => [
'description' => '数据项。',
'type' => 'object',
'properties' => [
'RuleName' => [
'description' => '事件通知规则名称。',
'type' => 'string',
'example' => 'rule-xsXDW',
],
'Subscriptions' => [
'description' => '订阅端。限制最大返回条数 20，如果超过请使用 [订阅列表](~~2804757~~) 查询。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndpointType' => [
'description' => '接入点类型。',
'type' => 'string',
'example' => 'queue',
],
'EndpointValue' => [
'description' => '接收终端实际值',
'type' => 'string',
'example' => 'wyx-vp-complete-queue',
],
],
],
],
'TopicName' => [
'description' => '主题的名称。',
'type' => 'string',
'example' => 'demo-topic',
],
'MatchRules' => [
'title' => '事件匹配规则,or 关系',
'description' => '事件匹配规则,or 关系',
'type' => 'array',
'items' => [
'description' => '事件匹配规则,or 关系',
'type' => 'array',
'items' => [
'description' => '匹配规则，多个规则之间 or 关系',
'example' => '[[{\\"MatchState\\":true,\\"Prefix\\":\\"cdhxdev1cdh-bba-dto-052901-sem-5seh/\\",\\"Suffix\\":\\"\\"}]]',
'$ref' => '#/components/schemas/EventMatchRule',
],
],
],
'EventTypes' => [
'description' => '事件类型列表',
'type' => 'array',
'items' => [
'description' => '事件类型列表',
'type' => 'string',
'example' => '["oss:ObjectCreated:CopyObject"]',
],
],
'Endpoint' => [
'description' => '订阅的终端地址。',
'type' => 'object',
'properties' => [
'EndpointType' => [
'description' => '接入点类型。取值：'."\n"
."\n"
.'- **topic**： 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
.'- **queue**： 队列类型。直接投递到队列。可以减少链路路径，但后续不可增加新的订阅接收端。',
'type' => 'string',
'example' => 'topic',
],
'EndpointValue' => [
'description' => '接收终端实际值',
'type' => 'string',
'example' => 'test-topic',
],
],
],
'DeliveryMode' => [
'description' => '已废弃字段',
'type' => 'string',
'example' => '--',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123E62C\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 50,\\n \\"Size\\": 20,\\n \\"Pages\\": 3,\\n \\"Total\\": 130,\\n \\"NextToken\\": \\"a88f58d504b8b4c4e0b5e8707e68181f\\",\\n \\"MaxResults\\": 1,\\n \\"PageData\\": [\\n {\\n \\"RuleName\\": \\"rule-xsXDW\\",\\n \\"Subscriptions\\": [\\n {\\n \\"EndpointType\\": \\"queue\\",\\n \\"EndpointValue\\": \\"wyx-vp-complete-queue\\"\\n }\\n ],\\n \\"TopicName\\": \\"demo-topic\\",\\n \\"MatchRules\\": [\\n [\\n {\\n \\"MatchState\\": true,\\n \\"Name\\": \\"\\",\\n \\"Prefix\\": \\"\\",\\n \\"Suffix\\": \\"\\"\\n }\\n ]\\n ],\\n \\"EventTypes\\": [\\n \\"[\\\\\\"oss:ObjectCreated:CopyObject\\\\\\"]\\"\\n ],\\n \\"Endpoint\\": {\\n \\"EndpointType\\": \\"topic\\",\\n \\"EndpointValue\\": \\"test-topic\\"\\n },\\n \\"DeliveryMode\\": \\"--\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取事件规则列表',
],
'CreateEventRule' => [
'summary' => '用于创建事件规则。',
'methods' => [
'post',
],
'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' => '匹配规则，多个规则之间 or 关系',
'type' => 'array',
'items' => [
'description' => '子项列表，多个规则 and 关系',
'type' => 'array',
'items' => [
'description' => '事件原子匹配规则对象',
'required' => false,
'$ref' => '#/components/schemas/EventMatchRule',
],
'required' => false,
'maxItems' => 6,
],
'required' => true,
'maxItems' => 10,
],
],
[
'name' => 'Endpoints',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '已废弃字段。请使用 Endpoint',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndpointType' => [
'description' => '已废弃。请使用Endpoint.EndpointType',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'http' => 'http',
'topic' => 'topic',
'queue' => 'queue',
],
'example' => 'http',
],
'EndpointValue' => [
'description' => '已废弃。请使用Endpoint.EndpointValue',
'type' => 'string',
'required' => false,
'example' => 'test-xxx-queue',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token，用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。',
'type' => 'string',
'required' => false,
'example' => '06273500-249F-5863-121D-74D51123****'."\n",
],
],
[
'name' => 'Endpoint',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '此次订阅中接收消息的终端地址。',
'type' => 'object',
'properties' => [
'EndpointType' => [
'description' => '接入点类型。取值：'."\n"
."\n"
.'- **topic**： 主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。'."\n"
.'- **queue**： 队列类型。直接投递到队列。可以减少链路路径，但后续不可增加新的订阅接收端。',
'type' => 'string',
'required' => false,
'example' => 'topic',
],
'EndpointValue' => [
'description' => '接收终端实际值',
'type' => 'string',
'required' => false,
'example' => 'test-topic',
],
],
'required' => false,
],
],
[
'name' => 'DeliveryMode',
'in' => 'query',
'schema' => [
'title' => '',
'description' => '已废弃字段',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '--',
'enum' => [
'DIRECT',
'BROADCAST',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '响应数据，创建规则成功时，返回创建的规则名称',
'type' => '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' => '创建事件规则',
],
'DeleteEventRule' => [
'summary' => '用于删除事件规则。',
'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' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
'type' => 'string',
'example' => '06273500-249F-5863-121D-74D51123****',
],
'Code' => [
'description' => '响应code。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Status' => [
'description' => '响应的状态。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'operation success',
],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06273500-249F-5863-121D-74D51123****\\",\\n \\"Code\\": 200,\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"operation success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除事件规则',
],
],
'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',
],
],
];