Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 4.61 KB

File metadata and controls

71 lines (47 loc) · 4.61 KB

Projects

Projects refer to Openstack Projects. Projects are organizational units in the cloud to which you can assign users See Openstack Docs for more info

NOTE: ProjectQuery will only work with admin credentials - set by clouds.yaml

Querying

To Query for Projects using the Query Library, you can import ProjectQuery() like so:

from openstackquery import ProjectQuery

ProjectQuery() can then be used to setup and run queries - see API.md for details on API calls

Properties

A Project has the following properties:

Return Type Property Name(s) (case-insensitive) Description
string "description", "desc" The description of the project.
string "domain_id" The ID of the domain which owns the project.
string "project_id" Unique ID Openstack has assigned the project.
bool "is_domain" Indicates whether the project also acts as a domain.
If set to True, the project acts as both a project and a domain.
bool "is_enabled" Indicates whether users can authorize against this project.
if set to False, users cannot access project, additionally all authorized tokens are invalidated.
string "name" Name of the project.
string "parent_id" The ID of the parent of the project.
string "tags" JSON-formatted string of a list of project tags (usually one of these is an email)
string "email" The first email found in tags, or None (which outputs in results as 'Not Found').

Any of these properties can be used for any of the API methods that takes a property - like select, where, sort_by etc

Chaining

This section details valid mappings you can use to chain onto other queries or from other queries to chain into a ProjectQuery object. This applies to API calls then and append_from - see API.md for details

Query Alias

The aliases that can be used for the query when chaining are listed below:

Aliases (case-insensitive
"project", "projects", "project_query", "projectquery"

Chaining from

A ProjectQuery can be chained to other queries. The following shared-common properties are listed below (as well as the Query object they map to):

Prop 1 Prop 2 Type Maps
"id" "project_id" One-to-Many ProjectQuery to ServerQuery
"id" "owner" One-to-Many ProjectQuery to ServerQuery

Chaining to

Chaining from other ProjectQuery requires passing PROJECT_QUERY or any aliases mentioned above as the query_type

From Prop 1 Prop 2 Type Documentation
ServerQuery "project_id" "id" Many-to-One SERVERS.md
ImageQuery "owner" "id" Many-to-One IMAGES.md

run() meta-parameters

ProjectQuery() accepts no extra meta-parameters when calling run().