List stacks#

スタックを一覧表示します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://orchestration.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://orchestration.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v1/{tenant_id}/stacks

HTTPステータスコード#

正常時：200

エラー時：400, 401, 500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定		 Description
tenant_id path string 必須 プロジェクトID
id query string 任意 レスポンスをスタックIDで絞り込みます。複数指定可能です。
status query string 任意 レスポンスをステータスで絞り込みます。複数指定可能です。
name query string 任意 レスポンスをスタック名で絞り込みます。複数指定可能です。
action query string 任意 レスポンスをアクションで絞り込みます。複数指定可能です。
tenant query string 任意 レスポンスをプロジェクトで絞り込みます。複数指定可能です。
username query string 任意 レスポンスをユーザー名で絞り込みます。複数指定可能です。
owner_id query string 任意 レスポンスを所有者IDで絞り込みます。複数指定可能です。
limit query integer 任意 クエリ結果で返却される項目の最大数
指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
marker query string 任意 前回のレスポンスの最後の項目のID
limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
sort_keys query string 任意 レスポンスをソートします。「stack_name」、「 stack_status」、「creation_time」、または「updated_time」を指定できます。
sort_dir query string 任意 ソートの方向
asc (ascending：昇順)、またはdesc (descending：降順)です。
show_deleted query boolean 任意 「true」の場合は、削除済みのスタックも返却されます。
show_nested query boolean 任意 「true」の場合は、入れ子のスタックも返却されます。
tags query string 任意 指定するタグが入っていることでレスポンスを絞り込みます。複数のタグを指定する場合は、コンマで区切ることや、ANDで組み合わせることができます。
tags_any query string 任意 指定するタグのどれかが入っていることでレスポンスを絞り込みます。複数のタグを指定する場合は、コンマで区切ることや、ORで組み合わせることができます。
not_tags query string 任意 指定するタグのどれも入っていないことでレスポンスを絞り込みます。複数のタグを指定する場合は、コンマで区切ることや、ANDで組み合わせることができます。
not_tags_any query string 任意 指定するタグのどれかが入っていないことでレスポンスを絞り込みます。複数のタグを指定する場合は、コンマで区切ることや、ORで組み合わせることができます。
global_tenant query boolean 任意 「true」の場合は、レスポンスにすべてのプロジェクトのスタックが返却されます。
with_count query boolean 任意 レスポンスにある項目の数を表示するかどうかを設定します。

レスポンスボディ（正常系）の説明#

名前 Type Description
stacks array スタックオブジェクトのリスト
creation_time string リソースの作成日時
日時の入力形式は以下のISO 8601形式です。
CCYY-MM-DDThh:mm:ss±hh:mm
例：2015-08-27T09:49:58-05:00
「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合にだけ表示されます。
deletion_time string リソースの削除日時
日時の入力形式は以下のISO 8601形式です。
CCYY-MM-DDThh:mm:ss±hh:mm
例：2015-08-27T09:49:58-05:00
「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合にだけ表示されます。
description string スタックの説明
links array スタックのURLのリスト
各URLはhrefとrelのキーペアを含めるJSONのオブジェクトです。relは対象のスタックとの関係を表示します。selfの場合は、対象スタック自身です。
parent string 親スタックの名前
(当該スタックが子スタックである場合だけ表示されます。)
stack_name string 作成するスタックの名前
半角英数字、アンダースコア(_)、ハイフン(-)、ピリオド(.)で構成される先頭英字の文字列を指定します。最大長は255文字です。256文字目以降は無視されます。
stack_owner string スタックの所有者
stack_status string スタックのステータス
stack_status_reason string スタックのステータスの理由
tags array スタックのタグのリスト
updated_time string リソースの更新日時
日時の入力形式は以下のISO 8601形式です。
CCYY-MM-DDThh:mm:ss±hh:mm
例：2015-08-27T09:49:58-05:00
「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合にだけ表示されます。
stack_user_project_id string スタックの所有者のプロジェクトUUID

レスポンス例#

{
    "stacks": [
        {
            "creation_time": "2014-06-03T20:59:46Z",
            "deletion_time": null,
            "description": "sample stack",
            "id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
            "links": [
                {
                    "href": "http://192.168.123.200:8004/v1/eb1c63a4f77141548385f113a28f0f52/stacks/simple_stack/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
                    "rel": "self"
                }
            ],
            "parent": null,
            "stack_name": "simple_stack",
            "stack_owner": null,
            "stack_status": "CREATE_COMPLETE",
            "stack_status_reason": "Stack CREATE completed successfully",
            "stack_user_project_id": "71510cbd459a49ac989ca1055de7038b",
            "tags": null,
            "updated_time": null
        }
    ]
}