summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Day <eday@oddments.org>2010-12-07 10:06:49 -0800
committerEric Day <eday@oddments.org>2010-12-07 10:06:49 -0800
commitc1a40a8381ae3e559b3faad4a93ffec1abe8907f (patch)
treeb170be3536962f59f0c315e87aeb779c7cb8c6df
parent12f46626c4dd8a41a23c109e784a296ec702dd9a (diff)
downloadnova-c1a40a8381ae3e559b3faad4a93ffec1abe8907f.tar.gz
nova-c1a40a8381ae3e559b3faad4a93ffec1abe8907f.tar.xz
nova-c1a40a8381ae3e559b3faad4a93ffec1abe8907f.zip
Added docstring for get_instances.
-rw-r--r--nova/compute/api.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/nova/compute/api.py b/nova/compute/api.py
index 995bed91b..cb23dae55 100644
--- a/nova/compute/api.py
+++ b/nova/compute/api.py
@@ -246,6 +246,9 @@ class ComputeAPI(base.Base):
self.db.instance_destroy(context, instance['id'])
def get_instances(self, context, project_id=None):
+ """Get all instances, possibly filtered by project ID or
+ user ID. If there is no filter and the context is an admin,
+ it will retreive all instances in the system."""
if project_id or not context.is_admin:
if not context.project:
return self.db.instance_get_all_by_user(context,