List stack resources#

スタックのリソースを一覧表示します。

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/{stack_name}/{stack_id}/resources

HTTPステータスコード#

正常時：200

エラー時：400, 401, 404

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

名前 In Type デフォルト値
/必須指定		 Description
tenant_id path string 必須 プロジェクトID
stack_name path string 必須 スタック名
stack_id path string 必須 スタックのUUID
type query string 任意 レスポンスをスタックのリソースタイプで絞り込みます。複数指定可能です。
status query string 任意 レスポンスをスタックのステータスで絞り込みます。指定可能なステータスは「COMPLETE」、「FAILED」と「IN_PROGRESS」です。複数指定可能です。
name query string 任意 レスポンスをリソース名で絞り込みます。複数指定可能です。
action query string 任意 レスポンスをスタックのリソースアクションで絞り込みます。指定可能なステータスは「ADOPT」、「CHECK」、「CREATE」、「DELETE」、「INIT」、「RESTORE」、「RESUME」、「ROLLBACK」、「SNAPSHOT」、「SUSPEND」、または「UPDATE」です。
id query string 任意 レスポンスをスタックリソースのIDで絞り込みます。複数指定可能です。
physical_resource_id query string 任意 レスポンスをスタックの物理リソースのIDで絞り込みます。複数指定可能です。
nested_depth query integer 任意 指定する階層までの入れ子が返却されます。
with_detail query boolean 任意 リソースの詳細情報を表示します。

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

名前 Type Description
resources array リソースオブジェクトのリスト
creation_time string リソースの作成日時
日時の入力形式は以下のISO 8601形式です。
CCYY-MM-DDThh:mm:ss±hh:mm
例：2015-08-27T09:49:58-05:00
「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合にだけ表示されます。
links array スタックのURLのリスト
各URLはhrefとrelのキーペアを含めるJSONのオブジェクトです。relは対象のスタックとの関係を表示します。selfの場合は、対象スタック自身です。
logical_resource_id string スタックの論理リソースのID
physical_resource_id string スタックの物理リソースのID
required_by array スタックを必要としているリソースのリスト
resource_name string リソース名
resource_status string リソースのステータス
resource_status_reason string リソースのステータスの理由
resource_type string リソースのタイプの名前
updated_time string リソースの更新日時
日時の入力形式は以下のISO 8601形式です。
CCYY-MM-DDThh:mm:ss±hh:mm
例：2015-08-27T09:49:58-05:00
「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合にだけ表示されます。

レスポンス例#

{
    "resources": [
        {
            "creation_time": "2015-06-25T14:59:53",
            "links": [
                {
                    "href": "http://hostname/v1/1234/stacks/mystack/629a32d0-ac4f-4f63-b58d-f0d047b1ba4c/resources/random_key_name",
                    "rel": "self"
                },
                {
                    "href": "http://hostname/v1/1234/stacks/mystack/629a32d0-ac4f-4f63-b58d-f0d047b1ba4c",
                    "rel": "stack"
                }
            ],
            "logical_resource_id": "random_key_name",
            "physical_resource_id": "mystack-random_key_name-pmjmy5pks735",
            "required_by": [],
            "resource_name": "random_key_name",
            "resource_status": "CREATE_COMPLETE",
            "resource_status_reason": "state changed",
            "resource_type": "OS::Heat::RandomString",
            "updated_time": "2015-06-25T14:59:53"
        }
    ]
}