Skip to content

bowenpay/mns-python-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

阿里云消息和通知服务 Message And Notification Service (MNS) Python SDK说明文档
===============================================================
阿里云消息和通知服务官方网站:
    http://www.aliyun.com/product/mns/

阿里云消息和通知服务
===============================================================

简介
===============================================================
这篇文档主要介绍如何使用Python来进行MNS API调用,并且介绍mnscmd
的简单使用方法。
这篇文档假设您已经熟悉Python,熟悉MNS的相关概念,并且已经注册阿
里云账号、开通阿里云的MNS服务,且获得了相应的AccessKeyId、
AccessKeySecret和AccountId。如果您还没有开通或者还不了解MNS,请
移步MNS官方网站。

环境要求
===============================================================
Python SDK需要:安装python 2.5 (包括) 以上且在3.0 (不包括) 以下
的版本。
可以在Windows平台和Linux平台使用。

使用说明
===============================================================
安装sdk和mnscmd
===============================================================
1. linux平台
   sudo python setup.py install

2. Windows平台
   python.exe setup.py install

===============================================================
运行sample.py
===============================================================
1. 访问阿里云官网获取的AccessKeyId、AccessKeySecret、AccountId;
2. 访问阿里云消息和通知服务官网,进入控制台获取Endpoint;
3. 将AccessKeyId、AccessKeySecret、Endpoint填写到sample.cfg中;
4. linux平台运行"python sample.py",Windows平台运行"python.exe sample.py"。

===============================================================
使用mnscmd
注意:在Windows平台cmd中mnscmd不能直接运行,需要进入bin目录,用"python.exe mnscmd"替换使用帮助中的"mnscmd";
===============================================================
1. 配置访问MNS所需要的认证码
   命令:mnscmd config --endpoint=http://$accountid.mns.cn-hangzhou.aliyuncs.com --accesskeyid=YOUR_ACCESSKEYID --accesskeysecret=YOUR_ACCESSKEYSECRET

2. 列出创建的queue
   命令:mnscmd listqueue
   如果是刚刚使用MNS的用户因为没有创建queue,输出是空

3. 创建queue
   命令:mnscmd createqueue --queuename=myqueue
   帮助:mnscmd createqueue --info
   "myqueue"可以根据需求修改为符合规则的queue name
   queue name的详细规则请移步阿里云消息和通知服务官方网站
   更多属性指定,运行帮助命令

4. 获取queue
   命令:mnscmd getqueueattr --queuename=myqueue
   命令返回queue的各项属性

5. 设置queue属性
   命令:mnscmd setqueueattr --queuename=myqueue --delaysec=5
   帮助:mnscmd setqueueattr --info
   设置queue的delayseconds为5秒
   更多属性设置,运行帮助命令
 
5. 发送message
   命令:mnscmd sendmessage --queuename=myqueue --body="I am a test message."
   帮助:mnscmd sendmessage --info
   发送一条消息到队列myqueue中
   更多属性指定,运行帮助命令

6. 查看message
   命令:mnscmd peekmessage --queuename=myqueue
   查看myqueue中的第一条消息

7. 消费message
   命令:mnscmd receivemessage --queuename=myqueue
   消费myqueue中的第一条消息
   命令返回消息基本信息和临时句柄(ReceiptHandle)

8. 修改message下次可消费时间
   命令:mnscmd changevisibility --queuename=myqueue --handle=YOUR_RECEIPTHANDLE --vistimeout=10
   YOUR_RECEIPTHANDLE是receivemessage返回的ReceiptHandle
   消息10秒后可再次被消费,命令返回新的ReceiptHandle

9. 删除message
   命令:mnscmd deletemessage --queuename=myqueue --handle=YOUR_RECEIPTHANDLE
   YOUR_RECEIPTHANDLE是最近一次操作返回的ReceiptHandle,即第9步返回的ReceiptHandle

10. 删除queue
   命令:mnscmd deletequeue --queuename=myqueue
   注意,如果queue中有message,所有message都会被删除

ChangeHistory
===============================================================
1.0.2 - 2015-06-01
* 支持SDK安装
* 提供mnscmd命令

1.0.1 - 2015-02-03
* 统一队列非字符串属性为int类型;
* 修正SetQueueAttr的http状态码为204。

1.0.0 - 2014-08-01
* SDK支持queue的创建、修改、获取、删除,message的发送、查看、消费、删除和修改下次可消费时间。

About

python client for Aliyun message notify service

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages