Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Python SDK for OpenSearch of Ali Cloud

Project Description

[![Build Status](](
[![Coverage Status](](
[![PyPI version](](

### Aliyun OpenSearch Python SDK

ali-opensearch-sdk is a python SDK for [Aliyun OpenSearch]( Product.
Based on OpenSearch API version v2. This SDK supports both python2.x and python3.x.
Pypi link:[](
Project manage [Launchpad](

#### 1 Design
##### 1.1 SDK structure
There are 7 type of resources provided by opensearch, they are:

1, app: Application
2, data: Data Process
3, search: Search Related Action
4, suggest: Suggestion for Search
5, index: Index Reconstruction
6, quota: Quota Management
7, log: Error Log Query

There are 5 Operation for almost all resources, they are CURD as follow:

1, list: list all of this type of resources.
2, show: show detail information of a specific resource.
3,4,5, CUD: create, update and delete a specific resource.

###### 1.1.1 app Operation:

#### 2, Installation:

You can install via pip:

#pip install ali-opensearch

Or, From Source code:

#git clone
#cd ali-opensearch-sdk
#python install

#### 3, Getting Started :

from opensearchsdk.client import Client as osclient
client = osclient(base_url, key, key_id)
apps =
print apps


u'status': u'OK',
u'total': u'1',
u'result': [
u'description': u'test',
u'created': u'1447753400',
u'id': u'119631',
u'name': u'test'
u'request_id': u'1447866418002866600607068'

More examples can be found in `opensearchsdk/`.
Note: All return data from server were remained.

#### 4, Contribute and BUG:
This project was managed via [Launchpad](
Welcome to log bugs and commit patch.
Code style follow the PEP8 rules.

#### 5, License:
Apache License Version 2.0

#### 6, Release Note:
1, V2.0.0-dev Provide only few functions of opensearch, not yet cover all functions.
2, V2.0.0 completed all api functions.
3, V2.0.1 add compatibility for python3.5.

Release History

This version
History Node


History Node


History Node


History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Hash SHA256 Hash Help Version File Type Upload Date
(42.3 kB) Copy SHA256 Hash SHA256
2.7 Egg Sep 2, 2016
(44.3 kB) Copy SHA256 Hash SHA256
3.5 Egg Sep 2, 2016
(11.6 kB) Copy SHA256 Hash SHA256
Source Sep 2, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting