API概览

本产品(Mns-open/2022-01-19)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

主题管理

API

标题

API概述

CreateTopic 创建主题 调用CreateTopic接口创建主题。
SetTopicAttributes 修改主题的属性 调用SetTopicAttributes接口来修改主题的属性。
GetTopicAttributes 获取主题的属性 调用GetTopicAttributes接口获取主题的属性。
DeleteTopic 删除主题 调用DeleteTopic接口删除主题。
ListTopic 查询阿里云账号下的主题列表 调用ListTopic接口查询阿里云账号下的主题列表,可分页获取数据。

队列管理

API

标题

API概述

CreateQueue 创建队列 调用CreateQueue接口创建一个新的队列。
SetQueueAttributes 修改队列属性 调用SetQueueAttributes接口修改队列属性。
GetQueueAttributes 获取队列属性 获取某个已创建队列的属性。
DeleteQueue 删除队列 调用DeleteQueue接口删除已创建的队列。
ListQueue 列出指定阿里云账号下的所有队列 调用ListQueue接口,列出指定阿里云账号下的所有队列,可分页获取数据。

订阅管理

API

标题

API概述

Subscribe 为主题创建Subscription 调用Subscribe接口,为主题创建Subscription。
SetSubscriptionAttributes 修改Subscription的属性 调用SetSubscriptionAttributes接口修改Subscription的属性。
GetSubscriptionAttributes 获取Subscription的属性 调用GetSubscriptionAttributes接口获取Subscription的属性。
Unsubscribe 取消已创建的Subscription 调用Unsubscribe接口取消一个已创建的Subscription。
ListSubscriptionByTopic 列出主题下的Subscription列表 调用ListSubscriptionByTopic接口列出某个主题下的Subscription列表,可分页获取数据。

接入点管理

API

标题

API概述

DisableEndpoint 关闭接入点 本接口用于关闭指定类型接入点。关闭后,所有源自对应接入点的请求都将被拦截并返回错误。
EnableEndpoint 启用接入点 本接口用于启用指定类型的接入点。开启后,源自对应接入点且处于Acl白名单中的请求都将不会被拦截。
GetEndpointAttribute 获取接入点属性 GetEndpointAttribute
RevokeEndpointAcl 删除接入点Acl规则 本接口用于删除指定类型的接入点的一条或多条Acl规则。
AuthorizeEndpointAcl 增加接入点Acl规则 本接口用于新增指定类型的接入点的一条或多条Acl规则。

事件通知管理

API

标题

API概述

GetEventRule 获取事件通知规则 获取事件通知规则。
ListEventRules 获取事件规则列表 查询事件通知列表。
CreateEventRule 创建事件规则 用于创建事件规则。
DeleteEventRule 删除事件规则 用于删除事件规则。