openstack/senlin
Code Issues Proposed changes

Revised cluster list API doc

Browse Source
This commit is contained in:
tengqm
2015-03-03 14:22:46 +08:00
parent 026cff79d4
commit d7bb394593
2 changed files with 79 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
View File

@@ -183,56 +183,91 @@ name could be delayed for an unspecified time.</para></note>'>
<para role="shortdesc">Lists clusters.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<representation mediaType="application/json">
<param name="limit" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Limits the number of clusters that appear on a page to this value. The typical pattern of <code>limit</code> and
<code>marker</code> is to make an initial limited request and then to use the <code>id</code> of the last cluster
from the response as the <code>marker</code> parameter in a subsequent limited request.
<para>Limits the number of clusters that appear on a page to this value. The
typical pattern of <code>limit</code> and <code>marker</code> is to make
an initial limited request and then to use the <code>id</code> of the
last cluster from the response as the <code>marker</code> parameter in a
subsequent limited request.
</para>
</wadl:doc>
</param>
<param name="marker" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Specifies the <code>id</code> of the last-seen cluster. The typical pattern of <code>limit</code> and <code>marker</code>
is to make an initial limited request and then to use the <code>id</code> of the last cluster from the response as
the <code>marker</code> parameter in a subsequent limited request.
<para>Specifies the <code>id</code> of the last-seen cluster. The typical
pattern of <code>limit</code> and <code>marker</code> is to make an
initial limited request and then to use the <code>id</code> of the last
cluster from the response as the <code>marker</code> parameter in a
subsequent limited request.
</para>
</wadl:doc>
</param>
<param name="filters" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Filters to apply on the returned clusters. Each filter is in the form of key-value pair.</para>
<para>Filters to apply on the returned clusters. Each filter is in the form
of key-value pair, where the keys can be one of the following values:</para>
<itemizedlist xml:id="cluster_query_param">
<title>Cluster Query Filters</title>
<listitem>
<para>
<code>name</code> Name of cluster, may appear more than once.
</para>
</listitem>
<listitem>
<para>
<code>status</code> Status of cluster, may appear more than once.
</para>
</listitem>
<listitem>
<para>
<code>project</code> Project of cluster, may appear more than once.
</para>
</listitem>
<listitem>
<para>
<code>user</code> User who is owner of the cluster, may appear
more than once.
</para>
</listitem>
<listitem>
<para>
<code>parent</code> ID of parent cluster of the cluster, may
appear more than once. This is used for nested clusters.
</para>
</listitem>
</itemizedlist>
</wadl:doc>
</param>
<param name="show_deleted" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Specifies whether to include deleted clusters in the cluster list. Set to <code>False</code> by default, so that
deleted clusters are not shown in the results of the &GET; request unless you set this value to <code>True</code>.
<para>Specifies whether to include deleted clusters in the cluster list. Set
to <code>False</code> by default, so that deleted clusters are not shown
in the results of the &GET; request unless you set this value to
<code>True</code>.
</para>
</wadl:doc>
</param>
<param name="show_nested" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Specifies whether to include nested cluster in the cluster list.</para>
<para>Specifies whether to include nested cluster in the cluster list.</para>
</wadl:doc>
</param>
<param name="sort_keys" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the cluster list by one of these attributes: <code>name</code>, <code>status</code>, <code>created_time</code>,
or <code>updated_time</code>.
Sorts the cluster list by one of these attributes: <code>name</code>,
<code>status</code>, <code>created_time</code>, or <code>updated_time
</code>.
</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The sort direction of the cluster list. Either <code>asc</code> (ascending) or <code>desc</code> (descending).
<para>The sort direction of the cluster list. Either <code>asc</code>
(ascending) or <code>desc</code> (descending).
</para>
</wadl:doc>
</param>
@@ -245,9 +280,10 @@ name could be delayed for an unspecified time.</para></note>'>
</wadl:doc>
<param name="clusters" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
List of cluster records where each record contains fields like <code>created_time</code>, <code>id</code>,
<code>name</code>, <code>profile_id</code>, <code>size</code>, <code>status</code>, <code>status_reason</code>.
<para>List of cluster records where each record contains fields like
<code>created_time</code>, <code>id</code>, <code>name</code>,
<code>profile_id</code>, <code>size</code>, <code>nodes</code>,
<code>status</code>, <code>status_reason</code> etc.
</para>
</wadl:doc>
</param>

34
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/cluster_list_resp.json
View File

@@ -1,20 +1,30 @@
{
"clusters": [
{
"created_time": "2014-06-03T20:59:46Z",
"id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/stacks/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"rel": "self"
}
"created_time": "2015-02-10T14:26:14.000000",
"data": {},
"deleted_time": null,
"domain": "",
"id": "7d85f602-a948-4a30-afd4-e84f47471c15",
"init_time": "2015-02-10T14:26:11.000000",
"name": "cluster1",
"nodes": [
"b07c57c8-7ab2-47bf-bdf8-e894c0c601b9",
"ecc23d3e-bb68-48f8-8260-c9cf6bcb6e61",
"da1e9c87-e584-4626-a120-022da5062dac",
],
"name": "test_cluster",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"size": 5,
"parent": null,
"policies": [],
"profile_id": "edc63d0a-2ca4-48fa-9854-27926da76a4a",
"profile_name": "mystack",
"project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
"size": 11,
"status": "ACTIVE",
"status_reason": "Cluster created successfully",
"updated_time": ""
"status_reason": "Cluster scale-in succeeded",
"tags": {},
"timeout": null,
"updated_time": null,
"user": "admin"
}
]
}