Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

YY cloudns API python client

Project description

A python client for the YY cloudns API. A command line program is also included.


To install cloudns, simply:

$ pip install cloudns

Quick Start

This client supports all functions defined in the API. To use those functions, first create a User object, then call methods on it.

>>> import cloudns
>>> u = cloudns.User('dw_foo', '8AFBE6DEA02407989AF4DD4C97BB6E25')
>>> u.get_all_zones()
>>> u.get_all_records('')

Since most api function requires a zone to work on, you can create a zone from a User and call methods on zone. Zone contains the most frequently used functions from the API.

>>> z ='')
>>> z.create_record('test-foo', '', 'tel')
>>> z.get_records_by_name('test-foo')
>>> z.delete_records_by_name('test-foo')

This client does very strict error checking. Everything from HTTP error to bad response from cloudns server will raise an exception. All exceptions raised by cloudns will be a subclass of CloudnsError.

>>> r = z.create_record('test-foo', '', 'uni'); z.delete_record_by_id(r.rid)
... # Will raise exception. Pending record can not be deleted.

CLI usage

This client includes a CLI script named cloudns. You can use it as a interactive shell or as a command line program. This CLI script is available in v1.1.1.0+.

Example usage:

As a normal command line program:

cloudns --passport mypsp --token mytoken --zone create abc tel
cloudns --passport mypsp --token mytoken --zone create abc uni
cloudns --passport mypsp --token mytoken --zone search abc
cloudns --passport mypsp --token mytoken --zone delete abc

As an interactive shell:

$ cloudns --passport mypsp --token mytoken --zone
This is Cloudns REPL, an interactive shell for using cloudns.
Type help or ? for usage

cloudns> create abc tel

cloudns> create abc uni

cloudns> search abc
2 record(s).       300     A        tel     ACTIVE       300     A        uni     ACTIVE

cloudns> delete abc

cloudns> search abc
No record found.

cloudns> exit

For more information, see


Cloudns API documentation is available at

Cloudns python client and cloudns CLI documentation is available at


  • v1.2.0.2 2014-07-31
    • bugfix: add zone parameter in user.delete_records()
    • support “cloudns –version”
  • v1.2.0.0 2013-11-27
    • use upstream 1.2 api, this client is backward compatible with v1.1.1.3. It just use the new api.
    • minor, some spelling fixes
  • v1.1.1.3 2013-11-08
    • add CLI program named cloudns
    • add test using tox
  • v1.1.0.2 2013-08-31
    • package tested on python 2.6/2.7/3.3
    • bugfix: fix an import error on python 3.3
  • v1.1.0.1 2013-08-13
    • initial release

Project details

Download files

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

Files for cloudns, version
Filename, size File type Python version Upload date Hashes
Filename, size cloudns- (14.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page